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.

Sign up for GitHub

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

Jump to bottom

feat: Store "published display name" and "published description" in search index [FC-0062] #35678

Merged
merged 5 commits into from
Oct 21, 2024
Merged

feat: Store "published display name" and "published description" in search index [FC-0062] #35678

merged 5 commits into from
Oct 21, 2024

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Oct 19, 2024 •
edited
Loading

Description

This store in the search index, the display_name and description of the published version of a library component.

  • Which edX user roles will this change impact? "Course Author".

Supporting information

Issue link: openedx/frontend-app-authoring#1354
Internal ticket: FAL-3881

Testing instructions

  • Create or use a library
  • Add a component, and edit the content and the title.
  • Go to Meilisearch and search for your component. Verify the display_name and description and verify that it doesn't have a published dict.
  • Publish the library.
  • Return to Meilisearch and verify that the component has the published dict.
  • Update the title and the content of the component.
  • Return to Meilisearch and verify that the display_name and description have the new data, but the published has the old data.
  • Publish the library
  • Return to Meilisearch and verify the published has the new data.

Deadline

ASAP

@openedx-webhooks
Copy link

Thanks for the pull request, @ChrisChV!

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 Oct 19, 2024
@ChrisChV ChrisChV changed the title feat: Store "published display name" and "published description" in s… feat: Store "published display name" and "published description" in search index Oct 19, 2024
@ChrisChV ChrisChV changed the title feat: Store "published display name" and "published description" in search index feat: Store "published display name" and "published description" in search index [FC-0062] Oct 19, 2024
@ChrisChV ChrisChV force-pushed the chris/FAL-3881-published-fields-index branch from b6138eb to e2b3b38 Compare October 19, 2024 17:51
bradenmacdonald
bradenmacdonald reviewed Oct 19, 2024
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

Thanks, this is great! I tested and it's working well.

Just one request: can you please add published.display_name and published.description to update_searchable_attributes in edx-platform/openedx/core/djangoapps/content/search/api.py ? Then we can do keyword search on them and get highlighting on those attributes, which will be useful in the "published only" version of the component picker.

openedx/core/djangoapps/content/search/tests/test_documents.py
"display_name": "Text 2",
"description": "This is a Test",
},
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: you don't have to check all the fields of doc again here. You can just check doc["display_name"], doc["description"], and doc["published"]

@bradenmacdonald bradenmacdonald force-pushed the chris/FAL-3881-published-fields-index branch from 8d1f028 to e26c286 Compare October 21, 2024 18:54
bradenmacdonald
bradenmacdonald approved these changes Oct 21, 2024
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Good to go!

I rebased the PR for you and added those two fields to the keyword searchable list. I tested this out by rebuilding my own search index and by checking for those new fields in the search results JSON response.

@bradenmacdonald bradenmacdonald merged commit fb25a5d into openedx:master Oct 21, 2024
49 checks passed
@bradenmacdonald bradenmacdonald deleted the chris/FAL-3881-published-fields-index branch October 21, 2024 19:25
@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.

@ChrisChV
Copy link
Contributor Author

I rebased the PR for you and added those two fields to the keyword searchable list. I tested this out by rebuilding my own search index and by checking for those new fields in the search results JSON response.

Thanks!

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ChrisChV @openedx-webhooks @edx-pipeline-bot @bradenmacdonald