feat: add collection serialization to lp_dump#372
Conversation
- Add a prefetch query to the collections queryset to improve performance - When creating collection TOML files, include related entities but not their versions
|
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. |
wgu-taylor-payne
left a comment
There was a problem hiding this comment.
Looks good overall, Daniel. Here are some suggestions from a quick, high-level overview.
tests/openedx_learning/apps/authoring/backup_restore/test_backup.py
Outdated
Show resolved
Hide resolved
| [[entity]] | ||
| uuid = "f8ea9bae-b4ed-4a84-ab4f-2b9850b59cd6" | ||
| can_stand_alone = true | ||
| key = "xblock.v1:problem:my_published_example" | ||
| """ |
There was a problem hiding this comment.
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.
]There was a problem hiding this comment.
Applied. Thanks Dave
ormsbee
left a comment
There was a problem hiding this comment.
A couple of minor requests.
| for entity_key in entity_keys: | ||
| entities_array.append(entity_key) |
There was a problem hiding this comment.
Nit: You should be able to use extend() here instead of appending one key at a time:
entities_array.extend(entity_keys)There was a problem hiding this comment.
Nice. Applied. Thanks
| """ | ||
| doc = tomlkit.document() | ||
|
|
||
| entity_keys = collection.entities.values_list("key", flat=True) |
There was a problem hiding this comment.
For the sake of making exports consistent (and easier to diff), we should make the ordering deterministic. Please sort this list by key.
Description
Resolves #361
This PR adds support for serializing collections into the learning package dump file.
Key Changes
prefetch_relatedquery on the collections queryset to improve performance.Example Output
Filename: col1_06bb25.toml