Add extension full-text search

Author: gornostal

db_migrations/004.py

@@ -0,0 +1,10 @@
+import datetime
+
+from ext_api.db import extension_collection, migration_collection
+
+__version__ = 4
+
+
+def run_migration():
+    extension_collection.create_index([("ProjectPath", "text"), ("Description", "text")])
+    migration_collection.insert_one({"Version": __version__, "CreatedAt": datetime.datetime.now(datetime.UTC)})

ext_api/db.py

@@ -18,7 +18,7 @@
 migration_collection: Collection[Migration] = db.Migrations  # type: ignore
 extension_collection: Collection[Extension] = db.Extensions  # type: ignore
 
-__version__: int = 3
+__version__: int = 4
 
 
 class DbMigrationError(Exception):
@@ -100,3 +100,4 @@ def create_indexes() -> None:
     extension_collection.create_index("User")
     extension_collection.create_index([("Published", 1), ("CreatedAt", -1)])
     extension_collection.create_index([("Published", 1), ("GithubStars", -1)])
+    extension_collection.create_index([("ProjectPath", "text"), ("Description", "text")])

ext_api/repositories/extensions.py

@@ -88,13 +88,22 @@ def get_extensions(
     sort_by: str = "GithubStars",
     sort_order: int = -1,
     versions: list[str] | None = None,
+    search_query: str | None = None,
 ) -> GetExtensionsResult:
     query: dict[str, Any] = {"Published": True}
 
     if versions:
         query["SupportedVersions"] = {"$in": versions}
 
-    cursor = extension_collection.find(query).sort(sort_by, sort_order).skip(offset)
+    if search_query:
+        query["$text"] = {"$search": search_query}
+
+    cursor = extension_collection.find(query)
+    if search_query:
+        cursor = cursor.sort([("score", {"$meta": "textScore"}), (sort_by, sort_order)])
+    else:
+        cursor = cursor.sort(sort_by, sort_order)
+    cursor = cursor.skip(offset)
 
     if limit:
         cursor = cursor.limit(limit + 1)

ext_api/server.py

@@ -78,6 +78,7 @@ def get_extensions_route() -> dict[str, Any]:
     Returns all extensions
 
     Query params:
+    * q: string. Full-text search query across project path and description.
     * versions: string. Version of Ulauncher Extension API.
       Could be comma-separated list of versions.
       Returns all extensions if not specified.
@@ -87,6 +88,10 @@ def get_extensions_route() -> dict[str, Any]:
     versions_query = request.GET.get("versions")
     versions: list[str] = versions_query.split(",") if versions_query else []
     try:
+        q = request.GET.get("q")
+        search_query = q.strip() if q is not None else None
+        if q is not None:
+            assert search_query, 'query argument "q" cannot be empty'
         sort_by = request.GET.get("sort_by") or allowed_sort_by[0]
         sort_order = request.GET.get("sort_order") or allowed_sort_order[0]
         assert sort_by in allowed_sort_by, "allowed sorty_by: " + ", ".join(allowed_sort_by)
@@ -100,7 +105,14 @@ def get_extensions_route() -> dict[str, Any]:
     except (AssertionError, ValueError) as e:
         return ErrorResponse(e, 400)  # type: ignore
 
-    result = get_extensions(offset=offset, limit=limit, sort_by=sort_by, sort_order=int(sort_order), versions=versions)
+    result = get_extensions(
+        offset=offset,
+        limit=limit,
+        sort_by=sort_by,
+        sort_order=int(sort_order),
+        versions=versions,
+        search_query=search_query,
+    )
 
     return {"data": result["data"], "offset": offset, "has_more": result["has_more"]}
 

tests/integration/test_api_integration.py

@@ -132,3 +132,24 @@ def test_extensions_can_be_filtered_by_api_version(api_client: Any, auth_header:
     assert len(data) == 1
     assert data[0]["ID"] == "github-stub-owner-legacy-repo"
     assert data[0]["SupportedVersions"] == ["3"]
+
+
+def test_extensions_can_be_searched_by_project_path_and_description(
+    api_client: Any, auth_header: dict[str, str]
+) -> None:
+    _create_extension(api_client, auth_header, "https://github.com/stub-owner/stub-repo", "Stub Extension")
+    _create_extension(api_client, auth_header, "https://github.com/stub-owner/legacy-repo", "Legacy Extension")
+
+    description_response = api_client.request("GET", "/extensions?q=legacy")
+    assert description_response.status == 200
+    description_payload = api_client.parse_json(description_response)
+    description_data = cast("list[dict[str, Any]]", description_payload["data"])
+    assert len(description_data) == 1
+    assert description_data[0]["ID"] == "github-stub-owner-legacy-repo"
+
+    project_path_response = api_client.request("GET", '/extensions?q="stub-owner/stub-repo"')
+    assert project_path_response.status == 200
+    project_path_payload = api_client.parse_json(project_path_response)
+    project_path_data = cast("list[dict[str, Any]]", project_path_payload["data"])
+    assert len(project_path_data) == 1
+    assert project_path_data[0]["ID"] == "github-stub-owner-stub-repo"