feat: add API to return list of downstream blocks for an upstream [FC-0076] by rpenido · Pull Request #36253 · openedx/openedx-platform

rpenido · 2025-02-14T02:05:13Z

Description

This PR adds the api for listing downstream contexts and parents for a given publishable entity.

Additional Information

Testing Instructions

See feat: add component usage data in the ComponentDetails component [FC-0076] frontend-app-authoring#1656

Private ref: FAL-4005

openedx-webhooks · 2025-02-14T02:05:18Z

Thanks for the pull request, @rpenido!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

navinkarkera

@rpenido Works as expected, just left some suggestions.

cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py

ChrisChV

Looks good. Only one nit

cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py

...djangoapps/contentstore/migrations/0010_publishableentitylink_downstream_parent_usage_key.py

cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py

navinkarkera · 2025-02-21T03:15:10Z

cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py

+        downstream_usage_key_str_list = [str(usage_key) for usage_key in downstream_usage_key_list]
+
+        return Response(downstream_usage_key_str_list)


NIT: Instead of manually doing this, we can use serializer.

I avoided it because I was returning only a list of strings.
I updated to use a serializer here (439bc0f) so we can extend it further in the future if needed.

navinkarkera · 2025-02-21T03:53:18Z

openedx/core/djangoapps/content/search/documents.py

+                if cur_block.scope_ids.block_type not in ["chapter", "sequential"]:
+                    parent_data["url"] = (
+                        reverse_course_url("course_handler", cur_block.context_key) +
+                        reverse_usage_url("container_handler", cur_block.usage_key)
+                    )
+            else:
+                parent_data["url"] = reverse_course_url("course_handler", cur_block.context_key)


Not sure if we need to include this data in index as it can be easily derived from the information already present.

You're right. Initially, I thought this would help us handle different waffle flags (like contentstore.new_studio_mfe.use_new_unit_page) but that is not the case.

Reverted here: 6b27c09

navinkarkera

@rpenido Looks good, thanks for your patience. 👍

I tested this: (Tested api via frontend)
I read through the code
I checked for accessibility issues
Includes documentation

kdmccormick · 2025-02-25T18:31:17Z

Building off the feedback I gave @navinkarkera on #36190, I think that a better API structure would be:

downstreams/?course_id=... : List downstream links, filtered by a course key
downstreams/?upstream_usage_id=: List all downstream links for a particular upstream

Since both these API endpoints return one entry per downstream item, it makes sense for them to be under downstreams/ rather than upstream(s)/. Both endpoints could very naturally share the same DRF view class, and simply filter for either or both course_id or upstream_usage_id. Let me know if you disagree.

Definitely merge this PR now in order to unblock your team! But, please coordinate with @navinkarkera to make a followup PR with this new API structure.

edx-pipeline-bot · 2025-02-26T00:22:13Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2025-02-26T00:43:14Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2025-02-26T00:43:14Z

2U Release Notice: This PR has been deployed to the edX production environment.

…-0076] (openedx#36253) Adds the API for listing downstream contexts and parents for a given publishable entity.

…-0076] (#36253) Adds the API for listing downstream contexts and parents for a given publishable entity.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 14, 2025

rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch from c7ed62d to 3738603 Compare February 14, 2025 02:12

rpenido mentioned this pull request Feb 14, 2025

feat: add component usage data in the ComponentDetails component [FC-0076] openedx/frontend-app-authoring#1656

Merged

rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch 5 times, most recently from 4516aa2 to 88e9b08 Compare February 14, 2025 04:11

navinkarkera requested changes Feb 14, 2025

View reviewed changes

cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py Outdated Show resolved Hide resolved

cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py Outdated Show resolved Hide resolved

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 14, 2025

ChrisChV approved these changes Feb 17, 2025

View reviewed changes

cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py Outdated Show resolved Hide resolved

rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch 3 times, most recently from fcdad4c to 965e99a Compare February 20, 2025 02:20

rpenido commented Feb 20, 2025

View reviewed changes

...djangoapps/contentstore/migrations/0010_publishableentitylink_downstream_parent_usage_key.py Outdated Show resolved Hide resolved

rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch 2 times, most recently from c320186 to c752f6d Compare February 20, 2025 02:34

rpenido commented Feb 20, 2025

View reviewed changes

cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py Outdated Show resolved Hide resolved

rpenido marked this pull request as ready for review February 20, 2025 02:37

rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch 2 times, most recently from e92aa0f to c8bbff9 Compare February 20, 2025 02:56

rpenido marked this pull request as draft February 20, 2025 15:05

rpenido changed the title ~~feat: add API to return list of downstream contexts for an upstream [FC-0076]~~ feat: add API to return list of downstream blocks for an upstream [FC-0076] Feb 20, 2025

rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch 5 times, most recently from e904b0a to 537d374 Compare February 20, 2025 17:00

feat: add API to return list of downstream blocks for an upstream

9bf84b2

rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch from 537d374 to 9bf84b2 Compare February 20, 2025 17:16

navinkarkera requested changes Feb 21, 2025

View reviewed changes

fix: remove url from index

6b27c09

rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch from fb6303c to 439bc0f Compare February 21, 2025 19:45

fix: return the downstream_usage_key list using a serializer

ff81e48

rpenido marked this pull request as ready for review February 21, 2025 21:52

navinkarkera approved these changes Feb 24, 2025

View reviewed changes

rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch from 439bc0f to ff81e48 Compare February 25, 2025 12:42

ChrisChV approved these changes Feb 25, 2025

View reviewed changes

Merge branch 'master' into rpenido/fal-4005/list-courses-using-library

0c0f458

ChrisChV merged commit 9451cfc into openedx:master Feb 25, 2025
49 checks passed

ChrisChV deleted the rpenido/fal-4005/list-courses-using-library branch February 25, 2025 18:55

navinkarkera mentioned this pull request Feb 27, 2025

refactor: downstream entity links api [FC-0076] #36311

Merged

tonybusa pushed a commit to tonybusa/edx-platform that referenced this pull request Apr 23, 2025

feat: add API to return list of downstream blocks for an upstream [FC…

8ffaf7f

…-0076] (openedx#36253) Adds the API for listing downstream contexts and parents for a given publishable entity.

UsamaSadiq pushed a commit that referenced this pull request May 14, 2025

feat: add API to return list of downstream blocks for an upstream [FC…

3483634

…-0076] (#36253) Adds the API for listing downstream contexts and parents for a given publishable entity.

		downstream_usage_key_str_list = [str(usage_key) for usage_key in downstream_usage_key_list]

		return Response(downstream_usage_key_str_list)

Conversation

rpenido commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Additional Information

Testing Instructions

Uh oh!

openedx-webhooks commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

navinkarkera left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ChrisChV left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

navinkarkera Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

rpenido Feb 21, 2025 • 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!

navinkarkera Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

rpenido Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

navinkarkera left a comment

Choose a reason for hiding this comment

Uh oh!

kdmccormick commented Feb 25, 2025

Uh oh!

Uh oh!

edx-pipeline-bot commented Feb 26, 2025

Uh oh!

edx-pipeline-bot commented Feb 26, 2025

Uh oh!

edx-pipeline-bot commented Feb 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

rpenido commented Feb 14, 2025 •

edited

Loading

openedx-webhooks commented Feb 14, 2025 •

edited

Loading

rpenido Feb 21, 2025 •

edited

Loading