fix: resolve deprecations for implicitly nullable parameters in PHP 8.4 (#231)

wesolydexter · dmajka · web-flow · commit bad09acf421c · 2025-04-24T16:17:49.000+08:00
* fix: resolve deprecations for implicitly nullable parameters in PHP 8.4

* Update actions/cache from v2 to v3

* Update workflows to use the latest output method

* Fix composer cache directory setup

* Fix composer cache directory output in CI

* Fix mysqli connection test.

* Renamed abstract test classes to avoid warnings

* Fix namespace issue in MysqliTest

* Update CI to upload coverage report for PHP 8.1

* Revert version number in Docker Compose file.

* Use `docker compose` instead of `docker-compose`.

* Skip testing mysql connection on non-Linux systems


* Disable Codecov coverage upload in the CI workflow

* Remove code coverage in CI

---------

Co-authored-by: dmajka &lt;dawid.majka@verestro.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: [ubuntu-latest, windows-latest, macos-latest]
-        php-versions: ["7.4", "8.0", "8.1"]
+        php-versions: ["7.4", "8.0", "8.1", "8.2", "8.3", "8.4"]
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -27,9 +27,9 @@ jobs:
           extensions: mysql
       - name: Get composer cache directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "dir=$(composer config cache-files-dir | tr -d '\n' | tr -d '\r')" >> $GITHUB_OUTPUT
       - name: Cache composer dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
@@ -44,17 +44,3 @@ jobs:
         run: composer static-check
       - name: Run tests
         run: composer test -- --coverage-clover=build/logs/clover.xml
-      - name: Upload coverage report to codecov service
-        if: ${{ matrix.operating-system == 'ubuntu-latest' && matrix.php-versions == '8.0' }}
-        run: |
-          wget -c -nc --retry-connrefused --tries=0 https://github.com/satooshi/php-coveralls/releases/download/v2.4.3/php-coveralls.phar
-          chmod +x php-coveralls.phar
-          php php-coveralls.phar --version
-          mkdir -p build/logs
-          php php-coveralls.phar -v
-          bash <(curl -s https://codecov.io/bash)
-        env:
-          # Running coveralls with default config did not work so followed the workaround below:
-          # https://github.com/php-coveralls/php-coveralls/issues/273#issuecomment-537473525
-          COVERALLS_RUN_LOCALLY: 1
-          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ composer.phar
 composer.lock
 /vendor/
 .phpunit.result.cache
+.php-cs-fixer.cache
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,18 @@
+<?php
+
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+$finder = PhpCsFixer\Finder::create()
+    ->in('src')
+    ->in('tests')
+;
+
+return (new PhpCsFixer\Config())
+    ->setParallelConfig(ParallelConfigFactory::detect())
+    ->setRules(
+        [
+            'nullable_type_declaration_for_default_null_value' => true,
+        ]
+    )
+    ->setFinder($finder)
+;
diff --git a/README.md b/README.md
@@ -2,7 +2,6 @@
 
 ![CI](https://github.com/openzipkin/zipkin-php/workflows/CI/badge.svg)
 [![Latest Stable Version](https://poser.pugx.org/openzipkin/zipkin/v/stable)](https://packagist.org/packages/openzipkin/zipkin)
-[![Coverage Status](https://coveralls.io/repos/github/openzipkin/zipkin-php/badge.svg)](https://coveralls.io/github/openzipkin/zipkin-php)
 [![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.4-8892BF.svg)](https://php.net/)
 [![Total Downloads](https://poser.pugx.org/openzipkin/zipkin/downloads)](https://packagist.org/packages/openzipkin/zipkin)
 [![License](https://img.shields.io/packagist/l/openzipkin/zipkin.svg)](https://github.com/openzipkin/zipkin-php/blob/master/LICENSE)
diff --git a/composer.json b/composer.json
@@ -27,6 +27,7 @@
     },
     "require-dev": {
         "ext-mysqli": "*",
+        "friendsofphp/php-cs-fixer": "^3.75",
         "jcchavezs/httptest": "~0.2",
         "middlewares/fast-route": "^2.0",
         "middlewares/request-handler": "^2.0",
diff --git a/src/Zipkin/Instrumentation/Http/Client/HttpClientTracing.php b/src/Zipkin/Instrumentation/Http/Client/HttpClientTracing.php
@@ -27,8 +27,8 @@ class HttpClientTracing
 
     public function __construct(
         Tracing $tracing,
-        HttpClientParser $parser = null,
-        callable $requestSampler = null
+        ?HttpClientParser $parser = null,
+        ?callable $requestSampler = null
     ) {
         $this->tracing = $tracing;
         $this->parser = $parser ?? new DefaultHttpClientParser();
diff --git a/src/Zipkin/Instrumentation/Http/Server/HttpServerTracing.php b/src/Zipkin/Instrumentation/Http/Server/HttpServerTracing.php
@@ -26,8 +26,8 @@ class HttpServerTracing
 
     public function __construct(
         Tracing $tracing,
-        HttpServerParser $parser = null,
-        callable $requestSampler = null
+        ?HttpServerParser $parser = null,
+        ?callable $requestSampler = null
     ) {
         $this->tracing = $tracing;
         $this->parser = $parser ?? new DefaultHttpServerParser();
diff --git a/src/Zipkin/Instrumentation/Mysqli/Mysqli.php b/src/Zipkin/Instrumentation/Mysqli/Mysqli.php
@@ -30,12 +30,12 @@ final class Mysqli extends \Mysqli
     public function __construct(
         Tracer $tracer,
         array $options = [],
-        string $host = null,
-        string $user = null,
-        string $password = null,
+        ?string $host = null,
+        ?string $user = null,
+        ?string $password = null,
         string $database = '',
-        int $port = null,
-        string $socket = null
+        ?int $port = null,
+        ?string $socket = null
     ) {
         self::validateOptions($options);
         $this->tracer = $tracer;
@@ -65,7 +65,7 @@ private static function validateOptions(array $opts): void
         }
     }
 
-    private function addsTagsAndRemoteEndpoint(Span $span, string $query = null): void
+    private function addsTagsAndRemoteEndpoint(Span $span, ?string $query = null): void
     {
         if ($query !== null && $this->options['tag_query']) {
             $span->tag('sql.query', $query);
diff --git a/src/Zipkin/NoopSpan.php b/src/Zipkin/NoopSpan.php
@@ -37,7 +37,7 @@ public function getContext(): TraceContext
      * Spans can be modified before calling start. For example, you can add tags to the span and
      * set its name without lock contention.
      */
-    public function start(int $timestamp = null): void
+    public function start(?int $timestamp = null): void
     {
     }
 
@@ -87,7 +87,7 @@ public function setError(Throwable $e): void
      * @return void
      * @see Annotations
      */
-    public function annotate(string $value, int $timestamp = null): void
+    public function annotate(string $value, ?int $timestamp = null): void
     {
     }
 
@@ -113,7 +113,7 @@ public function abandon(): void
      * {@link zipkin.Span#duration Zipkin's span duration} is derived by subtracting the start
      * timestamp from this, and set when appropriate.
      */
-    public function finish(int $timestamp = null): void
+    public function finish(?int $timestamp = null): void
     {
     }
 
diff --git a/src/Zipkin/NoopSpanCustomizer.php b/src/Zipkin/NoopSpanCustomizer.php
@@ -23,7 +23,7 @@ public function tag(string $key, string $value): void
     /**
      * {@inheritdoc}
      */
-    public function annotate(string $value, int $timestamp = null): void
+    public function annotate(string $value, ?int $timestamp = null): void
     {
     }
 }
diff --git a/src/Zipkin/Propagation/B3.php b/src/Zipkin/Propagation/B3.php
@@ -147,7 +147,7 @@ final class B3 implements Propagation
      * same injector list.
      */
     public function __construct(
-        LoggerInterface $logger = null,
+        ?LoggerInterface $logger = null,
         array $kindInjectors = []
     ) {
         $this->logger = $logger ?: new NullLogger();
diff --git a/src/Zipkin/Propagation/CurrentTraceContext.php b/src/Zipkin/Propagation/CurrentTraceContext.php
@@ -20,7 +20,7 @@ final class CurrentTraceContext
 {
     private ?TraceContext $context;
 
-    public function __construct(TraceContext $currentContext = null)
+    public function __construct(?TraceContext $currentContext = null)
     {
         $this->context = $currentContext;
     }
@@ -40,7 +40,7 @@ public function getContext(): ?TraceContext
      * @param TraceContext|null $currentContext
      * @return callable():void The scope closed
      */
-    public function createScopeAndRetrieveItsCloser(TraceContext $currentContext = null): callable
+    public function createScopeAndRetrieveItsCloser(?TraceContext $currentContext = null): callable
     {
         $previous = $this->context;
         $self = $this;
diff --git a/src/Zipkin/RealSpan.php b/src/Zipkin/RealSpan.php
@@ -52,7 +52,7 @@ public function getContext(): TraceContext
      * @return void
      * @throws \InvalidArgumentException
      */
-    public function start(int $timestamp = null): void
+    public function start(?int $timestamp = null): void
     {
         if ($timestamp !== null && !isValid($timestamp)) {
             throw new InvalidArgumentException(
@@ -117,7 +117,7 @@ public function setError(Throwable $e): void
      * @throws \InvalidArgumentException
      * @see Zipkin\Annotations
      */
-    public function annotate(string $value, int $timestamp = null): void
+    public function annotate(string $value, ?int $timestamp = null): void
     {
         if ($timestamp !== null && !isValid($timestamp)) {
             throw new InvalidArgumentException(
@@ -161,7 +161,7 @@ public function abandon(): void
      * @return void
      * @throws \InvalidArgumentException
      */
-    public function finish(int $timestamp = null): void
+    public function finish(?int $timestamp = null): void
     {
         if ($timestamp !== null && !isValid($timestamp)) {
             throw new InvalidArgumentException('Invalid timestamp');
diff --git a/src/Zipkin/Recording/Span.php b/src/Zipkin/Recording/Span.php
@@ -268,7 +268,7 @@ public function setRemoteEndpoint(Endpoint $remoteEndpoint): void
      *
      * @param int|null $finishTimestamp
      */
-    public function finish(int $finishTimestamp = null): void
+    public function finish(?int $finishTimestamp = null): void
     {
         if ($this->finished) {
             return;
diff --git a/src/Zipkin/Reporters/Http.php b/src/Zipkin/Reporters/Http.php
@@ -51,9 +51,9 @@ final class Http implements Reporter
      */
     public function __construct(
         array $options = [],
-        ClientFactory $requesterFactory = null,
-        LoggerInterface $logger = null,
-        SpanSerializer $serializer = null
+        ?ClientFactory $requesterFactory = null,
+        ?LoggerInterface $logger = null,
+        ?SpanSerializer $serializer = null
     ) {
         $this->options = \array_merge(self::DEFAULT_OPTIONS, $options);
         $this->clientFactory = $requesterFactory ?? CurlFactory::create();
diff --git a/src/Zipkin/Reporters/JsonV2Serializer.php b/src/Zipkin/Reporters/JsonV2Serializer.php
@@ -13,7 +13,7 @@ class JsonV2Serializer implements SpanSerializer
 {
     private ErrorParser $errorParser;
 
-    public function __construct(ErrorParser $errorParser = null)
+    public function __construct(?ErrorParser $errorParser = null)
     {
         $this->errorParser = $errorParser ?? new DefaultErrorParser();
     }
diff --git a/src/Zipkin/Reporters/Log.php b/src/Zipkin/Reporters/Log.php
@@ -16,7 +16,7 @@ final class Log implements Reporter
 
     public function __construct(
         LoggerInterface $logger,
-        SpanSerializer $serializer = null
+        ?SpanSerializer $serializer = null
     ) {
         $this->logger = $logger;
         $this->serializer = $serializer ?? new JsonV2Serializer();
diff --git a/src/Zipkin/Span.php b/src/Zipkin/Span.php
@@ -25,7 +25,7 @@ public function getContext(): TraceContext;
      * Spans can be modified before calling start. For example, you can add tags to the span and
      * set its name without lock contention.
      */
-    public function start(int $timestamp = null): void;
+    public function start(?int $timestamp = null): void;
 
     /**
      * Sets the string name for the logical operation this span represents.
@@ -67,7 +67,7 @@ public function setError(Throwable $e): void;
      * @return void
      * @see Annotations
      */
-    public function annotate(string $value, int $timestamp = null): void;
+    public function annotate(string $value, ?int $timestamp = null): void;
 
     /**
      * For a client span, this would be the server's address.
@@ -95,7 +95,7 @@ public function abandon(): void;
      * @param int|null $timestamp
      * @return void
      */
-    public function finish(int $timestamp = null): void;
+    public function finish(?int $timestamp = null): void;
 
     /**
      * Reports the span, even if unfinished. Most users will not call this method.
diff --git a/src/Zipkin/SpanCustomizer.php b/src/Zipkin/SpanCustomizer.php
@@ -41,5 +41,5 @@ public function tag(string $key, string $value): void;
      * @return void
      * @see Annotations
      */
-    public function annotate(string $value, int $timestamp = null): void;
+    public function annotate(string $value, ?int $timestamp = null): void;
 }
diff --git a/src/Zipkin/SpanCustomizerShield.php b/src/Zipkin/SpanCustomizerShield.php
@@ -37,7 +37,7 @@ public function tag(string $key, string $value): void
     /**
      * {@inheritdoc}
      */
-    public function annotate(string $value, int $timestamp = null): void
+    public function annotate(string $value, ?int $timestamp = null): void
     {
         $this->delegate->annotate($value, $timestamp);
     }
diff --git a/src/Zipkin/Tracer.php b/src/Zipkin/Tracer.php
@@ -73,7 +73,7 @@ public function __construct(
      * @param SamplingFlags $samplingFlags
      * @return Span
      */
-    public function newTrace(SamplingFlags $samplingFlags = null): Span
+    public function newTrace(?SamplingFlags $samplingFlags = null): Span
     {
         if ($samplingFlags === null) {
             $samplingFlags = DefaultSamplingFlags::createAsEmpty();
@@ -139,7 +139,7 @@ public function joinSpan(TraceContext $context): Span
      *
      * @return callable():void The scope closer
      */
-    public function openScope(Span $span = null): callable
+    public function openScope(?Span $span = null): callable
     {
         return $this->currentTraceContext->createScopeAndRetrieveItsCloser(
             $span === null ? null : $span->getContext()
@@ -193,7 +193,7 @@ public function flush(): void
      * @return Span
      * @throws \RuntimeException
      */
-    public function nextSpan(SamplingFlags $contextOrFlags = null): Span
+    public function nextSpan(?SamplingFlags $contextOrFlags = null): Span
     {
         if ($contextOrFlags === null) {
             $parent = $this->currentTraceContext->getContext();
@@ -230,7 +230,7 @@ public function nextSpan(SamplingFlags $contextOrFlags = null): Span
     public function nextSpanWithSampler(
         callable $sampler,
         array $args = [],
-        SamplingFlags $contextOrFlags = null
+        ?SamplingFlags $contextOrFlags = null
     ): Span {
         if ($contextOrFlags === null) {
             $contextOrFlags = $this->currentTraceContext->getContext();
diff --git a/tests/Integration/Instrumentation/Mysqli/MysqliTest.php b/tests/Integration/Instrumentation/Mysqli/MysqliTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace ZipkinTests\Integration\Instrumentation\Http\Server;
+namespace ZipkinTests\Integration\Instrumentation\Mysqli;
 
 use Zipkin\Tracer;
 use Zipkin\Samplers\BinarySampler;
@@ -20,12 +20,12 @@ final class MysqliTest extends TestCase
     private static function launchMySQL(): array
     {
         shell_exec('docker rm -f zipkin_php_mysql_test');
-        shell_exec(sprintf('cd %s; docker-compose up -d', __DIR__));
+        shell_exec(sprintf('cd %s; docker compose up -d', __DIR__));
         echo "Waiting for MySQL container to be up.\n";
         while (true) {
             $res = shell_exec('docker ps --filter "name=zipkin_php_mysql_test" --format "{{.Status}}"');
             usleep(500000);
-            if (strpos($res, "healthy") !== false) {
+            if ($res !== null && strpos($res, "healthy") !== false) {
                 echo "MySQL container is up.\n";
                 break;
             }
@@ -38,14 +38,14 @@ private static function launchMySQL(): array
         $port = 3306;
 
         return [[$host, $user, $pass, $db, $port], function () {
-            shell_exec(sprintf('cd %s; docker-compose stop', __DIR__));
+            shell_exec(sprintf('cd %s; docker compose stop', __DIR__));
         }];
     }
 
     public function testConnect()
     {
-        if (PHP_OS_FAMILY === 'Windows') {
-            $this->markTestSkipped("Running the test on windows might be problematic");
+        if (PHP_OS_FAMILY !== 'Linux') {
+            $this->markTestSkipped("Running the test on non-Linux systems might be problematic");
         }
 
         if (!extension_loaded("mysqli")) {
diff --git a/tests/Unit/Instrumentation/Http/Client/BaseRequestTestCase.php b/tests/Unit/Instrumentation/Http/Client/BaseRequestTestCase.php
@@ -7,7 +7,7 @@
 use Zipkin\Instrumentation\Http\Client\Request;
 use PHPUnit\Framework\TestCase;
 
-abstract class BaseRequestTest extends TestCase
+abstract class BaseRequestTestCase extends TestCase
 {
     /**
      * @return mixed[] including
diff --git a/tests/Unit/Instrumentation/Http/Client/BaseResponseTestCase.php b/tests/Unit/Instrumentation/Http/Client/BaseResponseTestCase.php
diff --git a/tests/Unit/Instrumentation/Http/Client/Psr18/RequestTestCase.php b/tests/Unit/Instrumentation/Http/Client/Psr18/RequestTestCase.php
diff --git a/tests/Unit/Instrumentation/Http/Client/Psr18/ResponseTestCase.php b/tests/Unit/Instrumentation/Http/Client/Psr18/ResponseTestCase.php
diff --git a/tests/Unit/Instrumentation/Http/Server/BaseRequestTestCase.php b/tests/Unit/Instrumentation/Http/Server/BaseRequestTestCase.php
diff --git a/tests/Unit/Instrumentation/Http/Server/BaseResponseTestCase.php b/tests/Unit/Instrumentation/Http/Server/BaseResponseTestCase.php
diff --git a/tests/Unit/Instrumentation/Http/Server/Psr15/MiddlewareTest.php b/tests/Unit/Instrumentation/Http/Server/Psr15/MiddlewareTest.php
diff --git a/tests/Unit/Instrumentation/Http/Server/Psr15/RequestTestCase.php b/tests/Unit/Instrumentation/Http/Server/Psr15/RequestTestCase.php
diff --git a/tests/Unit/Instrumentation/Http/Server/Psr15/ResponseTestCase.php b/tests/Unit/Instrumentation/Http/Server/Psr15/ResponseTestCase.php
diff --git a/tests/Unit/SpanCustomizerShieldSpan.php b/tests/Unit/SpanCustomizerShieldSpan.php
diff --git a/tests/Unit/SpanCustomizerShieldTest.php b/tests/Unit/SpanCustomizerShieldTest.php

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function getContext(): TraceContext`
`37`	`37`	`* Spans can be modified before calling start. For example, you can add tags to the span and`
`38`	`38`	`* set its name without lock contention.`
`39`	`39`	`*/`
`40`		`- public function start(int $timestamp = null): void`
	`40`	`+ public function start(?int $timestamp = null): void`
`41`	`41`	`{`
`42`	`42`	`}`
`43`	`43`
`@@ -87,7 +87,7 @@ public function setError(Throwable $e): void`
`87`	`87`	`* @return void`
`88`	`88`	`* @see Annotations`
`89`	`89`	`*/`
`90`		`- public function annotate(string $value, int $timestamp = null): void`
	`90`	`+ public function annotate(string $value, ?int $timestamp = null): void`
`91`	`91`	`{`
`92`	`92`	`}`
`93`	`93`
`@@ -113,7 +113,7 @@ public function abandon(): void`
`113`	`113`	`* {@link zipkin.Span#duration Zipkin's span duration} is derived by subtracting the start`
`114`	`114`	`* timestamp from this, and set when appropriate.`
`115`	`115`	`*/`
`116`		`- public function finish(int $timestamp = null): void`
	`116`	`+ public function finish(?int $timestamp = null): void`
`117`	`117`	`{`
`118`	`118`	`}`
`119`	`119`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public function tag(string $key, string $value): void`
`23`	`23`	`/**`
`24`	`24`	`* {@inheritdoc}`
`25`	`25`	`*/`
`26`		`- public function annotate(string $value, int $timestamp = null): void`
	`26`	`+ public function annotate(string $value, ?int $timestamp = null): void`
`27`	`27`	`{`
`28`	`28`	`}`
`29`	`29`	`}`