launchdarkly
diff --git a/‎.circleci/config.yml‎
Lines changed: 15 additions & 1 deletion b/‎.circleci/config.yml‎
Lines changed: 15 additions & 1 deletion
diff --git a/‎.gitignore‎
Lines changed: 1 addition & 0 deletions b/‎.gitignore‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 6 additions & 0 deletions b/‎CONTRIBUTING.md‎
Lines changed: 6 additions & 0 deletions
diff --git a/‎Makefile‎
Lines changed: 33 additions & 0 deletions b/‎Makefile‎
Lines changed: 33 additions & 0 deletions
diff --git a/‎src/LaunchDarkly/FeatureFlagsState.php‎
Lines changed: 10 additions & 6 deletions b/‎src/LaunchDarkly/FeatureFlagsState.php‎
Lines changed: 10 additions & 6 deletions
diff --git a/‎src/LaunchDarkly/Impl/Integrations/CurlEventPublisher.php‎
Lines changed: 5 additions & 3 deletions b/‎src/LaunchDarkly/Impl/Integrations/CurlEventPublisher.php‎
Lines changed: 5 additions & 3 deletions
diff --git a/‎src/LaunchDarkly/Impl/Integrations/GuzzleEventPublisher.php‎
Lines changed: 7 additions & 5 deletions b/‎src/LaunchDarkly/Impl/Integrations/GuzzleEventPublisher.php‎
Lines changed: 7 additions & 5 deletions
diff --git a/‎src/LaunchDarkly/Impl/Integrations/GuzzleFeatureRequester.php‎
Lines changed: 4 additions & 2 deletions b/‎src/LaunchDarkly/Impl/Integrations/GuzzleFeatureRequester.php‎
Lines changed: 4 additions & 2 deletions
diff --git a/‎src/LaunchDarkly/Impl/Util.php‎
Lines changed: 8 additions & 0 deletions b/‎src/LaunchDarkly/Impl/Util.php‎
Lines changed: 8 additions & 0 deletions
diff --git a/‎test-service/README.md‎
Lines changed: 9 additions & 0 deletions b/‎test-service/README.md‎
Lines changed: 9 additions & 0 deletions
@@ -53,6 +53,7 @@ jobs:
 
     environment:
       LD_INCLUDE_INTEGRATION_TESTS: 1
+      TEST_HARNESS_PARAMS: -junit build/contract-tests-output/junit-results.xml
 
     docker:
       - image: cimg/php:<<parameters.php-version>>
@@ -90,10 +91,23 @@ jobs:
       - run:
           name: run tests
           command: php -d xdebug.mode=coverage vendor/bin/phpunit
-          enviroment:
+          environment:
             XDEBUG_MODE: coverage
 
+      - run:
+          name: build contract test service
+          command: make build-contract-tests
+      - run:
+          name: start contract test service
+          command: make start-contract-test-service
+          background: true
+      - run:
+          name: run contract tests
+          command: mkdir -p build/contract-tests-output && make run-contract-tests
+
       - store_test_results:
           path: build/phpunit
+      - store_test_results:
+          path: build/contract-tests-output
       - store_artifacts:
           path: build/phpunit
@@ -1,4 +1,5 @@
 /vendor/
+/test-service/vendor/
 /doc/
 *.iml
 composer.phar
 
@@ -39,3 +39,9 @@ By default, this test suite does not include any integration test that relies on
 ```
 docker run --rm -p 8080:8080 wiremock/wiremock
 ```
+
+To run the SDK contract test suite in Linux (see [`test-service/README.md`](./test-service/README.md)):
+
+```bash
+make contract-tests
+```
@@ -0,0 +1,33 @@
+
+TEMP_TEST_OUTPUT=/tmp/sse-contract-test-service.log
+
+# TEST_HARNESS_PARAMS can be set to add -skip parameters for any contract tests that cannot yet pass
+# Explanation of current skips:
+# - "secondary": In the PHP SDK this is not an addressable attribute for clauses; in other
+#   SDKs, it is. This was underspecified in the past; in future major versions, the other
+#   SDKs and the contract tests will be in line with the PHP behavior.
+# - "date - bad syntax", "semver - bad type": The PHP SDK has insufficiently strict
+#   validation for these types. We will definitely fix this in 5.0 but may or may not
+#   address it in 4.x, since it does not prevent any valid values from working.
+TEST_HARNESS_PARAMS := $(TEST_HARNESS_PARAMS) \
+	-skip 'evaluation/parameterized/secondary' \
+	-skip 'evaluation/parameterized/operators - date - bad syntax' \
+	-skip 'evaluation/parameterized/operators - semver - bad type'
+
+build-contract-tests:
+	@cd test-service && composer install --no-progress
+
+start-contract-test-service: build-contract-tests
+	@cd test-service && php -S localhost:8000 index.php
+
+start-contract-test-service-bg:
+	@echo "Test service output will be captured in $(TEMP_TEST_OUTPUT)"
+	@make start-contract-test-service >$(TEMP_TEST_OUTPUT) 2>&1 &
+
+run-contract-tests:
+	@curl -s https://raw.githubusercontent.com/launchdarkly/sdk-test-harness/main/downloader/run.sh \
+      | VERSION=v1 PARAMS="-url http://localhost:8000 -debug -stop-service-at-end $(TEST_HARNESS_PARAMS)" sh
+
+contract-tests: build-contract-tests start-contract-test-service-bg run-contract-tests
+
+.PHONY: build-contract-tests start-contract-test-service start-contract-test-service-bg run-contract-tests contract-tests
@@ -149,13 +149,17 @@ public function toValuesMap(): array
     public function jsonSerialize(): array
     {
         $ret = array_replace([], $this->_flagValues);
-        $metaMap = [];
-        foreach ($this->_flagMetadata as $key => $meta) {
-            $meta = array_replace([], $meta);
-            if (isset($meta['reason'])) {
-                $meta['reason'] = $meta['reason']->jsonSerialize();
+        if (count($this->_flagMetadata) === 0) {
+            $metaMap = new \stdClass(); // using object rather than array ensures the JSON value is {}, not []
+        } else {
+            $metaMap = [];
+            foreach ($this->_flagMetadata as $key => $meta) {
+                $meta = array_replace([], $meta);
+                if (isset($meta['reason'])) {
+                    $meta['reason'] = $meta['reason']->jsonSerialize();
+                }
+                $metaMap[$key] = $meta;
             }
-            $metaMap[$key] = $meta;
         }
         $ret['$flagsState'] = $metaMap;
         $ret['$valid'] = $this->_valid;
 
@@ -41,10 +41,12 @@ public function __construct(string $sdkKey, array $options = [])
     {
         $this->_sdkKey = $sdkKey;
 
-        $eventsUri = LDClient::DEFAULT_EVENTS_URI;
-        if (isset($options['events_uri'])) {
-            $eventsUri = $options['events_uri'];
+        $baseUri = $options['events_uri'] ?? null;
+        if (!$baseUri) {
+            $baseUri = LDClient::DEFAULT_EVENTS_URI;
         }
+        $eventsUri = \LaunchDarkly\Impl\Util::adjustBaseUri($baseUri);
+
         $url = parse_url(rtrim($eventsUri, '/'));
         $this->_host = $url['host'] ?? '';
         $this->_ssl = ($url['scheme'] ?? '') === 'https';
 
@@ -28,11 +28,13 @@ public function __construct(string $sdkKey, array $options = [])
     {
         $this->_sdkKey = $sdkKey;
         $this->_logger = $options['logger'];
-        if (isset($options['events_uri'])) {
-            $this->_eventsUri = $options['events_uri'];
-        } else {
-            $this->_eventsUri = LDClient::DEFAULT_EVENTS_URI;
+
+        $baseUri = $options['events_uri'] ?? null;
+        if (!$baseUri) {
+            $baseUri = LDClient::DEFAULT_EVENTS_URI;
         }
+        $this->_eventsUri = \LaunchDarkly\Impl\Util::adjustBaseUri($baseUri);
+
         $this->_requestOptions = [
             'headers' => [
                 'Content-Type'  => 'application/json',
@@ -53,7 +55,7 @@ public function publish(string $payload): bool
         try {
             $options = $this->_requestOptions;
             $options['body'] = $payload;
-            $response = $client->request('POST', '/bulk', $options);
+            $response = $client->request('POST', 'bulk', $options);
         } catch (\Exception $e) {
             $this->_logger->warning("GuzzleEventPublisher::publish caught $e");
             return false;
 
@@ -21,8 +21,8 @@
  */
 class GuzzleFeatureRequester implements FeatureRequester
 {
-    const SDK_FLAGS = "/sdk/flags";
-    const SDK_SEGMENTS = "/sdk/segments";
+    const SDK_FLAGS = "sdk/flags";
+    const SDK_SEGMENTS = "sdk/segments";
     /** @var Client  */
     private $_client;
     /** @var LoggerInterface */
@@ -32,6 +32,8 @@ class GuzzleFeatureRequester implements FeatureRequester
 
     public function __construct(string $baseUri, string $sdkKey, array $options)
     {
+        $baseUri = \LaunchDarkly\Impl\Util::adjustBaseUri($baseUri);
+
         $this->_logger = $options['logger'];
         $stack = HandlerStack::create();
         if (class_exists('\Kevinrob\GuzzleCache\CacheMiddleware')) {
 
@@ -13,6 +13,14 @@
  */
 class Util
 {
+    public static function adjustBaseUri(string $uri): string
+    {
+        if (substr($uri, strlen($uri) - 1, 1) == '/') {
+            return $uri;
+        }
+        return $uri . '/';  // ensures that subpaths are concatenated correctly
+    }
+
     public static function dateTimeToUnixMillis(DateTime $dateTime): int
     {
         $timeStampSeconds = (int)$dateTime->getTimestamp();
 
@@ -0,0 +1,9 @@
+# SDK contract test service
+
+This directory contains an implementation of the cross-platform SDK testing protocol defined by https://github.com/launchdarkly/sdk-test-harness. See that project's `README` for details of this protocol, and the kinds of SDK capabilities that are relevant to the contract tests. This code should not need to be updated unless the SDK has added or removed such capabilities.
+
+To run these tests locally, run `make contract-tests` from the SDK project root directory. This downloads the correct version of the test harness tool automatically.
+
+Or, to test against an in-progress local version of the test harness, run `make start-contract-test-service` from the SDK project root directory; then, in the root directory of the `sdk-test-harness` project, build the test harness and run it from the command line.
+
+The test service is designed to be run by any web server; PHP's built-in development server is adequate. The server must be configured to run `index.php` for all requests. The environment variable `LD_TEST_SERVICE_DATA_DIR` can be set, if desired, to point to a specific file path where the test service can store data; otherwise it will create a directory under `/tmp`.
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`/vendor/`
	`2`	`+/test-service/vendor/`
`2`	`3`	`/doc/`
`3`	`4`	`*.iml`
`4`	`5`	`composer.phar`