Skip to content

feat: container links api #36911

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.

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

Merged
merged 7 commits into from
Jun 24, 2025

Conversation

navinkarkera
Copy link
Contributor

@navinkarkera navinkarkera commented Jun 13, 2025

Description

Adds list api to fetch container library links information. See openedx/frontend-app-authoring#2145 for more details.

Useful information to include:

  • Which edX user roles will this change impact: "Developer".

Supporting information

Testing instructions

Please see openedx/frontend-app-authoring#2145 for instructions

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.
  • If your database migration can't be rolled back easily.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jun 13, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jun 13, 2025

Thanks for the pull request, @navinkarkera!

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.

Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 This code is working well, thank you @navinkarkera !

I noted a bug with deleting / restoring containers with parents that can be included here, or fixed as a separate PR, as you wish.

@@ -312,7 +312,7 @@ def filter_links(
ready_to_sync = link_filter.pop('ready_to_sync', None)
result = cls.objects.filter(**link_filter).select_related(
"upstream_container__publishable_entity__published__version",
"upstream_container__publishable_entity__learning_package"
"upstream_container__publishable_entity__learning_package",
Copy link
Contributor

Choose a reason for hiding this comment

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

Oops.. We should probably backport this one-line fix to Teak. Can you split it into a separate commit?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pomegranited Good idea.

assert response.status_code == 200
data = response.json()
self.assertTrue(all(o["ready_to_sync"] for o in data["results"]))
self.assertEqual(data["count"], 1)
Copy link
Contributor

Choose a reason for hiding this comment

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

(Unrelated to this line/file, but part of this issue)

When I delete a Unit from a Subsection (or a Subsection from a Section), the container API correctly returns the updated child list, but the search index still shows the old child Unit/Subsection in the container Card preview.

The content_libraries.api.containers.delete_container and restore_container methods need to send LIBRARY_CONTAINER_UPDATED for each of the affected parent containers, like we do in update_container.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pomegranited Fixed it here: 1d97610

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Jun 20, 2025
@navinkarkera navinkarkera force-pushed the navin/fal-4167/container-link-api branch from 5d6b281 to e9e3a86 Compare June 24, 2025 09:27
@navinkarkera navinkarkera force-pushed the navin/fal-4167/container-link-api branch from 07bd28d to 1d97610 Compare June 24, 2025 10:17
@ChrisChV ChrisChV enabled auto-merge (squash) June 24, 2025 17:00
@ChrisChV ChrisChV merged commit 2c27214 into openedx:master Jun 24, 2025
48 checks passed
@ChrisChV ChrisChV deleted the navin/fal-4167/container-link-api branch June 24, 2025 17:20
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Jun 24, 2025
@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants