Skip to content

Conversation

@dwong2708
Copy link
Contributor

@dwong2708 dwong2708 commented Sep 3, 2025

Description

Resolves #361
This PR adds support for serializing collections into the learning package dump file.

Key Changes

  • Each collection is serialized as a TOML file within the dump folder.
  • Added a prefetch_related query on the collections queryset to improve performance.
  • When generating collection TOML files, related entities are included, but their versions are not.

Example Output

Filename: col1_06bb25.toml

[collection]
title = "Collection 1"
description = "Description of Collection 1"
created = 2025-09-03T18:56:57.524111Z

# ### Entities

[[entity]]
uuid = "4ebf2668-75e2-4e27-b339-33b45fd2a087"
can_stand_alone = true
key = "xblock.v1:problem:my_published_example"

[[entity]]
uuid = "a068659e-27ea-4495-82ad-9d0bf11d64da"
can_stand_alone = true
key = "xblock.v1:html:my_draft_example"

- Add a prefetch query to the collections queryset to improve performance
- When creating collection TOML files, include related entities but not their versions
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 3, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 3, 2025

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 Sep 3, 2025
@dwong2708 dwong2708 marked this pull request as ready for review September 3, 2025 18:58
@dwong2708 dwong2708 requested a review from ormsbee September 3, 2025 19:07
Copy link

@wgu-taylor-payne wgu-taylor-payne left a comment

Choose a reason for hiding this comment

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

Looks good overall, Daniel. Here are some suggestions from a quick, high-level overview.

Comment on lines 165 to 169
[[entity]]
uuid = "f8ea9bae-b4ed-4a84-ab4f-2b9850b59cd6"
can_stand_alone = true
key = "xblock.v1:problem:my_published_example"
"""
Copy link
Contributor

Choose a reason for hiding this comment

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

The entity information will already come out with the TOML files for each entity. The collection just needs to point to it using its identifiers, like containers will. So something like this would work:

 [collection]
title = "Collection 1"
key = "collection-1"
description = "Description of Collection 1"
created = 2025-09-03T17:50:59.565939Z
entities = [
    "key-for-entity-1",
    "key-for-entity-2",
    # etc.
]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Applied. Thanks Dave

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.

A couple of minor requests.

Comment on lines 183 to 184
for entity_key in entity_keys:
entities_array.append(entity_key)
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: You should be able to use extend() here instead of appending one key at a time:

entities_array.extend(entity_keys)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice. Applied. Thanks

"""
doc = tomlkit.document()

entity_keys = collection.entities.values_list("key", flat=True)
Copy link
Contributor

Choose a reason for hiding this comment

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

For the sake of making exports consistent (and easier to diff), we should make the ordering deterministic. Please sort this list by key.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@dwong2708 dwong2708 requested a review from ormsbee September 5, 2025 22:31
@ormsbee ormsbee merged commit 126588e into openedx:main Sep 5, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Sep 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Serialize collections into dump output

5 participants