incorporate reviewer feedback

Author: JimacoMS4

search-website-functions-v4/api-v4/requirements.txt

@@ -2,19 +2,19 @@
 # The Python Worker is managed by Azure Functions platform
 # Manually managing azure-functions-worker may cause unexpected issues
 
-azure-common==1.1.28
-azure-core==1.29.4
-azure-functions==1.17.0
-azure-search-documents==11.3.0
-certifi==2023.7.22
-chardet==5.2.0
-charset-normalizer==3.2.0
-idna==3.4
-isodate==0.6.1
-msrest==0.7.1
-oauthlib==3.2.2
-requests==2.31.0
-requests-oauthlib==1.3.1
-six==1.16.0
-typing_extensions==4.8.0
-urllib3==2.0.4
+azure-common==1.1.28,<2.0.0
+azure-core==1.29.4,<2.0.0
+azure-functions==1.17.0,<2.0.0
+azure-search-documents==11.3.0,<12.0.0
+certifi==2023.7.22,<2024.0.0
+chardet==5.2.0,<6.0.0
+charset-normalizer==3.2.0,<4.0.0
+idna==3.4,<4.0.0
+isodate==0.6.1,<1.0.0
+msrest==0.7.1,<1.0.0
+oauthlib==3.2.2,<4.0.0
+requests==2.31.0,<3.0.0
+requests-oauthlib==1.3.1,<2.0.0
+six==1.16.0,<2.0.0
+typing_extensions==4.8.0,<5.0.0
+urllib3==2.0.4,<3.0.0

search-website-functions-v4/api-v4/search.py

@@ -60,7 +60,6 @@ def new_shape(docs):
 
     old_api_shape = list(docs)
 
-    count = 0
     client_side_expected_shape = []
 
     for item in old_api_shape:
@@ -69,32 +68,32 @@ def new_shape(docs):
         new_document["score"] = item["@search.score"]
         new_document["highlights"] = item["@search.highlights"]
 
-        new_shape = {}
-        new_shape["id"] = item["id"]
-        new_shape["goodreads_book_id"] = item["goodreads_book_id"]
-        new_shape["best_book_id"] = item["best_book_id"]
-        new_shape["work_id"] = item["work_id"]
-        new_shape["books_count"] = item["books_count"]
-        new_shape["isbn"] = item["isbn"]
-        new_shape["isbn13"] = item["isbn13"]
-        new_shape["authors"] = item["authors"]
-        new_shape["original_publication_year"] = item["original_publication_year"]
-        new_shape["original_title"] = item["original_title"]
-        new_shape["title"] = item["title"]
-        new_shape["language_code"] = item["language_code"]
-        new_shape["average_rating"] = item["average_rating"]
-        new_shape["ratings_count"] = item["ratings_count"]
-        new_shape["work_ratings_count"] = item["work_ratings_count"]
-        new_shape["work_text_reviews_count"] = item["work_text_reviews_count"]
-        new_shape["ratings_1"] = item["ratings_1"]
-        new_shape["ratings_2"] = item["ratings_2"]
-        new_shape["ratings_3"] = item["ratings_3"]
-        new_shape["ratings_4"] = item["ratings_4"]
-        new_shape["ratings_5"] = item["ratings_5"]
-        new_shape["image_url"] = item["image_url"]
-        new_shape["small_image_url"] = item["small_image_url"]
-
-        new_document["document"] = new_shape
+        new_api_shape = {}
+        new_api_shape["id"] = item["id"]
+        new_api_shape["goodreads_book_id"] = item["goodreads_book_id"]
+        new_api_shape["best_book_id"] = item["best_book_id"]
+        new_api_shape["work_id"] = item["work_id"]
+        new_api_shape["books_count"] = item["books_count"]
+        new_api_shape["isbn"] = item["isbn"]
+        new_api_shape["isbn13"] = item["isbn13"]
+        new_api_shape["authors"] = item["authors"]
+        new_api_shape["original_publication_year"] = item["original_publication_year"]
+        new_api_shape["original_title"] = item["original_title"]
+        new_api_shape["title"] = item["title"]
+        new_api_shape["language_code"] = item["language_code"]
+        new_api_shape["average_rating"] = item["average_rating"]
+        new_api_shape["ratings_count"] = item["ratings_count"]
+        new_api_shape["work_ratings_count"] = item["work_ratings_count"]
+        new_api_shape["work_text_reviews_count"] = item["work_text_reviews_count"]
+        new_api_shape["ratings_1"] = item["ratings_1"]
+        new_api_shape["ratings_2"] = item["ratings_2"]
+        new_api_shape["ratings_3"] = item["ratings_3"]
+        new_api_shape["ratings_4"] = item["ratings_4"]
+        new_api_shape["ratings_5"] = item["ratings_5"]
+        new_api_shape["image_url"] = item["image_url"]
+        new_api_shape["small_image_url"] = item["small_image_url"]
+
+        new_document["document"] = new_api_shape
 
         client_side_expected_shape.append(new_document)
 
@@ -115,9 +114,9 @@ def main(req: func.HttpRequest) -> func.HttpResponse:
     facets = environment_vars["search_facets"]
     facetKeys = read_facets(facets)
 
-    filter = ""
+    search_filter = ""
     if len(filters):
-        filter = create_filter_expression(filters, facetKeys)
+        search_filter = create_filter_expression(filters, facetKeys)
 
     if q:
         logging.info(f"/Search q = {q}")
@@ -127,13 +126,11 @@ def main(req: func.HttpRequest) -> func.HttpResponse:
             top=top,
             skip=skip,
             facets=facetKeys,
-            filter=filter,
+            filter=search_filter,
             include_total_count=True,
         )
 
         returned_docs = new_shape(search_results)
-        returned_count = search_results.get_count()
-        returned_facets = search_results.get_facets()
 
         # format the React app expects
         full_response = {}

search-website-functions-v4/api-v4/suggest.py

@@ -32,17 +32,17 @@ def main(req: func.HttpRequest) -> func.HttpResponse:
     # variables sent in body
     req_body = req.get_json()
     q = req_body.get("q")
-    top = req_body.get("top")
-    suggester = req_body.get("suggester")
+    top = req_body.get("top") or 5
+    suggester = req_body.get("suggester") or "sg"
 
     if q:
-        logging.info(f"/Suggest q = {q}")
-        suggestions = search_client.suggest(search_text=q, suggester_name="sg", top=5)
+        logging.info("/Suggest q = %s", q)
+        suggestions = search_client.suggest(search_text=q, suggester_name=suggester, top=top)
 
         # format the React app expects
         full_response = {}
         full_response["suggestions"] = suggestions
-        print(suggestions)
+        logging.debug(suggestions)
 
         return func.HttpResponse(
             body=json.dumps(full_response), mimetype="application/json", status_code=200

search-website-functions-v4/api/requirements.txt

@@ -2,19 +2,19 @@
 # The Python Worker is managed by Azure Functions platform
 # Manually managing azure-functions-worker may cause unexpected issues
 
-azure-common==1.1.28
-azure-core==1.26.0
-azure-functions==1.17.0
-azure-search-documents==11.3.0
-certifi==2022.12.7
-chardet==5.0.0
-charset-normalizer==2.1.1
-idna==3.4
-isodate==0.6.1
-msrest==0.7.1
-oauthlib==3.2.2
-requests==2.31.0
-requests-oauthlib==1.3.1
-six==1.16.0
-typing_extensions==4.4.0
-urllib3==1.26.12
+azure-common==1.1.28,<2.0.0
+azure-core==1.29.4,<2.0.0
+azure-functions==1.17.0,<2.0.0
+azure-search-documents==11.3.0,<12.0.0
+certifi==2023.7.22,<2024.0.0
+chardet==5.2.0,<6.0.0
+charset-normalizer==3.2.0,<4.0.0
+idna==3.4,<4.0.0
+isodate==0.6.1,<1.0.0
+msrest==0.7.1,<1.0.0
+oauthlib==3.2.2,<4.0.0
+requests==2.31.0,<3.0.0
+requests-oauthlib==1.3.1,<2.0.0
+six==1.16.0,<2.0.0
+typing_extensions==4.8.0,<5.0.0
+urllib3==2.0.4,<3.0.0

search-website-functions-v4/api/search.py

@@ -60,7 +60,6 @@ def new_shape(docs):
 
     old_api_shape = list(docs)
 
-    count = 0
     client_side_expected_shape = []
 
     for item in old_api_shape:
@@ -69,32 +68,32 @@ def new_shape(docs):
         new_document["score"] = item["@search.score"]
         new_document["highlights"] = item["@search.highlights"]
 
-        new_shape = {}
-        new_shape["id"] = item["id"]
-        new_shape["goodreads_book_id"] = item["goodreads_book_id"]
-        new_shape["best_book_id"] = item["best_book_id"]
-        new_shape["work_id"] = item["work_id"]
-        new_shape["books_count"] = item["books_count"]
-        new_shape["isbn"] = item["isbn"]
-        new_shape["isbn13"] = item["isbn13"]
-        new_shape["authors"] = item["authors"]
-        new_shape["original_publication_year"] = item["original_publication_year"]
-        new_shape["original_title"] = item["original_title"]
-        new_shape["title"] = item["title"]
-        new_shape["language_code"] = item["language_code"]
-        new_shape["average_rating"] = item["average_rating"]
-        new_shape["ratings_count"] = item["ratings_count"]
-        new_shape["work_ratings_count"] = item["work_ratings_count"]
-        new_shape["work_text_reviews_count"] = item["work_text_reviews_count"]
-        new_shape["ratings_1"] = item["ratings_1"]
-        new_shape["ratings_2"] = item["ratings_2"]
-        new_shape["ratings_3"] = item["ratings_3"]
-        new_shape["ratings_4"] = item["ratings_4"]
-        new_shape["ratings_5"] = item["ratings_5"]
-        new_shape["image_url"] = item["image_url"]
-        new_shape["small_image_url"] = item["small_image_url"]
-
-        new_document["document"] = new_shape
+        new_api_shape = {}
+        new_api_shape["id"] = item["id"]
+        new_api_shape["goodreads_book_id"] = item["goodreads_book_id"]
+        new_api_shape["best_book_id"] = item["best_book_id"]
+        new_api_shape["work_id"] = item["work_id"]
+        new_api_shape["books_count"] = item["books_count"]
+        new_api_shape["isbn"] = item["isbn"]
+        new_api_shape["isbn13"] = item["isbn13"]
+        new_api_shape["authors"] = item["authors"]
+        new_api_shape["original_publication_year"] = item["original_publication_year"]
+        new_api_shape["original_title"] = item["original_title"]
+        new_api_shape["title"] = item["title"]
+        new_api_shape["language_code"] = item["language_code"]
+        new_api_shape["average_rating"] = item["average_rating"]
+        new_api_shape["ratings_count"] = item["ratings_count"]
+        new_api_shape["work_ratings_count"] = item["work_ratings_count"]
+        new_api_shape["work_text_reviews_count"] = item["work_text_reviews_count"]
+        new_api_shape["ratings_1"] = item["ratings_1"]
+        new_api_shape["ratings_2"] = item["ratings_2"]
+        new_api_shape["ratings_3"] = item["ratings_3"]
+        new_api_shape["ratings_4"] = item["ratings_4"]
+        new_api_shape["ratings_5"] = item["ratings_5"]
+        new_api_shape["image_url"] = item["image_url"]
+        new_api_shape["small_image_url"] = item["small_image_url"]
+
+        new_document["document"] = new_api_shape
 
         client_side_expected_shape.append(new_document)
 
@@ -115,9 +114,9 @@ def main(req: func.HttpRequest) -> func.HttpResponse:
     facets = environment_vars["search_facets"]
     facetKeys = read_facets(facets)
 
-    filter = ""
+    search_filter = ""
     if len(filters):
-        filter = create_filter_expression(filters, facetKeys)
+        search_filter = create_filter_expression(filters, facetKeys)
 
     if q:
         logging.info(f"/Search q = {q}")
@@ -127,13 +126,11 @@ def main(req: func.HttpRequest) -> func.HttpResponse:
             top=top,
             skip=skip,
             facets=facetKeys,
-            filter=filter,
+            filter=search_filter,
             include_total_count=True,
         )
 
         returned_docs = new_shape(search_results)
-        returned_count = search_results.get_count()
-        returned_facets = search_results.get_facets()
 
         # format the React app expects
         full_response = {}

search-website-functions-v4/api/suggest.py

@@ -32,17 +32,17 @@ def main(req: func.HttpRequest) -> func.HttpResponse:
     # variables sent in body
     req_body = req.get_json()
     q = req_body.get("q")
-    top = req_body.get("top")
-    suggester = req_body.get("suggester")
+    top = req_body.get("top") or 5
+    suggester = req_body.get("suggester") or "sg"
 
     if q:
-        logging.info(f"/Suggest q = {q}")
-        suggestions = search_client.suggest(search_text=q, suggester_name="sg", top=5)
+        logging.info("/Suggest q = %s", q)
+        suggestions = search_client.suggest(search_text=q, suggester_name=suggester, top=top)
 
         # format the React app expects
         full_response = {}
         full_response["suggestions"] = suggestions
-        print(suggestions)
+        logging.debug(suggestions)
 
         return func.HttpResponse(
             body=json.dumps(full_response), mimetype="application/json", status_code=200

search-website-functions-v4/test-requests/test-requests.http

@@ -27,6 +27,14 @@ content-type: application/json
 
 {
     "q":"w",
-    "top":5,
+    "top":8,
     "suggester":"sg"
+}
+
+### suggest
+POST http://localhost:7071/api/suggest
+content-type: application/json
+
+{
+    "q":"w"
 }