PYCBC-1752: Provide ClusterOption to enable C++ core lazy KV connections

Changes
-------
* Add `enable_lazy_connections` option to `ClusterOptions`
* Update bindings to pass `enable_lazy_connections` to C++ core
* Update connection tests to confirm option is propagated to the C++
  core

Change-Id: I5a693982addd021fb33f02b917f68e3370245594
Reviewed-on: https://review.couchbase.org/c/couchbase-python-client/+/242352
Reviewed-by: Dimitris Christodoulou <dimitris.christodoulou@couchbase.com>
Tested-by: Build Bot <build@couchbase.com>

Author: thejcfactor

couchbase/logic/options.py

@@ -683,6 +683,7 @@ class ClusterOptionsBase(dict):
         "app_telemetry_ping_interval": {"app_telemetry_ping_interval": timedelta_as_milliseconds},
         "app_telemetry_ping_timeout": {"app_telemetry_ping_timeout": timedelta_as_milliseconds},
         "allow_enterprise_analytics": {"allow_enterprise_analytics": validate_bool},
+        "enable_lazy_connections": {"enable_lazy_connections": validate_bool}
     }
 
     @overload
@@ -734,6 +735,7 @@ def __init__(
         app_telemetry_ping_interval=None,  # type: Optional[timedelta]
         app_telemetry_ping_timeout=None,  # type: Optional[timedelta]
         allow_enterprise_analytics=None,  # type: Optional[bool]
+        enable_lazy_connections=None  # type: Optional[bool]
     ):
         """ClusterOptions instance."""
 

couchbase/options.py

@@ -405,6 +405,7 @@ class ClusterOptions(ClusterOptionsBase):
         app_telemetry_backoff (timedelta, optional): Specifies the time to wait before attempting a websocket reconnection. Defaults to 5 seconds.
         app_telemetry_ping_interval (timedelta, optional): Specifies the time to wait between sending consecutive websocket PING commands to the server. Defaults to 30 seconds.
         app_telemetry_ping_timeout (timedelta, optional): Specifies the time allowed for the server to respond to websocket PING command. Defaults to 2 seconds.
+        enable_lazy_connections (bool, optional): Set to True to enable the C++ core to lazily establish bucket connections. Defaults to False (disabled).
     """  # noqa: E501
 
     def apply_profile(self,

couchbase/tests/connection_t.py

@@ -327,6 +327,7 @@ def test_cluster_options(self, couchbase_config):
             'app_telemetry_backoff': timedelta(seconds=10),
             'app_telemetry_ping_interval': timedelta(seconds=60),
             'app_telemetry_ping_timeout': timedelta(seconds=5),
+            'enable_lazy_connections': True,
         }
 
         expected_opts = copy(opts)
@@ -1190,8 +1191,8 @@ def test_valid_connection_strings(self, conn_str):
             pytest.fail(f'Unexpected exception occurred: {ex}')
 
     @pytest.mark.parametrize('conn_str, expected_opts',
-                             [('couchbase://10.0.0.1?num_io_threads=1&dump_configuration=true',
-                               {'num_io_threads': 1, 'dump_configuration': True}),
+                             [('couchbase://10.0.0.1?num_io_threads=1&dump_configuration=true&enable_lazy_connections=true',  # noqa: E501
+                               {'num_io_threads': 1, 'dump_configuration': True, 'enable_lazy_connections': True}),
                               ('couchbase://10.0.0.1?max_http_connections=4&disable_mozilla_ca_certificates=False',
                                {'max_http_connections': 4, 'disable_mozilla_ca_certificates': False}),
                               ('couchbase://localhost?enable_app_telemetry=true&app_telemetry_endpoint=ws://localhost:8091',  # noqa: E501

src/utils.hxx

@@ -236,6 +236,7 @@ update_cluster_options_from_py(couchbase::core::cluster_options& options,
   extract_bool_field(pyObj_options, "enable_compression", options.enable_compression);
   extract_bool_field(
     pyObj_options, "disable_mozilla_ca_certificates", options.disable_mozilla_ca_certificates);
+  extract_bool_field(pyObj_options, "enable_lazy_connections", options.enable_lazy_connections);
 
   // Always disable metrics for now
   options.enable_metrics = false;
@@ -361,6 +362,7 @@ cluster_options_to_py(const couchbase::core::cluster_options& opts,
   add_bool_field(dict, "disable_mozilla_ca_certificates", opts.disable_mozilla_ca_certificates);
   add_bool_field(dict, "enable_metrics", opts.enable_metrics);
   add_bool_field(dict, "enable_tracing", opts.enable_tracing);
+  add_bool_field(dict, "enable_lazy_connections", opts.enable_lazy_connections);
 
   // Other
   add_field<std::chrono::milliseconds>(dict, "config_poll_interval", opts.config_poll_interval);