Merge branch 'main' into noref-add-platform-api-client

Author: nonword

CHANGELOG.md

@@ -1,7 +1,12 @@
 # Changelog
 
-## v0.0.7 - 2/28/23
+## v0.0.8 - 3/3/23
+- Pass in all kwargs from PostgreSQLClient to ConnectionPool so that all ConnectionPool settings
+can be set from the wrapper
+
+## v0.0.7 - 3/1/23
 - Added Oauth2ApiClient for oauth2 authenticated calls to our Platform API and Sierra
+- Set PostgreSQL connection pool to have a default pool size minimum of 0
 
 ## v0.0.5 - 2/22/23
 - Support write queries to PostgreSQL and MySQL databases
@@ -12,17 +17,14 @@
 - Updated README with deployment information
 
 ## v0.0.3 - 2/10/23
-
 - Added GitHub Actions workflow for deploying to production
 - Switched PostgreSQLClient to use connection pooling
 
 ## v0.0.2 - 2/6/23
-
 - Added CODEOWNERS
 - Added GitHub Actions workflows for running tests and deploying to QA
 - Added tests for helper functions
 - Updated Avro encoder to avoid dependency on pandas
 
 ## v0.0.1 - 1/26/23
-
 Initial version. Includes the `avro_encoder`, `kinesis_client`, `mysql_client`, `postgresql_client`, `redshift_client`, and `s3_client` classes as well as the `config_helper`, `kms_helper`, `log_helper`, and `obfuscation_helper` functions.

README.md

@@ -10,7 +10,7 @@ This package contains common Python utility classes and functions.
 * Connecting to and querying a MySQL database
 * Connecting to and querying a PostgreSQL database using a connection pool
 * Connecting to and querying Redshift
-* Making requests to the Oauth2 authenticated APIS such as NYPL Platform API and Sierra
+* Making requests to the Oauth2 authenticated APIs such as NYPL Platform API and Sierra
 
 ## Functions
 * Reading a YAML config file and putting the contents in os.environ

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "nypl_py_utils"
-version = "0.0.7"
+version = "0.0.8"
 authors = [
   { name="Aaron Friedman", email="aaronfriedman@nypl.org" },
 ]

src/nypl_py_utils/classes/postgresql_client.py

@@ -19,12 +19,10 @@ def __init__(self, host, port, db_name, user, password, **kwargs):
                           '{db_name}').format(user=user, password=password,
                                               host=host, port=port,
                                               db_name=db_name)
-        self.min_size = kwargs.get('min_size', 1)
-        self.max_size = kwargs.get('max_size', None)
-        self.pool = ConnectionPool(
-            self.conn_info, open=False,
-            min_size=kwargs.get('min_size', 1),
-            max_size=kwargs.get('max_size', None))
+        self.kwargs = kwargs
+        self.kwargs['min_size'] = kwargs.get('min_size', 0)
+        self.kwargs['max_size'] = kwargs.get('max_size', 1)
+        self.pool = ConnectionPool(self.conn_info, open=False, **self.kwargs)
 
     def connect(self):
         """
@@ -35,8 +33,7 @@ def connect(self):
         try:
             if self.pool is None:
                 self.pool = ConnectionPool(
-                    self.conn_info, open=False, min_size=self.min_size,
-                    max_size=self.max_size)
+                    self.conn_info, open=False, **self.kwargs)
             self.pool.open(wait=True, timeout=self.timeout)
         except psycopg.Error as e:
             self.logger.error(
@@ -73,7 +70,6 @@ def execute_query(self, query, is_write_query=False, query_params=None,
         """
         self.logger.info('Querying {} database'.format(self.db_name))
         self.logger.debug('Executing query {}'.format(query))
-        self.pool.check()
         with self.pool.connection() as conn:
             try:
                 conn.row_factory = row_factory

tests/test_postgresql_client.py

@@ -1,6 +1,7 @@
 import pytest
 
 from nypl_py_utils import PostgreSQLClient, PostgreSQLClientError
+from psycopg import Error
 
 
 class TestPostgreSQLClient:
@@ -17,25 +18,29 @@ def test_init(self, test_instance):
             'postgresql://test_user:test_password@test_host:test_port/' +
             'test_db_name')
         assert test_instance.pool._opened is False
-        assert test_instance.pool.min_size == 1
+        assert test_instance.pool.min_size == 0
         assert test_instance.pool.max_size == 1
 
     def test_init_with_kwargs(self):
         test_instance = PostgreSQLClient(
             'test_host', 'test_port', 'test_db_name', 'test_user',
-            'test_password', min_size=5, max_size=10)
+            'test_password', min_size=5, max_size=10, max_idle=15.0)
         assert test_instance.pool.conninfo == (
             'postgresql://test_user:test_password@test_host:test_port/' +
             'test_db_name')
         assert test_instance.pool._opened is False
         assert test_instance.pool.min_size == 5
         assert test_instance.pool.max_size == 10
+        assert test_instance.pool.max_idle == 15.0
 
     def test_connect(self, test_instance):
         test_instance.connect()
         test_instance.pool.open.assert_called_once_with(wait=True, timeout=300)
 
-    def test_connect_with_exception(self):
+    def test_connect_with_exception(self, mocker):
+        mocker.patch('psycopg_pool.ConnectionPool.open',
+                     side_effect=Error())
+
         test_instance = PostgreSQLClient(
             'test_host', 'test_port', 'test_db_name', 'test_user',
             'test_password', timeout=1.0)