prepare 4.1.0 release (#156)

Author: LaunchDarklyReleaseBot

.circleci/config.yml

@@ -1,5 +1,8 @@
 version: 2.1
 
+orbs:
+  win: circleci/[email protected]
+
 workflows:
   workflow:
     jobs:
@@ -12,17 +15,53 @@ workflows:
       - test-with-preinstalled-php:
          name: PHP 8.0
          docker-image: cimg/php:8.0
+      - test-on-windows
 
 jobs:
+  test-on-windows:
+    executor:
+      name: win/default
+      shell: powershell.exe
+
+    environment:
+      LD_INCLUDE_INTEGRATION_TESTS: 1
+
+    steps:
+      - checkout
+      - run:
+          name: install php and java support
+          command: choco install -y php composer javaruntime
+      - run:
+          name: download wiremock
+          command: Invoke-WebRequest -Uri https://repo1.maven.org/maven2/com/github/tomakehurst/wiremock-jre8-standalone/2.31.0/wiremock-jre8-standalone-2.31.0.jar -UseBasicParsing -OutFile wiremock.jar
+      - run:
+          name: start wiremock
+          background: true
+          command: java -jar ./wiremock.jar
+      - run:
+          name: wait for wiremock to be available
+          command: PowerShell -Command Start-Sleep -Seconds 5
+      - run:
+          name: install dependencies
+          command: composer install --no-progress
+      - run:
+          name: run tests
+          command: .\vendor\bin\phpunit
+
   test-with-preinstalled-php:
     parameters:
       docker-image:
         type: string
 
+    environment:
+      LD_INCLUDE_INTEGRATION_TESTS: 1
+
     docker:
       - image: <<parameters.docker-image>>
+      - image: wiremock/wiremock
 
     steps:
+      - setup_remote_docker
       - checkout
       - run:
           name: validate composer.json
@@ -33,13 +72,15 @@ jobs:
       - run:
           name: psalm linting
           command: ./vendor/bin/psalm --no-cache
-      - run: mkdir -p ~/phpunit
+      - run:
+          name: php-cs-fixer check
+          command: composer cs-check
       - run:
           name: run tests with highest compatible dependency versions
           command: php -d xdebug.mode=coverage vendor/bin/phpunit
           enviroment:
             XDEBUG_MODE: coverage
       - store_test_results:
-          path: ~/phpunit
+          path: build/phpunit
       - store_artifacts:
-          path: ~/phpunit
+          path: build/phpunit

.ldrelease/build-docs.sh

@@ -1,3 +1,5 @@
+version: 2
+
 repo:
   public: php-server-sdk
   private: php-server-sdk-private
@@ -6,12 +8,13 @@ publications:
   - url: https://packagist.org/packages/launchdarkly/server-sdk
     description: Packagist
 
-circleci:
-  linux:
-    image: ldcircleci/php-sdk-release:1  # built in sdks-ci-docker project, contains PHP 7.3 + phpDocumentor 3
+jobs:
+  - template:
+      name: php
 
 documentation:
-  githubPages: true
+  gitHubPages: true
+  title: "LaunchDarkly PHP SDK"
 
 sdk:
   displayName: "PHP"

.ldrelease/config.yml

@@ -0,0 +1,15 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()->in(__DIR__);
+
+$config = new PhpCsFixer\Config();
+return $config
+    ->setFinder($finder)
+    ->setUsingCache(true)
+    ->setRules([
+        '@PSR2' => true,
+        'blank_line_after_opening_tag' => true,
+        'ordered_imports' => true,
+        'no_unused_imports' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ]);

.ldrelease/publish-docs.sh

@@ -108,7 +108,7 @@ The package name will also change. In the 3.5.3 release, it is still `launchdark
 
 ## [3.5.0] - 2019-01-30
 ### Added:
-- It is now possible to use Consul or DynamoDB as a data store with `ld-relay`, similar to the existing Redis integration. See `LaunchDarkly\Integrations\Consul` and `LaunchDarkly\Integrations\DynamoDb`, and the reference guide [Using a persistent feature store](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
+- It is now possible to use Consul or DynamoDB as a data store with `ld-relay`, similar to the existing Redis integration. See `LaunchDarkly\Integrations\Consul` and `LaunchDarkly\Integrations\DynamoDb`, and the reference guide [Persistent data stores](https://docs.launchdarkly.com/sdk/concepts/data-stores).
 - When using the Redis integration, you can specify a Redis connection timeout different from the default of 5 seconds by setting the option `redis_timeout` to the desired number of seconds. (Thanks, [jjozefowicz](https://github.com/launchdarkly/php-client/pull/113)!)
 - It is now possible to inject feature flags into the client from local JSON files, replacing the normal LaunchDarkly connection. This would typically be for testing purposes. See `LaunchDarkly\Integrations\Files`.
 - The `allFlagsState` method now accepts a new option, `detailsOnlyForTrackedFlags`, which reduces the size of the JSON representation of the flag state by omitting some metadata. Specifically, it omits any data that is normally used for generating detailed evaluation events if a flag does not have event tracking or debugging turned on.
@@ -166,7 +166,7 @@ The package name will also change. In the 3.5.3 release, it is still `launchdark
 
 ## [2.4.0] - 2018-01-04
 ### Added
-- Support for [private user attributes](https://docs.launchdarkly.com/docs/private-user-attributes).
+- Support for [private user attributes](https://docs.launchdarkly.com/home/users/attributes#creating-private-user-attributes).
 
 ### Changed
 - Stop retrying HTTP requests if the API key has been invalidated.

.php-cs-fixer.php

@@ -1,6 +1,6 @@
 # Contributing to the LaunchDarkly Server-Side SDK for PHP
 
-LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.
+LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/sdk/concepts/contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.
 
 ## Submitting bug reports and feature requests
 
@@ -33,3 +33,9 @@ To run all unit tests:
 ```
 
 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.
+
+By default, this test suite does not include any integration test that relies on external dependencies. To include them, set the environment variable `LD_INCLUDE_INTEGRATION_TESTS=1` before running the tests. Note that you will also need an instance of [WireMock](http://wiremock.org/) for the tests to connect to. This can be run via docker as follows:
+
+```
+docker run --rm -p 8080:8080 wiremock/wiremock
+```

.php_cs

@@ -1,10 +1,12 @@
 # LaunchDarkly Server-side SDK for PHP
 
 [![Circle CI](https://img.shields.io/circleci/project/launchdarkly/php-server-sdk.png)](https://circleci.com/gh/launchdarkly/php-server-sdk)
+[![Packagist](https://img.shields.io/packagist/v/launchdarkly/server-sdk.svg?style=flat-square)](https://packagist.org/packages/launchdarkly/server-sdk)
+[![Documentation](https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8)](https://launchdarkly.github.io/php-server-sdk)
 
 ## LaunchDarkly overview
 
-[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/docs/getting-started) using LaunchDarkly today!
+[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
 
@@ -37,7 +39,7 @@ We encourage pull requests and other contributions from the community. Check out
     * Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
     * Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
     * Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
-* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/docs) for a complete list.
+* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
 * Explore LaunchDarkly
     * [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information
     * [docs.launchdarkly.com](https://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDK reference guides

CHANGELOG.md

@@ -0,0 +1,2 @@
+*
+!.gitignore

CONTRIBUTING.md

@@ -22,9 +22,9 @@
         "friendsofphp/php-cs-fixer": ">=2.2.19 <3.0",
         "guzzlehttp/guzzle": "^7",
         "kevinrob/guzzle-cache-middleware": "^3",
-        "phpunit/phpunit": "^9",
         "phpunit/php-code-coverage": "^9",
-        "vimeo/psalm": "^4.7"
+        "phpunit/phpunit": "^9",
+        "vimeo/psalm": "^4.0"
     },
     "suggest": {
         "guzzlehttp/guzzle": "(^7) Required when using GuzzleEventPublisher or the default FeatureRequester",
@@ -44,6 +44,7 @@
         "sort-packages": true
     },
     "scripts": {
-        "cs": "vendor/bin/php-cs-fixer fix --diff --verbose"
+        "cs-check": "vendor/bin/php-cs-fixer fix --diff --dry-run --verbose",
+        "cs-fix": "vendor/bin/php-cs-fixer fix --diff --verbose"
     }
 }

README.md

@@ -2,16 +2,16 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" beStrictAboutChangesToGlobalState="true" beStrictAboutOutputDuringTests="true" beStrictAboutResourceUsageDuringSmallTests="true" beStrictAboutTestsThatDoNotTestAnything="true" beStrictAboutTodoAnnotatedTests="true" verbose="true" defaultTimeLimit="10">
 
   <logging>
-    <junit outputFile="~/phpunit/junit.xml"/>
+    <junit outputFile="build/phpunit/junit.xml"/>
   </logging>
 
   <coverage>
     <include>
       <directory suffix=".php">src</directory>
     </include>
     <report>
-      <html outputDirectory="~/phpunit/html-coverage"/>
-      <xml outputDirectory="~/phpunit/xml-coverage"/>
+      <html outputDirectory="build/phpunit/html-coverage"/>
+      <xml outputDirectory="build/phpunit/xml-coverage"/>
     </report>
   </coverage>
 

VERSION

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="4"
+    errorLevel="2"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"

build/.gitignore

@@ -2,8 +2,6 @@
 
 namespace LaunchDarkly;
 
-use \LaunchDarkly\EvaluationReason;
-
 /**
  * An object that combines the result of a flag evaluation with an explanation of how it was calculated.
  *

composer.json

@@ -166,8 +166,8 @@ private function __construct(
         ?int $ruleIndex = null,
         ?string $ruleId = null,
         ?string $prerequisiteKey = null,
-        bool $inExperiment = false)
-    {
+        bool $inExperiment = false
+    ) {
         $this->_kind = $kind;
         $this->_errorKind = $errorKind;
         $this->_ruleIndex = $ruleIndex;
@@ -258,7 +258,7 @@ public function __toString(): string
      */
     public function jsonSerialize(): array
     {
-        $ret = array('kind' => $this->_kind);
+        $ret = ['kind' => $this->_kind];
         if ($this->_errorKind !== null) {
             $ret['errorKind'] = $this->_errorKind;
         }

docs/Makefile

@@ -1,4 +1,5 @@
 <?php
+
 namespace LaunchDarkly;
 
 /**