fix: "Explore courses" search wasn't working with Typesense#267
Conversation
|
Thanks for the pull request, @bradenmacdonald! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
samuelallan72
left a comment
There was a problem hiding this comment.
I haven't been able to test this yet, as my devstack is hanging on build... However it's a simple change and it looks solid to me.
Please see my inline comment about the readme update for consideration.
- I tested this: ...
- I read through the code
- I checked for accessibility issues
- Includes documentation
| If you're using Tutor, the easiest way to use Typesense is to install [tutor-contrib-typesense](https://github.com/open-craft/tutor-contrib-typesense/). To configure it manually, you'll need to update these CMS/LMS settings: | ||
|
|
||
| ```python | ||
| SEARCH_ENGINE = "search.typesense.TypesenseEngine" | ||
| FORUM_SEARCH_BACKEND = "forum.search.typesense.TypesenseBackend" | ||
| TYPESENSE_URLS = ["http://typesense:8108"] | ||
| TYPESENSE_PUBLIC_URL = "http://typesense.example.com:8108" | ||
| TYPESENSE_API_KEY: "..." |
There was a problem hiding this comment.
It might be better to link to the official docs at https://docs.openedx.org/en/latest/site_ops/how-tos/use_typesense_search_backend.html as the source of truth. That doc has a complete explanation of enabling typesense, both with tutor-contrib-typesense and manually. It also has a more detailed listing of manual settings.
There was a problem hiding this comment.
Oh yeah, that's much better.
87ce001 to
c2f9ef9
Compare
feanil
left a comment
There was a problem hiding this comment.
@bradenmacdonald thanks for the fix. Can you also bump the version for this so we can release it?
|
@feanil Sure, done. |
|
Publish going out here: https://github.com/openedx/edx-search/actions/runs/25517886603/job/74893859966 |
Browsing courses at http://apps.local.openedx.io:1998/catalog/courses seems to no longer be working with Typesense. I suspect it was the upgrade to Typesense 2, but it could have been some other change.
The error seen is:
This PR applies a quick fix by using
""instead ofNonewhen we don't specify any particular search query.I also updated the README.
Internal ref MNG-4952