Skip to content

Fix/meilisearch course_team_index filterable attributes #207

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

zemelten
Copy link

@zemelten zemelten commented Jun 9, 2025

Added course_team_index filterable attributes

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 9, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jun 9, 2025

Thanks for the pull request, @zemelten!

This repository is currently maintained by @Ali-Salman29.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.


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.

@mphilbrick211
Copy link

Hi @zemelten - thank you for this contribution! Please let me know if you have any questions regarding submitting a CLA form. Thanks!

@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jun 12, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Jun 12, 2025
Copy link

@tecoholic tecoholic left a comment

Choose a reason for hiding this comment

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

@zemelten Great work identify the right place to fix the indexes. I have requested some changes to make this PR a bit more leaner. Kindly address them.

Can you also kindly add some testing instructions to the PR description (with screenshots, if possible)?

@@ -1,14 +1,14 @@
#!/usr/bin/env python

Choose a reason for hiding this comment

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

We can switch this back with chmod +x manage.py I think

@@ -1,85 +1,85 @@
#!/usr/bin/env python

Choose a reason for hiding this comment

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

Same here. Switch this back with a chmod.

Comment on lines 284 to 285
if(index_name == 'course_team_index'):
task_info = client.create_index(index_name, {"primaryKey": "id"})

Choose a reason for hiding this comment

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

We don't need this. The default PRIMARY_KEY value _pk seems to work just fine.

@@ -99,14 +99,32 @@
"org",
"catalog_visibility", # used if not settings.SEARCH_SKIP_SHOW_IN_CATALOG_FILTERING
"enrollment_end", # include only enrollable courses
"course_id"

Choose a reason for hiding this comment

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

I don't think we need to introduce "course_id" here and in line 110. Let's not touch the other indices and just keep this fix to the course_team_index.

zemelten added a commit to zemelten/edx-search that referenced this pull request Jun 12, 2025
@e0d
Copy link

e0d commented Jun 12, 2025

@zemelten
I notice there are some commit-lint failures. Please note that we use conventional commits across Open edX projects. You can read about the details here. Can you please amend your commit messages to follow our standard?

It looks like there are some other failures as well.

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jun 12, 2025
@tecoholic
Copy link

@zemelten Hi, after you address the file modes changes, I think it would best to squash all the commits into one and then use a conventions commit message as @e0d points out.

zemelten added a commit to zemelten/edx-search that referenced this pull request Jun 14, 2025
@zemelten zemelten force-pushed the fix/meilisearch-primary-key branch from 64ca730 to 18b63f0 Compare June 16, 2025 17:07
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jun 16, 2025
@e0d
Copy link

e0d commented Jun 16, 2025

@zemelten Your branch is behind the base. I've pulled in changes from master as a merge commit which will update your branch and cause the tests to be re-run.

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jun 16, 2025
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jun 20, 2025
@mphilbrick211
Copy link

Hi @zemelten! Checking in to see if this pull request is still in progress? Please let us know if you have any questions re: filling out a CLA form.

@zemelten
Copy link
Author

zemelten commented Jul 1, 2025

Hi @zemelten! Checking in to see if this pull request is still in progress? Please let us know if you have any questions re: filling out a CLA form.

Hello, I have submitted the CLA form.

@e0d
Copy link

e0d commented Jul 16, 2025

@zemelten It looks like there are some failing checks, please have a look.

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 16, 2025
@e0d e0d moved this from Needs Tests Run or CLA Signed to Waiting on Author in Contributions Jul 16, 2025
@mphilbrick211
Copy link

Hi @zemelten! Checking in to see if this pull request is still in progress? Please let us know if you have any questions re: filling out a CLA form.

Hello, I have submitted the CLA form.

@zemelten - thanks! Looks like it was sent out to you to sign 2 days ago (July 14). If you don't see it, please be sure to check your spam folder(s).

@tecoholic
Copy link

@zemelten Hi, can you kindly fix the tests that are failing in the CI here?

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: Waiting on Author
Development

Successfully merging this pull request may close these issues.

5 participants