remove global set_sdk_key, make SDK key required in Config (#140)

Author: eli-darkly

demo/demo.py

@@ -5,7 +5,7 @@ ldclient module
 ---------------
 
 .. automodule:: ldclient
-    :members: get,set_config,set_sdk_key
+    :members: get,set_config
 
 ldclient.client module
 ----------------------

docs/api-main.rst

@@ -18,7 +18,7 @@
 start_wait = 5
 
 __client = None
-__config = Config()
+__config = None
 __lock = ReadWriteLock()
 
 
@@ -48,52 +48,12 @@ def set_config(config: Config):
         __lock.unlock()
 
 
-def set_sdk_key(sdk_key: str):
-    """Sets the SDK key for the shared SDK client instance.
-
-    If this is called prior to :func:`ldclient.get()`, it stores the SDK key that will be used when the client is
-    initialized. If it is called after the client has already been initialized, the client will be
-    re-initialized with the new SDK key (this will result in the next call to :func:`ldclient.get()` returning a
-    new client instance).
-
-    If you need to set any configuration options other than the SDK key, use :func:`ldclient.set_config()` instead.
-
-    :param sdk_key: the new SDK key
-    """
-    global __config
-    global __client
-    global __lock
-    sdk_key_changed = False
-    try:
-        __lock.rlock()
-        if sdk_key == __config.sdk_key:
-            log.info("New sdk_key is the same as the existing one. doing nothing.")
-        else:
-            sdk_key_changed = True
-    finally:
-        __lock.runlock()
-
-    if sdk_key_changed:
-        try:
-            __lock.lock()
-            __config = __config.copy_with_new_sdk_key(new_sdk_key=sdk_key)
-            if __client:
-                log.info("Reinitializing LaunchDarkly Client " + VERSION + " with new sdk key")
-                new_client = LDClient(config=__config, start_wait=start_wait)
-                old_client = __client
-                __client = new_client
-                old_client.close()
-        finally:
-            __lock.unlock()
-
-
 def get() -> LDClient:
     """Returns the shared SDK client instance, using the current global configuration.
 
-    To use the SDK as a singleton, first make sure you have called :func:`ldclient.set_sdk_key()` or
-    :func:`ldclient.set_config()` at startup time. Then ``get()`` will return the same shared
-    :class:`ldclient.client.LDClient` instance each time. The client will be initialized if it has
-    not been already.
+    To use the SDK as a singleton, first make sure you have called :func:`ldclient.set_config()`
+    at startup time. Then ``get()`` will return the same shared :class:`ldclient.client.LDClient`
+    instance each time. The client will be initialized if it has not been already.
 
     If you need to create multiple client instances with different configurations, instead of this
     singleton approach you can call the :class:`ldclient.client.LDClient` constructor directly instead.
@@ -105,6 +65,8 @@ def get() -> LDClient:
         __lock.rlock()
         if __client:
             return __client
+        if __config is None:
+            raise Exception("set_config was not called")
     finally:
         __lock.runlock()
 

ldclient/__init__.py

@@ -64,8 +64,8 @@ class LDClient:
 
     Applications should configure the client at startup time and continue to use it throughout the lifetime
     of the application, rather than creating instances on the fly. The best way to do this is with the
-    singleton methods :func:`ldclient.set_sdk_key()`, :func:`ldclient.set_config()`, and :func:`ldclient.get()`.
-    However, you may also call the constructor directly if you need to maintain multiple instances.
+    singleton methods :func:`ldclient.set_config()` and :func:`ldclient.get()`. However, you may also call
+    the constructor directly if you need to maintain multiple instances.
 
     Client instances are thread-safe.
     """

ldclient/client.py

@@ -82,7 +82,7 @@ class Config:
     if you are using the singleton client, or the :class:`ldclient.client.LDClient` constructor otherwise.
     """
     def __init__(self,
-                 sdk_key: Optional[str]=None,
+                 sdk_key: str,
                  base_uri: str='https://app.launchdarkly.com',
                  events_uri: str='https://events.launchdarkly.com',
                  events_max_pending: int=10000,
@@ -111,7 +111,7 @@ def __init__(self,
                  wrapper_version: Optional[str]=None,
                  http: HTTPConfig=HTTPConfig()):
         """
-        :param sdk_key: The SDK key for your LaunchDarkly account.
+        :param sdk_key: The SDK key for your LaunchDarkly account. This is always required.
         :param base_uri: The base URL for the LaunchDarkly server. Most users should use the default
           value.
         :param events_uri: The URL for the LaunchDarkly events server. Most users should use the
@@ -205,12 +205,6 @@ def __init__(self,
         self.__wrapper_version = wrapper_version
         self.__http = http
 
-    @classmethod
-    def default(cls) -> 'Config':
-        """Returns a ``Config`` instance with default values for all properties.
-        """
-        return cls()
-
     def copy_with_new_sdk_key(self, new_sdk_key: str) -> 'Config':
         """Returns a new ``Config`` instance that is the same as this one, except for having a different SDK key.
 

ldclient/config.py

@@ -8,6 +8,7 @@
 import uuid
 import platform
 
+from ldclient.config import Config
 from ldclient.version import VERSION
 
 class _DiagnosticAccumulator:
@@ -62,7 +63,7 @@ def _diagnostic_base_fields(kind, creation_date, diagnostic_id):
             'id': diagnostic_id}
 
 def _create_diagnostic_config_object(config):
-    default_config = config.default()
+    default_config = Config("SDK_KEY")
     return {'customBaseURI': config.base_uri != default_config.base_uri,
             'customEventsURI': config.events_uri != default_config.events_uri,
             'customStreamURI': config.stream_base_uri != default_config.stream_base_uri,

ldclient/diagnostics.py

@@ -39,7 +39,7 @@ def test_create_diagnostic_init():
     json.dumps(diag_init)
 
 def test_create_diagnostic_config_defaults():
-    test_config = Config()
+    test_config = Config("SDK_KEY")
     diag_config = _create_diagnostic_config_object(test_config)
 
     assert len(diag_config) == 17
@@ -63,7 +63,7 @@ def test_create_diagnostic_config_defaults():
 
 def test_create_diagnostic_config_custom():
     test_store = CachingStoreWrapper(_TestStoreForDiagnostics(), CacheConfig.default())
-    test_config = Config(base_uri='https://test.com', events_uri='https://test.com',
+    test_config = Config("SDK_KEY", base_uri='https://test.com', events_uri='https://test.com',
                          events_max_pending=10, flush_interval=1, stream_uri='https://test.com',
                          stream=False, poll_interval=60, use_ldd=True, feature_store=test_store,
                          all_attributes_private=True, user_keys_capacity=10, user_keys_flush_interval=60,
@@ -95,7 +95,7 @@ def describe_configuration(self, config):
 
 def test_diagnostic_accumulator():
     test_config = Config(sdk_key = "SDK_KEY")
-    diag_id = create_diagnostic_id(test_config);
+    diag_id = create_diagnostic_id(test_config)
     diag_accum = _DiagnosticAccumulator(diag_id)
 
     # Test default periodic event

testing/test_diagnostics.py

@@ -13,7 +13,7 @@
 from testing.stub_util import MockResponse, MockHttp
 
 
-default_config = Config()
+default_config = Config("fake_sdk_key")
 user = {
     'key': 'userkey',
     'name': 'Red'
@@ -69,6 +69,8 @@ class DefaultTestProcessor(DefaultEventProcessor):
     def __init__(self, **kwargs):
         if not 'diagnostic_opt_out' in kwargs:
             kwargs['diagnostic_opt_out'] = True
+        if not 'sdk_key' in kwargs:
+            kwargs['sdk_key'] = 'SDK_KEY'
         config = Config(**kwargs)
         diagnostic_accumulator = _DiagnosticAccumulator(create_diagnostic_id(config))
         DefaultEventProcessor.__init__(self, config, mock_http, diagnostic_accumulator = diagnostic_accumulator)
@@ -531,7 +533,7 @@ def test_will_still_send_after_500_error():
     verify_recoverable_http_error(500)
 
 def test_does_not_block_on_full_inbox():
-    config = Config(events_max_pending=1)  # this sets the size of both the inbox and the outbox to 1
+    config = Config("fake_sdk_key", events_max_pending=1)  # this sets the size of both the inbox and the outbox to 1
     ep_inbox_holder = [ None ]
     ep_inbox = None
 

testing/test_event_processor.py

@@ -100,7 +100,7 @@ def teardown_function():
 
 def make_data_source(**kwargs):
     global data_source
-    data_source = Files.new_data_source(**kwargs)(Config(), store, ready)
+    data_source = Files.new_data_source(**kwargs)(Config("SDK_KEY"), store, ready)
     return data_source
 
 def make_temp_file(content):
@@ -226,7 +226,7 @@ def test_evaluates_full_flag_with_client_as_expected():
     path = make_temp_file(all_properties_json)
     try:
         factory = Files.new_data_source(paths = path)
-        client = LDClient(config=Config(update_processor_class = factory, send_events = False))
+        client = LDClient(config=Config('SDK_KEY', update_processor_class = factory, send_events = False))
         value = client.variation('flag1', { 'key': 'user' }, '')
         assert value == 'on'
     finally:
@@ -238,7 +238,7 @@ def test_evaluates_simplified_flag_with_client_as_expected():
     path = make_temp_file(all_properties_json)
     try:
         factory = Files.new_data_source(paths = path)
-        client = LDClient(config=Config(update_processor_class = factory, send_events = False))
+        client = LDClient(config=Config('SDK_KEY', update_processor_class = factory, send_events = False))
         value = client.variation('flag2', { 'key': 'user' }, '')
         assert value == 'value2'
     finally:
@@ -264,7 +264,7 @@ def test_does_not_allow_unsafe_yaml():
     path = make_temp_file(unsafe_yaml)
     try:
         factory = Files.new_data_source(paths = path)
-        client = LDClient(config=Config(update_processor_class = factory, send_events = False))
+        client = LDClient(config=Config('SDK_KEY', update_processor_class = factory, send_events = False))
     finally:
         os.remove(path)
         if client is not None:

testing/test_file_data_source.py

@@ -6,26 +6,6 @@
 mylogger = logging.getLogger()
 
 
-def test_set_sdk_key():
-    old_sdk_key = "OLD_SDK_KEY"
-    new_sdk_key = "NEW_SDK_KEY"
-
-    old_config = Config(sdk_key=old_sdk_key, stream=False, offline=True)
-    ldclient.set_config(old_config)
-
-    old_client = ldclient.get()
-    assert old_client.get_sdk_key() == old_sdk_key
-
-    ldclient.set_sdk_key(new_sdk_key)
-    new_client = ldclient.get()
-
-    assert new_client.get_sdk_key() == new_sdk_key
-
-    # illustrates bad behavior- assigning value of ldclient.get() means
-    # the old_client didn't get updated when we called set_sdk_key()
-    assert old_client.get_sdk_key() == old_sdk_key
-
-
 def test_set_config():
     old_sdk_key = "OLD_SDK_KEY"
     new_sdk_key = "NEW_SDK_KEY"