devcycle-python-server-sdk 3.5.0__py3-none-any.whl → 3.6.0__py3-none-any.whl

devcycle_python_sdk/VERSION.txt

@@ -1 +1 @@
-3.5.0
+3.6.0

devcycle_python_sdk/api/config_client.py

@@ -2,7 +2,7 @@ import logging
 import time
 from http import HTTPStatus
 from typing import Optional, Tuple
-
+import email.utils
 import requests
 
 from devcycle_python_sdk.api.backoff import exponential_backoff
@@ -36,15 +36,15 @@ class ConfigAPIClient:
         )
 
     def get_config(
-        self, config_etag: Optional[str] = None
-    ) -> Tuple[Optional[dict], Optional[str]]:
+        self, config_etag: Optional[str] = None, last_modified: Optional[str] = None
+    ) -> Tuple[Optional[dict], Optional[str], Optional[str]]:
         """
         Get the config from the server. If the config_etag is provided, the server will only return the config if it
         has changed since the last request. If the config hasn't changed, the server will return a 304 Not Modified
         response.
 
         :param config_etag: The etag of the last config request
-
+        :param last_modified: Last modified RFC1123 Timestamp of the stored config
         :return: A tuple containing the config and the etag of the config. If the config hasn't changed since the last
         request, the config will be None and the etag will be the same as the last request.
         """
@@ -56,6 +56,8 @@ class ConfigAPIClient:
         headers = {}
         if config_etag:
             headers["If-None-Match"] = config_etag
+        if last_modified:
+            headers["If-Modified-Since"] = last_modified
 
         attempts = 1
         while retries_remaining > 0:
@@ -74,7 +76,7 @@ class ConfigAPIClient:
                 elif res.status_code == HTTPStatus.NOT_MODIFIED:
                     # the config hasn't changed since the last request
                     # don't return anything
-                    return None, config_etag
+                    return None, config_etag, last_modified
                 elif res.status_code == HTTPStatus.NOT_FOUND:
                     # Not a retryable error
                     raise NotFoundError(url)
@@ -113,6 +115,16 @@ class ConfigAPIClient:
             raise APIClientError(message="Retries exceeded", cause=request_error)
 
         new_etag = res.headers.get("ETag", None)
+        new_lastmodified = res.headers.get("Last-Modified", None)
+
+        if last_modified and new_lastmodified:
+            stored_lm = email.utils.parsedate_to_datetime(last_modified)
+            response_lm = email.utils.parsedate_to_datetime(new_lastmodified)
+            if stored_lm > response_lm:
+                logger.warning(
+                    "Request returned a last modified header older than the current stored timestamp. not saving config"
+                )
+                return None, None, None
 
         data: dict = res.json()
-        return data, new_etag
+        return data, new_etag, new_lastmodified

devcycle_python_sdk/managers/config_manager.py

@@ -30,6 +30,7 @@ class EnvironmentConfigManager(threading.Thread):
 
         self._config: Optional[dict] = None
         self._config_etag: Optional[str] = None
+        self._config_lastmodified: Optional[str] = None
 
         self._config_api_client = ConfigAPIClient(self._sdk_key, self._options)
 
@@ -42,10 +43,13 @@ class EnvironmentConfigManager(threading.Thread):
 
     def _get_config(self):
         try:
-            new_config, new_etag = self._config_api_client.get_config(
-                config_etag=self._config_etag
+            new_config, new_etag, new_lastmodified = self._config_api_client.get_config(
+                config_etag=self._config_etag, last_modified=self._config_lastmodified
             )
 
+            # Abort early if the last modified is before the sent one.
+            if new_config is None and new_etag is None and new_lastmodified is None:
+                return
             if new_config is None and new_etag == self._config_etag:
                 # api not returning data and the etag is the same
                 # no change to the config since last request
@@ -60,6 +64,7 @@ class EnvironmentConfigManager(threading.Thread):
 
             self._config = new_config
             self._config_etag = new_etag
+            self._config_lastmodified = new_lastmodified
 
             json_config = json.dumps(self._config)
             self._local_bucketing.store_config(json_config)

devcycle_python_sdk/models/bucketed_config.py

@@ -60,9 +60,9 @@ class ProjectSettings:
     @classmethod
     def from_json(cls, data: dict) -> "ProjectSettings":
         return cls(
-            edge_db=EdgeDBSettings.from_json(data["edgeDB"])
-            if "edgeDB" in data
-            else None,
+            edge_db=(
+                EdgeDBSettings.from_json(data["edgeDB"]) if "edgeDB" in data else None
+            ),
             opt_in=OptInSettings.from_json(data["optIn"]) if "optIn" in data else None,
             disable_passthrough_rollouts=data.get("disablePassthroughRollouts", False),
         )
@@ -81,9 +81,11 @@ class Project:
             id=data["_id"],
             key=data["key"],
             a0_organization=data["a0_organization"],
-            settings=ProjectSettings.from_json(data["settings"])
-            if "settings" in data
-            else None,
+            settings=(
+                ProjectSettings.from_json(data["settings"])
+                if "settings" in data
+                else None
+            ),
         )
 
 

devcycle_python_sdk/open_feature_provider/provider.py

@@ -58,9 +58,11 @@ class DevCycleProvider(AbstractProvider):
                 else:
                     return FlagResolutionDetails(
                         value=variable.value,
-                        reason=Reason.DEFAULT
-                        if variable.isDefaulted
-                        else Reason.TARGETING_MATCH,
+                        reason=(
+                            Reason.DEFAULT
+                            if variable.isDefaulted
+                            else Reason.TARGETING_MATCH
+                        ),
                     )
             except ValueError as e:
                 # occurs if the key or default value is None

{devcycle_python_server_sdk-3.5.0.dist-info → devcycle_python_server_sdk-3.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devcycle-python-server-sdk
-Version: 3.5.0
+Version: 3.6.0
 Summary: DevCycle Python SDK
 Home-page: https://github.com/devcycleHQ/python-server-sdk
 Author: UNKNOWN
@@ -10,7 +10,7 @@ Keywords: DevCycle
 Platform: UNKNOWN
 Requires-Dist: setuptools >=21.0.0
 Requires-Dist: urllib3 >=1.15.1
-Requires-Dist: requests ~=2.31.0
+Requires-Dist: requests ~=2.31
 Requires-Dist: wasmtime ==9.0.0
 Requires-Dist: protobuf >=4.23.3
 Requires-Dist: openfeature-sdk >=0.7.0

{devcycle_python_server_sdk-3.5.0.dist-info → devcycle_python_server_sdk-3.6.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-devcycle_python_sdk/VERSION.txt,sha256=dhIMHyxDEcIVTCKmtY4A5BHg6-dq-uDa9gjZGWxh8RQ,6
+devcycle_python_sdk/VERSION.txt,sha256=E4ID4_YEoI-tDE0KKX7-LEhiGYINzdBT5yt9hDUEx6E,6
 devcycle_python_sdk/__init__.py,sha256=30TcYb9PbvVi97gwk16omCGG1UoUI9lmmU7xpvxNMvc,336
 devcycle_python_sdk/bucketing-lib.release.wasm,sha256=yrNDrAxZS1h9VlTzsdOrNLP4ngnM04PmKxcWop1yrt4,202623
 devcycle_python_sdk/cloud_client.py,sha256=UMfXvXwO4v3pZW9ZA52ivxPH1Lp4Goy5gpV_s0qCpxQ,7352
@@ -10,14 +10,14 @@ devcycle_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 devcycle_python_sdk/api/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 devcycle_python_sdk/api/backoff.py,sha256=F6WYCloaZD9CjNu6mKBMq7K20S8-i2WVU6X05ZRoawE,303
 devcycle_python_sdk/api/bucketing_client.py,sha256=-S0y9uAffippCTfjYgxI5j4j7YNfMxQJYUba1219nps,5111
-devcycle_python_sdk/api/config_client.py,sha256=BbPAjvB8c4engCiVnrRDXAXabHJLKYc1uxCtoPpvffg,4293
+devcycle_python_sdk/api/config_client.py,sha256=NnqHmPcwK__LNqPzmKo5EBqULAQEteH1YmzRE_eIXJs,5077
 devcycle_python_sdk/api/event_client.py,sha256=WxkuV6geEC9MgG4FN36HeEQQa22ilq2mkOVMZkpiEk4,3356
 devcycle_python_sdk/api/local_bucketing.py,sha256=-TfG3Jb0syVF3sqzzlFyKxHqLQ6a37C4mW0oj53J-yQ,16332
 devcycle_python_sdk/managers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-devcycle_python_sdk/managers/config_manager.py,sha256=_-1kWwyyAcwVF_DibXjnehXi3Qj6HR8orYfgNfgWJOc,3248
+devcycle_python_sdk/managers/config_manager.py,sha256=YfgGKW4mtMhqdwWZiZ_Y67AYLC9VTpTjYhpDgfGFA4g,3599
 devcycle_python_sdk/managers/event_queue_manager.py,sha256=06TcdlRoB89C7vGH1UTnnoDFsSnT71tPwf0gn1NK-W0,8071
 devcycle_python_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-devcycle_python_sdk/models/bucketed_config.py,sha256=76bdF7pgUdIAn2y8YPs3AO7Qa2eyJQ_jf4QhG3IERaE,3951
+devcycle_python_sdk/models/bucketed_config.py,sha256=NsdT-6RbEuDy5QuK5qlr6UqNKQQnwjoXVYN-uQp0P-E,3999
 devcycle_python_sdk/models/error_response.py,sha256=r_dRUDAbral9UGaMYcnBsZOr9Hmkyi1SQbhGmZilgpA,442
 devcycle_python_sdk/models/event.py,sha256=-6bhKp72mAgaoSxvhS__G4vvfQ9Psj83fc0Igelzw3o,3713
 devcycle_python_sdk/models/feature.py,sha256=m3wxxIjC5jxhKpPLI4RcsBaNLuy-zsMqoAgc8ySPe0I,852
@@ -25,7 +25,7 @@ devcycle_python_sdk/models/platform_data.py,sha256=kIFevH5trsxI32qp7BW6glUCpipgp
 devcycle_python_sdk/models/user.py,sha256=57d_n8Yy8g-zsGzVF0hmSf4McPtFPJJ0LLY_ql75FWk,6266
 devcycle_python_sdk/models/variable.py,sha256=qp00SyCNyfYiMlTwnDSDJ4ZetRF35JHTbYZQOBxFIqY,1711
 devcycle_python_sdk/open_feature_provider/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-devcycle_python_sdk/open_feature_provider/provider.py,sha256=FjNxmyKrnUO4ma4c-Z39qWigLVC_P-L_Nly0mycA1Vc,4475
+devcycle_python_sdk/open_feature_provider/provider.py,sha256=VjUMhCYiMLixXUSSIjQ7kVCQrls1QD_Nltooe5EjGks,4539
 devcycle_python_sdk/protobuf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 devcycle_python_sdk/protobuf/utils.py,sha256=zi-kVx6yvgS2c04cUobLd2IDc_ZqKkWduay9YcpjoGc,4684
 devcycle_python_sdk/protobuf/variableForUserParams_pb2.py,sha256=Zf4-8n67UnulC0Sz90aqLYsXCFEgywOqfiSHuXZomLk,4244
@@ -41,13 +41,13 @@ test/test_cloud_client.py,sha256=zjk302m7qKMCQryolkc1WKLFmbGWUxA0VtHlZk0rY-0,114
 test/test_local_client.py,sha256=Ds6VIfLcaefboyvGrhQTGsdJj_DGB4IVnR2_16xDpSY,13022
 test/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 test/api/test_bucketing_client.py,sha256=M2mjACowLvbsIjXdP-w8-fwY02xqv1X1r_h9v-pXa7A,7739
-test/api/test_config_client.py,sha256=oZMBlXGw4UHb5-rSNF_ARTrAjvbvkbFgb8GAK4ExR14,4413
+test/api/test_config_client.py,sha256=jT48_llov5QQs0jNDbHANRqySVT1HamXm82uPZXKSrE,5129
 test/api/test_event_client.py,sha256=v4Xoum-PdywfczrfMV1llM5vrIJoqHybzxPLVokh09g,3310
 test/api/test_local_bucketing.py,sha256=lPL3ThZcGG-8-67jFxRvGrwL8NB6-sM5qGJb0p2O__Q,15254
 test/fixture/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 test/fixture/data.py,sha256=6ReLxWPMhCDbJ5Ex24_iR0PJNjKzPFV1I9j_v0FVbBU,1462
 test/managers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-test/managers/test_config_manager.py,sha256=_MtvyxK06xpBzzEsN1zsLdYrk3DsPsbCmSj7XorINmI,5366
+test/managers/test_config_manager.py,sha256=X0DxzWdjkvkUmarJSgzTDvO2Ma0TU6RNwL0WUwX2uA8,5963
 test/managers/test_event_queue_manager.py,sha256=KquHBuYiDdoVStm5Ga9mIB-wvmJnChiFRBNC8sMKaxQ,11053
 test/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 test/models/test_bucketed_config.py,sha256=8wCEyxaHxY21nl7ZbiFzp-IzZQBZIPIVPPzeREjumQk,858
@@ -59,8 +59,8 @@ test/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 test/util/test_strings.py,sha256=T5H5U0af7_ld1yJC8IdDmay_Mx-iJQ5Fi5fbvKcAc7A,862
 test/util/test_utils.py,sha256=tVBJm_qnqg-4PssLpXIxqlk0JehuiAIPs4zpi2oNVnY,6671
 test/util/test_version.py,sha256=3Xg0_84m0bdHXz6pxd2Z85Oz9DoUC1T0Ol_WqEH_jac,335
-devcycle_python_server_sdk-3.5.0.dist-info/LICENSE,sha256=tHQMqu-Jic2UpMGqb-vNFbGygysl8IG4l1clnnh0OFo,1071
-devcycle_python_server_sdk-3.5.0.dist-info/METADATA,sha256=IAUJWGuZDWtOoCfJ6Tj6aKURxJODAtUuutO1g94hLho,510
-devcycle_python_server_sdk-3.5.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-devcycle_python_server_sdk-3.5.0.dist-info/top_level.txt,sha256=34f8zDzihAHoH7siAFlmscyO_QLNWWq9HApFlwtYL4k,33
-devcycle_python_server_sdk-3.5.0.dist-info/RECORD,,
+devcycle_python_server_sdk-3.6.0.dist-info/LICENSE,sha256=tHQMqu-Jic2UpMGqb-vNFbGygysl8IG4l1clnnh0OFo,1071
+devcycle_python_server_sdk-3.6.0.dist-info/METADATA,sha256=mEHWiA0xrfnZ4-GLr2uyc0_HOPyEc2ENqvD6CLe8SKo,508
+devcycle_python_server_sdk-3.6.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+devcycle_python_server_sdk-3.6.0.dist-info/top_level.txt,sha256=34f8zDzihAHoH7siAFlmscyO_QLNWWq9HApFlwtYL4k,33
+devcycle_python_server_sdk-3.6.0.dist-info/RECORD,,

test/api/test_config_client.py

@@ -2,6 +2,9 @@ import logging
 import unittest
 import uuid
 from http import HTTPStatus
+from datetime import datetime
+from email.utils import formatdate
+from time import mktime
 
 import requests
 import responses
@@ -36,6 +39,9 @@ class ConfigAPIClientTest(unittest.TestCase):
 
         options = DevCycleLocalOptions(config_retry_delay_ms=0)
         self.test_client = ConfigAPIClient(self.sdk_key, options)
+        now = datetime.now()
+        stamp = mktime(now.timetuple())
+        self.test_lastmodified = formatdate(timeval=stamp, localtime=False, usegmt=True)
         self.test_etag = str(uuid.uuid4())
         self.test_config_json: dict = small_config_json()
 
@@ -45,14 +51,20 @@ class ConfigAPIClientTest(unittest.TestCase):
     @responses.activate
     def test_get_config(self):
         new_etag = str(uuid.uuid4())
+        now = datetime.now()
+        stamp = mktime(now.timetuple())
+        new_lastmodified = formatdate(timeval=stamp, localtime=False, usegmt=True)
         responses.add(
             responses.GET,
             self.config_url,
-            headers={"ETag": new_etag},
+            headers={"ETag": new_etag, "Last-Modified": new_lastmodified},
             json=self.test_config_json,
         )
-        result, etag = self.test_client.get_config(config_etag=self.test_etag)
+        result, etag, lastmodified = self.test_client.get_config(
+            config_etag=self.test_etag, last_modified=self.test_lastmodified
+        )
         self.assertDictEqual(result, self.test_config_json)
+        self.assertEqual(lastmodified, new_lastmodified)
         self.assertEqual(etag, new_etag)
 
     @responses.activate(registry=OrderedRegistry)
@@ -68,7 +80,9 @@ class ConfigAPIClientTest(unittest.TestCase):
             headers={"ETag": self.test_etag},
             json=self.test_config_json,
         )
-        result, etag = self.test_client.get_config(config_etag=self.test_etag)
+        result, etag, lastmodified = self.test_client.get_config(
+            config_etag=self.test_etag
+        )
 
         self.assertDictEqual(result, self.test_config_json)
         self.assertEqual(etag, self.test_etag)
@@ -83,10 +97,12 @@ class ConfigAPIClientTest(unittest.TestCase):
         responses.add(
             responses.GET,
             self.config_url,
-            headers={"ETag": self.test_etag},
+            headers={"ETag": self.test_etag, "Last-Modified": self.test_lastmodified},
             json=self.test_config_json,
         )
-        result, etag = self.test_client.get_config(config_etag=self.test_etag)
+        result, etag, last_modified = self.test_client.get_config(
+            config_etag=self.test_etag
+        )
         self.assertDictEqual(result, self.test_config_json)
         self.assertEqual(etag, self.test_etag)
 
@@ -131,6 +147,8 @@ class ConfigAPIClientTest(unittest.TestCase):
             status=HTTPStatus.NOT_MODIFIED,
         )
 
-        new_config, new_etag = self.test_client.get_config(config_etag=self.test_etag)
+        new_config, new_etag, last_modified = self.test_client.get_config(
+            config_etag=self.test_etag
+        )
         self.assertIsNone(new_config)
         self.assertEqual(new_etag, self.test_etag)

test/managers/test_config_manager.py

@@ -1,8 +1,11 @@
-import logging
 import json
+import logging
 import time
-import uuid
 import unittest
+import uuid
+from datetime import datetime
+from email.utils import formatdate
+from time import mktime
 from unittest.mock import patch, MagicMock
 
 from devcycle_python_sdk import DevCycleLocalOptions
@@ -18,20 +21,27 @@ class EnvironmentConfigManagerTest(unittest.TestCase):
         self.test_local_bucketing = MagicMock()
         self.test_options = DevCycleLocalOptions(config_polling_interval_ms=500)
 
+        now = datetime.now()
+        stamp = mktime(now.timetuple())
+        self.test_lastmodified = formatdate(timeval=stamp, localtime=False, usegmt=True)
         self.test_etag = str(uuid.uuid4())
         self.test_config_json = small_config_json()
         self.test_config_string = json.dumps(self.test_config_json)
 
     @patch("devcycle_python_sdk.api.config_client.ConfigAPIClient.get_config")
     def test_init(self, mock_get_config):
-        mock_get_config.return_value = (self.test_config_json, self.test_etag)
+        mock_get_config.return_value = (
+            self.test_config_json,
+            self.test_etag,
+            self.test_lastmodified,
+        )
         config_manager = EnvironmentConfigManager(
             self.sdk_key, self.test_options, self.test_local_bucketing
         )
 
         # sleep to allow polling thread to load the config
         time.sleep(0.1)
-        mock_get_config.assert_called_once_with(config_etag=None)
+        mock_get_config.assert_called_once_with(config_etag=None, last_modified=None)
 
         self.assertTrue(config_manager._polling_enabled)
         self.assertTrue(config_manager.is_alive())
@@ -45,7 +55,11 @@ class EnvironmentConfigManagerTest(unittest.TestCase):
 
     @patch("devcycle_python_sdk.api.config_client.ConfigAPIClient.get_config")
     def test_init_with_client_callback(self, mock_get_config):
-        mock_get_config.return_value = (self.test_config_json, self.test_etag)
+        mock_get_config.return_value = (
+            self.test_config_json,
+            self.test_etag,
+            self.test_lastmodified,
+        )
 
         mock_callback = MagicMock()
 
@@ -55,7 +69,7 @@ class EnvironmentConfigManagerTest(unittest.TestCase):
             self.sdk_key, self.test_options, self.test_local_bucketing
         )
         time.sleep(0.1)
-        mock_get_config.assert_called_once_with(config_etag=None)
+        mock_get_config.assert_called_once_with(config_etag=None, last_modified=None)
         self.assertEqual(config_manager._config_etag, self.test_etag)
         self.assertDictEqual(config_manager._config, self.test_config_json)
         self.test_local_bucketing.store_config.assert_called_once_with(
@@ -66,7 +80,11 @@ class EnvironmentConfigManagerTest(unittest.TestCase):
 
     @patch("devcycle_python_sdk.api.config_client.ConfigAPIClient.get_config")
     def test_init_with_client_callback_with_error(self, mock_get_config):
-        mock_get_config.return_value = (self.test_config_json, self.test_etag)
+        mock_get_config.return_value = (
+            self.test_config_json,
+            self.test_etag,
+            self.test_lastmodified,
+        )
         mock_callback = MagicMock()
         mock_callback.side_effect = Exception(
             "Badly written callback generates an exception"
@@ -79,7 +97,7 @@ class EnvironmentConfigManagerTest(unittest.TestCase):
         )
         # the callback error should not negatively impact initialization of the config manager
         time.sleep(0.1)
-        mock_get_config.assert_called_once_with(config_etag=None)
+        mock_get_config.assert_called_once_with(config_etag=None, last_modified=None)
         self.assertEqual(config_manager._config_etag, self.test_etag)
         self.assertDictEqual(config_manager._config, self.test_config_json)
         self.test_local_bucketing.store_config.assert_called_once_with(
@@ -105,7 +123,11 @@ class EnvironmentConfigManagerTest(unittest.TestCase):
 
     @patch("devcycle_python_sdk.api.config_client.ConfigAPIClient.get_config")
     def test_get_config_unchanged(self, mock_get_config):
-        mock_get_config.return_value = (self.test_config_json, self.test_etag)
+        mock_get_config.return_value = (
+            self.test_config_json,
+            self.test_etag,
+            self.test_lastmodified,
+        )
 
         self.test_options.config_polling_interval_ms = 200
         config_manager = EnvironmentConfigManager(
@@ -117,7 +139,7 @@ class EnvironmentConfigManagerTest(unittest.TestCase):
         config_manager.close()
 
         self.test_local_bucketing.store_config.reset_mock()
-        mock_get_config.return_value = (None, config_manager._config_etag)
+        mock_get_config.return_value = (None, config_manager._config_etag, None)
 
         # trigger refresh of the config directly
         config_manager._get_config()