Merge pull request #20 from simple-repository/feature/exact-search-result

Simplify exact search result handling, and make sure that if the project is in the index, we return the result

Author: pelson

simple_repository_browser/controller.py

@@ -109,7 +109,7 @@ async def search(self, request: fastapi.Request, query: str, page: int = 1) -> s
         # Note: page is 1 based. We don't have a page 0.
         page_size = 50
         try:
-            response = self.model.project_query(
+            response = await self.model.project_query(
                 query=query, page_size=page_size, page=page
             )
         except errors.InvalidSearchQuery as e:

simple_repository_browser/model.py

@@ -1,3 +1,5 @@
+import dataclasses
+import datetime
 import itertools
 import math
 import sqlite3
@@ -15,18 +17,24 @@
 from .short_release_info import ReleaseInfoModel, ShortReleaseInfo
 
 
+@dataclasses.dataclass(frozen=True)
+class SearchResultItem:
+    canonical_name: str
+    summary: str | None = None
+    release_version: str | None = None
+    release_date: datetime.datetime | None = None
+
+
 class RepositoryStatsModel(typing.TypedDict):
     n_packages: int
     n_dist_info: int
     n_packages_w_dist_info: int
 
 
 class QueryResultModel(typing.TypedDict):
-    exact: tuple[str, str, str, str] | None
     search_query: str
-    results: list[tuple[str, str, str, str]]
+    results: list[SearchResultItem]
     results_count: int  # May be more than in the results list (since paginated).
-    single_name_proposal: str | None
     page: int  # Note: starts at 1.
     n_pages: int
 
@@ -102,7 +110,9 @@ def _compatibility_matrix(
         # Compute the compatibility matrix for the given files.
         return compatibility_matrix.compatibility_matrix(files)
 
-    def project_query(self, query: str, page_size: int, page: int) -> QueryResultModel:
+    async def project_query(
+        self, query: str, page_size: int, page: int
+    ) -> QueryResultModel:
         try:
             search_terms = _search.parse(query)
         except _search.ParseError:
@@ -133,27 +143,34 @@ def project_query(self, query: str, page_size: int, page: int) -> QueryResultMod
                     f"Requested page (page: {page}) is beyond the number of pages ({n_pages})",
                 )
 
-            if single_name_proposal:
-                exact = cursor.execute(
-                    "SELECT canonical_name, summary, release_version, release_date FROM projects WHERE canonical_name == ?",
-                    (single_name_proposal,),
-                ).fetchone()
             results = cursor.execute(
                 "SELECT canonical_name, summary, release_version, release_date FROM projects WHERE "
                 f"{condition_query} LIMIT ? OFFSET ?",
                 condition_terms + (page_size, offset),
             ).fetchall()
 
-        # Drop the duplicate.
-        if exact in results:
-            results.remove(exact)
+        # Convert results to SearchResultItem objects
+        results = [SearchResultItem(*result) for result in results]
+
+        # Check if single_name_proposal is already in the results
+        if single_name_proposal and page == 1:
+            exact_found = any(r.canonical_name == single_name_proposal for r in results)
+            if not exact_found:
+                # Not in results, check if it exists in repository
+                try:
+                    await self.source.get_project_page(single_name_proposal)
+                    # Package exists in repository! Add it to the beginning
+                    results.insert(
+                        0, SearchResultItem(canonical_name=single_name_proposal)
+                    )
+                    n_results += 1
+                except PackageNotFoundError:
+                    pass
 
         return QueryResultModel(
-            exact=exact,
             search_query=query,
             results=results,
             results_count=n_results,
-            single_name_proposal=single_name_proposal,
             page=page,
             n_pages=n_pages,
         )

simple_repository_browser/templates/base/search.html

@@ -9,7 +9,7 @@
 
 
 {% macro package_card(content) -%}
-<a href="{{ url_for('project', project_name=content[0]) }}">
+<a href="{{ url_for('project', project_name=content.canonical_name) }}">
     <div class="card" style="margin: 1em;">
       <div class="card-body">
          <img src="{{ static_file_url('/images/python-logo-only.svg') }}" style="padding: 0 1em 0 0.5em; vertical-align: top; width: 64px;" >
@@ -30,25 +30,11 @@
 <!--        <div class="col-md-3"></div>-->
           <div class="col-md-9 mx-auto">
 
-            {% if exact %}
-                Exact match found:
-                {{ package_card(exact) }}
-            {% endif %}
-
-            {% if not exact and single_name_proposal %}
-              No exact match found. Were you expecting one? If so, visit the
-                <a href="{{ url_for('project', project_name=single_name_proposal) }}">
-                    "{{ single_name_proposal }}" project page
-                </a>
-              to have the index updated automatically.
-              <br><br>
-            {% elif results_count == 0 %}
-              No results found. Consider reducing the number of filters in your query.
-            {% endif %}
-
-            {% if results_count > 0 %}
+            {% if results_count == 0 %}
+              No results found.
+            {% else %}
               Found {{ results_count }} results
-                {% if n_pages > 1%}. Page {{ page }} of {{  n_pages }}:{% endif %}
+                {% if n_pages > 1%}. Page {{ page }} of {{ n_pages }}:{% endif %}
               <br>
 
               {% for result in results %}