Protein Search Paging (#248)

* Updates search proteins URL to include paging * Added page UI elements to search page * Changed display when no proteins found from spinner to none found message * Small grammar fix: proteins -> protein when only 1 protein found * Format * Ruff reformat * Changed != none to is not none to appease Ruff * Fixed issue where pressing next page would break search functionality if the last page had exactly 20 entries * Added searchAndResetPage function for the search bar to call * Fix: Accounted for edge case scenario where next page would return 0 proteins: Changed message from 'no proteins found' to 'no more proteins found' in this case. * Fix: Input fields for length and mass now reset on filter
Venom-Biochem-Lab · Apr 26, 2024 · f79aa26 · f79aa26
1 parent a15ae9e
commit f79aa26
Show file tree

Hide file tree

Showing 39 changed files with 127 additions and 64 deletions.
diff --git a/backend/src/api/search.py b/backend/src/api/search.py
@@ -29,6 +29,8 @@ class SearchProteinsBody(CamelModel):
  species_filter: str | None = None
  length_filter: RangeFilter | None = None
  mass_filter: RangeFilter | None = None
+ proteinsPerPage: int | None = None
+ page: int | None = None
 
 
 class SearchProteinsResults(CamelModel):
@@ -94,8 +96,16 @@ def gen_sql_filters(
 @router.post("/search/proteins", response_model=SearchProteinsResults)
 def search_proteins(body: SearchProteinsBody):
  text_query = sanitize_query(body.query)
+ limit = 10000 # Limit defaulted to exceed the number of entries in db to grab whole thing.
+ offset = 0
  with Database() as db:
  try:
+ # If both the number requested and the page number are present in the request, the limit and offset are set.
+ # Otherwise, defaults to entire database.
+ if body.proteinsPerPage is not None and body.page is not None:
+ limit = body.proteinsPerPage
+ offset = limit * body.page
+
  filter_clauses = gen_sql_filters(
  "species",
  "proteins_scores",
@@ -124,10 +134,13 @@ def search_proteins(body: SearchProteinsBody):
  FROM proteins) as proteins_scores
  JOIN species ON species.id = proteins_scores.species_id
  WHERE {} {}
- ORDER BY (proteins_scores.name_score*4 + proteins_scores.desc_score*2 + proteins_scores.content_score) DESC;
+ ORDER BY (proteins_scores.name_score*4 + proteins_scores.desc_score*2 + proteins_scores.content_score) DESC
+ LIMIT {}
+ OFFSET {};
  """.format(
- score_filter, filter_clauses
+ score_filter, filter_clauses, limit, offset
  ) # numbers in order by correspond to weighting
+ log.warn("EQ:" + entries_query)
  log.warn(filter_clauses)
  entries_result = db.execute_return(
  sanitize_query(entries_query),

diff --git a/frontend/src/lib/openapi/core/ApiError.ts b/frontend/src/lib/openapi/core/ApiError.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/core/ApiRequestOptions.ts b/frontend/src/lib/openapi/core/ApiRequestOptions.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/core/ApiResult.ts b/frontend/src/lib/openapi/core/ApiResult.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/core/CancelablePromise.ts b/frontend/src/lib/openapi/core/CancelablePromise.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -85,9 +85,9 @@ export class CancelablePromise<T> implements Promise<T> {
  });
  }
 
-  get [Symbol.toStringTag]() {
-  return "Cancellable Promise";
-  }
+ get [Symbol.toStringTag]() {
+ return "Cancellable Promise";
+ }
 
  public then<TResult1 = T, TResult2 = never>(
  onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,

diff --git a/frontend/src/lib/openapi/core/OpenAPI.ts b/frontend/src/lib/openapi/core/OpenAPI.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/core/request.ts b/frontend/src/lib/openapi/core/request.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -164,7 +164,7 @@ export const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptio
  headers['Authorization'] = `Basic ${credentials}`;
  }
 
- if (options.body) {
+ if (options.body !== undefined) {
  if (options.mediaType) {
  headers['Content-Type'] = options.mediaType;
  } else if (isBlob(options.body)) {

diff --git a/frontend/src/lib/openapi/index.ts b/frontend/src/lib/openapi/index.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/Article.ts b/frontend/src/lib/openapi/models/Article.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/ArticleImageComponent.ts b/frontend/src/lib/openapi/models/ArticleImageComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/ArticleProteinComponent.ts b/frontend/src/lib/openapi/models/ArticleProteinComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/ArticleTextComponent.ts b/frontend/src/lib/openapi/models/ArticleTextComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/ArticleUpload.ts b/frontend/src/lib/openapi/models/ArticleUpload.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/EditArticleImageComponent.ts b/frontend/src/lib/openapi/models/EditArticleImageComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/EditArticleMetadata.ts b/frontend/src/lib/openapi/models/EditArticleMetadata.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/EditArticleProteinComponent.ts b/frontend/src/lib/openapi/models/EditArticleProteinComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/EditArticleTextComponent.ts b/frontend/src/lib/openapi/models/EditArticleTextComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/EditBody.ts b/frontend/src/lib/openapi/models/EditBody.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/HTTPValidationError.ts b/frontend/src/lib/openapi/models/HTTPValidationError.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/InsertBlankComponentEnd.ts b/frontend/src/lib/openapi/models/InsertBlankComponentEnd.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/InsertComponent.ts b/frontend/src/lib/openapi/models/InsertComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/LoginBody.ts b/frontend/src/lib/openapi/models/LoginBody.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/LoginResponse.ts b/frontend/src/lib/openapi/models/LoginResponse.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/MoveComponent.ts b/frontend/src/lib/openapi/models/MoveComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/ProteinEditSuccess.ts b/frontend/src/lib/openapi/models/ProteinEditSuccess.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/ProteinEntry.ts b/frontend/src/lib/openapi/models/ProteinEntry.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/RangeFilter.ts b/frontend/src/lib/openapi/models/RangeFilter.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/SearchProteinsBody.ts b/frontend/src/lib/openapi/models/SearchProteinsBody.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -8,5 +8,7 @@ export type SearchProteinsBody = {
  speciesFilter?: (string | null);
  lengthFilter?: (RangeFilter | null);
  massFilter?: (RangeFilter | null);
+ proteinsPerPage?: (number | null);
+ page?: (number | null);
 };
 
diff --git a/frontend/src/lib/openapi/models/SearchProteinsResults.ts b/frontend/src/lib/openapi/models/SearchProteinsResults.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/SimilarProtein.ts b/frontend/src/lib/openapi/models/SimilarProtein.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/UploadArticleImageComponent.ts b/frontend/src/lib/openapi/models/UploadArticleImageComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/UploadArticleProteinComponent.ts b/frontend/src/lib/openapi/models/UploadArticleProteinComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/UploadArticleTextComponent.ts b/frontend/src/lib/openapi/models/UploadArticleTextComponent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/UploadBody.ts b/frontend/src/lib/openapi/models/UploadBody.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/UploadError.ts b/frontend/src/lib/openapi/models/UploadError.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/UploadPNGBody.ts b/frontend/src/lib/openapi/models/UploadPNGBody.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/models/ValidationError.ts b/frontend/src/lib/openapi/models/ValidationError.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

diff --git a/frontend/src/lib/openapi/services/DefaultService.ts b/frontend/src/lib/openapi/services/DefaultService.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */