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 Meilisearch-compatible search engine #162

Closed
wants to merge 4 commits into from

Conversation

regisb
Copy link
Contributor

@regisb regisb commented Oct 17, 2024

The goal of this change is to introduce a search engine that is
compatible with the edx-search API but that uses Meilisearch instead of
Elasticsearch. That way, we can replace one by the other across
edx-platform by simply changing a single SEARCH_ENGINE django setting.

There are a couple of differences between Meilisearch and Elasticsearch:

  1. Filterable attributes must be defined explicitly.
  2. No support for datetime objects, which must be converted to
    timestamps (with an extra field to store the timezone).
  3. No special characters allowed in the primary key values, such that we
    must hash course IDs before we can use them as primary key values.

Note that this PR does not introduce any breaking change. This is an
opt-in engine that anyone is free to use. There is some setup work for
every search feature: see the engine module documentation for more
information.

See the corresponding conversation here:
openedx/frontend-app-authoring#1334 (comment)

This PR replaces the corresponding one in edx-platform: openedx/edx-platform#35650

Unit test command was failing because manage.py was pointing to an
incorrect module by default.
@openedx-webhooks
Copy link

Thanks for the pull request, @regisb!

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/openedx-unmaintained. 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.

This command makes it possible to compile requirements without upgrading
them. Note that the `make upgrade` command still works with this change.
The goal of this change is to introduce a search engine that is
compatible with the edx-search API but that uses Meilisearch instead of
Elasticsearch. That way, we can replace one by the other across
edx-platform by simply changing a single SEARCH_ENGINE django setting.

There are a couple of differences between Meilisearch and Elasticsearch:

1. Filterable attributes must be defined explicitly.
2. No support for datetime objects, which must be converted to
timestamps (with an extra field to store the timezone).
3. No special characters allowed in the primary key values, such that we
must hash course IDs before we can use them as primary key values.

Note that this PR does not introduce any breaking change. This is an
opt-in engine that anyone is free to use. There is some setup work for
every search feature: see the engine module documentation for more
information.

See the corresponding conversation here:
openedx/frontend-app-authoring#1334 (comment)
@regisb regisb force-pushed the regisb/meilisearch branch from 0be358e to fa0fc71 Compare October 17, 2024 11:17
@regisb
Copy link
Contributor Author

regisb commented Oct 17, 2024

I will add more unit tests to improve the test coverage later. In the meantime, this PR is ready for review.

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.

👍 Works a treat @regisb . Thank you for building this!

  • I tested this on my tutor dev stack:
    • ran make compile-requirements to test the requirements & Makefile change
    • installed requirements in virtualenv and ran ./manage.py migrate to test change to manage.py
    • enabled courseware search and this new engine during launch, according to the instructions in search/meilisearch.py
    • created a new course in Studio with content
    • published the course
    • searched the course from the learning MFE and saw my published content.
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes documentation
  • User-facing strings are extracted for translation

@pomegranited
Copy link
Contributor

@itsjeyd @mphilbrick211 Backstage says this repo is unmaintained, but we'd really like to get this change into Sumac.
Can you help locate someone with merge rights?

CC @feanil since you touched it last 😄

@regisb
Copy link
Contributor Author

regisb commented Oct 18, 2024

Jill, you are faster than light.

@itsjeyd
Copy link

itsjeyd commented Oct 18, 2024

@pomegranited I think you did the right thing by pinging @feanil :) When a repo is unmaintained we usually need to get help from someone that's part of Axim's technical team to move forward.

@pomegranited
Copy link
Contributor

@regisb

Jill, you are faster than light.

Know why? Because somebody built this amazing development and production build system that allows me test changes reliably and easily 😄

@@ -7,7 +7,7 @@
import sys

if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "edxsearch.settings")
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
Copy link

Choose a reason for hiding this comment

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

[question]: Why was this done? Why do we have these separate settings modules at all?

Copy link
Contributor

Choose a reason for hiding this comment

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

This was to fix an existing issue with that manage.py file -- it was referencing a non-existent file. AFAIK, you'd only use this to run a dev server locally, not for anything real.

@ormsbee
Copy link

ormsbee commented Oct 23, 2024

Closing this in favor of #164, which adds more unit tests and some settings file related cleanup.

@ormsbee ormsbee closed this Oct 23, 2024
@regisb regisb deleted the regisb/meilisearch branch October 29, 2024 07:16
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.

5 participants