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: meilisearch backend for notes search #444

Merged
merged 5 commits into from
Nov 14, 2024
Merged

feat: meilisearch backend for notes search #444

merged 5 commits into from
Nov 14, 2024

Conversation

regisb
Copy link
Contributor

@regisb regisb commented Oct 17, 2024

This is a very simple and basic backend. It is based on Django signals,
just like the Elasticsearch backend. But it is much simpler, in the
sense that there are just two signals: one for saving documents and one
for deletion.

This backend is limited, in the sense that it does not support
highlighting -- but that's probably not such a big deal.

To start using this backend, define the following settings:

ES_DISABLED = True
MEILISEARCH_ENABLED = True
MEILISEARCH_URL = "http://meilisearch:7700"
MEILISEARCH_API_KEY = "s3cr3t"
MEILISEARCH_INDEX = "tutor_student_notes"

@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/axim-engineering. 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 17, 2024
@regisb regisb force-pushed the regisb/meilisearch branch from 5a9de41 to 8ee54c7 Compare October 17, 2024 22:06
@regisb regisb mentioned this pull request Oct 17, 2024
Merged
@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Oct 24, 2024
@regisb regisb mentioned this pull request Oct 31, 2024
Closed
@regisb regisb force-pushed the regisb/meilisearch branch 4 times, most recently from feffa42 to 8030d34 Compare November 12, 2024 08:00
@regisb
feat: introduce "make compile-requirement" target
f618484 
This is convenient to compile dependencies without upgrading them.
@regisb regisb force-pushed the regisb/meilisearch branch from 8030d34 to 4a15d8f Compare November 12, 2024 08:10
@regisb
chore: simplify tox/make test commands
7a9aa32 
This makes it possible to run the make commands directly without going
through tox (though tox targets keep working, of course).
@regisb
chore: more convenient unit test running
3ff7cbd 
Previously, it was not possible to run unit tests locally without
manually creating mysql & elasticsearch containers. Here, we create a
`make pytest` target that automatically starts the required containers.
@regisb
chore: refactor views for better mysql/es separation
dbfffdf 
Instead of checking a boolean flag in multiple different places, we use
class inheritance. This makes it possible to later override the view and
implement our own using a different search backend, such as Meilisearch.
@regisb regisb force-pushed the regisb/meilisearch branch from 4a15d8f to 26718a2 Compare November 12, 2024 10:12
@regisb regisb requested a review from irtazaakram November 12, 2024 10:13
@regisb regisb force-pushed the regisb/meilisearch branch 2 times, most recently from d893502 to 71b63c8 Compare November 12, 2024 10:32
@regisb
feat: meilisearch backend for notes search
3e4c8cd 
This is a very simple and basic backend. It is based on Django signals,
just like the Elasticsearch backend. But it is much simpler, in the
sense that there are just two signals: one for saving documents and one
for deletion.

This backend is limited, in the sense that it does not support
highlighting -- but that's probably not such a big deal.

To start using this backend, define the following settings:

	ES_DISABLED = True
	MEILISEARCH_ENABLED = True
	MEILISEARCH_URL = "http://meilisearch:7700"
	MEILISEARCH_API_KEY = "s3cr3t"
	MEILISEARCH_INDEX = "tutor_student_notes"
@regisb regisb force-pushed the regisb/meilisearch branch from 71b63c8 to 3e4c8cd Compare November 12, 2024 10:36
@irtazaakram irtazaakram merged commit 34e2ef3 into openedx:master Nov 14, 2024
16 checks passed
@regisb regisb deleted the regisb/meilisearch branch November 14, 2024 08:59
regisb added a commit to regisb/edx-notes-api that referenced this pull request Nov 14, 2024
@regisb
feat: meilisearch backend for notes search (openedx#444)
1f4fd45 
* feat: introduce "make compile-requirement" target

This is convenient to compile dependencies without upgrading them.

* chore: simplify tox/make test commands

This makes it possible to run the make commands directly without going
through tox (though tox targets keep working, of course).

* chore: more convenient unit test running

Previously, it was not possible to run unit tests locally without
manually creating mysql & elasticsearch containers. Here, we create a
`make pytest` target that automatically starts the required containers.

* chore: refactor views for better mysql/es separation

Instead of checking a boolean flag in multiple different places, we use
class inheritance. This makes it possible to later override the view and
implement our own using a different search backend, such as Meilisearch.

* feat: meilisearch backend for notes search

This is a very simple and basic backend. It is based on Django signals,
just like the Elasticsearch backend. But it is much simpler, in the
sense that there are just two signals: one for saving documents and one
for deletion.

This backend is limited, in the sense that it does not support
highlighting -- but that's probably not such a big deal.

To start using this backend, define the following settings:

	ES_DISABLED = True
	MEILISEARCH_ENABLED = True
	MEILISEARCH_URL = "http://meilisearch:7700"
	MEILISEARCH_API_KEY = "s3cr3t"
	MEILISEARCH_INDEX = "tutor_student_notes"
@regisb regisb mentioned this pull request Nov 14, 2024
Merged
regisb added a commit to regisb/edx-notes-api that referenced this pull request Nov 14, 2024
@regisb
feat: meilisearch backend for notes search (openedx#444)
d4e5591 
* feat: introduce "make compile-requirement" target

This is convenient to compile dependencies without upgrading them.

* chore: simplify tox/make test commands

This makes it possible to run the make commands directly without going
through tox (though tox targets keep working, of course).

* chore: more convenient unit test running

Previously, it was not possible to run unit tests locally without
manually creating mysql & elasticsearch containers. Here, we create a
`make pytest` target that automatically starts the required containers.

* chore: refactor views for better mysql/es separation

Instead of checking a boolean flag in multiple different places, we use
class inheritance. This makes it possible to later override the view and
implement our own using a different search backend, such as Meilisearch.

* feat: meilisearch backend for notes search

This is a very simple and basic backend. It is based on Django signals,
just like the Elasticsearch backend. But it is much simpler, in the
sense that there are just two signals: one for saving documents and one
for deletion.

This backend is limited, in the sense that it does not support
highlighting -- but that's probably not such a big deal.

To start using this backend, define the following settings:

	ES_DISABLED = True
	MEILISEARCH_ENABLED = True
	MEILISEARCH_URL = "http://meilisearch:7700"
	MEILISEARCH_API_KEY = "s3cr3t"
	MEILISEARCH_INDEX = "tutor_student_notes"
irtazaakram added a commit that referenced this pull request Nov 14, 2024
@regisb @salman2013
@irtazaakram @edx-requirements-bot @marslanabdulrauf
feat: meilisearch integration (#453)
5cdc0d4 
* chore: Update catalog.yaml file for release data

* chore: Delete openedx.yaml file

* fix: refactor workflows

* chore: Upgrade Python requirements (#450)

* fix: path import is fixed
After upgrading path-py from 9.1 to 12.5.0 they upgrade the import as well from p to capital P as import path from Path

* fix: enable quality checks

* chore: Upgrade Python requirements (#452)

* chore: Upgrade Python requirements

* fix: trivy action failure

---------

Co-authored-by: Irtaza Akram <[email protected]>

* feat: meilisearch backend for notes search (#444)

* feat: introduce "make compile-requirement" target

This is convenient to compile dependencies without upgrading them.

* chore: simplify tox/make test commands

This makes it possible to run the make commands directly without going
through tox (though tox targets keep working, of course).

* chore: more convenient unit test running

Previously, it was not possible to run unit tests locally without
manually creating mysql & elasticsearch containers. Here, we create a
`make pytest` target that automatically starts the required containers.

* chore: refactor views for better mysql/es separation

Instead of checking a boolean flag in multiple different places, we use
class inheritance. This makes it possible to later override the view and
implement our own using a different search backend, such as Meilisearch.

* feat: meilisearch backend for notes search

This is a very simple and basic backend. It is based on Django signals,
just like the Elasticsearch backend. But it is much simpler, in the
sense that there are just two signals: one for saving documents and one
for deletion.

This backend is limited, in the sense that it does not support
highlighting -- but that's probably not such a big deal.

To start using this backend, define the following settings:

	ES_DISABLED = True
	MEILISEARCH_ENABLED = True
	MEILISEARCH_URL = "http://meilisearch:7700"
	MEILISEARCH_API_KEY = "s3cr3t"
	MEILISEARCH_INDEX = "tutor_student_notes"

---------

Co-authored-by: salman2013 <[email protected]>
Co-authored-by: Irtaza Akram <[email protected]>
Co-authored-by: edX requirements bot <[email protected]>
Co-authored-by: Muhammad Arslan <[email protected]>
Co-authored-by: Irtaza Akram <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@irtazaakram irtazaakram irtazaakram approved these changes

Assignees
No one assigned
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@regisb @openedx-webhooks @irtazaakram @itsjeyd