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.

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

fix: delete discarded components from meilisearch index [FC-0062] #35243

Merged
merged 6 commits into from
Aug 19, 2024

Conversation

navinkarkera
Copy link
Contributor

@navinkarkera navinkarkera commented Aug 7, 2024

Description

Reverting a library to its last published state is done by calling revert_changes view, which triggers CONTENT_LIBRARY_UPDATED signal. This PR updates the task that is triggered to also delete newly created components which were never published from the meilisearch index.

This PR includes three ways of updating the index:

  • 970736f & 06e4c5d fetches draft components that have version = null and explicitly removes them the index. One drawback here is that if the number of components having draft version = null increase, this technique will try to delete them on each discard/publish even if they don't exists in the index.
  • 30ea189 deletes all documents for a given library in the index. This works but it also deletes components which do have draft version and adds them back.
  • 2ec9070 only deletes components that were never published after the publish or discard request.

Supporting information

Testing instructions

See open-craft/frontend-app-authoring#58 for instructions on testing.

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 the open-source-contribution PR author is not from Axim or 2U label Aug 7, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Aug 7, 2024

Thanks for the pull request, @navinkarkera!

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.

@navinkarkera navinkarkera force-pushed the navin/fix-learning-discard branch from 3530c0d to 780ac44 Compare August 7, 2024 10:06
@navinkarkera navinkarkera force-pushed the navin/fix-learning-discard branch from 780ac44 to 34d2c0e Compare August 7, 2024 12:03
@navinkarkera navinkarkera changed the title Navin/fix learning discard fix: delete discarded components from meilisearch index Aug 7, 2024
@navinkarkera navinkarkera changed the title fix: delete discarded components from meilisearch index fix: delete discarded components from meilisearch index [FAL-3797] Aug 12, 2024
@navinkarkera navinkarkera changed the title fix: delete discarded components from meilisearch index [FAL-3797] fix: delete discarded components from meilisearch index [FC-0062] Aug 12, 2024
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Aug 12, 2024
@navinkarkera navinkarkera marked this pull request as ready for review August 13, 2024 10:08
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.

@navinkarkera Looks good 👍

@navinkarkera navinkarkera force-pushed the navin/fix-learning-discard branch from 34d2c0e to 508f6b7 Compare August 14, 2024 15:33
@navinkarkera navinkarkera force-pushed the navin/fix-learning-discard branch from 742a701 to 3dbbbac Compare August 19, 2024 07:33
@navinkarkera navinkarkera merged commit c3480b8 into openedx:master Aug 19, 2024
49 checks passed
@navinkarkera navinkarkera deleted the navin/fix-learning-discard branch August 19, 2024 11:31
@openedx-webhooks
Copy link

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

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants