feat: add Collection model and api #206

rpenido · 2024-08-05T20:35:08Z

Description

This PR adds the Collection model and some basic APIs to create/get collections.

More information

Closes openedx/modular-learning#225

Testing Instructions

Please ensure that the tests cover the expected behavior

Private ref: FAL-3782

openedx-webhooks · 2024-08-05T20:35:12Z

Thanks for the pull request, @rpenido!

What's next?

Please work through the following steps to get your changes 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.

🔘 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

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

tests/openedx_learning/apps/authoring/components/test_api.py

yusuf-musleh · 2024-08-06T15:31:13Z

@rpenido This is looking good to me so far, great work!

openedx_learning/apps/authoring/collections/models.py

pomegranited

Looks great @rpenido !
One little nit and could you please bump the minor version for this package?

👍

I tested this by running the tests and checking for full coverage of the API and tests.
I read through the code
~~I checked for accessibility issues~~ N/A
Includes documentation
User-facing strings are extracted for translation

openedx_learning/apps/authoring/collections/readme.rst

Co-authored-by: Jillian <[email protected]>

rpenido · 2024-08-07T15:46:46Z

One little nit and could you please bump the minor version for this package?

Done! 370e73a

rpenido · 2024-08-08T12:34:55Z

Hi @pomegranited! I added a update_collection function and more tests here: d6cdf08

pomegranited

👍 Thanks @rpenido ! I forgot to ask you to add collections.api to api.authoring, so did that here: ba04b4b.

Will merge this today, thank you!

I tested this by checking the test coverage
I read through the code
~~I checked for accessibility issues~~ N/A
Includes documentation -- readme, field help, and docstrings
User-facing strings are extracted for translation

openedx-webhooks · 2024-08-08T16:37:38Z

@rpenido 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

ormsbee · 2024-08-08T17:29:28Z

@pomegranited, @rpenido: This is my fault for not watching the PRs flowing here more closely, but could you please tag me on PRs that make new models or significant changes to old ones in the openedx_learning package? I've had my head wrapped around that area for a while, and I haven't properly documented up all the considerations like I should.

I'll add comments about some of the specifics to this PR, even though I realize it's already merged. To be clear: I'm not asking for a revert–just followup at a later point in time.

pomegranited · 2024-08-08T17:32:57Z

My apologies @ormsbee ! I thought you had approved the discovery so we were ok to proceed here.
Will tag you before merging in future, and please let me know if we need to change anything here.

ormsbee · 2024-08-08T18:36:13Z

My apologies @ormsbee ! I thought you had approved the discovery so we were ok to proceed here.

Yeah, that was totally my fault for not communicating clearly. I did approve the discovery doc, but with this comment:

I'm good with the general approach. There are some low level details that we can work out in the PRs–e.g. keeping field naming in line with existing openedx-learning conventions, or understanding exactly what some fields mean (allow_multiple?).

Will tag you before merging in future, and please let me know if we need to change anything here.

Thank you!

ormsbee

Sorry I didn't get this feedback to you folks sooner. Thank you!

ormsbee · 2024-08-08T18:44:06Z

openedx_learning/apps/authoring/collections/models.py

+            "The name of the collection."
+        ),
+    )
+    description = case_insensitive_char_field(


If we're intending this to be long, it should be a text field, not a char field. There's no helper for this in fields.py right now–see the example for LearningPackage's description field.

Also, MySQL indexing limits means that even if you specify 10K as the max length here, only the first 767 characters will be guaranteed to be indexable as a varchar. We can just turn this off altogether and not make the name searchable at the database layer (relying on dedicated search later).

ormsbee · 2024-08-08T18:44:34Z

openedx_learning/apps/authoring/collections/models.py

+    # Each collection belongs to a learning package
+    learning_package = models.ForeignKey(LearningPackage, on_delete=models.CASCADE)
+
+    name = case_insensitive_char_field(


Please use title here instead of name for consistency with LearningPackage and PublishableEntityVersion.

ormsbee · 2024-08-08T18:45:50Z

openedx_learning/apps/authoring/collections/models.py

+    name = case_insensitive_char_field(
+        null=False,
+        max_length=255,
+        db_index=True,


Please put all indexes in the indexes attribute of this model's Meta, even the ones for individual columns.

Also, while it's fine to have a global index on the Collection titles, the most common sorting case is going to be to order by name, scoped to a particular LearningPackage. So you'll want to make a compound index on the combination of (learning_package_id, title).

ormsbee · 2024-08-08T18:48:17Z

openedx_learning/apps/authoring/collections/models.py

+
+    name = case_insensitive_char_field(
+        null=False,
+        max_length=255,


Again for consistency, please use the same numbers as LearningPackage for now (500).

The historical reason for 255 was because that was the largest indexable value when using utf8mb3 encoding and the older InnoDB backend. We're now running utf8mb4 and newer InnoDB tables.

ormsbee · 2024-08-08T18:59:59Z

openedx_learning/apps/authoring/collections/models.py

+        ),
+    )
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)


Most of Learning Core uses manually set datetimes (no auto), but I think it's okay to use here because Collections are created differently (e.g. you're not going to have Publish operation that creates a Collections in bulk).

But please do add the validate_utc_datetime validator.

ormsbee · 2024-08-08T19:06:45Z

openedx_learning/apps/authoring/collections/models.py

+            "Whether the collection is enabled or not."
+        ),
+    )
+    created = models.DateTimeField(auto_now_add=True)


In addition to when it was created, we need to track who it was created by (which should be nullable in case the system created it or the user is deleted). We have created_by fields in some other models as well.

ormsbee · 2024-08-08T19:09:52Z

openedx_learning/apps/authoring/collections/api.py

+    """
+    Update a Collection
+    """
+    lp = Collection.objects.get(id=collection_id)


Why is this variable lp? LearningPackage?

ormsbee · 2024-08-08T19:12:55Z

openedx_learning/apps/authoring/collections/api.py

+        .filter(learning_package_id=learning_package_id, enabled=True)
+        .select_related("learning_package")


Nit: I'm a little surprised the linter didn't error on this, since I thought it was pretty fussy about indentation, e.g.

Collection.objects \ .filter(learning_package_id=learning_package_id, enabled=True) \ .select_related("learning_package")

rpenido · 2024-08-09T16:39:04Z

Sorry I didn't get this feedback to you folks sooner. Thank you!

No worries, and thank you for your review @ormsbee! I addressed the issues in #208.

Could you check and see if you find more room for improvements there?

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 5, 2024

rpenido force-pushed the rpenido/fal-3782-collections-model branch 3 times, most recently from 329c77f to 0acacf2 Compare August 5, 2024 20:55

feat: add collection model and api

bd78879

rpenido force-pushed the rpenido/fal-3782-collections-model branch from 0acacf2 to bd78879 Compare August 5, 2024 21:00

rpenido commented Aug 5, 2024

View reviewed changes

tests/openedx_learning/apps/authoring/components/test_api.py Show resolved Hide resolved

bradenmacdonald reviewed Aug 6, 2024

View reviewed changes

openedx_learning/apps/authoring/collections/models.py Show resolved Hide resolved

docs: add readme, docstring and return types

28a96f9

rpenido marked this pull request as ready for review August 6, 2024 19:44

rpenido requested a review from pomegranited August 6, 2024 19:44

pomegranited approved these changes Aug 7, 2024

View reviewed changes

openedx_learning/apps/authoring/collections/readme.rst Outdated Show resolved Hide resolved

rpenido and others added 2 commits August 7, 2024 12:45

docs: fix typo

29c0b29

Co-authored-by: Jillian <[email protected]>

chore: bump version

370e73a

rpenido force-pushed the rpenido/fal-3782-collections-model branch from 8c56b26 to ec9365c Compare August 8, 2024 12:26

feat: add update function and more tests

d6cdf08

rpenido force-pushed the rpenido/fal-3782-collections-model branch from ec9365c to d6cdf08 Compare August 8, 2024 12:28

rpenido requested a review from pomegranited August 8, 2024 12:35

chore: export collections.api api.authoring

ba04b4b

pomegranited approved these changes Aug 8, 2024

View reviewed changes

pomegranited merged commit ddb78bb into openedx:main Aug 8, 2024
9 checks passed

pomegranited deleted the rpenido/fal-3782-collections-model branch August 8, 2024 16:37

ormsbee reviewed Aug 8, 2024

View reviewed changes

rpenido mentioned this pull request Aug 9, 2024

fix: improve collections models and api [FC-0059] #208

Merged

rpenido mentioned this pull request Aug 14, 2024

feat: add collections app from openedx-learning [FC-0059] openedx/edx-platform#35312

Merged

This was referenced Aug 14, 2024

fix: prevent soft-deletes from being re-published every time #211

Merged

refactor: create_next_version -> create_next_component_version #215

Merged

ormsbee mentioned this pull request Aug 22, 2024

Basic asset response support #217

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add Collection model and api #206

feat: add Collection model and api #206

rpenido commented Aug 5, 2024 •

edited

Loading

openedx-webhooks commented Aug 5, 2024 •

edited

Loading

yusuf-musleh commented Aug 6, 2024

pomegranited left a comment

rpenido commented Aug 7, 2024

rpenido commented Aug 8, 2024

pomegranited left a comment •

edited

Loading

openedx-webhooks commented Aug 8, 2024

ormsbee commented Aug 8, 2024

pomegranited commented Aug 8, 2024

ormsbee commented Aug 8, 2024

ormsbee left a comment

ormsbee Aug 8, 2024

ormsbee Aug 8, 2024

ormsbee Aug 8, 2024

ormsbee Aug 8, 2024

ormsbee Aug 8, 2024

ormsbee Aug 8, 2024

ormsbee Aug 8, 2024

ormsbee Aug 8, 2024

ormsbee Aug 8, 2024

rpenido commented Aug 9, 2024

		.filter(learning_package_id=learning_package_id, enabled=True)
		.select_related("learning_package")

feat: add Collection model and api #206

feat: add Collection model and api #206

Conversation

rpenido commented Aug 5, 2024 • edited Loading

Description

More information

Testing Instructions

openedx-webhooks commented Aug 5, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

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

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

yusuf-musleh commented Aug 6, 2024

pomegranited left a comment

Choose a reason for hiding this comment

rpenido commented Aug 7, 2024

rpenido commented Aug 8, 2024

pomegranited left a comment • edited Loading

Choose a reason for hiding this comment

openedx-webhooks commented Aug 8, 2024

ormsbee commented Aug 8, 2024

pomegranited commented Aug 8, 2024

ormsbee commented Aug 8, 2024

ormsbee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rpenido commented Aug 9, 2024

rpenido commented Aug 5, 2024 •

edited

Loading

openedx-webhooks commented Aug 5, 2024 •

edited

Loading

pomegranited left a comment •

edited

Loading