prepare 5.0.0 release

.circleci/config.yml

@@ -9,7 +9,7 @@ workflows:
       - test-on-linux:
           matrix:
               parameters:
-                  php-version: ["7.3", "7.4", "8.0", "8.1"]
+                  php-version: ["8.0", "8.1"]
                   composer-dependencies: ["lowest", "highest"]
       - test-on-windows
 
@@ -77,22 +77,12 @@ jobs:
                 name: downgrade to lowest versions
                 command: composer update --prefer-lowest --prefer-stable
 
-      - run:
-          name: psalm linting
-          command: ./vendor/bin/psalm --no-cache
-      - when:
-          condition:
-              not:
-                equal: [ "8.1", <<parameters.php-version>> ]
-          steps:
-            - run:
-                name: php-cs-fixer check
-                command: composer cs-check
       - run:
           name: run tests
-          command: php -d xdebug.mode=coverage vendor/bin/phpunit
-          environment:
-            XDEBUG_MODE: coverage
+          command: make test
+      - run:
+          name: lint
+          command: make lint
 
       - run:
           name: build contract test service

.gitignore

@@ -4,6 +4,7 @@
 *.iml
 composer.phar
 .php_cs.cache
+.php-cs-fixer.cache
 .vagrant
 integration-tests/vendor
 composer.lock

.ldrelease/config.yml

@@ -9,7 +9,9 @@ publications:
     description: Packagist
 
 jobs:
-  - template:
+  - docker:
+      image: ldcircleci/php-sdk-release:4  # Releaser's default for PHP is still php-sdk-release:3, which is PHP 7.x
+    template:
       name: php
 
 documentation:

CONTRIBUTING.md

@@ -28,8 +28,11 @@ composer install
 
 To run all unit tests:
 
-```
+```shell
 ./vendor/bin/phpunit
+
+# Or, as a shortcut in Linux:
+make test
 ```
 
 It is preferable to run tests against all supported minor versions of PHP (as described in `README.md` under Requirements), or at least the lowest and highest versions, prior to submitting a pull request. However, LaunchDarkly's CI tests will run automatically against all supported versions.
@@ -45,3 +48,13 @@ To run the SDK contract test suite in Linux (see [`test-service/README.md`](./te
 ```bash
 make contract-tests
 ```
+
+To run the Psalm linter and cs-check:
+
+```shell
+./vendor/bin/psalm --no-cache
+composer cs-check
+
+# Or, as a shortcut in Linux:
+make lint
+```

Makefile

@@ -1,18 +1,21 @@
 
+test:
+	php -d xdebug.mode=coverage vendor/bin/phpunit
+
+lint:
+	./vendor/bin/psalm --no-cache
+	composer cs-check
+
+
 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.
+# - "evaluation/parameterized/attribute references/array index is not supported": Due to how PHP
+#   arrays work, there's no way to disallow an array index lookup without breaking object property
+#   lookups for properties that are numeric strings.
 TEST_HARNESS_PARAMS := $(TEST_HARNESS_PARAMS) \
-	-skip 'evaluation/parameterized/secondary' \
-	-skip 'evaluation/parameterized/operators - date - bad syntax' \
-	-skip 'evaluation/parameterized/operators - semver - bad type'
+	-skip 'evaluation/parameterized/attribute references/array index is not supported'
 
 build-contract-tests:
 	@cd test-service && composer install --no-progress
@@ -26,7 +29,7 @@ start-contract-test-service-bg:
 
 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
+      | VERSION=v2 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
 

README.md

@@ -12,7 +12,7 @@
 
 ## Supported PHP versions
 
-This version of the LaunchDarkly SDK is compatible with PHP 7.3 and higher.
+This version of the LaunchDarkly SDK is compatible with PHP 8.0 and higher.
 
 ## Getting started
 

composer.json

@@ -14,13 +14,13 @@
         }
     ],
     "require": {
-        "php": ">=7.3",
-        "monolog/monolog": "^1.6|^2.0|^3.0",
+        "php": ">=8.0",
+        "monolog/monolog": "^2.0|^3.0",
         "psr/log": "^1.0|^2.0|^3.0"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": ">=2.18.0 <3.0",
-        "guzzlehttp/guzzle": "^6.3 | ^7",
+        "friendsofphp/php-cs-fixer": "^3.12.0",
+        "guzzlehttp/guzzle": "^7",
         "kevinrob/guzzle-cache-middleware": "^4.0",
         "phpunit/php-code-coverage": "^9",
         "phpunit/phpunit": "^9",

src/LaunchDarkly/EvaluationDetail.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace LaunchDarkly;
 
 /**
@@ -9,43 +11,39 @@
  */
 class EvaluationDetail
 {
-    /** @var int|null */
-    private $_variationIndex = null;
-
-    /** @var mixed|null */
-    private $_value = null;
-
-    /** @var EvaluationReason */
-    private $_reason;
+    private ?int $_variationIndex = null;
+    private mixed $_value = null;
+    private EvaluationReason $_reason;
 
     /**
      * EvaluationDetail constructor.
-     * @param mixed|null $value the value of the flag variation
+     * @param mixed $value the value of the flag variation
      * @param int|null $variationIndex the index of the flag variation, or null if it was the default value
      * @param EvaluationReason $reason evaluation reason properties
      */
-    public function __construct($value, ?int $variationIndex, EvaluationReason $reason)
+    public function __construct(mixed $value, ?int $variationIndex, EvaluationReason $reason)
     {
         $this->_value = $value;
         $this->_variationIndex = $variationIndex;
         $this->_reason = $reason;
     }
 
     /**
-     * Returns the value of the flag variation for the user.
+     * Returns the result of the flag evaluation. This will be either one of the flag's variations or the default
+     * value that was passed to the {@see \LaunchDarkly\LDClient::variationDetail()} method.
      *
-     * @return mixed
+     * @return mixed the flag value
      */
-    public function getValue()
+    public function getValue(): mixed
     {
         return $this->_value;
     }
 
     /**
-     * Returns the index of the flag variation for the user, e.g. 0 for the first variation -
-     * or null if it was the default value.
+     * The index of the returned value within the flag's list of variations, e.g. 0 for the first variation--
+     * or null if it was the default value (evaluation failed).
      *
-     * @return int | null
+     * @return ?int the variation index if applicable
      */
     public function getVariationIndex(): ?int
     {

src/LaunchDarkly/EvaluationReason.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace LaunchDarkly;
 
 /**
@@ -81,23 +83,12 @@ class EvaluationReason implements \JsonSerializable
      */
     const EXCEPTION_ERROR = 'EXCEPTION';
 
-    /** @var string */
-    private $_kind;
-
-    /** @var string|null */
-    private $_errorKind;
-
-    /** @var int|null */
-    private $_ruleIndex;
-
-    /** @var string|null */
-    private $_ruleId;
-
-    /** @var string|null */
-    private $_prerequisiteKey;
-
-    /** @var bool */
-    private $_inExperiment;
+    private string $_kind;
+    private ?string $_errorKind;
+    private ?int $_ruleIndex;
+    private ?string $_ruleId;
+    private ?string $_prerequisiteKey;
+    private bool $_inExperiment;
 
     /**
      * Creates a new instance of the OFF reason.
@@ -228,7 +219,7 @@ public function getPrerequisiteKey(): ?string
     /**
      * Returns true if the evaluation resulted in an experiment rollout *and* served
      * one of the variations in the experiment.  Otherwise it returns false.
-     * @return boolean
+     * @return bool
      */
     public function isInExperiment(): bool
     {
@@ -242,11 +233,11 @@ public function __toString(): string
     {
         switch ($this->_kind) {
             case self::RULE_MATCH:
-                return $this->_kind . '(' . ($this->_ruleIndex ?? 0) . ',' . ($this->_ruleId ?? '') . ')';
+                return $this->_kind . '(' . ($this->_ruleIndex ?: 0) . ',' . ($this->_ruleId ?: '') . ')';
             case self::PREREQUISITE_FAILED:
-                return $this->_kind . '(' . ($this->_prerequisiteKey ?? '') . ')';
+                return $this->_kind . '(' . ($this->_prerequisiteKey ?: '') . ')';
             case self::ERROR:
-                return $this->_kind . '(' . ($this->_errorKind ?? '') . ')';
+                return $this->_kind . '(' . ($this->_errorKind ?: '') . ')';
             default:
                 return $this->_kind;
         }

src/LaunchDarkly/FeatureFlagsState.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace LaunchDarkly;
 
 use LaunchDarkly\Impl\Model\FeatureFlag;
@@ -15,14 +17,9 @@
  */
 class FeatureFlagsState implements \JsonSerializable
 {
-    /** @var bool */
-    protected $_valid = false;
-
-    /** @var array */
-    protected $_flagValues;
-
-    /** @var array<string, array{debugEventsUntilDate?: int|null, reason?: EvaluationReason, trackEvents?: true, variation?: int|null, version?: int}> **/
-    protected $_flagMetadata;
+    protected bool $_valid = false;
+    protected array $_flagValues;
+    protected array $_flagMetadata;
 
     /**
      * @ignore
@@ -44,16 +41,15 @@ public function __construct(bool $valid)
     public function addFlag(
         FeatureFlag $flag,
         EvaluationDetail $detail,
+        bool $forceReasonTracking = false,
         bool $withReason = false,
         bool $detailsOnlyIfTracked = false
     ): void {
-        $requireExperimentData = $flag->isExperiment($detail->getReason());
-
         $this->_flagValues[$flag->getKey()] = $detail->getValue();
         $meta = [];
 
-        $trackEvents = $flag->isTrackEvents() || $requireExperimentData;
-        $trackReason = $requireExperimentData;
+        $trackEvents = $flag->isTrackEvents() || $forceReasonTracking;
+        $trackReason = $forceReasonTracking;
 
         $omitDetails = false;
         if ($detailsOnlyIfTracked) {
@@ -100,9 +96,9 @@ public function isValid(): bool
      * @param string $key the feature flag key
      * @return mixed the flag's value; null if the flag returned the default value, or if there was no such flag
      */
-    public function getFlagValue(string $key)
+    public function getFlagValue(string $key): mixed
     {
-        return isset($this->_flagValues[$key]) ? $this->_flagValues[$key] : null;
+        return $this->_flagValues[$key] ?? null;
     }
 
     /**
@@ -115,11 +111,7 @@ public function getFlagValue(string $key)
      */
     public function getFlagReason(string $key): ?EvaluationReason
     {
-        if (isset($this->_flagMetadata[$key])) {
-            $meta = $this->_flagMetadata[$key];
-            return isset($meta['reason']) ? $meta['reason'] : null;
-        }
-        return null;
+        return ($this->_flagMetadata[$key] ?? [])['reason'] ?? null;
     }
 
     /**
@@ -155,7 +147,7 @@ public function jsonSerialize(): array
             $metaMap = [];
             foreach ($this->_flagMetadata as $key => $meta) {
                 $meta = array_replace([], $meta);
-                if (isset($meta['reason'])) {
+                if ($meta['reason'] ?? null) {
                     $meta['reason'] = $meta['reason']->jsonSerialize();
                 }
                 $metaMap[$key] = $meta;