Further work on handling connection string parsing for lesser known

parameters.

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -85,13 +85,15 @@ Common Changes
 #)  Added :meth:`oracledb.register_password_type()` to allow users to register
     a function that will be called when a password is supplied as a dictionary
     containing the key "type".
-#)  All connect strings are now parsed by the driver. Previously, only thin
-    mode parsed all connect strings and thick mode passed the connect string
+#)  All connect strings are now parsed by the driver. Previously, only Thin
+    mode parsed all connect strings and Thick mode passed the connect string
     unchanged to the Oracle Client library to parse. Parameters unrecognized by
-    the driver in Easy Connect strings are now ignored. Parameters unrecognized
-    by the driver in the ``CONNECT_DATA`` section of a full connect descriptor
-    are passed through unchanged. All other parameters in other sections of a
-    full connect deescriptor that are unrecognized by the driver are ignored.
+    the driver in :ref:`Easy Connect strings <easyconnect>` are now ignored.
+    Parameters unrecognized by the driver in the ``DESCRIPTION``,
+    ``CONNECT_DATA`` and ``SECURITY`` sections of a
+    :ref:`full connect descriptor <conndescriptor>` are passed through
+    unchanged. All other parameters in other sections of a full connect
+    descriptor that are unrecognized by the driver are ignored.
 #)  Added attributes :attr:`DbObjectAttribute.precision`,
     :attr:`DbObjectAttribute.scale`, and :attr:`DbObjectAttribute.max_size` that
     provide additional metadata about

src/oracledb/base_impl.pxd

@@ -456,6 +456,7 @@ cdef class ConnectParamsNode:
         list active_children
 
     cdef int _copy(self, ConnectParamsNode source) except -1
+    cdef list _get_initial_connect_string_parts(self)
     cdef int _set_active_children(self, list children) except -1
 
 
@@ -502,6 +503,8 @@ cdef class Description(ConnectParamsNode):
         public object ssl_version
         public str wallet_location
         dict extra_connect_data_args
+        dict extra_security_args
+        dict extra_args
         str connection_id
 
     cdef str _build_duration_str(self, double value)

src/oracledb/impl/base/connect_params.pyx

@@ -561,6 +561,20 @@ cdef class ConnectParamsNode:
             self.load_balance = source.load_balance
             self.source_route = source.source_route
 
+    cdef list _get_initial_connect_string_parts(self):
+        """
+        Returns a list of the initial connect strings parts used for container
+        nodes.
+        """
+        cdef list parts = []
+        if not self.failover:
+            parts.append("(FAILOVER=OFF)")
+        if self.load_balance:
+            parts.append("(LOAD_BALANCE=ON)")
+        if self.source_route:
+            parts.append("(SOURCE_ROUTE=ON)")
+        return parts
+
     cdef int _set_active_children(self, list children) except -1:
         """
         Set the active children to process when connecting to the database.
@@ -731,8 +745,12 @@ cdef class AddressList(ConnectParamsNode):
         """
         Build a connect string from the components.
         """
-        cdef Address a
-        parts = [a.build_connect_string() for a in self.children]
+        cdef:
+            Address address
+            list parts
+        parts = self._get_initial_connect_string_parts()
+        for address in self.children:
+            parts.append(address.build_connect_string())
         if len(parts) == 1:
             return parts[0]
         return f'(ADDRESS_LIST={"".join(parts)})'
@@ -795,11 +813,7 @@ cdef class Description(ConnectParamsNode):
             str temp
 
         # build top-level description parts
-        parts = []
-        if self.load_balance:
-            parts.append("(LOAD_BALANCE=ON)")
-        if self.source_route:
-            parts.append("(SOURCE_ROUTE=ON)")
+        parts = self._get_initial_connect_string_parts()
         if self.retry_count != 0:
             parts.append(f"(RETRY_COUNT={self.retry_count})")
             if self.retry_delay != 0:
@@ -813,6 +827,9 @@ cdef class Description(ConnectParamsNode):
             parts.append("(USE_SNI=ON)")
         if self.sdu != DEFAULT_SDU:
             parts.append(f"(SDU={self.sdu})")
+        if self.extra_args is not None:
+            parts.extend(f"({k.upper()}={self._value_repr(v)})"
+                         for k, v in self.extra_args.items())
 
         # add address lists, but if the address list contains only a single
         # entry and that entry does not have a host, the other parts aren't
@@ -872,6 +889,9 @@ cdef class Description(ConnectParamsNode):
             if self.wallet_location is not None:
                 temp = f"(MY_WALLET_DIRECTORY={self.wallet_location})"
                 temp_parts.append(temp)
+            if self.extra_security_args is not None:
+                temp_parts.extend(f"({k.upper()}={self._value_repr(v)})"
+                                  for k, v in self.extra_security_args.items())
             parts.append(f'(SECURITY={"".join(temp_parts)})')
 
         return f'(DESCRIPTION={"".join(parts)})'
@@ -902,6 +922,9 @@ cdef class Description(ConnectParamsNode):
         description.ssl_version = self.ssl_version
         description.use_sni = self.use_sni
         description.wallet_location = self.wallet_location
+        description.extra_args = self.extra_args
+        description.extra_connect_data_args = self.extra_connect_data_args
+        description.extra_security_args = self.extra_security_args
         return description
 
     def set_from_args(self, dict args):
@@ -949,6 +972,9 @@ cdef class Description(ConnectParamsNode):
         self.sdu = min(max(self.sdu, 512), 2097152)         # sanitize SDU
         _set_duration_param(args, "tcp_connect_timeout",
                             &self.tcp_connect_timeout)
+        extra_args = args.get("extra_args")
+        if extra_args is not None:
+            self.extra_args = extra_args
 
     def set_from_security_args(self, dict args):
         """
@@ -959,6 +985,9 @@ cdef class Description(ConnectParamsNode):
         _set_str_param(args, "ssl_server_cert_dn", self)
         _set_ssl_version_param(args, "ssl_version", self)
         _set_str_param(args, "wallet_location", self)
+        extra_args = args.get("extra_security_args")
+        if extra_args is not None:
+            self.extra_security_args = extra_args
 
     cdef int set_server_type(self, str value) except -1:
         """
@@ -985,12 +1014,14 @@ cdef class DescriptionList(ConnectParamsNode):
         Build a connect string from the components.
         """
         cdef:
-            Description d
+            Description description
             list parts
-        parts = [d.build_connect_string() for d in self.children]
+        parts = self._get_initial_connect_string_parts()
+        for description in self.children:
+            parts.append(description.build_connect_string())
         if len(parts) == 1:
             return parts[0]
-        return f'(DESCIPTION_LIST={"".join(parts)})'
+        return f'(DESCRIPTION_LIST={"".join(parts)})'
 
     cdef list get_addresses(self):
         """

src/oracledb/impl/base/parsers.pyx

@@ -50,8 +50,34 @@ CONTAINER_PARAM_NAMES = set([
     "security",
 ])
 
+# DESCRIPTION parameter names that are supported by the driver; all other
+# key/value pairs are passed unchanged to the database
+DESCRIPTION_PARAM_NAMES = set([
+    "address",
+    "address_list",
+    "connect_data",
+    "expire_time",
+    "failover",
+    "load_balance",
+    "source_route",
+    "retry_count",
+    "retry_delay",
+    "sdu",
+    "tcp_connect_timeout",
+    "use_sni",
+    "security",
+])
+
+# extra DESCRIPTION parameter names that are passed through when detected in an
+# easy connect string
+EXTRA_DESCRIPTION_PARAM_NAMES = set([
+    "enable",
+    "recv_buf_size",
+    "send_buf_size"
+])
+
 # CONNECT_DATA parameter names that are supported by the driver; all other
-# simple key/value pairs are passed unchanged to the database
+# key/value pairs are passed unchanged to the database
 CONNECT_DATA_PARAM_NAMES = set([
     "cclass",
     "connection_id_prefix",
@@ -64,18 +90,30 @@ CONNECT_DATA_PARAM_NAMES = set([
     "use_tcp_fast_open",
 ])
 
+# SECURITY parameter names that are supported by the driver; all other
+# key/value pairs are passed unchanged to the database
+SECURITY_PARAM_NAMES = set([
+    "ssl_server_cert_dn",
+    "ssl_server_dn_match",
+    "ssl_version",
+    "wallet_location",
+])
+
 # a set of parameter names supported by the driver in EasyConnect strings that
 # are common to all drivers
 COMMON_PARAM_NAMES = set([
     "expire_time",
+    "failover",
     "https_proxy",
     "https_proxy_port",
+    "load_balance",
     "pool_boundary",
     "pool_connection_class",
     "pool_purity",
     "retry_count",
     "retry_delay",
     "sdu",
+    "source_route",
     "ssl_server_cert_dn",
     "ssl_server_dn_match",
     "transport_connect_timeout",
@@ -154,7 +192,9 @@ cdef class BaseParser:
         cdef Py_UCS4 ch
         while self.temp_pos < self.num_chars:
             ch = self.get_current_char()
-            if not cpython.Py_UNICODE_ISALPHA(ch) and ch != '_' and ch != '.':
+            if not cpython.Py_UNICODE_ISALPHA(ch) \
+                    and not cpython.Py_UNICODE_ISDIGIT(ch) \
+                    and ch != '_' and ch != '.':
                 break
             self.temp_pos += 1
 
@@ -444,9 +484,9 @@ cdef class ConnectStringParser(BaseParser):
         """
         cdef:
             ssize_t start_pos, end_pos = 0
+            str name, value
             Py_UCS4 ch = 0
             bint keep
-            str name
 
         # get parameter name
         self.skip_spaces()
@@ -459,7 +499,8 @@ cdef class ConnectStringParser(BaseParser):
             name = name[len(EXTENDED_PARAM_PREFIX):]
             keep = name in EXTENDED_PARAM_NAMES
         else:
-            keep = name in COMMON_PARAM_NAMES
+            keep = name in COMMON_PARAM_NAMES \
+                    or name in EXTRA_DESCRIPTION_PARAM_NAMES
             name = ALTERNATIVE_PARAM_NAMES.get(name, name)
 
         # look for the equals sign
@@ -495,7 +536,11 @@ cdef class ConnectStringParser(BaseParser):
         if end_pos > start_pos and keep:
             if self.parameters is None:
                 self.parameters = {}
-            self.parameters[name] = self.data_as_str[start_pos:end_pos]
+            value = self.data_as_str[start_pos:end_pos]
+            if name in EXTRA_DESCRIPTION_PARAM_NAMES:
+                self.parameters.setdefault("extra_args", {})[name] = value
+            else:
+                self.parameters[name] = value
         self.skip_spaces()
         self.pos = self.temp_pos
 
@@ -636,19 +681,23 @@ cdef class ConnectStringParser(BaseParser):
                     self.data_as_str[self.pos + 1:instance_name_end_pos]
             self.pos = self.temp_pos
 
-    cdef dict _set_connect_data(self, dict args):
+    cdef dict _process_args_with_extras(self, dict args, set allowed_names,
+                                        str extras_name):
         """
-        Sets the connect data value.
+        Processes arguments which contain a set of known attributes and any
+        number of unknown attributes. The known attributes are left untouched
+        whereas the unknown ones are put in a separate dictionary with the
+        given name.
         """
         cdef:
             dict extras, result = {}
             object value
             str key
         for key, value in args.items():
-            if key in CONNECT_DATA_PARAM_NAMES:
+            if key in allowed_names:
                 result[key] = value
             else:
-                extras = result.setdefault("extra_connect_data_args", {})
+                extras = result.setdefault(extras_name, {})
                 extras[key] = value
         return result
 
@@ -663,6 +712,21 @@ cdef class ConnectStringParser(BaseParser):
         being added and addresses already exist, those addresses are first
         added to the address list before the new value is added.
         """
+        # process unrecognized parameters, if applicable
+        if name == "description":
+            value = self._process_args_with_extras(
+                value, DESCRIPTION_PARAM_NAMES, "extra_args"
+            )
+        elif name == "connect_data":
+            value = self._process_args_with_extras(
+                value, CONNECT_DATA_PARAM_NAMES, "extra_connect_data_args"
+            )
+        elif name == "security":
+            value = self._process_args_with_extras(
+                value, SECURITY_PARAM_NAMES, "extra_security_args"
+            )
+
+        # add value to arguments, creating a list if encountered multiple times
         orig_value = args.get(name)
         if orig_value is None:
             if name == "address" and "address_list" in args:
@@ -673,8 +737,6 @@ cdef class ConnectStringParser(BaseParser):
                 if not isinstance(addresses, list):
                     addresses = [addresses]
                 value = [dict(address=a) for a in addresses] + [value]
-            elif name == "connect_data":
-                value = self._set_connect_data(value)
             args[name] = value
         elif isinstance(orig_value, list):
             args[name].append(value)