Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add API to return list of downstream blocks for an upstream [FC-0076] #36253

Merged
merged 4 commits into from
Feb 25, 2025
Merged

feat: add API to return list of downstream blocks for an upstream [FC-0076] #36253

merged 4 commits into from
Feb 25, 2025
+95 −3

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Feb 14, 2025 •
edited
Loading

Description

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

Additional Information

Testing Instructions

Private ref: FAL-4005

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

openedx-webhooks commented Feb 14, 2025 •
edited
Loading

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.

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.

@rpenido rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch from c7ed62d to 3738603 Compare February 14, 2025 02:12
@rpenido rpenido mentioned this pull request Feb 14, 2025
Merged
@rpenido 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
navinkarkera requested changes Feb 14, 2025
View reviewed changes
Copy link
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rpenido Works as expected, just left some suggestions.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 14, 2025
ChrisChV
ChrisChV approved these changes Feb 17, 2025
View reviewed changes
Copy link
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Only one nit

@rpenido 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 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 rpenido marked this pull request as ready for review February 20, 2025 02:37
@rpenido 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 rpenido marked this pull request as draft February 20, 2025 15:05
@rpenido 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 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
@rpenido rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch from 537d374 to 9bf84b2 Compare February 20, 2025 17:16
navinkarkera
navinkarkera requested changes Feb 21, 2025
View reviewed changes
cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py Outdated
Comment on lines 165 to 167
downstream_usage_key_str_list = [str(usage_key) for usage_key in downstream_usage_key_list]

return Response(downstream_usage_key_str_list)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

@rpenido rpenido Feb 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

openedx/core/djangoapps/content/search/documents.py Outdated
Comment on lines 233 to 239
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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@rpenido rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch from fb6303c to 439bc0f Compare February 21, 2025 19:45
@rpenido rpenido marked this pull request as ready for review February 21, 2025 21:52
navinkarkera
navinkarkera approved these changes Feb 24, 2025
View reviewed changes
Copy link
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

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

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.

@ChrisChV ChrisChV merged commit 9451cfc into openedx:master Feb 25, 2025
49 checks passed
@ChrisChV ChrisChV deleted the rpenido/fal-4005/list-courses-using-library branch February 25, 2025 18:55
@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

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

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

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

@navinkarkera navinkarkera mentioned this pull request Feb 27, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@navinkarkera navinkarkera navinkarkera approved these changes

@ChrisChV ChrisChV ChrisChV approved these changes

Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@rpenido @openedx-webhooks @kdmccormick @edx-pipeline-bot @navinkarkera @ChrisChV @mphilbrick211