fix: add timezone for BackgroundScheduler, rename eval function to value (#4)

* fix: add timezone for BackgroundScheduler, rename eval function to value

* chore: add license header(s)

* style: format python code (pep8)

* fix tz

* style: format python code (pep8)

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Author: hezean

.github/workflows/test.yml

@@ -37,4 +37,5 @@ jobs:
         run: pytest --cov featureprobe
 
       - name: Upload coverage to Codecov
+        if: ${{ matrix.python }} == '3.8'
         uses: codecov/codecov-action@v3

README.md

@@ -49,6 +49,8 @@ First, install the FeatureProbe SDK as a dependency in your application.
 pip3 install featureprobe-server
 ```
 
+> You may get the latest version of this repo (not released) via [TestPyPI](https://test.pypi.org/project/featureprobe-server/)
+
 <!-- WIP
 #### conda
 
@@ -87,11 +89,11 @@ if __name__ == '__main__':
         'userId': '9876',
         'tel': '12345678998',
     })
-    bool_eval = bool(client.evaluate('bool_toggle_key', user, default=False))
+    bool_eval = bool(client.value('bool_toggle_key', user, default=False))
     if bool_eval:
-        # application code to show the feature
+        ...  # application code to show the feature
     else:
-        # the code to run if the feature is off
+        ...  # the code to run if the feature is off
 ```
 
 

demo.py

@@ -5,32 +5,28 @@
 logging.basicConfig(level=logging.WARNING)
 
 if __name__ == '__main__':
-    config = fp.Config(remote_uri='http://127.0.0.1:4007',  # FeatureProbe server URL
+    # FEATURE_PROBE_SERVER_URL = 'http://localhost:4007'  # for local docker
+    FEATURE_PROBE_SERVER_URL = 'https://featureprobe.io/server'  # for featureprobe.io
+
+    config = fp.Config(remote_uri=FEATURE_PROBE_SERVER_URL,  # FeatureProbe server URL
                        sync_mode='pooling',
                        refresh_interval=3)
 
-    client = fp.Client('server-8ed48815ef044428826787e9a238b9c6a479f98c',
+    client = fp.Client('server-b8b7c58417680d9e76b1b8454326f357296b5003',
                        # Server Side SDK Key for your project and environment
                        config)
 
-    # create one user, with id='user_unique_id' and one attribute
-    user = fp.User('user_unique_id', {'city': 'New York'})
-    discount = float(client.evaluate('promotion_activity',  # Toggle you want to use
-                                     user, default=0))
-    print('user in New York has a discount of : %d' % discount)
-
-    detail = client.evaluate_detail('promotion_activity', user, default=0)
-    print('detail: %s' % detail.reason)
-    # rule_index = None on default rule is hit
-    print('rule index: ' + str(detail.rule_index))
+    # create one user
+    # key is for percentage rollout, normally use userId as key
+    user = fp.User('00001', {'userId': '00001'})
 
-    user2 = fp.User('user_id2')
-    # create another user, here's the alternative way to set user attributes
-    user2['city'] = 'Paris'
+    # Toggle you want to use
+    TOGGLE_KEY = 'feature_toggle02'
 
-    discount = float(client.evaluate('promotion_activity', user2, default=0))
-    print('user in Paris has a discount of : %d' % discount)
+    # get toggle result for this user
+    is_open = client.value(TOGGLE_KEY, user, default=False)
+    print('feature for this user is: ' + str(is_open))
 
-    detail2 = client.evaluate_detail('promotion_activity', user2, default=0)
-    print('detail2: %s' % detail2.reason)
-    print('rule index: %d' % detail2.rule_index)
+    is_open_detail = client.value_detail(TOGGLE_KEY, user, default=False)
+    print('detail: ' + str(is_open_detail.reason))
+    print('rule index: ' + str(is_open_detail.rule_index))

featureprobe/client.py

@@ -35,7 +35,7 @@ def __init__(self, sdk_key: str, config: Config = Config()):
     def flush(self):
         self._event_processor.flush()
 
-    def evaluate(self, toggle_key: str, user: User, default) -> Any:
+    def value(self, toggle_key: str, user: User, default) -> Any:
         toggle = self._data_repo.get_toggle(toggle_key)
         segments = self._data_repo.get_all_segment()
         if not toggle:
@@ -51,7 +51,7 @@ def evaluate(self, toggle_key: str, user: User, default) -> Any:
         self._event_processor.push(access_event)
         return eval_result.value
 
-    def evaluate_detail(self, toggle_key: str, user: User, default) -> Detail:
+    def value_detail(self, toggle_key: str, user: User, default) -> Detail:
         if not self._data_repo.initialized:
             return Detail(
                 value=default,

featureprobe/default_event_processor.py

@@ -13,7 +13,6 @@
 # limitations under the License.
 
 import contextlib
-import json
 import logging
 import queue
 import threading
@@ -23,6 +22,7 @@
 from queue import Queue
 from typing import List, Optional
 
+import tzlocal
 from apscheduler.schedulers.background import BackgroundScheduler
 from requests import Session, HTTPError
 
@@ -109,7 +109,7 @@ def __init__(self, context: Context):
         handler_thread.start()
 
         self._executor = ThreadPoolExecutor(max_workers=5)
-        self._scheduler = BackgroundScheduler()
+        self._scheduler = BackgroundScheduler(timezone=tzlocal.get_localzone())
         self._scheduler.start()
         self._scheduler.add_job(self.flush,
                                 trigger='interval',

featureprobe/pooling_synchronizer.py

@@ -17,6 +17,7 @@
 from datetime import datetime
 from typing import TYPE_CHECKING
 
+import tzlocal
 from apscheduler.schedulers.background import BackgroundScheduler
 from requests import Session
 
@@ -63,7 +64,8 @@ def sync(self):
             % self._refresh_interval.total_seconds() * 1000)
         self._poll()
         with self._lock:
-            self._scheduler = BackgroundScheduler()
+            self._scheduler = BackgroundScheduler(
+                timezone=tzlocal.get_localzone())
             self._scheduler.start()
             self._scheduler.add_job(
                 self._poll,

requirements.txt

@@ -1,2 +1,3 @@
 APScheduler~=3.0
-requests>=2.12.0
+requests>=2.12.0
+tzlocal~=2.0.0

tests/featureprobe_test.py

@@ -14,6 +14,7 @@
 
 import json
 import logging
+import re
 
 import pytest
 
@@ -79,14 +80,16 @@ def test_case():
             expect_value = expect_result['value']
 
             if func_name.endswith('value'):
-                assert server.evaluate(
+                assert server.value(
                     toggle_key, user, default_value) == expect_value
             elif func_name.endswith('detail'):
-                detail = server.evaluate_detail(
+                detail = server.value_detail(
                     toggle_key, user, default_value)
                 assert detail.value == expect_value
-                # assert detail.reason == expect_result['reason']
-                # assert detail.version == expect_result['version']
-                # assert (detail.rule_index is None) == expect_result['no_rule_index']
+                if expect_result.get('reason') is not None:
+                    assert re.search(
+                        expect_result.get('reason'),
+                        detail.reason,
+                        re.IGNORECASE)
             else:
                 pytest.fail('should have no other cases yet')