fix(connection, startup): support new startup message properties

Author: Brooke-white

redshift_connector/__init__.py

@@ -38,6 +38,7 @@
     PGVarchar,
 )
 from redshift_connector.redshift_property import RedshiftProperty
+from redshift_connector.utils import DriverInfo
 
 from .version import __version__
 
@@ -267,6 +268,7 @@ def connect(
         replication=info.replication,
         client_protocol_version=info.client_protocol_version,
         database_metadata_current_db_only=database_metadata_current_db_only,
+        credentials_provider=info.credentials_provider,
     )
 
 

redshift_connector/core.py

@@ -47,6 +47,7 @@
     FC_BINARY,
     NULL,
     NULL_BYTE,
+    DriverInfo,
     array_check_dimensions,
     array_dim_lengths,
     array_find_first_element,
@@ -347,6 +348,16 @@ def _getError(self: "Connection", error):
         warn("DB-API extension connection.%s used" % error.__name__, stacklevel=3)
         return error
 
+    @property
+    def client_os_version(self: "Connection") -> str:
+        from platform import platform as CLIENT_PLATFORM
+
+        try:
+            os_version: str = CLIENT_PLATFORM()
+        except:
+            os_version = "unknown"
+        return os_version
+
     def __init__(
         self: "Connection",
         user: str,
@@ -365,6 +376,7 @@ def __init__(
         replication: typing.Optional[str] = None,
         client_protocol_version: int = DEFAULT_PROTOCOL_VERSION,
         database_metadata_current_db_only: bool = True,
+        credentials_provider: typing.Optional[str] = None,
     ):
         """
         Creates a :class:`Connection` to an Amazon Redshift cluster. For more information on establishing a connection to an Amazon Redshift cluster using `federated API access <https://aws.amazon.com/blogs/big-data/federated-api-access-to-amazon-redshift-using-an-amazon-redshift-connector-for-python/>`_ see our examples page.
@@ -401,6 +413,8 @@ def __init__(
             The requested server protocol version. The default value is 1 representing `EXTENDED_RESULT_METADATA`. If the requested server protocol cannot be satisfied, a warning will be displayed to the user.
         database_metadata_current_db_only : bool
             Is `datashare <https://docs.aws.amazon.com/redshift/latest/dg/datashare-overview.html>`_ disabled. Default value is True, implying datasharing will not be used.
+        credentials_provider : Optional[str]
+            The class-path of the IdP plugin used for authentication with Amazon Redshift.
         """
         self.merge_socket_read = False
 
@@ -432,8 +446,13 @@ def __init__(
             "application_name": application_name,
             "replication": replication,
             "client_protocol_version": str(self._client_protocol_version),
+            "driver_version": DriverInfo.driver_full_name(),
+            "os_version": self.client_os_version,
         }
 
+        if credentials_provider:
+            init_params["plugin_name"] = credentials_provider
+
         for k, v in tuple(init_params.items()):
             if isinstance(v, str):
                 init_params[k] = v.encode("utf8")

redshift_connector/iam_helper.py

@@ -146,6 +146,11 @@ def set_iam_properties(
                         "Invalid connection property setting. It is not valid to provide both Credentials provider and "
                         "AWS credentials or AWS profile"
                     )
+                elif not isinstance(credentials_provider, str):
+                    raise InterfaceError(
+                        "Invalid connection property setting. It is not valid to provide a non-string value to "
+                        "credentials_provider."
+                    )
                 else:
                     info.credentials_provider = credentials_provider
             elif profile is not None:
@@ -272,9 +277,11 @@ def set_iam_credentials(info: RedshiftProperty) -> None:
             except (AttributeError, ModuleNotFoundError):
                 _logger.debug("Failed to load user defined plugin: {}".format(info.credentials_provider))
                 try:
-                    klass = dynamic_plugin_import("redshift_connector.plugin.{}".format(info.credentials_provider))
+                    predefined_idp: str = "redshift_connector.plugin.{}".format(info.credentials_provider)
+                    klass = dynamic_plugin_import(predefined_idp)
                     provider = klass()  # type: ignore
                     provider.add_parameter(info)  # type: ignore
+                    info.credentials_provider = predefined_idp
                 except (AttributeError, ModuleNotFoundError):
                     _logger.debug(
                         "Failed to load pre-defined IdP plugin from redshift_connector.plugin: {}".format(

redshift_connector/utils/__init__.py

@@ -6,6 +6,7 @@
     array_has_null,
     walk_array,
 )
+from .driver_info import DriverInfo
 from .type_utils import (
     FC_BINARY,
     NULL,

redshift_connector/utils/driver_info.py

@@ -0,0 +1,48 @@
+class DriverInfo:
+    """
+    No-op informative class containing  Amazon Redshift Python driver specifications.
+    """
+
+    @staticmethod
+    def version() -> str:
+        """
+        The version of redshift_connector
+        Returns
+        -------
+        The redshift_connector package version: str
+        """
+        from redshift_connector import __version__ as DRIVER_VERSION
+
+        return str(DRIVER_VERSION)
+
+    @staticmethod
+    def driver_name() -> str:
+        """
+        The name of the Amazon Redshift Python driver, redshift_connector
+        Returns
+        -------
+        The human readable name of the redshift_connector package: str
+        """
+        return "Redshift Python Driver"
+
+    @staticmethod
+    def driver_short_name() -> str:
+        """
+        The shortened name of the Amazon Redshift Python driver, redshift_connector
+        Returns
+        -------
+        The shortened human readable name of the Amazon Redshift Python driver: str
+        """
+        return "RsPython"
+
+    @staticmethod
+    def driver_full_name() -> str:
+        """
+        The fully qualified name of the Amazon Redshift Python driver, redshift_connector
+        Returns
+        -------
+        The fully qualified name of the Amazon Redshift Python driver: str
+        """
+        return "{driver_name} {driver_version}".format(
+            driver_name=DriverInfo.driver_name(), driver_version=DriverInfo.version()
+        )