added warning when not ready

Author: chillaq

splitio/client/client.py

@@ -61,6 +61,7 @@ def destroyed(self):
 
     def _evaluate_if_ready(self, matching_key, bucketing_key, feature, attributes=None):
         if not self.ready:
+            _LOGGER.warning("The SDK is not ready, results may be incorrect for feature flag %s. Make sure to wait for SDK readiness before using this method", feature)
             self._telemetry_init_producer.record_not_ready_usage()
             return {
                 'treatment': CONTROL,
@@ -214,6 +215,7 @@ def _make_evaluations(self, key, feature_flags, attributes, method_name, metric_
 
     def _evaluate_features_if_ready(self, matching_key, bucketing_key, feature_flags, attributes=None):
         if not self.ready:
+            _LOGGER.warning("The SDK is not ready, results may be incorrect for feature flags %s. Make sure to wait for SDK readiness before using this method", ', '.join([feature for feature in feature_flags]))
             self._telemetry_init_producer.record_not_ready_usage()
             return {
                 feature_flag: {

tests/client/test_client.py

@@ -83,6 +83,7 @@ def test_get_treatment(self, mocker):
         assert mocker.call(
             [(Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY), {'some_attribute': 1})]
         ) in impmanager.process_impressions.mock_calls
+        assert _logger.call(["The SDK is not ready, results may be incorrect for feature flag %s. Make sure to wait for SDK readiness before using this method", 'some_feature'])
 
         # Test with exception:
         ready_property.return_value = True
@@ -159,6 +160,7 @@ def test_get_treatment_with_config(self, mocker):
             [(Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY),
               {'some_attribute': 1})]
         ) in impmanager.process_impressions.mock_calls
+        assert _logger.call(["The SDK is not ready, results may be incorrect for feature flag %s. Make sure to wait for SDK readiness before using this method", 'some_feature'])
 
         # Test with exception:
         ready_property.return_value = True
@@ -236,6 +238,7 @@ def test_get_treatments(self, mocker):
         assert mocker.call(
             [(Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY), {'some_attribute': 1})]
         ) in impmanager.process_impressions.mock_calls
+        assert _logger.call(["The SDK is not ready, results may be incorrect for feature flags %s. Make sure to wait for SDK readiness before using this method", 'some_feature'])
 
         # Test with exception:
         ready_property.return_value = True
@@ -310,6 +313,7 @@ def test_get_treatments_with_config(self, mocker):
         assert mocker.call(
             [(Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY), {'some_attribute': 1})]
         ) in impmanager.process_impressions.mock_calls
+        assert _logger.call(["The SDK is not ready, results may be incorrect for feature flags %s. Make sure to wait for SDK readiness before using this method", 'some_feature'])
 
         # Test with exception:
         ready_property.return_value = True
@@ -400,6 +404,7 @@ def evaluate_features(feature_flag_names, matching_key, bucketing_key, attribute
         assert mocker.call(
             [(Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY), {'some_attribute': 1})]
         ) in impmanager.process_impressions.mock_calls
+        assert _logger.call(["The SDK is not ready, results may be incorrect for feature flags %s. Make sure to wait for SDK readiness before using this method", 'some_feature'])
 
         # Test with exception:
         ready_property.return_value = True
@@ -465,7 +470,6 @@ def evaluate_features(feature_flag_names, matching_key, bucketing_key, attribute
         client._evaluator.evaluate_features = evaluate_features
         _logger = mocker.Mock()
         client._send_impression_to_listener = mocker.Mock()
-#        pytest.set_trace()
         assert client.get_treatments_by_flag_sets('key', ['set1', 'set2']) == {'f1': 'on', 'f2': 'on'}
 
         impressions_called = impmanager.process_impressions.mock_calls[0][1][0]
@@ -488,6 +492,7 @@ def evaluate_features(feature_flag_names, matching_key, bucketing_key, attribute
         assert mocker.call(
             [(Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY), {'some_attribute': 1})]
         ) in impmanager.process_impressions.mock_calls
+        assert _logger.call(["The SDK is not ready, results may be incorrect for feature flags %s. Make sure to wait for SDK readiness before using this method", 'some_feature'])
 
         # Test with exception:
         ready_property.return_value = True
@@ -581,6 +586,7 @@ def evaluate_features(feature_flag_names, matching_key, bucketing_key, attribute
         assert mocker.call(
             [(Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY), {'some_attribute': 1})]
         ) in impmanager.process_impressions.mock_calls
+        assert _logger.call(["The SDK is not ready, results may be incorrect for feature flags %s. Make sure to wait for SDK readiness before using this method", 'some_feature'])
 
         # Test with exception:
         ready_property.return_value = True
@@ -677,6 +683,7 @@ def evaluate_features(feature_flag_names, matching_key, bucketing_key, attribute
         assert mocker.call(
             [(Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY), {'some_attribute': 1})]
         ) in impmanager.process_impressions.mock_calls
+        assert _logger.call(["The SDK is not ready, results may be incorrect for feature flags %s. Make sure to wait for SDK readiness before using this method", 'some_feature'])
 
         # Test with exception:
         ready_property.return_value = True
@@ -748,6 +755,7 @@ def test_track(self, mocker):
             telemetry_producer.get_telemetry_init_producer(),
             mocker.Mock()
         )
+        _logger = mocker.Mock()
 
         destroyed_mock = mocker.PropertyMock()
         destroyed_mock.return_value = False
@@ -762,6 +770,7 @@ def test_track(self, mocker):
                 size=1024
             )
         ]) in event_storage.put.mock_calls
+        assert _logger.call("track: the SDK is not ready, results may be incorrect. Make sure to wait for SDK readiness before using this method")
 
     def test_evaluations_before_running_post_fork(self, mocker):
         destroyed_property = mocker.PropertyMock()