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: skip block indexing if it raises an error while loading #35139

Merged
merged 4 commits into from
Jul 25, 2024

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Jul 18, 2024

Description

This PR handles errors while updating the document for a library component, so if we get an error with one component, it does not prevent other components from the library from being indexed.

More info

While indexing a library with an openassessment block, the following error is thrown: Every assessment must contain a "title" element. This prevented the whole library with an openassessment block from being indexed.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 18, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @rpenido!

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.

@rpenido rpenido force-pushed the rpenido/skip-block-error branch from 6f0680e to e41db7f Compare July 18, 2024 13:47
@rpenido rpenido changed the title fix: skip indexing only the block if it raises an error while loading fix: skip block indexing if it raises an error while loading Jul 18, 2024
@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Jul 18, 2024
@rpenido rpenido requested a review from pomegranited July 23, 2024 23:26
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.

@rpenido Thank you for finding this issue and fixing it!

I've proposed a slightly different implementation -- please let me know what do you think.

Could you also add a brief test to openedx/core/djangoapps/content/search/tests/test_api.py which demonstrates the issue, so we're sure it stays fixed?

openedx/core/djangoapps/content/search/api.py Outdated Show resolved Hide resolved
@rpenido
Copy link
Contributor Author

rpenido commented Jul 24, 2024

Could you also add a brief test to openedx/core/djangoapps/content/search/tests/test_api.py which demonstrates the issue, so we're sure it stays fixed?

Tests here: a5fa737

@rpenido rpenido requested a review from pomegranited July 24, 2024 19:22
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.

👍 Thanks @rpenido !

  • I tested this by running ./manage.py cms reindex_studio --experimental on a course containing an ORA problem. Noted indexing the ORA was skipped, but the rest of the library was indexed as expected.
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes documentation N/A
  • User-facing strings are extracted for translation N/A

@pomegranited pomegranited merged commit 238dca7 into openedx:master Jul 25, 2024
49 checks passed
@pomegranited pomegranited deleted the rpenido/skip-block-error branch July 25, 2024 16:45
@openedx-webhooks
Copy link

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

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

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

@itsjeyd itsjeyd removed the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Sep 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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