feat: Add missing metadata backup fields to the result endpoint data#416
Conversation
- Add original_server, created_by_email, and created_by_full_name
|
Thanks for the pull request, @dwong2708! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
| import logging | ||
| import time | ||
|
|
||
| from django.contrib.auth.models import User as UserType # pylint: disable=imported-auth-user |
There was a problem hiding this comment.
Why do we need to disable a pylint check here?
There was a problem hiding this comment.
Should we change to use get_user_model?
There was a problem hiding this comment.
Hi guys, I replaced direct User imports with UserType for type hints and get_user_model() for runtime queries
…d get_user_model() for runtime queries
ormsbee
left a comment
ormsbee
left a comment
There was a problem hiding this comment.
Sorry, this one is totally my fault: Please remove the full name in the output, since we store that in a non-standard way that only exists in edx-platform and not openedx-learning.
| if user: | ||
| metadata.add("created_by", user.username) | ||
| metadata.add("created_by_email", user.email) | ||
| metadata.add("created_by_full_name", user.get_full_name()) |
There was a problem hiding this comment.
Argh, I forgot again that what we do with User is weird and edx-platform specific with our UserProfile holding the full name. Please just remove the full name for now and stick with username and email. Thank you.
5 participants
Description
This PR adds the missing backup metadata fields, specifically:
created_by_email = "lp_user@example.com"origin_server = "cms.test"These fields are now included in the
package.tomlfile as part of the backup metadata and will be used by the restore endpoint.Motivation
The restore process depends on these metadata fields to properly identify the backup source and author information.