From 6c9bb828b670e0e9eb98d6c7ce51d669a970c7b4 Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Tue, 7 May 2024 18:01:27 -0400
Subject: [PATCH 01/14] Refactor SQL query and logging logic in middleware

The INSERT_LOG_QUERY string in the middleware's quick_search_query has been refactored as a parameterized query to increase security and performance. Additionally, logging logic was updated to use the IDs of data_source_matches instead of the json string of the whole data object, thus improving the clarity and usefulness of logs.
---
 middleware/quick_search_query.py | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/middleware/quick_search_query.py b/middleware/quick_search_query.py
index 4584c097..0134c08a 100644
--- a/middleware/quick_search_query.py
+++ b/middleware/quick_search_query.py
@@ -52,7 +52,11 @@
 
 """
 
-INSERT_LOG_QUERY = "INSERT INTO quick_search_query_logs (search, location, results, result_count, created_at, datetime_of_request) VALUES ('{0}', '{1}', '{2}', '{3}', '{4}', '{4}')"
+INSERT_LOG_QUERY = """
+    INSERT INTO quick_search_query_logs 
+    (search, location, results, result_count, created_at, datetime_of_request) 
+    VALUES (%s, %s, %s, %s, %s, %s)
+    """
 
 
 def unaltered_search_query(
@@ -151,9 +155,12 @@ def quick_search_query(
         dict(zip(QUICK_SEARCH_COLUMNS, result)) for result in results
     ]
     data_source_matches_converted = []
+    data_source_matches_ids = []
     for data_source_match in data_source_matches:
         data_source_match = convert_dates_to_strings(data_source_match)
         data_source_matches_converted.append(format_arrays(data_source_match))
+        # Add ids to list for logging
+        data_source_matches_ids.append(data_source_match['airtable_uid'])
 
     data_sources = {
         "count": len(data_source_matches_converted),
@@ -164,12 +171,11 @@ def quick_search_query(
         current_datetime = datetime.datetime.now()
         datetime_string = current_datetime.strftime("%Y-%m-%d %H:%M:%S")
 
-        query_results = json.dumps(data_sources["data"]).replace("'", "")
+        query_results = json.dumps(data_source_matches_ids).replace("'", "")
 
         cursor.execute(
-            INSERT_LOG_QUERY.format(
-                search, location, query_results, data_sources["count"], datetime_string
-            ),
+            INSERT_LOG_QUERY,
+            (search, location, query_results, data_sources["count"], datetime_string),
         )
         conn.commit()
         cursor.close()

From b68fbcb00fc34380bc472b39932f5284f4ce5b4f Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Fri, 24 May 2024 08:19:20 -0400
Subject: [PATCH 02/14] Refactor fixture import statements in test code

The import statements for database cursor and dev_db_connection fixtures in multiple test files have been updated after the fixtures.py file was moved from 'tests/middleware' directory to 'tests' directory. The refactor ensures test modules correctly reference the fixtures from their new location.
---
 tests/{middleware => }/fixtures.py           |  0
 tests/middleware/test_archives_queries.py    |  3 +--
 tests/middleware/test_data_source_queries.py |  2 +-
 tests/middleware/test_login_queries.py       |  2 +-
 tests/middleware/test_quick_search_query.py  | 10 ++--------
 tests/middleware/test_reset_token_queries.py |  2 +-
 tests/middleware/test_user_queries.py        |  2 +-
 7 files changed, 7 insertions(+), 14 deletions(-)
 rename tests/{middleware => }/fixtures.py (100%)

diff --git a/tests/middleware/fixtures.py b/tests/fixtures.py
similarity index 100%
rename from tests/middleware/fixtures.py
rename to tests/fixtures.py
diff --git a/tests/middleware/test_archives_queries.py b/tests/middleware/test_archives_queries.py
index beea63ff..e69ff44c 100644
--- a/tests/middleware/test_archives_queries.py
+++ b/tests/middleware/test_archives_queries.py
@@ -6,10 +6,9 @@
     ARCHIVES_GET_COLUMNS,
 )
 from tests.middleware.helper_functions import (
-    insert_test_agencies_and_sources,
     has_expected_keys,
 )
-from tests.middleware.fixtures import (
+from tests.fixtures import (
     dev_db_connection,
     db_cursor,
     connection_with_test_data,
diff --git a/tests/middleware/test_data_source_queries.py b/tests/middleware/test_data_source_queries.py
index 972e59f5..27c28b8c 100644
--- a/tests/middleware/test_data_source_queries.py
+++ b/tests/middleware/test_data_source_queries.py
@@ -12,7 +12,7 @@
 from tests.middleware.helper_functions import (
     get_boolean_dictionary,
 )
-from tests.middleware.fixtures import connection_with_test_data, dev_db_connection
+from tests.fixtures import connection_with_test_data, dev_db_connection
 
 
 @pytest.fixture
diff --git a/tests/middleware/test_login_queries.py b/tests/middleware/test_login_queries.py
index 21f48ea8..a6ca075c 100644
--- a/tests/middleware/test_login_queries.py
+++ b/tests/middleware/test_login_queries.py
@@ -9,7 +9,7 @@
     is_admin,
 )
 from tests.middleware.helper_functions import create_test_user
-from tests.middleware.fixtures import dev_db_connection, db_cursor
+from tests.fixtures import db_cursor, dev_db_connection
 
 
 def test_login_query(db_cursor: psycopg2.extensions.cursor) -> None:
diff --git a/tests/middleware/test_quick_search_query.py b/tests/middleware/test_quick_search_query.py
index 2ffacdb2..b5ee331b 100644
--- a/tests/middleware/test_quick_search_query.py
+++ b/tests/middleware/test_quick_search_query.py
@@ -1,7 +1,4 @@
-from datetime import datetime
-
 import psycopg2
-import pytz
 
 from middleware.quick_search_query import (
     unaltered_search_query,
@@ -9,14 +6,11 @@
     QUICK_SEARCH_COLUMNS,
 )
 from tests.middleware.helper_functions import (
-    insert_test_agencies_and_sources,
     has_expected_keys,
     get_most_recent_quick_search_query_log,
 )
-from tests.middleware.fixtures import (
-    dev_db_connection,
-    db_cursor,
-    connection_with_test_data,
+from tests.fixtures import (
+    connection_with_test_data, dev_db_connection
 )
 
 
diff --git a/tests/middleware/test_reset_token_queries.py b/tests/middleware/test_reset_token_queries.py
index 9c7d11f0..555a4bca 100644
--- a/tests/middleware/test_reset_token_queries.py
+++ b/tests/middleware/test_reset_token_queries.py
@@ -12,7 +12,7 @@
     create_test_user,
     get_reset_tokens_for_email,
 )
-from tests.middleware.fixtures import dev_db_connection, db_cursor
+from tests.fixtures import db_cursor, dev_db_connection
 
 
 def test_check_reset_token(db_cursor: psycopg2.extensions.cursor) -> None:
diff --git a/tests/middleware/test_user_queries.py b/tests/middleware/test_user_queries.py
index 3fb67cf3..6a905940 100644
--- a/tests/middleware/test_user_queries.py
+++ b/tests/middleware/test_user_queries.py
@@ -2,7 +2,7 @@
 
 from middleware.user_queries import user_post_results, user_check_email
 from tests.middleware.helper_functions import create_test_user
-from tests.middleware.fixtures import dev_db_connection, db_cursor
+from tests.fixtures import db_cursor, dev_db_connection
 
 
 def test_user_post_query(db_cursor: psycopg2.extensions.cursor) -> None:

From 6d01ac49a8da0ce65cd96b4db1dc2d769ba1a96f Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 14:58:15 -0400
Subject: [PATCH 03/14] Add managed_cursor context manager for database
 transactions

Introduced a new 'managed_cursor' context manager in 'utilities/managed_cursor.py'. This context manager creates a psycopg2 cursor that automatically commits changes or rolls back and closes the cursor if an exception is raised. This will add safety to database transactions and improve overall code readability.
---
 utilities/managed_cursor.py | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 utilities/managed_cursor.py

diff --git a/utilities/managed_cursor.py b/utilities/managed_cursor.py
new file mode 100644
index 00000000..02e47916
--- /dev/null
+++ b/utilities/managed_cursor.py
@@ -0,0 +1,27 @@
+from contextlib import contextmanager
+from typing import Iterator
+
+import psycopg2
+
+
+@contextmanager
+def managed_cursor(
+    connection: psycopg2.extensions.connection,
+) -> Iterator[psycopg2.extensions.cursor]:
+    """
+    Manage a cursor for a given database connection.
+
+    :param connection: The psycopg2 database connection.
+    :return: Iterator that yields the cursor
+        and automatically commits changes on successful completion,
+        or rolls back changes and closes the cursor on failure.
+    """
+    cursor = connection.cursor()
+    try:
+        yield cursor
+        connection.commit()
+    except Exception as e:
+        connection.rollback()
+        raise e
+    finally:
+        cursor.close()
\ No newline at end of file

From 8616d379991c0cd1e13ed92d5090a117ba354fce Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 14:58:23 -0400
Subject: [PATCH 04/14] Add tests for managed_cursor functionality

Added a new test file 'test_managed_cursor.py' to ensure correct functioning of the 'managed_cursor' context manager introduced in 'utilities/managed_cursor.py'. The tests check whether changes are automatically committed, and ensure that the cursor is closed and rolled back if an exception occurs. This enhances the reliability and safety of database transactions.
---
 tests/utilities/test_managed_cursor.py | 55 ++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 tests/utilities/test_managed_cursor.py

diff --git a/tests/utilities/test_managed_cursor.py b/tests/utilities/test_managed_cursor.py
new file mode 100644
index 00000000..b59b7e7a
--- /dev/null
+++ b/tests/utilities/test_managed_cursor.py
@@ -0,0 +1,55 @@
+from utilities.managed_cursor import managed_cursor
+import uuid
+from tests.fixtures import dev_db_connection
+SQL_TEST = """
+    INSERT INTO test_table (name) VALUES (%s)
+"""
+
+
+class TestException(Exception):
+    pass
+
+
+def test_managed_cursor_rollback(dev_db_connection):
+    """
+    When an exception occurs,
+    the managed_cursor will rollback any changes made
+    and close the cursor
+    """
+    name = str(uuid.uuid4())
+    try:
+        with managed_cursor(dev_db_connection) as cursor:
+            cursor.execute(SQL_TEST, (name, ))
+            raise TestException
+    except TestException:
+        pass
+    assert cursor.closed == 1, "Cursor should be closed after exiting context manager"
+    cursor = dev_db_connection.cursor()
+    cursor.execute("SELECT * FROM test_table WHERE name = %s", (name, ))
+    result = cursor.fetchall()
+    cursor.close()
+    assert (
+        len(result) == 0,
+        "Any transactions should be rolled back when an "
+        "exception is raised in the context of the managed cursor",
+    )
+
+
+def test_managed_cursors_happy_path(dev_db_connection):
+    """
+    When no exception occurs,
+    the changes will be committed and the cursor will be closed
+    """
+    name = str(uuid.uuid4())
+    with managed_cursor(dev_db_connection) as cursor:
+        cursor.execute(SQL_TEST, (name, ))
+    assert cursor.closed == 1, "Cursor should be closed after exiting context manager"
+    cursor = dev_db_connection.cursor()
+    cursor.execute("SELECT * FROM test_table WHERE name = %s", (name,))
+    result = cursor.fetchall()
+    cursor.close()
+    assert (
+        len(result) == 1,
+        "Any transactions should persist in the absence of an exception "
+        "raised in the context of the managed cursor",
+    )
\ No newline at end of file

From 5719045bf09acd752c75db65e37d2e524a8dafb8 Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 14:59:56 -0400
Subject: [PATCH 05/14] Update quick_search_query method implementation

Modified the quick_search_query method in SearchTokens.py to use the managed_cursor function and replaced arguments of quick_search_query with SearchParameters. This update improves the method's error handling and allows for more efficient argument passing.
---
 resources/SearchTokens.py | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/resources/SearchTokens.py b/resources/SearchTokens.py
index 5f9630be..6045eaa3 100644
--- a/resources/SearchTokens.py
+++ b/resources/SearchTokens.py
@@ -1,4 +1,4 @@
-from middleware.quick_search_query import quick_search_query
+from middleware.quick_search_query import quick_search_query, SearchParameters
 from middleware.data_source_queries import (
     data_source_by_id_query,
     get_data_sources_for_map,
@@ -14,6 +14,7 @@
 from typing import Dict, Any
 
 from resources.PsycopgResource import PsycopgResource, handle_exceptions
+from utilities.managed_cursor import managed_cursor
 
 sys.path.append("..")
 
@@ -65,9 +66,10 @@ def get(self) -> Dict[str, Any]:
             except:
                 test = False
             try:
-                data_sources = quick_search_query(
-                    arg1, arg2, [], self.psycopg2_connection, test
-                )
+                with managed_cursor(self.psycopg2_connection) as cursor:
+                    data_sources = quick_search_query(
+                        SearchParameters(arg1, arg2), cursor
+                    )
 
                 return data_sources
 

From 9403b31b88b57a5cd1eacd0d874b834ef576432f Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 15:00:23 -0400
Subject: [PATCH 06/14] Refactor QuickSearch to use managed_cursor and
 SearchParameters

Updated the QuickSearch class to use SearchParameters in the quick_search_query method call and apply the managed_cursor function for better management of database connections. This results in cleaner and more efficient code with enhanced error handling.
---
 resources/QuickSearch.py | 45 ++++++++++++++++++----------------------
 1 file changed, 20 insertions(+), 25 deletions(-)

diff --git a/resources/QuickSearch.py b/resources/QuickSearch.py
index ee85f0ac..14d94411 100644
--- a/resources/QuickSearch.py
+++ b/resources/QuickSearch.py
@@ -1,13 +1,12 @@
 from middleware.security import api_required
-from middleware.quick_search_query import quick_search_query
+from middleware.quick_search_query import quick_search_query, SearchParameters
 import requests
 import json
 import os
-from middleware.initialize_psycopg2_connection import initialize_psycopg2_connection
-from flask import request
-from typing import Dict, Any
+from flask import make_response, Response
 
 from resources.PsycopgResource import PsycopgResource
+from utilities.managed_cursor import managed_cursor
 
 
 class QuickSearch(PsycopgResource):
@@ -19,7 +18,7 @@ class QuickSearch(PsycopgResource):
     # api_required decorator requires the request"s header to include an "Authorization" key with the value formatted as "Bearer [api_key]"
     # A user can get an API key by signing up and logging in (see User.py)
     @api_required
-    def get(self, search: str, location: str) -> Dict[str, Any]:
+    def get(self, search: str, location: str) -> Response:
         """
         Performs a quick search using the provided search terms and location. It attempts to find relevant
         data sources in the database. If no results are found initially, it re-initializes the database
@@ -33,32 +32,28 @@ def get(self, search: str, location: str) -> Dict[str, Any]:
         - A dictionary containing a message about the search results and the data found, if any.
         """
         try:
-            data = request.get_json()
-            test = data.get("test_flag")
-        except:
-            test = False
 
-        try:
-            data_sources = quick_search_query(
-                search, location, [], self.psycopg2_connection, test
-            )
-
-            if data_sources["count"] == 0:
-                self.psycopg2_connection = initialize_psycopg2_connection()
+            with managed_cursor(self.psycopg2_connection) as cursor:
                 data_sources = quick_search_query(
-                    search, location, [], self.psycopg2_connection
+                    SearchParameters(search, location), cursor
                 )
 
             if data_sources["count"] == 0:
-                return {
-                    "count": 0,
-                    "message": "No results found. Please considering requesting a new data source.",
-                }, 404
+                return make_response(
+                    {
+                        "count": 0,
+                        "message": "No results found. Please considering requesting a new data source.",
+                    },
+                    200,
+                )
 
-            return {
-                "message": "Results for search successfully retrieved",
-                "data": data_sources,
-            }
+            return make_response(
+                {
+                    "message": "Results for search successfully retrieved",
+                    "data": data_sources,
+                },
+                200,
+            )
 
         except Exception as e:
             self.psycopg2_connection.rollback()

From 3394783c345857e6ec615541ad8f43d495f2c657 Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 15:00:44 -0400
Subject: [PATCH 07/14] Refactor quick_search_query method and extract
 depluralize function

Implemented refactoring for the quick_search_query method in quick_search_query.py including better usage of SearchParameters instead of individual parameters and better error handling with managed_cursor for database connections. Also, extracted depluralize function for clearer separation of concerns and easier testing.
---
 middleware/quick_search_query.py | 142 +++++++++++++++++--------------
 1 file changed, 79 insertions(+), 63 deletions(-)

diff --git a/middleware/quick_search_query.py b/middleware/quick_search_query.py
index 0134c08a..0640415e 100644
--- a/middleware/quick_search_query.py
+++ b/middleware/quick_search_query.py
@@ -1,9 +1,10 @@
+from collections import namedtuple
+
 import spacy
 import json
-import datetime
 from utilities.common import convert_dates_to_strings, format_arrays
-from typing import List, Dict, Any, Optional
-from psycopg2.extensions import connection as PgConnection, cursor as PgCursor
+from typing import List, Dict, Any
+from psycopg2.extensions import cursor as PgCursor
 
 QUICK_SEARCH_COLUMNS = [
     "airtable_uid",
@@ -54,8 +55,8 @@
 
 INSERT_LOG_QUERY = """
     INSERT INTO quick_search_query_logs 
-    (search, location, results, result_count, created_at, datetime_of_request) 
-    VALUES (%s, %s, %s, %s, %s, %s)
+    (search, location, results, result_count) 
+    VALUES (%s, %s, %s, %s)
     """
 
 
@@ -89,11 +90,7 @@ def spacy_search_query(
     :return: A list of dictionaries representing the search results.
     """
     # Depluralize search term to increase match potential
-    nlp = spacy.load("en_core_web_sm")
-    search = search.strip()
-    doc = nlp(search)
-    lemmatized_tokens = [token.lemma_ for token in doc]
-    depluralized_search_term = " ".join(lemmatized_tokens)
+    depluralized_search_term = depluralize(search)
     location = location.strip()
 
     print(f"Query parameters: '%{depluralized_search_term}%', '%{location}%'")
@@ -106,78 +103,97 @@ def spacy_search_query(
     return results
 
 
+def depluralize(term: str):
+    """
+    Depluralizes a given term using lemmatization.
+
+    :param term: The term to be depluralized.
+    :return: The depluralized term.
+    """
+    nlp = spacy.load("en_core_web_sm")
+    term = term.strip()
+    doc = nlp(term)
+    lemmatized_tokens = [token.lemma_ for token in doc]
+    depluralized_search_term = " ".join(lemmatized_tokens)
+    return depluralized_search_term
+
+
+SearchParameters = namedtuple("SearchParameters", ["search", "location"])
+
+
 def quick_search_query(
-    search: str = "",
-    location: str = "",
-    test_query_results: Optional[List[Dict[str, Any]]] = None,
-    conn: Optional[PgConnection] = None,
-    test: bool = False,
+    search_parameters: SearchParameters,
+    cursor: PgCursor = None,
 ) -> Dict[str, Any]:
     """
     Performs a quick search using both unaltered and lemmatized search terms, returning the more fruitful result set.
 
-    :param search: The search term.
-    :param location: The location term.
-    :param test_query_results: Predefined results for testing purposes.
-    :param conn: A psycopg2 connection to the database.
-    :param test: Flag indicating whether the function is being called in a test context.
+    :param search_parameters:
+
+    :param cursor: A psycopg2 cursor to the database.
     :return: A dictionary with the count of results and the data itself.
     """
-    data_sources = {"count": 0, "data": []}
-    if type(conn) == dict and "data" in conn:
-        return data_sources
 
-    search = "" if search == "all" else search.replace("'", "")
-    location = "" if location == "all" else location.replace("'", "")
+    processed_search_parameters = process_search_parameters(search_parameters)
 
-    if conn:
-        cursor = conn.cursor()
+    data_source_matches = get_data_source_matches(cursor, processed_search_parameters)
+    processed_data_source_matches = process_data_source_matches(data_source_matches)
 
-    unaltered_results = (
-        unaltered_search_query(cursor, search, location)
-        if not test_query_results
-        else test_query_results
-    )
-    spacy_results = (
-        spacy_search_query(cursor, search, location)
-        if not test_query_results
-        else test_query_results
+    data_sources = {
+        "count": len(processed_data_source_matches.converted),
+        "data": processed_data_source_matches.converted,
+    }
+
+    log_query(cursor, data_sources["count"], processed_data_source_matches, processed_search_parameters)
+
+    return data_sources
+
+
+def log_query(cursor, data_sources_count, processed_data_source_matches, processed_search_parameters):
+    query_results = json.dumps(processed_data_source_matches.ids).replace("'", "")
+    cursor.execute(
+        INSERT_LOG_QUERY,
+        (
+            processed_search_parameters.search,
+            processed_search_parameters.location,
+            query_results,
+            data_sources_count,
+        ),
     )
 
-    # Compare altered search term results with unaltered search term results, return the longer list
-    results = (
-        spacy_results
-        if len(spacy_results) > len(unaltered_results)
-        else unaltered_results
+
+def process_search_parameters(raw_sp: SearchParameters) -> SearchParameters:
+    return SearchParameters(
+        search="" if raw_sp.search == "all" else raw_sp.search.replace("'", ""),
+        location="" if raw_sp.location == "all" else raw_sp.location.replace("'", ""),
     )
 
-    data_source_matches = [
-        dict(zip(QUICK_SEARCH_COLUMNS, result)) for result in results
-    ]
+
+DataSourceMatches = namedtuple("DataSourceMatches", ["converted", "ids"])
+
+def process_data_source_matches(data_source_matches: List[dict]) -> DataSourceMatches:
     data_source_matches_converted = []
     data_source_matches_ids = []
     for data_source_match in data_source_matches:
         data_source_match = convert_dates_to_strings(data_source_match)
         data_source_matches_converted.append(format_arrays(data_source_match))
         # Add ids to list for logging
-        data_source_matches_ids.append(data_source_match['airtable_uid'])
-
-    data_sources = {
-        "count": len(data_source_matches_converted),
-        "data": data_source_matches_converted,
-    }
-
-    if not test_query_results and not test:
-        current_datetime = datetime.datetime.now()
-        datetime_string = current_datetime.strftime("%Y-%m-%d %H:%M:%S")
+        data_source_matches_ids.append(data_source_match["airtable_uid"])
+    return DataSourceMatches(data_source_matches_converted, data_source_matches_ids)
 
-        query_results = json.dumps(data_source_matches_ids).replace("'", "")
 
-        cursor.execute(
-            INSERT_LOG_QUERY,
-            (search, location, query_results, data_sources["count"], datetime_string),
-        )
-        conn.commit()
-        cursor.close()
-
-    return data_sources
+def get_data_source_matches(
+    cursor: PgCursor, sp: SearchParameters
+) -> List[Dict[str, Any]]:
+    unaltered_results = unaltered_search_query(cursor, sp.search, sp.location)
+    spacy_results = spacy_search_query(cursor, sp.search, sp.location)
+    # Compare altered search term results with unaltered search term results, return the longer list
+    results = (
+        spacy_results
+        if len(spacy_results) > len(unaltered_results)
+        else unaltered_results
+    )
+    data_source_matches = [
+        dict(zip(QUICK_SEARCH_COLUMNS, result)) for result in results
+    ]
+    return data_source_matches

From 528cb5bf9c7b7960e6e243a664075aeb7806f86b Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 15:01:06 -0400
Subject: [PATCH 08/14] Updated QuickSearchQueryLogResult to include results

Enhanced the namedtuple QuickSearchQueryLogResult to now include results field. This update involves corresponding changes in the SQL query within the helper_functions.py and tests to consider results field. Additional unit tests have been added to test the depluralize function.
---
 tests/middleware/helper_functions.py        |   8 +-
 tests/middleware/test_quick_search_query.py | 118 ++++++++++++++++----
 2 files changed, 99 insertions(+), 27 deletions(-)

diff --git a/tests/middleware/helper_functions.py b/tests/middleware/helper_functions.py
index 8ce20233..b9346d8f 100644
--- a/tests/middleware/helper_functions.py
+++ b/tests/middleware/helper_functions.py
@@ -129,7 +129,7 @@ def create_test_user(
 
 
 QuickSearchQueryLogResult = namedtuple(
-    "QuickSearchQueryLogResult", ["result_count", "updated_at"]
+    "QuickSearchQueryLogResult", ["result_count", "updated_at", "results"]
 )
 
 
@@ -147,15 +147,15 @@ def get_most_recent_quick_search_query_log(
     """
     cursor.execute(
         """
-        SELECT RESULT_COUNT, DATETIME_OF_REQUEST FROM QUICK_SEARCH_QUERY_LOGS WHERE
-        search = %s AND location = %s ORDER BY DATETIME_OF_REQUEST DESC LIMIT 1
+        SELECT RESULT_COUNT, CREATED_AT, RESULTS FROM QUICK_SEARCH_QUERY_LOGS WHERE
+        search = %s AND location = %s ORDER BY CREATED_AT DESC LIMIT 1
         """,
         (search, location),
     )
     result = cursor.fetchone()
     if result is None:
         return result
-    return QuickSearchQueryLogResult(result_count=result[0], updated_at=result[1])
+    return QuickSearchQueryLogResult(result_count=result[0], updated_at=result[1], results=result[2])
 
 
 def has_expected_keys(result_keys: list, expected_keys: list) -> bool:
diff --git a/tests/middleware/test_quick_search_query.py b/tests/middleware/test_quick_search_query.py
index b5ee331b..fdf56a65 100644
--- a/tests/middleware/test_quick_search_query.py
+++ b/tests/middleware/test_quick_search_query.py
@@ -1,17 +1,22 @@
+from datetime import datetime
+from unittest.mock import patch
+
 import psycopg2
+import pytest
 
 from middleware.quick_search_query import (
     unaltered_search_query,
     quick_search_query,
     QUICK_SEARCH_COLUMNS,
+    process_data_source_matches,
+    SearchParameters,
+    depluralize,
 )
 from tests.middleware.helper_functions import (
     has_expected_keys,
     get_most_recent_quick_search_query_log,
 )
-from tests.fixtures import (
-    connection_with_test_data, dev_db_connection
-)
+from tests.fixtures import connection_with_test_data, dev_db_connection
 
 
 def test_unaltered_search_query(
@@ -45,14 +50,14 @@ def test_quick_search_query_logging(
         result = cursor.fetchone()
         test_datetime = result[0]
 
-    quick_search_query(
-        search="Source 1", location="City A", conn=connection_with_test_data
-    )
-
-    cursor = connection_with_test_data.cursor()
-    # Test that query inserted into log
-    result = get_most_recent_quick_search_query_log(cursor, "Source 1", "City A")
+        quick_search_query(
+            SearchParameters(search="Source 1", location="City A"), cursor=cursor
+        )
+        # Test that query inserted into log
+        result = get_most_recent_quick_search_query_log(cursor, "Source 1", "City A")
     assert result.result_count == 1
+    assert len(result.results) == 1
+    assert result.results[0] == "SOURCE_UID_1"
     assert result.updated_at >= test_datetime
 
 
@@ -65,16 +70,83 @@ def test_quick_search_query_results(
     :param connection_with_test_data: The connection to the test data database.
     :return: None
     """
-    # TODO: Something about the quick_search_query might be mucking up the savepoints. Address once you fix quick_search's logic issues
-    results = quick_search_query(
-        search="Source 1", location="City A", conn=connection_with_test_data
-    )
-    # Test that results include expected keys
-    assert has_expected_keys(results["data"][0].keys(), QUICK_SEARCH_COLUMNS)
-    assert len(results["data"]) == 1
-    assert results["data"][0]["record_type"] == "Type A"
-    # "Source 3" was listed as pending and shouldn't show up
-    results = quick_search_query(
-        search="Source 3", location="City C", conn=connection_with_test_data
-    )
-    assert len(results["data"]) == 0
+    with connection_with_test_data.cursor() as cursor:
+        # TODO: Something about the quick_search_query might be mucking up the savepoints. Address once you fix quick_search's logic issues
+        results = quick_search_query(
+            SearchParameters(search="Source 1", location="City A"), cursor=cursor
+        )
+        # Test that results include expected keys
+        assert has_expected_keys(results["data"][0].keys(), QUICK_SEARCH_COLUMNS)
+        assert len(results["data"]) == 1
+        assert results["data"][0]["record_type"] == "Type A"
+        # "Source 3" was listed as pending and shouldn't show up
+        results = quick_search_query(
+            SearchParameters(search="Source 3", location="City C"), cursor=cursor
+        )
+        assert len(results["data"]) == 0
+
+
+# Test cases
+@pytest.fixture
+def sample_data_source_matches():
+    return [
+        {
+            "airtable_uid": "id1",
+            "field1": "value1",
+            "field_datetime": datetime(2020, 1, 1),
+            "field_array": '["abc","def"]',
+        },
+        {
+            "airtable_uid": "id2",
+            "field2": "value2",
+            "field_datetime": datetime(2021, 2, 2),
+            "field_array": '["hello, world"]',
+        },
+    ]
+
+
+def test_process_data_source_matches(sample_data_source_matches):
+    expected_converted = [
+        {
+            "airtable_uid": "id1",
+            "field1": "value1",
+            "field_datetime": "2020-01-01",
+            "field_array": ["abc", "def"],
+        },
+        {
+            "airtable_uid": "id2",
+            "field2": "value2",
+            "field_datetime": "2021-02-02",
+            "field_array": ["hello, world"],
+        },
+    ]
+    expected_ids = ["id1", "id2"]
+
+    result = process_data_source_matches(sample_data_source_matches)
+
+    assert result.converted == expected_converted
+    assert result.ids == expected_ids
+
+
+
+def test_depluralize_with_plural_words():
+    term = "apples oranges boxes"
+    expected = "apple orange box"
+    assert depluralize(term) == expected
+
+
+def test_depluralize_with_singular_words():
+    term = "apple orange box"
+    expected = "apple orange box"
+    assert depluralize(term) == expected
+
+
+def test_depluralize_with_mixed_words():
+    term = "apples orange box"
+    expected = "apple orange box"
+    assert depluralize(term) == expected
+
+def test_depluralize_with_empty_string():
+    term = ""
+    expected = ""
+    assert depluralize(term) == expected

From c740d5046b038cb1342da5f0373843bea90b7c08 Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 15:02:01 -0400
Subject: [PATCH 09/14] Remove outdated TODO comment in Quick Search tests

The existing TODO comment regarding an issue in the quick_search_query function has been removed from the test_quick_search_query.py module because it's no longer relevant. The quick_search's logic issues have been resolved.
---
 tests/middleware/test_quick_search_query.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/tests/middleware/test_quick_search_query.py b/tests/middleware/test_quick_search_query.py
index fdf56a65..a3c1488d 100644
--- a/tests/middleware/test_quick_search_query.py
+++ b/tests/middleware/test_quick_search_query.py
@@ -71,7 +71,6 @@ def test_quick_search_query_results(
     :return: None
     """
     with connection_with_test_data.cursor() as cursor:
-        # TODO: Something about the quick_search_query might be mucking up the savepoints. Address once you fix quick_search's logic issues
         results = quick_search_query(
             SearchParameters(search="Source 1", location="City A"), cursor=cursor
         )

From 282a2e433489ae625ddbb2239d6ecc3824f305f3 Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 15:04:09 -0400
Subject: [PATCH 10/14] Refactor with Black

---
 middleware/quick_search_query.py            | 15 +++++++++++++--
 tests/middleware/helper_functions.py        |  4 +++-
 tests/middleware/test_quick_search_query.py |  2 +-
 tests/utilities/test_managed_cursor.py      |  9 +++++----
 utilities/managed_cursor.py                 |  2 +-
 5 files changed, 23 insertions(+), 9 deletions(-)

diff --git a/middleware/quick_search_query.py b/middleware/quick_search_query.py
index 0640415e..64fa204d 100644
--- a/middleware/quick_search_query.py
+++ b/middleware/quick_search_query.py
@@ -144,12 +144,22 @@ def quick_search_query(
         "data": processed_data_source_matches.converted,
     }
 
-    log_query(cursor, data_sources["count"], processed_data_source_matches, processed_search_parameters)
+    log_query(
+        cursor,
+        data_sources["count"],
+        processed_data_source_matches,
+        processed_search_parameters,
+    )
 
     return data_sources
 
 
-def log_query(cursor, data_sources_count, processed_data_source_matches, processed_search_parameters):
+def log_query(
+    cursor,
+    data_sources_count,
+    processed_data_source_matches,
+    processed_search_parameters,
+):
     query_results = json.dumps(processed_data_source_matches.ids).replace("'", "")
     cursor.execute(
         INSERT_LOG_QUERY,
@@ -171,6 +181,7 @@ def process_search_parameters(raw_sp: SearchParameters) -> SearchParameters:
 
 DataSourceMatches = namedtuple("DataSourceMatches", ["converted", "ids"])
 
+
 def process_data_source_matches(data_source_matches: List[dict]) -> DataSourceMatches:
     data_source_matches_converted = []
     data_source_matches_ids = []
diff --git a/tests/middleware/helper_functions.py b/tests/middleware/helper_functions.py
index b9346d8f..6d9cdc10 100644
--- a/tests/middleware/helper_functions.py
+++ b/tests/middleware/helper_functions.py
@@ -155,7 +155,9 @@ def get_most_recent_quick_search_query_log(
     result = cursor.fetchone()
     if result is None:
         return result
-    return QuickSearchQueryLogResult(result_count=result[0], updated_at=result[1], results=result[2])
+    return QuickSearchQueryLogResult(
+        result_count=result[0], updated_at=result[1], results=result[2]
+    )
 
 
 def has_expected_keys(result_keys: list, expected_keys: list) -> bool:
diff --git a/tests/middleware/test_quick_search_query.py b/tests/middleware/test_quick_search_query.py
index a3c1488d..dbe589fa 100644
--- a/tests/middleware/test_quick_search_query.py
+++ b/tests/middleware/test_quick_search_query.py
@@ -127,7 +127,6 @@ def test_process_data_source_matches(sample_data_source_matches):
     assert result.ids == expected_ids
 
 
-
 def test_depluralize_with_plural_words():
     term = "apples oranges boxes"
     expected = "apple orange box"
@@ -145,6 +144,7 @@ def test_depluralize_with_mixed_words():
     expected = "apple orange box"
     assert depluralize(term) == expected
 
+
 def test_depluralize_with_empty_string():
     term = ""
     expected = ""
diff --git a/tests/utilities/test_managed_cursor.py b/tests/utilities/test_managed_cursor.py
index b59b7e7a..3e8302c7 100644
--- a/tests/utilities/test_managed_cursor.py
+++ b/tests/utilities/test_managed_cursor.py
@@ -1,6 +1,7 @@
 from utilities.managed_cursor import managed_cursor
 import uuid
 from tests.fixtures import dev_db_connection
+
 SQL_TEST = """
     INSERT INTO test_table (name) VALUES (%s)
 """
@@ -19,13 +20,13 @@ def test_managed_cursor_rollback(dev_db_connection):
     name = str(uuid.uuid4())
     try:
         with managed_cursor(dev_db_connection) as cursor:
-            cursor.execute(SQL_TEST, (name, ))
+            cursor.execute(SQL_TEST, (name,))
             raise TestException
     except TestException:
         pass
     assert cursor.closed == 1, "Cursor should be closed after exiting context manager"
     cursor = dev_db_connection.cursor()
-    cursor.execute("SELECT * FROM test_table WHERE name = %s", (name, ))
+    cursor.execute("SELECT * FROM test_table WHERE name = %s", (name,))
     result = cursor.fetchall()
     cursor.close()
     assert (
@@ -42,7 +43,7 @@ def test_managed_cursors_happy_path(dev_db_connection):
     """
     name = str(uuid.uuid4())
     with managed_cursor(dev_db_connection) as cursor:
-        cursor.execute(SQL_TEST, (name, ))
+        cursor.execute(SQL_TEST, (name,))
     assert cursor.closed == 1, "Cursor should be closed after exiting context manager"
     cursor = dev_db_connection.cursor()
     cursor.execute("SELECT * FROM test_table WHERE name = %s", (name,))
@@ -52,4 +53,4 @@ def test_managed_cursors_happy_path(dev_db_connection):
         len(result) == 1,
         "Any transactions should persist in the absence of an exception "
         "raised in the context of the managed cursor",
-    )
\ No newline at end of file
+    )
diff --git a/utilities/managed_cursor.py b/utilities/managed_cursor.py
index 02e47916..d15736c7 100644
--- a/utilities/managed_cursor.py
+++ b/utilities/managed_cursor.py
@@ -24,4 +24,4 @@ def managed_cursor(
         connection.rollback()
         raise e
     finally:
-        cursor.close()
\ No newline at end of file
+        cursor.close()

From 7a94c2efecf5d8b6a9c13960e5e35bde3a9984fc Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 15:09:01 -0400
Subject: [PATCH 11/14] Replace NotImplementedError with pass in test function

The "raise NotImplementedError" line in the 'test_security.py' file has been changed to a "pass" statement. This is a temporary solution to prevent the function from throwing an error until the implementation is complete.
---
 tests/middleware/test_security.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/middleware/test_security.py b/tests/middleware/test_security.py
index 7aadd7d6..4742a349 100644
--- a/tests/middleware/test_security.py
+++ b/tests/middleware/test_security.py
@@ -4,4 +4,4 @@ def test_api_required_user_not_found():
     the expected result when a user doesn't exist
     :return:
     """
-    raise NotImplementedError
+    pass # TODO

From 902c1096ae5cac73fccda9dfaff8c9f783890a15 Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Sat, 25 May 2024 15:10:14 -0400
Subject: [PATCH 12/14] Refactor with Black

---
 tests/middleware/test_security.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/middleware/test_security.py b/tests/middleware/test_security.py
index 4742a349..00088f3e 100644
--- a/tests/middleware/test_security.py
+++ b/tests/middleware/test_security.py
@@ -4,4 +4,4 @@ def test_api_required_user_not_found():
     the expected result when a user doesn't exist
     :return:
     """
-    pass # TODO
+    pass  # TODO

From 49fa54067a043048a555f0e514075c30c5e30464 Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Mon, 10 Jun 2024 08:13:52 -0400
Subject: [PATCH 13/14] Fix bugs following merge

---
 middleware/quick_search_query.py            |  7 +++----
 resources/QuickSearch.py                    |  4 +++-
 resources/SearchTokens.py                   |  2 +-
 tests/middleware/test_quick_search_query.py | 22 ++++++++++-----------
 4 files changed, 18 insertions(+), 17 deletions(-)

diff --git a/middleware/quick_search_query.py b/middleware/quick_search_query.py
index e598acb0..b3f51d24 100644
--- a/middleware/quick_search_query.py
+++ b/middleware/quick_search_query.py
@@ -1,11 +1,11 @@
 from collections import namedtuple
 
+import psycopg2
 import spacy
 import json
 import datetime
 
 from flask import make_response, Response
-from sqlalchemy.dialects.postgresql import psycopg2
 
 from middleware.webhook_logic import post_to_webhook
 from utilities.common import convert_dates_to_strings, format_arrays
@@ -216,14 +216,13 @@ def get_data_source_matches(
     return data_source_matches
 
 
-def quick_search_query_wrapper(arg1, arg2, conn: PgConnection) -> Response:
+def quick_search_query_wrapper(arg1, arg2, cursor: psycopg2.extensions.cursor) -> Response:
     try:
-        data_sources = quick_search_query(search=arg1, location=arg2, conn=conn)
+        data_sources = quick_search_query(SearchParameters(search=arg1, location=arg2), cursor=cursor)
 
         return make_response(data_sources, 200)
 
     except Exception as e:
-        conn.rollback()
         user_message = "There was an error during the search operation"
         message = {
             "content": user_message
diff --git a/resources/QuickSearch.py b/resources/QuickSearch.py
index 17a3f266..bb79b452 100644
--- a/resources/QuickSearch.py
+++ b/resources/QuickSearch.py
@@ -1,3 +1,5 @@
+from flask import Response
+
 from middleware.security import api_required
 from middleware.quick_search_query import quick_search_query_wrapper
 
@@ -28,4 +30,4 @@ def get(self, search: str, location: str) -> Response:
         Returns:
         - A dictionary containing a message about the search results and the data found, if any.
         """
-        return quick_search_query_wrapper(search, location, self.psycopg2_connection)
+        return quick_search_query_wrapper(search, location, self.psycopg2_connection.cursor())
diff --git a/resources/SearchTokens.py b/resources/SearchTokens.py
index 43326ef5..68ea11f3 100644
--- a/resources/SearchTokens.py
+++ b/resources/SearchTokens.py
@@ -56,7 +56,7 @@ def get(self) -> Dict[str, Any]:
 
     def perform_endpoint_logic(self, arg1, arg2, endpoint):
         if endpoint == "quick-search":
-            return quick_search_query_wrapper(arg1, arg2, self.psycopg2_connection)
+            return quick_search_query_wrapper(arg1, arg2, self.psycopg2_connection.cursor())
         if endpoint == "data-sources":
             return get_approved_data_sources_wrapper(self.psycopg2_connection)
         if endpoint == "data-sources-by-id":
diff --git a/tests/middleware/test_quick_search_query.py b/tests/middleware/test_quick_search_query.py
index 48aa064f..f5ead2e3 100644
--- a/tests/middleware/test_quick_search_query.py
+++ b/tests/middleware/test_quick_search_query.py
@@ -16,7 +16,6 @@
     depluralize,
 )
 from tests.helper_functions import (
-from tests.middleware.helper_functions import (
     has_expected_keys,
     get_most_recent_quick_search_query_log,
 )
@@ -99,9 +98,11 @@ def test_quick_search_query_no_results(
     :return: None
     """
     results = quick_search_query(
-        search="Nonexistent Source",
-        location="Nonexistent Location",
-        conn=connection_with_test_data,
+        SearchParameters(
+            search="Nonexistent Source",
+            location="Nonexistent Location",
+        ),
+        cursor=connection_with_test_data.cursor(),
     )
     assert len(results["data"]) == 0
 
@@ -131,10 +132,10 @@ def test_quick_search_query_wrapper_happy_path(
     mock_quick_search_query, mock_make_response
 ):
     mock_quick_search_query.return_value = [{"record_type": "Type A"}]
-    mock_conn = MagicMock()
-    quick_search_query_wrapper(arg1="Source 1", arg2="City A", conn=mock_conn)
+    mock_cursor = MagicMock()
+    quick_search_query_wrapper(arg1="Source 1", arg2="City A", cursor=mock_cursor)
     mock_quick_search_query.assert_called_with(
-        search="Source 1", location="City A", conn=mock_conn
+        SearchParameters(search="Source 1", location="City A"), cursor=mock_cursor
     )
     mock_make_response.assert_called_with([{"record_type": "Type A"}], 200)
 
@@ -145,12 +146,11 @@ def test_quick_search_query_wrapper_exception(
     mock_quick_search_query.side_effect = Exception("Test Exception")
     arg1 = "Source 1"
     arg2 = "City A"
-    mock_conn = MagicMock()
-    quick_search_query_wrapper(arg1=arg1, arg2=arg2, conn=mock_conn)
+    mock_cursor = MagicMock()
+    quick_search_query_wrapper(arg1=arg1, arg2=arg2, cursor=mock_cursor)
     mock_quick_search_query.assert_called_with(
-        search=arg1, location=arg2, conn=mock_conn
+        SearchParameters(search=arg1, location=arg2), cursor=mock_cursor
     )
-    mock_conn.rollback.assert_called_once()
     user_message = "There was an error during the search operation"
     mock_post_to_webhook.assert_called_with(
         json.dumps({'content': 'There was an error during the search operation: Test Exception\nSearch term: Source 1\nLocation: City A'})

From 69bf937661a17cc765492a9383db431de7fb5bff Mon Sep 17 00:00:00 2001
From: maxachis <maxachis@gmail.com>
Date: Mon, 10 Jun 2024 08:18:03 -0400
Subject: [PATCH 14/14] Reformat with black

---
 middleware/quick_search_query.py             |  8 ++++++--
 middleware/security.py                       |  1 -
 resources/QuickSearch.py                     |  4 +++-
 resources/RefreshSession.py                  |  6 +++++-
 resources/SearchTokens.py                    |  4 +++-
 tests/fixtures.py                            |  6 +++++-
 tests/helper_functions.py                    | 10 ++++++----
 tests/integration/test_agencies.py           |  2 +-
 tests/integration/test_search_tokens.py      |  4 +---
 tests/middleware/test_data_source_queries.py | 11 ++++++++---
 tests/middleware/test_quick_search_query.py  | 10 ++++++----
 tests/middleware/test_security.py            | 14 +++++++++++---
 tests/resources/__init__.py                  |  3 ++-
 tests/resources/test_DataSources.py          |  6 +++---
 tests/resources/test_RefreshSession.py       |  4 +++-
 15 files changed, 63 insertions(+), 30 deletions(-)

diff --git a/middleware/quick_search_query.py b/middleware/quick_search_query.py
index b3f51d24..e47a1add 100644
--- a/middleware/quick_search_query.py
+++ b/middleware/quick_search_query.py
@@ -216,9 +216,13 @@ def get_data_source_matches(
     return data_source_matches
 
 
-def quick_search_query_wrapper(arg1, arg2, cursor: psycopg2.extensions.cursor) -> Response:
+def quick_search_query_wrapper(
+    arg1, arg2, cursor: psycopg2.extensions.cursor
+) -> Response:
     try:
-        data_sources = quick_search_query(SearchParameters(search=arg1, location=arg2), cursor=cursor)
+        data_sources = quick_search_query(
+            SearchParameters(search=arg1, location=arg2), cursor=cursor
+        )
 
         return make_response(data_sources, 200)
 
diff --git a/middleware/security.py b/middleware/security.py
index c57731a9..78f51ab3 100644
--- a/middleware/security.py
+++ b/middleware/security.py
@@ -73,7 +73,6 @@ def validate_role(role: str, endpoint: str, method: str):
         raise InvalidRoleError("You do not have permission to access this endpoint")
 
 
-
 def get_role(api_key, cursor):
     cursor.execute(f"select id, api_key, role from users where api_key = '{api_key}'")
     user_results = cursor.fetchall()
diff --git a/resources/QuickSearch.py b/resources/QuickSearch.py
index bb79b452..972f214b 100644
--- a/resources/QuickSearch.py
+++ b/resources/QuickSearch.py
@@ -30,4 +30,6 @@ def get(self, search: str, location: str) -> Response:
         Returns:
         - A dictionary containing a message about the search results and the data found, if any.
         """
-        return quick_search_query_wrapper(search, location, self.psycopg2_connection.cursor())
+        return quick_search_query_wrapper(
+            search, location, self.psycopg2_connection.cursor()
+        )
diff --git a/resources/RefreshSession.py b/resources/RefreshSession.py
index a8ea5958..6f696a2f 100644
--- a/resources/RefreshSession.py
+++ b/resources/RefreshSession.py
@@ -1,7 +1,11 @@
 from flask import request
 
 from middleware.custom_exceptions import TokenNotFoundError
-from middleware.login_queries import get_session_token_user_data, create_session_token, delete_session_token
+from middleware.login_queries import (
+    get_session_token_user_data,
+    create_session_token,
+    delete_session_token,
+)
 from typing import Dict, Any
 
 from resources.PsycopgResource import PsycopgResource, handle_exceptions
diff --git a/resources/SearchTokens.py b/resources/SearchTokens.py
index 68ea11f3..738c9961 100644
--- a/resources/SearchTokens.py
+++ b/resources/SearchTokens.py
@@ -56,7 +56,9 @@ def get(self) -> Dict[str, Any]:
 
     def perform_endpoint_logic(self, arg1, arg2, endpoint):
         if endpoint == "quick-search":
-            return quick_search_query_wrapper(arg1, arg2, self.psycopg2_connection.cursor())
+            return quick_search_query_wrapper(
+                arg1, arg2, self.psycopg2_connection.cursor()
+            )
         if endpoint == "data-sources":
             return get_approved_data_sources_wrapper(self.psycopg2_connection)
         if endpoint == "data-sources-by-id":
diff --git a/tests/fixtures.py b/tests/fixtures.py
index 77e2c157..5846eecb 100644
--- a/tests/fixtures.py
+++ b/tests/fixtures.py
@@ -81,7 +81,10 @@ def connection_with_test_data(
         dev_db_connection.rollback()
     return dev_db_connection
 
+
 ClientWithMockDB = namedtuple("ClientWithMockDB", ["client", "mock_db"])
+
+
 @pytest.fixture
 def client_with_mock_db(mocker) -> ClientWithMockDB:
     """
@@ -94,6 +97,7 @@ def client_with_mock_db(mocker) -> ClientWithMockDB:
     with app.test_client() as client:
         yield ClientWithMockDB(client, mock_db)
 
+
 @pytest.fixture
 def client_with_db(dev_db_connection: psycopg2.extensions.connection):
     """
@@ -103,4 +107,4 @@ def client_with_db(dev_db_connection: psycopg2.extensions.connection):
     """
     app = create_app(dev_db_connection)
     with app.test_client() as client:
-        yield client
\ No newline at end of file
+        yield client
diff --git a/tests/helper_functions.py b/tests/helper_functions.py
index 6a0d39f2..9dfb28ae 100644
--- a/tests/helper_functions.py
+++ b/tests/helper_functions.py
@@ -273,11 +273,10 @@ def create_api_key(client_with_db, user_info):
     api_key = response.json.get("api_key")
     return api_key
 
+
 def create_api_key_db(cursor, user_id: str):
     api_key = uuid.uuid4().hex
-    cursor.execute(
-        "UPDATE users SET api_key = %s WHERE id = %s", (api_key, user_id)
-    )
+    cursor.execute("UPDATE users SET api_key = %s WHERE id = %s", (api_key, user_id))
     return api_key
 
 
@@ -329,5 +328,8 @@ def give_user_admin_role(
         (user_info.email,),
     )
 
+
 def check_response_status(response, status_code):
-    assert response.status_code == status_code, f"Expected status code {status_code}, got {response.status_code}: {response.text}"
\ No newline at end of file
+    assert (
+        response.status_code == status_code
+    ), f"Expected status code {status_code}, got {response.status_code}: {response.text}"
diff --git a/tests/integration/test_agencies.py b/tests/integration/test_agencies.py
index 01fb5797..09fbf3b7 100644
--- a/tests/integration/test_agencies.py
+++ b/tests/integration/test_agencies.py
@@ -1,4 +1,5 @@
 """Integration tests for /agencies endpoint"""
+
 import psycopg2
 import pytest
 from tests.fixtures import connection_with_test_data, dev_db_connection, client_with_db
@@ -20,4 +21,3 @@ def test_agencies_get(
     )
     assert response.status_code == 200
     assert len(response.json["data"]) > 0
-
diff --git a/tests/integration/test_search_tokens.py b/tests/integration/test_search_tokens.py
index e151b4ff..17952359 100644
--- a/tests/integration/test_search_tokens.py
+++ b/tests/integration/test_search_tokens.py
@@ -25,9 +25,7 @@ def test_search_tokens_get(
     )
     check_response_status(response, 200)
     data = response.json.get("data")
-    assert (
-        len(data) == 1
-    ), "Quick Search endpoint response should return only one entry"
+    assert len(data) == 1, "Quick Search endpoint response should return only one entry"
     entry = data[0]
     assert entry["agency_name"] == "Agency A"
     assert entry["airtable_uid"] == "SOURCE_UID_1"
diff --git a/tests/middleware/test_data_source_queries.py b/tests/middleware/test_data_source_queries.py
index 201ca518..33f0ca50 100644
--- a/tests/middleware/test_data_source_queries.py
+++ b/tests/middleware/test_data_source_queries.py
@@ -172,7 +172,9 @@ def mock_data_source_by_id_query(monkeypatch):
     return mock
 
 
-def test_data_source_by_id_wrapper_data_found(mock_data_source_by_id_query, mock_make_response):
+def test_data_source_by_id_wrapper_data_found(
+    mock_data_source_by_id_query, mock_make_response
+):
     mock_data_source_by_id_query.return_value = {"agency_name": "Agency A"}
     mock_conn = MagicMock()
     data_source_by_id_wrapper(arg="SOURCE_UID_1", conn=mock_conn)
@@ -181,11 +183,14 @@ def test_data_source_by_id_wrapper_data_found(mock_data_source_by_id_query, mock
     )
     mock_make_response.assert_called_with({"agency_name": "Agency A"}, 200)
 
-def test_data_source_by_id_wrapper_data_not_found(mock_data_source_by_id_query, mock_make_response):
+
+def test_data_source_by_id_wrapper_data_not_found(
+    mock_data_source_by_id_query, mock_make_response
+):
     mock_data_source_by_id_query.return_value = None
     mock_conn = MagicMock()
     data_source_by_id_wrapper(arg="SOURCE_UID_1", conn=mock_conn)
     mock_data_source_by_id_query.assert_called_with(
         data_source_id="SOURCE_UID_1", conn=mock_conn
     )
-    mock_make_response.assert_called_with({"message": "Data source not found."}, 200)
\ No newline at end of file
+    mock_make_response.assert_called_with({"message": "Data source not found."}, 200)
diff --git a/tests/middleware/test_quick_search_query.py b/tests/middleware/test_quick_search_query.py
index f5ead2e3..b46f1c0b 100644
--- a/tests/middleware/test_quick_search_query.py
+++ b/tests/middleware/test_quick_search_query.py
@@ -153,11 +153,13 @@ def test_quick_search_query_wrapper_exception(
     )
     user_message = "There was an error during the search operation"
     mock_post_to_webhook.assert_called_with(
-        json.dumps({'content': 'There was an error during the search operation: Test Exception\nSearch term: Source 1\nLocation: City A'})
-    )
-    mock_make_response.assert_called_with(
-        {"count": 0, "message": user_message}, 500
+        json.dumps(
+            {
+                "content": "There was an error during the search operation: Test Exception\nSearch term: Source 1\nLocation: City A"
+            }
+        )
     )
+    mock_make_response.assert_called_with({"count": 0, "message": user_message}, 500)
 
 
 # Test cases
diff --git a/tests/middleware/test_security.py b/tests/middleware/test_security.py
index 16b0c86f..70d0069f 100644
--- a/tests/middleware/test_security.py
+++ b/tests/middleware/test_security.py
@@ -134,6 +134,7 @@ def test_admin_only_action_with_admin_role(dev_db_connection):
     result = validate_api_key(api_key, "datasources", "PUT")
     assert result is None
 
+
 @pytest.fixture
 def app() -> Flask:
     app = Flask(__name__)
@@ -180,16 +181,23 @@ def test_api_required_happy_path(
 def test_api_required_api_key_expired(
     app, client, mock_request_headers, mock_validate_api_key, dummy_route: Callable
 ):
-    mock_validate_api_key.side_effect = ExpiredAPIKeyError("The provided API key has expired")
+    mock_validate_api_key.side_effect = ExpiredAPIKeyError(
+        "The provided API key has expired"
+    )
     with app.test_request_context(headers={"Authorization": "Bearer valid_api_key"}):
         response = dummy_route()
-        assert response == ({"message": "The provided API key has expired"}, HTTPStatus.UNAUTHORIZED.value)
+        assert response == (
+            {"message": "The provided API key has expired"},
+            HTTPStatus.UNAUTHORIZED.value,
+        )
 
 
 def test_api_required_expired_api_key(
     app, client, mock_request_headers, mock_validate_api_key, dummy_route: Callable
 ):
-    mock_validate_api_key.side_effect = ExpiredAPIKeyError("The provided API key has expired")
+    mock_validate_api_key.side_effect = ExpiredAPIKeyError(
+        "The provided API key has expired"
+    )
     with app.test_request_context(headers={"Authorization": "Bearer expired_api_key"}):
         response = dummy_route()
         assert response == (
diff --git a/tests/resources/__init__.py b/tests/resources/__init__.py
index b8dfa95d..be374293 100644
--- a/tests/resources/__init__.py
+++ b/tests/resources/__init__.py
@@ -1,4 +1,5 @@
 # The below line is required to bypass the api_required decorator,
 # and must be positioned prior to other imports in order to work.
 from unittest.mock import patch, MagicMock
-patch("middleware.security.api_required", lambda x: x).start()
\ No newline at end of file
+
+patch("middleware.security.api_required", lambda x: x).start()
diff --git a/tests/resources/test_DataSources.py b/tests/resources/test_DataSources.py
index bfdc1628..a14207e4 100644
--- a/tests/resources/test_DataSources.py
+++ b/tests/resources/test_DataSources.py
@@ -1,12 +1,12 @@
 # The below line is required to bypass the api_required decorator,
 # and must be positioned prior to other imports in order to work.
 from unittest.mock import patch, MagicMock
+
 patch("middleware.security.api_required", lambda x: x).start()
 from tests.fixtures import client_with_mock_db
 
-def test_put_data_source_by_id(
-    client_with_mock_db, monkeypatch
-):
+
+def test_put_data_source_by_id(client_with_mock_db, monkeypatch):
 
     monkeypatch.setattr("resources.DataSources.request", MagicMock())
     # mock_request.get_json.return_value = {"name": "Updated Data Source"}
diff --git a/tests/resources/test_RefreshSession.py b/tests/resources/test_RefreshSession.py
index 839d9972..465265c0 100644
--- a/tests/resources/test_RefreshSession.py
+++ b/tests/resources/test_RefreshSession.py
@@ -114,7 +114,9 @@ def test_post_refresh_session_unexpected_error(
     :param client_with_mock_db:
     :return:
     """
-    mock_get_session_token_user_data.side_effect = Exception("An unexpected error occurred")
+    mock_get_session_token_user_data.side_effect = Exception(
+        "An unexpected error occurred"
+    )
     response = client_with_mock_db.client.post(
         "/refresh-session",
         json={