-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
feat: add publish status to library meilisearch index #36031
base: master
Are you sure you want to change the base?
Conversation
Thanks for the pull request, @DanielVZ96! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf 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 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Adds the publish status field to the libraries v2 meilisearch index in order to support filtering by component publish status: published, modified, never.
5fb0549
to
ecaf889
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is working great, but I'm not sure that we need it?
If we do keep it, we need one more test, so I'm happy to conditionally approve. 👍
- I tested this using the test instructions for feat: allow filtering library by publish status frontend-app-authoring#1570
- I read through the code
-
I checked for accessibility issuesN/A - Includes some documentation
-
User-facing strings are extracted for translationN/A
except NotFound: | ||
# Never published | ||
block_published = None | ||
publish_status = PublishStatus.never |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm.. technically this status can be determined using filters on the existing xblock document metadata fields, so we don't strictly need a field publish_status
field in the search index. e.g to filter out unpublished items when sorting by "Recently Published", we add a last_published IS NOT NULL
filter.
But I'm not sure what our stance is on having too much logic living in the frontend.. @bradenmacdonald what do you think?
@@ -420,6 +423,7 @@ def test_html_published_library_block(self): | |||
"display_name": "Text 2", | |||
"description": "This is a Test", | |||
}, | |||
"publish_status": "published", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(If we end up keeping this field) could you please add a test for "publish_status": "modified"
?
Description
Adds the publish status field to the libraries v2 meilisearch index in order to support filtering by component publish status: published, modified, never.
Supporting information
Testing instructions
tutor dev exec cms bash -c './manage.py cms reindex_studio --experimental '
Deadline
ASAP
Other information
Private-Ref