Skip to content

feat: include learning package metadata in the backup dump file #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
ormsbee merged 3 commits into from
Oct 2, 2025
Merged

feat: include learning package metadata in the backup dump file #402

ormsbee merged 3 commits into from
Oct 2, 2025

Conversation

@dwong2708
Copy link
Contributor

@dwong2708 dwong2708 commented Oct 1, 2025 •
edited
Loading

Resolves: #395

Changes

Add metadata to the backup dump file with the following fields:

[meta]
format_version = 1
created_by = "dormsbee"
created_at = <datetime>
origin_server = "{settings.CMS_BASE}"

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 1, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Oct 1, 2025 •
edited
Loading

Thanks for the pull request, @dwong2708!

This repository is currently maintained by @axim-engineering.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Oct 1, 2025
@dwong2708 dwong2708 requested a review from ormsbee October 1, 2025 18:05
@dwong2708 dwong2708 marked this pull request as ready for review October 1, 2025 18:05
ormsbee
ormsbee requested changes Oct 2, 2025
View reviewed changes
openedx_learning/apps/authoring/backup_restore/toml.py Outdated
learning_package: LearningPackage,
timestamp: datetime,
format_version: int = 1,
user: str | None = None
Copy link
Contributor

@ormsbee ormsbee Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should take an actual User object, so that we can add more info about the user later if we decide it's prudent, e.g. their email.

Copy link
Contributor Author

@dwong2708 dwong2708 Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Changes have been applied.

openedx_learning/apps/authoring/backup_restore/toml.py Outdated
# Learning package metadata
metadata = tomlkit.table()
metadata.add("format_version", format_version)
metadata.add("created_by", user or "unknown")
Copy link
Contributor

@ormsbee ormsbee Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we don't have user information, let's just omit the field. The string "unknown" is a highly unlikely, but technically legal username. Omitting the field is more or less the TOML version of making null.

Copy link
Contributor Author

@dwong2708 dwong2708 Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Done. Thanks.

openedx_learning/apps/authoring/backup_restore/toml.py Outdated
metadata.add("format_version", format_version)
metadata.add("created_by", user or "unknown")
metadata.add("created_at", timestamp)
metadata.add("origin_server", getattr(settings, "CMS_BASE", "unknown"))
Copy link
Contributor

@ormsbee ormsbee Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Argh. I forgot that we'd need to pipe this value from edx-platform settings if we were to include it. We don't want to start the precedent of openedx-learning knowing about edx-platform specific settings. Let's just make this an optional param on the function for now, instead of reading from the settings. Libraries code in edx-platform can pass it in later. This is another one of those fields that we can omit if there's no value passed in.

Copy link
Contributor Author

@dwong2708 dwong2708 Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. The value needs to be provided from edx-platform. Changes applied.

@dwong2708 dwong2708 requested a review from ormsbee October 2, 2025 17:06
ormsbee
ormsbee requested changes Oct 2, 2025
View reviewed changes
Copy link
Contributor

@ormsbee ormsbee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny nit, but otherwise LGTM

openedx_learning/apps/authoring/backup_restore/toml.py Outdated
format_version = 1
created_by = "dormsbee"
created_at = 2025-09-03T17:50:59.536190Z
origin_server = "http://cms.test"
Copy link
Contributor

@ormsbee ormsbee Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
origin_server = "http://cms.test"
origin_server = "cms.test"

Nit: The value from CMS_BASE isn't going to include "http://".

Copy link
Contributor Author

@dwong2708 dwong2708 Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Thanks.

@dwong2708 dwong2708 requested a review from ormsbee October 2, 2025 19:32
@ormsbee ormsbee merged commit 312d024 into openedx:main Oct 2, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Oct 2, 2025
@ormsbee ormsbee mentioned this pull request Dec 30, 2025
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ormsbee ormsbee ormsbee approved these changes

Assignees

No one assigned

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Backup creation date needs to be saved as a field

3 participants

@dwong2708 @openedx-webhooks @ormsbee