feat: adds Collection.key

pomegranited commented 2 months ago

Description

Adds a new required field to the Collection model: key (string), which uniquely identifies a Collection within a Learning Package. Existing Collection keys are initialized with a random string.

Supporting information

Part of : https://github.com/openedx/modular-learning/issues/226

Private-ref: FAL-3783

Testing instructions

See https://github.com/openedx/edx-platform/pull/35321 for full testing instructions.

Testing migrations:

In an openedx-learning virtual environment, run:

Create an openedx-learning virtual environment
Install openedx-learning @ main, and run python3 manage.py migrate

Create a collection python3 manage.py shell:

import openedx_learning.api.authoring as api
learning_package = api.create_learning_package("LP1", "Learning Package 1")
for x in range(0, 11):
   api.create_collection(learning_package.id, title=f"Collection {x}", created_by=None)
   # <Collection> (1:Collection 1)
   # <Collection> (2:Collection 2)
   ...
   # <Collection> (10:Collection 10)

Install openedx-learning @ open-craft/jill/collection-key
Run python3 manage.py migrate

Check that a key was generated for your collection python3 manage.py shell:

import openedx_learning.api.authoring as api
learning_package = api.get_learning_package_by_key("LP1")
collections = api.get_collections(learning_package.id)
for collection in collections.all():
   print(collection.key)
   # gy19KxxV9xrjEMmR4TRNeE2p8sEbQfetVjZPzKPUbHURAgAgJY
   # RNeE2p8sEbQfetVjZPzKPUbgy19KxxV9xrjEMmR4TRNeE2p8sEb
   ...

openedx-webhooks commented 2 months ago

Thanks for the pull request, @pomegranited!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: 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.

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

:radio_button: 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.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @axim-engineering. Tag them in a comment and let them know that your changes are ready for review.

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

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

pomegranited commented 2 months ago

Hi @ormsbee , this is a minor PR, but I'd appreciate your review if you have time?

openedx / openedx-learning