Ability to add custom HTTP client / Remove Monolog (#42)

* Make Guzzle optional, remove Monolog, set up phpstan & php-cs-fixer

* Update php-ci.yml

* Update .gitattributes

* Update composer.json

* Fixup log generation

* Fixup client comments

* Use PHPUnit 9 / More php cs rule options

* Update php-ci.yml

* Add CC UA header check in tests

.gitattributes

@@ -7,5 +7,6 @@
 /.sonarcloud.properties export-ignore
 /CONTRIBUTING.md export-ignore
 /DEPLOY.md export-ignore
-/phpcs.xml export-ignore
 /phpunit.xml export-ignore
+/.php-cs-fixer.php export-ignore
+/phpstan.neon export-ignore

.github/workflows/php-ci.yml

@@ -4,7 +4,7 @@ on:
   schedule:
     - cron: '0 0 * * *'
   push:
-    branches: [ master ]
+    branches: [ '*' ]
   pull_request:
     branches: [ master ]
 
@@ -43,12 +43,14 @@ jobs:
 
     - name: Execute tests
       run: vendor/bin/phpunit
-      
+
   coverage:
     needs: test
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -76,5 +78,68 @@ jobs:
     - name: Execute coverage
       run: vendor/bin/phpunit --coverage-clover clover.xml
 
-    - name: Upload coverage report
-      run: bash <(curl -s https://codecov.io/bash)
+    - name: Upload coverage
+      uses: codecov/codecov-action@v3
+      with:
+        fail_ci_if_error: true
+        files: ./clover.xml
+
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          ini-values: 'memory_limit=-1'
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        run: |
+          composer self-update
+          composer install --prefer-dist --no-progress --no-suggest --no-plugins
+
+      - run: vendor/bin/php-cs-fixer fix --ansi --diff --dry-run
+
+  phpstan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          ini-values: 'memory_limit=-1'
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        run: |
+          composer self-update
+          composer install --prefer-dist --no-progress --no-suggest --no-plugins
+
+      - run: vendor/bin/phpstan analyse --ansi

.gitignore

@@ -1,9 +1,7 @@
 /vendor
 composer.lock
 .idea/
-
 .DS_Store
-
 .phpunit.result.cache
-
+.php-cs-fixer.cache
 /samples/consolesample/vendor

.php-cs-fixer.php

@@ -0,0 +1,24 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__.'/src')
+    ->in(__DIR__.'/tests')
+;
+
+$config = (new PhpCsFixer\Config())
+    ->setRules([
+        '@PhpCsFixer' => true,
+        '@PSR2' => true,
+        'php_unit_internal_class' => false,
+        'php_unit_test_class_requires_covers' => false,
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => false,
+        ],
+    ])
+    ->setUsingCache(true)
+    ->setFinder($finder)
+;
+
+return $config;

DEPLOY.md

@@ -6,15 +6,19 @@
    ```
 2. Make sure the code is properly formatted.
    ```bash
-   ./vendor/bin/phpcs
+   vendor/bin/php-cs-fixer fix --ansi --diff --dry-run
    ```
-   > If it shows formatting errors, then you can fix them with the `./vendor/bin/phpcbf` command
-3. Run tests
+   > If it shows formatting errors, then you can fix them with the `vendor/bin/php-cs-fixer fix --ansi` command
+3. Make sure the static analyzer doesn't show errors.
+   ```bash
+   vendor/bin/phpstan analyse --ansi
+   ```
+4. Run tests
    ```bash
    vendor/bin/phpunit tests
    ```
-4. Set `SDK_VERSION` constant in `ConfigCatClient.php`
-5. Commit & Push
+5. Set `SDK_VERSION` constant in `ConfigCatClient.php`
+6. Commit & Push
 ## Publish
 - Via git tag
     1. Create a new version tag.

composer.json

@@ -17,15 +17,16 @@
     "guzzlehttp/guzzle": "^6.3|^7.0",
     "psr/log": "^2.0|^3.0",
     "ext-json": "*",
-    "monolog/monolog": "^2.0|^3.0",
-    "z4kn4fein/php-semver": "^2.0"
+    "z4kn4fein/php-semver": "^2.0",
+    "psr/http-client": "^1.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "~7.0|^8",
+    "phpunit/phpunit": "^9",
     "illuminate/cache": "^9.0",
     "psr/simple-cache": "^3.0",
     "psr/cache": "^1.0",
-    "squizlabs/php_codesniffer": "^3.7"
+    "phpstan/phpstan": "^1.0",
+    "friendsofphp/php-cs-fixer": "^3.0"
   },
   "autoload": {
     "psr-4": {

phpstan.neon

@@ -0,0 +1,9 @@
+parameters:
+    level: 8
+    paths:
+        - src
+    ignoreErrors:
+    		-
+    			message: '#PHPDoc tag \@throws with type Psr\\Cache\\InvalidArgumentException is not subtype of Throwable#'
+    			path: src/Cache/Psr6Cache.php
+    			count: 2

phpunit.xml

@@ -1,23 +1,13 @@
-<phpunit
-        backupGlobals="false"
-        backupStaticAttributes="false"
-        bootstrap="vendor/autoload.php"
-        colors="true"
-        convertErrorsToExceptions="true"
-        convertNoticesToExceptions="true"
-        convertWarningsToExceptions="true"
-        beStrictAboutTestsThatDoNotTestAnything="true"
-        beStrictAboutOutputDuringTests="true"
-        processIsolation="false"
-        stopOnFailure="false">
-    <testsuites>
-        <testsuite name="ConfigCat Tests">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false" bootstrap="vendor/autoload.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" beStrictAboutTestsThatDoNotTestAnything="true" beStrictAboutOutputDuringTests="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="ConfigCat Tests">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>

src/Attributes/Config.php

@@ -1,13 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ConfigCat\Attributes;
 
 /**
  * Represents the root JSON keys of a ConfigCat configuration file.
- * @package ConfigCat
  */
 class Config
 {
-    public const PREFERENCES = "p";
-    public const ENTRIES = "f";
+    public const PREFERENCES = 'p';
+    public const ENTRIES = 'f';
 }

src/Attributes/PercentageAttributes.php

@@ -1,14 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ConfigCat\Attributes;
 
 /**
  * Represents the JSON keys of a ConfigCat percentage rule.
- * @package ConfigCat
  */
 class PercentageAttributes
 {
-    public const VALUE = "v";
-    public const PERCENTAGE = "p";
-    public const VARIATION_ID = "i";
+    public const VALUE = 'v';
+    public const PERCENTAGE = 'p';
+    public const VARIATION_ID = 'i';
 }

src/Attributes/Preferences.php

@@ -1,13 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ConfigCat\Attributes;
 
 /**
  * Represents the JSON keys of the Preferences section in the ConfigCat configuration file.
- * @package ConfigCat
  */
 class Preferences
 {
-    public const BASE_URL = "u";
-    public const REDIRECT = "r";
+    public const BASE_URL = 'u';
+    public const REDIRECT = 'r';
 }

src/Attributes/RolloutAttributes.php

@@ -1,16 +1,17 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ConfigCat\Attributes;
 
 /**
  * Represents the JSON keys of a ConfigCat roll-out rule.
- * @package ConfigCat
  */
 class RolloutAttributes
 {
-    public const VALUE = "v";
-    public const COMPARISON_ATTRIBUTE = "a";
-    public const COMPARATOR = "t";
-    public const COMPARISON_VALUE = "c";
-    public const VARIATION_ID = "i";
+    public const VALUE = 'v';
+    public const COMPARISON_ATTRIBUTE = 'a';
+    public const COMPARATOR = 't';
+    public const COMPARISON_VALUE = 'c';
+    public const VARIATION_ID = 'i';
 }

src/Attributes/SettingAttributes.php

@@ -1,16 +1,17 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ConfigCat\Attributes;
 
 /**
  * Represents the JSON keys of a ConfigCat setting.
- * @package ConfigCat
  */
 class SettingAttributes
 {
-    public const VALUE = "v";
-    public const TYPE = "t";
-    public const ROLLOUT_PERCENTAGE_ITEMS = "p";
-    public const ROLLOUT_RULES = "r";
-    public const VARIATION_ID = "i";
+    public const VALUE = 'v';
+    public const TYPE = 't';
+    public const ROLLOUT_PERCENTAGE_ITEMS = 'p';
+    public const ROLLOUT_RULES = 'r';
+    public const VARIATION_ID = 'i';
 }