prepare 8.0.0 release (#190)

* make verify_ssl=False turn off certificate verification too (#129) * add more TLS config options and collect HTTP/HTTPS config options in a class (#130) * make stream retry/backoff/jitter behavior consistent with other SDKs + improve testing (#131) * streams shouldn't use the same read timeout as the rest of the SDK (#132) * implement our own retry logic & logging for event posts, don't use urllib3.Retry (#133) * remove support for indirect/patch and indirect/put * remove unused logic for individual flag/segment poll for indirect/patch * Ehaisley/84082/remove python2 (#136) * remove all references to six and remove queue fallback imports * remove NullHandler logger backwards compat * update circleci config to remove python 2.7 tests * remove ordereddict backwards compat * update setup.py to no longer list python 2.7 as compatible * no longer inherit from object for python 2 backwards compat * update readme and manifest to reflect python 2.7 removal * remove unicode type compatibility * remove 2.7 support from circleci * Allow authenticating with proxy This commit allows for authenticating with a proxy configured with the `http_proxy` environment variable. Authentication requires passing a header, and is not parsed by urllib3 from the proxy_url. * reimplement proxy tests for DRY and add test of proxy auth params * doc comment on auth params in proxy URL * add type hints to some of the public facing api. update some docs * Revert "add type hints to some of the public facing api." This reverts commit c35fa61. * Ehaisley/ch86857/type hints (#138) * add typehints to the public API * validate typehints in the public api and tests with mypy * remove all current deprecations (#139) * remove all currently deprecated classes, methods, arguments, and tests * also update semver usage to remove calls to deprecated functions and classes * remove global set_sdk_key, make SDK key required in Config (#140) * Removed the guides link * Pinning mypy and running it against different python versions (#141) * fix time zone mishandling that could make event debugging not work (#142) * fix 6.x build (#143) * fix time zone mishandling that could make event debugging not work (6.x) (#144) * prepare 6.13.3 release (#154) * Releasing version 6.13.3 * [ch99756] Add alias events (#145) * add support for experiment rollouts * fix unit test * address PR comments * use Releaser v2 config * Use newer docker images (#147) * Updates docs URLs * Add support for 3.10 (#150) * started work on FlagBuilder in as part of test data source implementation * finished FlagBuilder implementation and added FlagRuleBuilder implementation * added initial TestData interface and updated tests to not rely on test data internals * started data source implementation * changed FlagBuilder to public class; changed FlagBuilder attributes to be initialized in __init__ and eliminated use of try ... except: pass for handling empty attributes * (big segments 1) add public config/interface types * added implementation of test data source * docstring * formatting * ensure property doesn't return None * (big segments 2) implement evaluation, refactor eval logic & modules * linting * (big segments 3) implement big segment status tracking, wire up components * typing fixes * typing fixes * implement SSE contract tests * fix CI * fix CI again * fix CI * disable SSE tests in Python 3.5 * make test service port configurable * better SSE implementation that fixes linefeed and multi-byte char issues * fix constructor parameters in test service * comment * test improvements * rm obsolete default config logic * (big segments 4) implement big segment stores in Redis+DynamoDB, refactor db tests (#158) * converted ldclient.integrations module from file to directory; started moving public classes out of ldclient.impl.integrations.test_data* and instead into ldclient.integrations.test_data*; started adding TestData documentation * removed setup/teardown functions leftover from test scaffold * added TestData, FlagBuilder, and FlagRuleBuilder documentation; minor adjustments to implementation details * removed warning supression from TestData tests * fix big segments user hash algorithm to use SHA256 * update mypy version * updates to tests and related bug fixes * always cache Big Segment query result even if it's None * fix test assertion * lint * fix big segment ref format * fix big segments cache TTL being set to wrong value * fixed structure of fallthrough variation in result of FlagBuilder.build() * moved __test__ attribute into TestData class definition to prevent mypy from complaining about a missing class attribute * minor doc comment fix * Apply suggestions related to Sphinx docstring formatting from code review Co-authored-by: Eli Bishop <[email protected]> * fixed errors in the implementation of FlagBuilder's fallthrough_variation and off_variation when passing boolean variation values; updated tests to assert the expected behavior * added missing value_for_all_users() method to FlagBuilder class * Fix operator parsing errors (#169) * identify should not emit event if user key is empty (#164) * secondary should be treated as built-in attribute (#168) * URIs should have trailing slashes trimmed (#165) * all_flags_state should always include flag version (#166) * output event should not include a null prereqOf key (#167) * Account for traffic allocation on all flags (#171) * Add SDK contract tests (#170) * misc fixes to test data docs + add type hints * more type hints * remove some methods from the public test_data API * can't use "x|y" shortcut in typehints in older Pythons; use Union * fix misc type mistakes because I forgot to run the linter * update CONTRIBUTING.md and provide make targets * fixed a bug with flag rule clause builder internals; added unit test to verify rule evaluation * added ready argument to _TestDataSource class and indicated ready upon start to avoid delays in TestData initialization * Update contract tests to latest flask version (#176) Our contract tests depend on flask v1, which in turn depends on Jinja 2. Both of these are terribly dated and no longer supported. Jinja depends on markupsafe. markupsafe recently updated its code to no longer provide soft_unicode which in turn broke Jinja. Updating to the latest flask keeps all transitive dependencies better aligned and addresses this mismatch. * Adds link to Relay Proxy docs * Handle explicit None values in test payload (#179) The test harness may send explicit None values which should be treated the same as if the value was omitted entirely. * Fix "unhandled response" error in test harness (#180) When we return a `('', 204)` response from the flask handler, [Werkzeug intentionally removes the 'Content-Type' header][1], which causes the response to be created as a chunked response. The test harness is likely seeing a 204 response and isn't trying to read anything more from the stream. But since we are re-using connections, the next time it reads from the stream, it sees the `0\r\n\r\n` chunk and outputs an error: > 2022/04/20 14:23:39 Unsolicited response received on idle HTTP channel starting with "0\r\n\r\n"; err=<nil> Changing this response to 202 causes Werkzeug to return an empty response and silences the error. [1]: https://github.com/pallets/werkzeug/blob/560dd5f320bff318175f209595d42f5a80045417/src/werkzeug/wrappers/response.py#L540 * Exclude booleans when getting bucketable value (#181) When calculating a bucket, we get the bucketable value from the specified bucket by attribute. If this value is a string or an int, we can use it. Otherwise, we return None. Python considers a bool an instance of an int, which isn't what we want. So we need to add an explicit exclusion for this. * master -> main (#182) * Loosen restriction on expiringdict (#183) Originally this was pinned to a max version to deal with the incompatibility of Python 3.3 and the `typing` package. See [this PR][1]. Now that we now only support >=3.5, we can safely relax this restriction again. [1]: launchdarkly/python-server-sdk-private#120 * Fix mypy type checking (#184) A [customer requested][original-pr] that we start including a py.typed file in our repository. This would enable mypy to take advantage of our typehints. Unfortunately, this didn't completely solve the customers issue. A [second pr][second-pr] was opened to address the missing step of including the py.typed file in the `Manifest.in` file. However, this change alone is not sufficient. According to the [documentation][include_package_data], you must also include the `include_package_data=True` directive so that files specified in the `Manifest.in` file are included in distribution. [original-pr]: #166 [second-pr]: #172 [include_package_data]: https://setuptools.pypa.io/en/latest/userguide/datafiles.html#include-package-data * Add support for extra Redis connection parameters (#185) * Include wheel artifact when publishing package (#186) * remove warn-level logging done for every Big Segments query * skip tests that use a self-signed TLS cert in Python 3.7 * (U2C 1) drop EOL Python versions (#189) * drop EOL Python versions * misc cleanup, show Python version in CI * add Python 3.11 CI job * add Python 3.11 to package metadata * (U2C 2) remove alias event functionality (#187) * (U2C 3) remove inline users in events (#188) * (U2C 4) remove deprecated things (#192) * remove warn-level logging done for every Big Segments query (#190) * remove warn-level logging done for every Big Segments query * skip tests that use a self-signed TLS cert in Python 3.7 * implement context model * fix exports * specify exports * add copy constructor * minimal changes for SDK methods & evaluator to accept Context * update tests, add subscript method * lint * in type hints, must use Dict[A, B] rather than dict[A, B] for Python <3.9 * support context kind in clauses + enable v2 contract tests * misc fixes * misc fixes * support contextTargets * support contextKind in rollouts/experiments * support includedContexts/excludedContexts in segment * comment copyedit Co-authored-by: Matthew M. Keeler <[email protected]> * comment fixes * rm unused Co-authored-by: Matthew M. Keeler <[email protected]> * fix create_multi to support flattening * lint * use custom classes for flag/segment data model * use store adapter for safety * misc cleanup * misc fixes for persistent stores * more database store fixes * support attribute reference lookups in evaluations * pass logger from client * context kind logic for big segments + enable big segment contract tests * formatting fixes + test cleanup * prerequisite cycle detection * segment recursion * define custom classes for event data * add module init file * linting * fix prereq stack logic * (U2C 17) U2C changes for events, not including private attributes (#205) * private attribute redaction * move a lot of code out of top-level modules * TestData changes for contexts * general doc comment fixes for 8.0 * U2C configuration updates * update release metadata * store flag/segment target lists as sets * fix type hint * preprocess clause values for time/regex/semver operators * fix type checking for matches operator Co-authored-by: Eli Bishop <[email protected]> Co-authored-by: LaunchDarklyCI <[email protected]> Co-authored-by: Elliot <[email protected]> Co-authored-by: Gabor Angeli <[email protected]> Co-authored-by: Elliot <[email protected]> Co-authored-by: Ben Woskow <[email protected]> Co-authored-by: LaunchDarklyCI <[email protected]> Co-authored-by: hroederld <[email protected]> Co-authored-by: Robert J. Neal <[email protected]> Co-authored-by: Robert J. Neal <[email protected]> Co-authored-by: Ember Stevens <[email protected]> Co-authored-by: ember-stevens <[email protected]> Co-authored-by: Matthew M. Keeler <[email protected]> Co-authored-by: charukiewicz <[email protected]> Co-authored-by: LaunchDarklyReleaseBot <[email protected]> Co-authored-by: Christian Charukiewicz <[email protected]> Co-authored-by: Matthew M. Keeler <[email protected]>
launchdarkly · Dec 30, 2022 · 1d9769b · 1d9769b
1 parent 92f86e9
commit 1d9769b
Show file tree

Hide file tree

Showing 100 changed files with 6,083 additions and 3,629 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -6,14 +6,6 @@ orbs:
 workflows:
   test:
     jobs:
-      - test-linux:
-          name: Python 3.5
-          docker-image: cimg/python:3.5
-          skip-sse-contract-tests: true  # the test service app has dependencies that aren't available in 3.5, which is EOL anyway
-          skip-contract-tests: true  # the test service app has dependencies that aren't available in 3.5, which is EOL anyway
-      - test-linux:
-          name: Python 3.6
-          docker-image: cimg/python:3.6
       - test-linux:
           name: Python 3.7
           docker-image: cimg/python:3.7
@@ -26,6 +18,9 @@ workflows:
       - test-linux:
           name: Python 3.10
           docker-image: cimg/python:3.10
+      - test-linux:
+          name: Python 3.11
+          docker-image: cimg/python:3.11
       - test-windows:
           name: Windows Python 3
           py3: true
@@ -57,6 +52,7 @@ jobs:
       - image: consul
     steps:
       - checkout
+      - run: python --version
       - run:
           name: install requirements
           command: |
@@ -142,6 +138,7 @@ jobs:
       - run:
           name: install Python 3
           command: choco install python --no-progress
+      - run: python --version
       - run:
           name: set up DynamoDB
           command: |

diff --git a/.ldrelease/config.yml b/.ldrelease/config.yml
@@ -12,7 +12,8 @@ publications:
 
 branches:
   - name: main
-    description: 7.x
+    description: 8.x
+  - name: 7.x
   - name: 6.x
 
 jobs:

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,7 +1,7 @@
 version: 2
 
 python:
-  version: 3.5
+  version: 3.7
   install:
     - requirements: docs/requirements.txt
     - requirements: requirements.txt

diff --git a/Makefile b/Makefile
@@ -18,6 +18,10 @@ docs:
 
 TEMP_TEST_OUTPUT=/tmp/contract-test-service.log
 
+# TEST_HARNESS_PARAMS can be set to add -skip parameters for any contract tests that cannot yet pass
+# TEST_HARNESS_PARAMS := $(TEST_HARNESS_PARAMS) \
+
+
 # port 8000 and 9000 is already used in the CI environment because we're
 # running a DynamoDB container and an SSE contract test
 PORT=10000
@@ -33,8 +37,8 @@ start-contract-test-service-bg:
 	@make start-contract-test-service >$(TEMP_TEST_OUTPUT) 2>&1 &
 
 run-contract-tests:
-	@curl -s https://raw.githubusercontent.com/launchdarkly/sdk-test-harness/v1.0.0/downloader/run.sh \
-      | VERSION=v1 PARAMS="-url http://localhost:$(PORT) -debug -stop-service-at-end $(TEST_HARNESS_PARAMS)" sh
+	curl -s https://raw.githubusercontent.com/launchdarkly/sdk-test-harness/v2/downloader/run.sh \
+      | VERSION=v2 PARAMS="-url http://localhost:$(PORT) -debug -stop-service-at-end $(TEST_HARNESS_PARAMS)" sh
 
 contract-tests: build-contract-tests start-contract-test-service-bg run-contract-tests
 

diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 
 ## Supported Python versions
 
-This version of the LaunchDarkly SDK is compatible with Python 3.5 through 3.10. It is tested with the most recent patch releases of those versions. Python versions 2.7 to 3.4 are no longer supported.
+This version of the LaunchDarkly SDK is compatible with Python 3.7 through 3.11. It is tested with the most recent patch releases of those versions. Python versions 2.7 to 3.6 are no longer supported.
 
 ## Getting started
 

diff --git a/contract-tests/big_segment_store_fixture.py b/contract-tests/big_segment_store_fixture.py
@@ -0,0 +1,37 @@
+import json
+import os
+import sys
+from typing import Optional
+import urllib3
+
+# Import ldclient from parent directory
+sys.path.insert(1, os.path.join(sys.path[0], '..'))
+from ldclient.interfaces import BigSegmentStore, BigSegmentStoreMetadata
+
+
+http = urllib3.PoolManager()
+
+
+class BigSegmentStoreFixture(BigSegmentStore):
+    def __init__(self, callback_uri: str):
+        self._callback_uri = callback_uri
+
+    def get_metadata(self) -> BigSegmentStoreMetadata:
+        resp_data = self._post_callback('/getMetadata', None)
+        return BigSegmentStoreMetadata(resp_data.get("lastUpToDate"))
+
+    def get_membership(self, context_hash: str) -> Optional[dict]:
+        resp_data = self._post_callback('/getMembership', {'contextHash': context_hash})
+        return resp_data.get("values")
+
+    def _post_callback(self, path: str, params: Optional[dict]) -> dict:
+        url = self._callback_uri + path
+        resp = http.request('POST', url,
+            body=None if params is None else json.dumps(params),
+            headers=None if params is None else {'Content-Type': 'application/json'})
+        if resp.status != 200:
+            raise Exception("HTTP error %d from callback to %s" % (resp.status, url))
+        return json.loads(resp.data.decode('utf-8'))
+
+    def stop(self):
+        pass
diff --git a/contract-tests/client_entity.py b/contract-tests/client_entity.py
@@ -1,6 +1,12 @@
+import json
 import logging
 import os
 import sys
+from typing import Optional
+
+from big_segment_store_fixture import BigSegmentStoreFixture
+
+from ldclient.config import BigSegmentsConfig
 
 # Import ldclient from parent directory
 sys.path.insert(1, os.path.join(sys.path[0], '..'))
@@ -16,8 +22,7 @@ def __init__(self, tag, config):
             streaming = config["streaming"]
             if streaming.get("baseUri") is not None:
                 opts["stream_uri"] = streaming["baseUri"]
-            if streaming.get("initialRetryDelayMs") is not None:
-                opts["initial_reconnect_delay"] = streaming["initialRetryDelayMs"] / 1000.0
+            _set_optional_time_prop(streaming, "initialRetryDelayMs", opts, "initial_reconnect_delay")
 
         if config.get("events") is not None:
             events = config["events"]
@@ -28,13 +33,22 @@ def __init__(self, tag, config):
             opts["diagnostic_opt_out"] = not events.get("enableDiagnostics", False)
             opts["all_attributes_private"] = events.get("allAttributesPrivate", False)
             opts["private_attribute_names"] = events.get("globalPrivateAttributes", {})
-            if events.get("flushIntervalMs") is not None:
-                 opts["flush_interval"] = events["flushIntervalMs"] / 1000.0
-            if events.get("inlineUsers") is not None:
-                opts["inline_users_in_events"] = events["inlineUsers"]
+            _set_optional_time_prop(events, "flushIntervalMs", opts, "flush_interval")
         else:
             opts["send_events"] = False
 
+        if config.get("bigSegments") is not None:
+            big_params = config["bigSegments"]
+            big_config = {
+                "store": BigSegmentStoreFixture(big_params["callbackUri"])
+            }
+            if big_params.get("userCacheSize") is not None:
+                big_config["context_cache_size"] = big_params["userCacheSize"]
+            _set_optional_time_prop(big_params, "userCacheTimeMs", big_config, "context_cache_time")
+            _set_optional_time_prop(big_params, "statusPollIntervalMs", big_config, "status_poll_interval")
+            _set_optional_time_prop(big_params, "staleAfterMs", big_config, "stale_after")
+            opts["big_segments"] = BigSegmentsConfig(**big_config)
+
         start_wait = config.get("startWaitTimeMs") or 5000
         config = Config(**opts)
 
@@ -43,41 +57,90 @@ def __init__(self, tag, config):
     def is_initializing(self) -> bool:
         return self.client.is_initialized()
 
-    def evaluate(self, params) -> dict:
+    def evaluate(self, params: dict) -> dict:
         response = {}
 
         if params.get("detail", False):
-            detail = self.client.variation_detail(params["flagKey"], params["user"], params["defaultValue"])
+            detail = self.client.variation_detail(params["flagKey"], params["context"], params["defaultValue"])
             response["value"] = detail.value
             response["variationIndex"] = detail.variation_index
             response["reason"] = detail.reason
         else:
-            response["value"] = self.client.variation(params["flagKey"], params["user"], params["defaultValue"])
+            response["value"] = self.client.variation(params["flagKey"], params["context"], params["defaultValue"])
 
         return response
 
-    def evaluate_all(self, params):
+    def evaluate_all(self, params: dict):
         opts = {}
         opts["client_side_only"] = params.get("clientSideOnly", False)
         opts["with_reasons"] = params.get("withReasons", False)
         opts["details_only_for_tracked_flags"] = params.get("detailsOnlyForTrackedFlags", False)
 
-        state = self.client.all_flags_state(params["user"], **opts)
+        state = self.client.all_flags_state(params["context"], **opts)
 
         return {"state": state.to_json_dict()}
 
-    def track(self, params):
-        self.client.track(params["eventKey"], params["user"], params["data"], params.get("metricValue", None))
-
-    def identify(self, params):
-        self.client.identify(params["user"])
+    def track(self, params: dict):
+        self.client.track(params["eventKey"], params["context"], params["data"], params.get("metricValue", None))
 
-    def alias(self, params):
-        self.client.alias(params["user"], params["previousUser"])
+    def identify(self, params: dict):
+        self.client.identify(params["context"])
 
     def flush(self):
         self.client.flush()
 
+    def secure_mode_hash(self, params: dict) -> dict:
+        return {"result": self.client.secure_mode_hash(params["context"])}
+
+    def context_build(self, params: dict) -> dict:
+        if params.get("multi"):
+            b = Context.multi_builder()
+            for c in params.get("multi"):
+                b.add(self._context_build_single(c))
+            return self._context_response(b.build())
+        return self._context_response(self._context_build_single(params["single"]))
+
+    def _context_build_single(self, params: dict) -> Context:
+        b = Context.builder(params["key"])
+        if "kind" in params:
+            b.kind(params["kind"])
+        if "name" in params:
+            b.name(params["name"])
+        if "anonymous" in params:
+            b.anonymous(params["anonymous"])
+        if "custom" in params:
+            for k, v in params.get("custom").items():
+                b.set(k, v)
+        if "private" in params:
+            for attr in params.get("private"):
+                b.private(attr)
+        return b.build()
+
+    def context_convert(self, params: dict) -> dict:
+        input = params["input"]
+        try:
+            props = json.loads(input)
+            return self._context_response(Context.from_dict(props))
+        except Exception as e:
+            return {"error": str(e)}
+
+    def _context_response(self, c: Context) -> dict:
+        if c.valid:
+            return {"output": c.to_json_string()}
+        return {"error": c.error}
+
+    def get_big_segment_store_status(self) -> dict:
+        status = self.client.big_segment_store_status_provider.status
+        return {
+            "available": status.available,
+            "stale": status.stale
+        }
+
     def close(self):
         self.client.close()
         self.log.info('Test ended')
+
+def _set_optional_time_prop(params_in: dict, name_in: str, params_out: dict, name_out: str):
+    if params_in.get(name_in) is not None:
+        params_out[name_out] = params_in[name_in] / 1000.0
+    return None
diff --git a/contract-tests/service.py b/contract-tests/service.py
@@ -12,6 +12,7 @@
 
 default_port = 8000
 
+
 # logging configuration
 dictConfig({
     'version': 1,
@@ -30,11 +31,10 @@
         'level': 'INFO',
         'handlers': ['console']
     },
-    'ldclient.util': {
-        'level': 'INFO',
-        'handlers': ['console']
-    },
     'loggers': {
+        'ldclient': {
+            'level': 'INFO', # change to 'DEBUG' to enable SDK debug logging
+        },
         'werkzeug': { 'level': 'ERROR' } # disable irrelevant Flask app logging
     }
 })
@@ -53,6 +53,7 @@ def handle_exception(e):
     if isinstance(e, HTTPException):
         return e
 
+    app.logger.exception(e)
     return str(e), 500
 
 @app.route('/', methods=['GET'])
@@ -63,6 +64,9 @@ def status():
             'all-flags-with-reasons',
             'all-flags-client-side-only',
             'all-flags-details-only-for-tracked-flags',
+            'big-segments',
+            'context-type',
+            'secure-mode-hash',
         ]
     }
     return (json.dumps(body), 200, {'Content-type': 'application/json'})
@@ -102,26 +106,35 @@ def post_client_command(id):
     if client is None:
         return ('', 404)
 
-    if params.get('command') == "evaluate":
-        response = client.evaluate(params.get("evaluate"))
-        return (json.dumps(response), 200)
-    elif params.get("command") == "evaluateAll":
-        response = client.evaluate_all(params.get("evaluateAll"))
-        return (json.dumps(response), 200)
-    elif params.get("command") == "customEvent":
-        client.track(params.get("customEvent"))
-        return ('', 201)
-    elif params.get("command") == "identifyEvent":
-        client.identify(params.get("identifyEvent"))
-        return ('', 201)
-    elif params.get("command") == "aliasEvent":
-        client.alias(params.get("aliasEvent"))
-        return ('', 201)
-    elif params.get('command') == "flushEvents":
+    command = params.get('command')
+    sub_params = params.get(command)
+
+    response = None
+
+    if command == "evaluate":
+        response = client.evaluate(sub_params)
+    elif command == "evaluateAll":
+        response = client.evaluate_all(sub_params)
+    elif command == "customEvent":
+        client.track(sub_params)
+    elif command == "identifyEvent":
+        client.identify(sub_params)
+    elif command == "flushEvents":
         client.flush()
+    elif command == "secureModeHash":
+        response = client.secure_mode_hash(sub_params)
+    elif command == "contextBuild":
+        response = client.context_build(sub_params)
+    elif command == "contextConvert":
+        response = client.context_convert(sub_params)
+    elif command == "getBigSegmentStoreStatus":
+        response = client.get_big_segment_store_status()
+    else:
+        return ('', 400)
+
+    if response is None:
         return ('', 201)
-
-    return ('', 400)
+    return (json.dumps(response), 200)
 
 @app.route('/clients/<id>', methods=['DELETE'])
 def delete_client(id):

diff --git a/docs/api-deprecated.rst b/docs/api-deprecated.rst