Skip to content

feat: add Typesense backend for search (FC-0091) #225

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

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

feat: add Typesense backend for search (FC-0091) #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9d08ff5
feat: add Typesense backend for search
samuelallan72 Aug 26, 2025
c1a8d65
fix: switch to TYPESENSE_URLS for cluster support
samuelallan72 Aug 28, 2025
824e925
docs: fix missing word
samuelallan72 Aug 28, 2025
d073dce
refactor!: use a single index for all documents
samuelallan72 Sep 1, 2025
98a92fb
fix: improve validation and type checking
samuelallan72 Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
441 changes: 441 additions & 0 deletions forum/search/typesense.py
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 7 additions & 1 deletion forum/settings/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ def plugin_settings(settings: Any) -> None:
Common settings for forum app
"""
# Search backend
if getattr(settings, "MEILISEARCH_ENABLED", False):
if getattr(settings, "TYPESENSE_ENABLED", False):
settings.FORUM_SEARCH_BACKEND = getattr(
settings,
"FORUM_SEARCH_BACKEND",
"forum.search.typesense.TypesenseBackend",
)
elif getattr(settings, "MEILISEARCH_ENABLED", False):
settings.FORUM_SEARCH_BACKEND = getattr(
settings,
"FORUM_SEARCH_BACKEND",
Expand Down
1 change: 1 addition & 0 deletions requirements/base.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ requests
pymongo
elasticsearch
edx-search # meilisearch backend
typesense
mysqlclient
3 changes: 3 additions & 0 deletions requirements/base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ requests==2.32.5
# via
# -r requirements/base.in
# meilisearch
# typesense
six==1.17.0
# via
# edx-ccx-keys
Expand All @@ -157,6 +158,8 @@ stevedore==5.5.0
# edx-opaque-keys
text-unidecode==1.3
# via python-slugify
typesense==1.1.1
# via -r requirements/base.in
typing-extensions==4.15.0
# via
# beautifulsoup4
Expand Down
3 changes: 3 additions & 0 deletions requirements/ci.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,7 @@ requests==2.32.5
# meilisearch
# requests-toolbelt
# twine
# typesense
requests-toolbelt==1.0.0
# via
# -r requirements/quality.txt
Expand Down Expand Up @@ -507,6 +508,8 @@ types-urllib3==1.26.25.14
# via
# -r requirements/quality.txt
# types-requests
typesense==1.1.1
# via -r requirements/quality.txt
typing-extensions==4.15.0
# via
# -r requirements/quality.txt
Expand Down
5 changes: 5 additions & 0 deletions requirements/dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,7 @@ requests==2.32.5
# meilisearch
# requests-toolbelt
# twine
# typesense
requests-toolbelt==1.0.0
# via
# -r requirements/ci.txt
Expand Down Expand Up @@ -672,6 +673,10 @@ types-urllib3==1.26.25.14
# -r requirements/ci.txt
# -r requirements/quality.txt
# types-requests
typesense==1.1.1
# via
# -r requirements/ci.txt
# -r requirements/quality.txt
typing-extensions==4.15.0
# via
# -r requirements/ci.txt
Expand Down
3 changes: 3 additions & 0 deletions requirements/doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,7 @@ requests==2.32.5
# requests-toolbelt
# sphinx
# twine
# typesense
requests-toolbelt==1.0.0
# via
# -r requirements/test.txt
Expand Down Expand Up @@ -446,6 +447,8 @@ tox==4.28.4
# via -r requirements/test.txt
twine==6.1.0
# via -r requirements/test.txt
typesense==1.1.1
# via -r requirements/test.txt
typing-extensions==4.15.0
# via
# -r requirements/test.txt
Expand Down
3 changes: 3 additions & 0 deletions requirements/quality.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,7 @@ requests==2.32.5
# meilisearch
# requests-toolbelt
# twine
# typesense
requests-toolbelt==1.0.0
# via
# -r requirements/test.txt
Expand Down Expand Up @@ -470,6 +471,8 @@ types-requests==2.31.0.6
# djangorestframework-stubs
types-urllib3==1.26.25.14
# via types-requests
typesense==1.1.1
# via -r requirements/test.txt
typing-extensions==4.15.0
# via
# -r requirements/test.txt
Expand Down
3 changes: 3 additions & 0 deletions requirements/test.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,7 @@ requests==2.32.5
# meilisearch
# requests-toolbelt
# twine
# typesense
requests-toolbelt==1.0.0
# via twine
rfc3986==2.0.0
Expand Down Expand Up @@ -343,6 +344,8 @@ tox==4.28.4
# via -r requirements/test.in
twine==6.1.0
# via -r requirements/test.in
typesense==1.1.1
# via -r requirements/base.txt
typing-extensions==4.15.0
# via
# -r requirements/base.txt
Expand Down