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

feat: add publish status to library meilisearch index #36031

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

DanielVZ96
Copy link
Contributor

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

  1. [If needed] Create a new library with new components in http://apps.local.openedx.io:2001/course-authoring/libraries
  2. With the tutor stack running execute the following command: tutor dev exec cms bash -c './manage.py cms reindex_studio --experimental '
  3. Navigate to http://localhost:7700/
  4. Assert that the publish_status of the documents matches their respective components:
    • Published when the component was published and not modified since
    • Modified when the component has been modified after being published
    • Never when the component has never been published

Deadline

ASAP

Other information

Private-Ref

@openedx-webhooks
Copy link

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

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 13, 2024
Adds the publish status field to the libraries v2 meilisearch index in
order to support filtering by component publish status: published,
modified, never.
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 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. 👍

except NotFound:
# Never published
block_published = None
publish_status = PublishStatus.never
Copy link
Contributor

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",
Copy link
Contributor

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"?

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
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

3 participants