feat: REST API for create Library Collection [FC-0062] by ChrisChV · Pull Request #35447 · openedx/openedx-platform

ChrisChV · 2024-09-07T18:47:04Z

Description

Adds a REST API view to create a new collection.

Supporting information

Github link: Library Home - Create new collection frontend-app-authoring#1100
Internal ticket: FAL-3788
Used by: feat: Create collection Modal [FC-0062] frontend-app-authoring#1259

Testing instructions

Follow the testing instructions at feat: Create collection Modal [FC-0062] frontend-app-authoring#1259

openedx-webhooks · 2024-09-07T18:47:08Z

Thanks for the pull request, @ChrisChV!

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 @openedx/wg-maintenance-edx-platform. 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.

ChrisChV · 2024-09-09T16:19:29Z

 openedx-events                      # Open edX Events from Hooks Extension Framework (OEP-50)
 openedx-filters                     # Open edX Filters from Hooks Extension Framework (OEP-50)
-openedx-learning                    # Open edX Learning core (experimental)
+git+https://github.com/open-craft/openedx-learning.git@jill/collection-key#egg=openedx-learning                    # Open edX Learning core (experimental)


TODO: Bump version

rpenido

This is looking good @ChrisChV! Good work!

I think we already have the event for LIBRARY_COLLECTION_CREATED. Should we implement the index update as part of this task?

rpenido · 2024-09-09T16:52:49Z

    # Get the list of collections
    status_cb("Counting collections...")
-    num_collections = authoring_api.get_collections().count()
+    collections = Collection.objects.filter(enabled=True).select_related("learning_package").order_by('pk')


Note: This is also being solved here (#35321) with a different approach.

@rpenido Do you think I should revert this and let #35321 sort it out?

Yes! I think you don't need to worry about it here. cc @pomegranited

Done: 3180f76

rpenido · 2024-09-09T17:02:57Z

+        try:
+            result = authoring_api.create_collection(
+                learning_package_id=library.learning_package_id,
+                key=key,
+                title=title,
+                description=serializer.validated_data['description'],
+                created_by=request.user.id,
+            )
+        except IntegrityError:
+            return Response(status=status.HTTP_409_CONFLICT)


As the user can't directly edit the slug, do you think it is worth an approach like this?

Suggested change

try:

result = authoring_api.create_collection(

learning_package_id=library.learning_package_id,

key=key,

title=title,

description=serializer.validated_data['description'],

created_by=request.user.id,

)

except IntegrityError:

return Response(status=status.HTTP_409_CONFLICT)

attempt = 0

result = None

while not result:

modified_key = key if attempt = 0 else key + str(attempt)

try:

result = authoring_api.create_collection(

learning_package_id=library.learning_package_id,

key=modified_key,

title=title,

description=serializer.validated_data['description'],

created_by=request.user.id,

)

except IntegrityError:

attempt += 1

@rpenido Thanks! Updated here: 44144c4

rpenido · 2024-09-09T17:03:24Z

+    # Rename collection.key to "slug" because "key" is a reserved prop name in React
+    slug = serializers.CharField(read_only=True)


Do we plan to change it in the model?
Also, this is not being returned from the rest call.

That wasn't my plan. I've already updated the code to return the slug in the response: 817e3b4

…on create collection API view

ChrisChV · 2024-09-09T22:07:58Z

I think we already have the event for LIBRARY_COLLECTION_CREATED. Should we implement the index update as part of this task?

@rpenido I added it here: b7378ab

ChrisChV · 2024-09-10T16:50:04Z

@rpenido I just noticed that this API is being implemented here. I'm going to use that branch to avoid any conflicts.

ChrisChV · 2024-09-10T17:58:32Z

Closed in flavor of open-craft#683

ChrisChV added 2 commits September 7, 2024 13:36

fix: Bug when indexing collections

135a7ca

feat: Add REST-API to create a collection

590fc0e

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

feat: Verify key uniques in creating collection view

10f3e49

ChrisChV mentioned this pull request Sep 7, 2024

feat: Create collection Modal [FC-0062] openedx/frontend-app-authoring#1259

Merged

ChrisChV added 2 commits September 9, 2024 10:36

style: Fix lint on the code

121ed6c

chore: Using new version of open-edx learning from branch

0f173e9

ChrisChV commented Sep 9, 2024

View reviewed changes

ChrisChV added 2 commits September 9, 2024 11:21

style: Nit on one comment

bf367e8

test: for REST API to create collections

57bb313

rpenido reviewed Sep 9, 2024

View reviewed changes

ChrisChV added 3 commits September 9, 2024 15:15

refactor: Create correlative key in create collection rest api view

44144c4

fix: Adding slug to create collection response

817e3b4

Merge branch 'master' into chris/FAL-3788-create-collection

583f932

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Sep 9, 2024

feat: Update openedx_events and add LIBRARY_COLLECTION_CREATED event …

b7378ab

…on create collection API view

ChrisChV added 2 commits September 10, 2024 09:02

Merge branch 'master' into chris/FAL-3788-create-collection

0c5e572

revert: fixes in rebuild index

3180f76

ChrisChV closed this Sep 10, 2024

		# Rename collection.key to "slug" because "key" is a reserved prop name in React
		slug = serializers.CharField(read_only=True)

Uh oh!

Conversation

ChrisChV commented Sep 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Uh oh!

openedx-webhooks commented Sep 7, 2024

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?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rpenido left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rpenido Sep 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChrisChV commented Sep 9, 2024

Uh oh!

ChrisChV commented Sep 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChrisChV commented Sep 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ChrisChV commented Sep 7, 2024 •

edited

Loading

rpenido Sep 9, 2024 •

edited

Loading

ChrisChV commented Sep 10, 2024 •

edited

Loading