fix: update logging configs to ignore debug flag when given given a user provided logger

Author: kyeh-amp

src/amplitude_experiment/local/config.py

@@ -2,37 +2,30 @@
 import sys
 
 from ..assignment import AssignmentConfig
-from ..cohort.cohort_sync_config import (
-    CohortSyncConfig,
-    DEFAULT_COHORT_SYNC_URL,
-    EU_COHORT_SYNC_URL,
-)
+from ..cohort.cohort_sync_config import CohortSyncConfig, DEFAULT_COHORT_SYNC_URL, EU_COHORT_SYNC_URL
 from ..server_zone import ServerZone
 
-DEFAULT_SERVER_URL = "https://api.lab.amplitude.com"
-EU_SERVER_URL = "https://flag.lab.eu.amplitude.com"
+DEFAULT_SERVER_URL = 'https://api.lab.amplitude.com'
+EU_SERVER_URL = 'https://flag.lab.eu.amplitude.com'
 
-DEFAULT_STREAM_URL = "https://stream.lab.amplitude.com"
-EU_STREAM_SERVER_URL = "https://stream.lab.eu.amplitude.com"
+DEFAULT_STREAM_URL = 'https://stream.lab.amplitude.com'
+EU_STREAM_SERVER_URL = 'https://stream.lab.eu.amplitude.com'
 
 
 class LocalEvaluationConfig:
     """Experiment Local Client Configuration"""
 
-    def __init__(
-        self,
-        debug: bool = False,
-        server_url: str = DEFAULT_SERVER_URL,
-        server_zone: ServerZone = ServerZone.US,
-        flag_config_polling_interval_millis: int = 30000,
-        flag_config_poller_request_timeout_millis: int = 10000,
-        stream_updates: bool = False,
-        stream_server_url: str = DEFAULT_STREAM_URL,
-        stream_flag_conn_timeout: int = 1500,
-        assignment_config: AssignmentConfig = None,
-        cohort_sync_config: CohortSyncConfig = None,
-        logger: logging.Logger = None,
-    ):
+    def __init__(self, debug: bool = False,
+                 server_url: str = DEFAULT_SERVER_URL,
+                 server_zone: ServerZone = ServerZone.US,
+                 flag_config_polling_interval_millis: int = 30000,
+                 flag_config_poller_request_timeout_millis: int = 10000,
+                 stream_updates: bool = False,
+                 stream_server_url: str = DEFAULT_STREAM_URL,
+                 stream_flag_conn_timeout: int = 1500,
+                 assignment_config: AssignmentConfig = None,
+                 cohort_sync_config: CohortSyncConfig = None,
+                 logger: logging.Logger = None):
         """
         Initialize a config
            Parameters:
@@ -46,7 +39,7 @@ def __init__(
                 assignment_config (AssignmentConfig): The assignment configuration.
                 cohort_sync_config (CohortSyncConfig): The cohort sync configuration.
                 logger (logging.Logger): Optional logger instance. If provided, this logger will be used instead of
-                  creating a new one. The debug flag will still be applied to set the log level.
+                  creating a new one. The debug flag only applies when no logger is provided.
 
            Returns:
                The config object
@@ -57,20 +50,16 @@ def __init__(
         self.cohort_sync_config = cohort_sync_config
         if server_url == DEFAULT_SERVER_URL and server_zone == ServerZone.EU:
             self.server_url = EU_SERVER_URL
-            if (
-                cohort_sync_config is not None
-                and cohort_sync_config.cohort_server_url == DEFAULT_COHORT_SYNC_URL
-            ):
+            if (cohort_sync_config is not None and
+                    cohort_sync_config.cohort_server_url == DEFAULT_COHORT_SYNC_URL):
                 self.cohort_sync_config.cohort_server_url = EU_COHORT_SYNC_URL
 
         self.stream_server_url = stream_server_url
         if stream_server_url == DEFAULT_SERVER_URL and server_zone == ServerZone.EU:
             self.stream_server_url = EU_STREAM_SERVER_URL
 
         self.flag_config_polling_interval_millis = flag_config_polling_interval_millis
-        self.flag_config_poller_request_timeout_millis = (
-            flag_config_poller_request_timeout_millis
-        )
+        self.flag_config_poller_request_timeout_millis = flag_config_poller_request_timeout_millis
         self.stream_updates = stream_updates
         self.stream_flag_conn_timeout = stream_flag_conn_timeout
         self.assignment_config = assignment_config
@@ -82,10 +71,9 @@ def __init__(
             if not self.logger.handlers:
                 handler = logging.StreamHandler(sys.stderr)
                 self.logger.addHandler(handler)
+            # Set log level: DEBUG if debug=True, otherwise WARNING
+            # Only apply debug flag to default logger, not user-provided loggers
+            log_level = logging.DEBUG if self.debug else logging.WARNING
+            self.logger.setLevel(log_level)
         else:
             self.logger = logger
-
-        # Set log level: DEBUG if debug=True, otherwise WARNING
-        # This applies to both provided loggers and the default logger
-        log_level = logging.DEBUG if self.debug else logging.WARNING
-        self.logger.setLevel(log_level)

src/amplitude_experiment/remote/config.py

@@ -1,27 +1,24 @@
 from ..server_zone import ServerZone
 
-DEFAULT_SERVER_URL = "https://api.lab.amplitude.com"
-EU_SERVER_URL = "https://api.lab.eu.amplitude.com"
+DEFAULT_SERVER_URL = 'https://api.lab.amplitude.com'
+EU_SERVER_URL = 'https://api.lab.eu.amplitude.com'
 import logging
 import sys
 
 
 class RemoteEvaluationConfig:
     """Experiment Remote Client Configuration"""
 
-    def __init__(
-        self,
-        debug=False,
-        server_url=DEFAULT_SERVER_URL,
-        fetch_timeout_millis=10000,
-        fetch_retries=0,
-        fetch_retry_backoff_min_millis=500,
-        fetch_retry_backoff_max_millis=10000,
-        fetch_retry_backoff_scalar=1.5,
-        fetch_retry_timeout_millis=10000,
-        server_zone: ServerZone = ServerZone.US,
-        logger=None,
-    ):
+    def __init__(self, debug=False,
+                 server_url=DEFAULT_SERVER_URL,
+                 fetch_timeout_millis=10000,
+                 fetch_retries=0,
+                 fetch_retry_backoff_min_millis=500,
+                 fetch_retry_backoff_max_millis=10000,
+                 fetch_retry_backoff_scalar=1.5,
+                 fetch_retry_timeout_millis=10000,
+                 server_zone: ServerZone = ServerZone.US,
+                 logger=None):
         """
         Initialize a config
             Parameters:
@@ -38,7 +35,7 @@ def __init__(
                 fetch_retry_timeout_millis (int): The request timeout for retrying fetch requests.
                 server_zone (str): Select the Amplitude data center to get flags and variants from, US or EU.
                 logger (logging.Logger): Optional logger instance. If provided, this logger will be used instead of
-                  creating a new one. The debug flag will still be applied to set the log level.
+                  creating a new one. The debug flag only applies when no logger is provided.
 
             Returns:
                 The config object
@@ -62,10 +59,9 @@ def __init__(
             if not self.logger.handlers:
                 handler = logging.StreamHandler(sys.stderr)
                 self.logger.addHandler(handler)
+            # Set log level: DEBUG if debug=True, otherwise WARNING
+            # Only apply debug flag to default logger, not user-provided loggers
+            log_level = logging.DEBUG if self.debug else logging.WARNING
+            self.logger.setLevel(log_level)
         else:
             self.logger = logger
-
-        # Set log level: DEBUG if debug=True, otherwise WARNING
-        # This applies to both provided loggers and the default logger
-        log_level = logging.DEBUG if self.debug else logging.WARNING
-        self.logger.setLevel(log_level)

tests/local/config_test.py

@@ -41,25 +41,21 @@ def test_custom_logger_is_used(self):
         self.assertEqual(config.logger, custom_logger)
         self.assertEqual(config.logger.name, "CustomLogger")
 
-    def test_custom_logger_has_debug_level_when_debug_true(self):
-        """Test that custom logger has DEBUG level set when debug=True"""
-        custom_logger = logging.getLogger("CustomLogger")
-        config = LocalEvaluationConfig(debug=True, logger=custom_logger)
-        self.assertEqual(config.logger.level, logging.DEBUG)
-
-    def test_custom_logger_has_warning_level_when_debug_false(self):
-        """Test that custom logger has WARNING level set when debug=False"""
-        custom_logger = logging.getLogger("CustomLogger")
-        config = LocalEvaluationConfig(debug=False, logger=custom_logger)
-        self.assertEqual(config.logger.level, logging.WARNING)
-
-    def test_custom_logger_debug_flag_takes_precedence(self):
-        """Test that debug flag takes precedence over logger's existing level"""
-        custom_logger = logging.getLogger("CustomLogger")
+    def test_custom_logger_level_not_modified_by_debug_flag(self):
+        """Test that custom logger level is not modified by debug flag"""
+        # Test with debug=True
+        custom_logger = logging.getLogger("CustomLoggerDebug")
         custom_logger.setLevel(logging.ERROR)
         config = LocalEvaluationConfig(debug=True, logger=custom_logger)
-        # Debug flag should override to DEBUG
-        self.assertEqual(config.logger.level, logging.DEBUG)
+        # Logger level should remain unchanged (ERROR), not modified to DEBUG
+        self.assertEqual(config.logger.level, logging.ERROR)
+        
+        # Test with debug=False
+        custom_logger2 = logging.getLogger("CustomLoggerWarning")
+        custom_logger2.setLevel(logging.INFO)
+        config2 = LocalEvaluationConfig(debug=False, logger=custom_logger2)
+        # Logger level should remain unchanged (INFO), not modified to WARNING
+        self.assertEqual(config2.logger.level, logging.INFO)
 
     def test_default_logger_only_one_handler_added(self):
         """Test that only one handler is added to default logger"""

tests/remote/config_test.py

@@ -41,25 +41,21 @@ def test_custom_logger_is_used(self):
         self.assertEqual(config.logger, custom_logger)
         self.assertEqual(config.logger.name, "CustomLogger")
 
-    def test_custom_logger_has_debug_level_when_debug_true(self):
-        """Test that custom logger has DEBUG level set when debug=True"""
-        custom_logger = logging.getLogger("CustomLogger")
-        config = RemoteEvaluationConfig(debug=True, logger=custom_logger)
-        self.assertEqual(config.logger.level, logging.DEBUG)
-
-    def test_custom_logger_has_warning_level_when_debug_false(self):
-        """Test that custom logger has WARNING level set when debug=False"""
-        custom_logger = logging.getLogger("CustomLogger")
-        config = RemoteEvaluationConfig(debug=False, logger=custom_logger)
-        self.assertEqual(config.logger.level, logging.WARNING)
-
-    def test_custom_logger_debug_flag_takes_precedence(self):
-        """Test that debug flag takes precedence over logger's existing level"""
-        custom_logger = logging.getLogger("CustomLogger")
+    def test_custom_logger_level_not_modified_by_debug_flag(self):
+        """Test that custom logger level is not modified by debug flag"""
+        # Test with debug=True
+        custom_logger = logging.getLogger("CustomLoggerDebug")
         custom_logger.setLevel(logging.ERROR)
         config = RemoteEvaluationConfig(debug=True, logger=custom_logger)
-        # Debug flag should override to DEBUG
-        self.assertEqual(config.logger.level, logging.DEBUG)
+        # Logger level should remain unchanged (ERROR), not modified to DEBUG
+        self.assertEqual(config.logger.level, logging.ERROR)
+        
+        # Test with debug=False
+        custom_logger2 = logging.getLogger("CustomLoggerWarning")
+        custom_logger2.setLevel(logging.INFO)
+        config2 = RemoteEvaluationConfig(debug=False, logger=custom_logger2)
+        # Logger level should remain unchanged (INFO), not modified to WARNING
+        self.assertEqual(config2.logger.level, logging.INFO)
 
     def test_default_logger_only_one_handler_added(self):
         """Test that only one handler is added to default logger"""