fix(PHP): Fix compability warnings for PHP 8.4

pionl · pionl · commit ec74c5683c13 · 2025-05-17T15:42:30.000+02:00
BREAKING CHANGE: some of the method signatures has changed with null added. Check the code change
diff --git a/src/AbstractApi.php b/src/AbstractApi.php
@@ -77,7 +77,7 @@ public function shouldIgnoreLoggersOnException(): ?Closure
      *
      * @return T
      */
-    final protected function makeEndpoint(string $endpoint, string $implementation = null): EndpointInterface
+    final protected function makeEndpoint(string $endpoint, ?string $implementation = null): EndpointInterface
     {
         if (array_key_exists($endpoint, $this->cachedEndpoints) === false) {
             $endpoint = $this->getOverrideEndpointClassIfCan($endpoint, $implementation ?? $endpoint);
diff --git a/src/Actions/MakeApiFactory.php b/src/Actions/MakeApiFactory.php
@@ -27,7 +27,7 @@ public function __construct(
     /**
      * Builds API factory using http discovery package
      */
-    public function execute(LoggerConfigEntity $loggerConfig = null): ApiFactoryContract
+    public function execute(?LoggerConfigEntity $loggerConfig = null): ApiFactoryContract
     {
         $request = $this->containerOr(
             interface: RequestFactoryInterface::class,
diff --git a/src/Actions/SendRequestAction.php b/src/Actions/SendRequestAction.php
@@ -45,7 +45,7 @@ public function execute(
         array $headers = [],
         ?int $expectedResponseStatusCode = null,
         ?ResponseInterface $fakedResponse = null,
-        Closure $shouldIgnoreLoggersOnError = null,
+        ?Closure $shouldIgnoreLoggersOnError = null,
     ): AbstractResponse {
         $timeStart = (float) microtime(true);
 
@@ -168,7 +168,7 @@ private function getRequestDuration(float $timeStart): float
      * @param int|null                        $expectedResponseStatusCode Will raise and failed
      *                                                                                      exception if response
      *                                                                                      status code is different
-     * @param IgnoreLoggersOnExceptionClosure $shouldIgnoreLoggersOnError
+     * @param IgnoreLoggersOnExceptionClosure|null $shouldIgnoreLoggersOnError
      *
      * @return TResponse
      */
@@ -183,7 +183,7 @@ private function handleResponse(
         string $id,
         RequestInterface $request,
         float $timeStart,
-        Closure $shouldIgnoreLoggersOnError = null,
+        ?Closure $shouldIgnoreLoggersOnError = null,
     ): mixed {
         try {
             $container = $api->factory()
diff --git a/src/Contracts/SendRequestActionContract.php b/src/Contracts/SendRequestActionContract.php
@@ -26,7 +26,7 @@ interface SendRequestActionContract
      * @param int|null                                           $expectedResponseStatusCode Will raise and failed
      *                                                                                      exception if response
      *                                                                                      status code is different
-     * @param IgnoreLoggersOnExceptionClosure                    $shouldIgnoreLoggersOnError
+     * @param IgnoreLoggersOnExceptionClosure|null                    $shouldIgnoreLoggersOnError
      * @return TResponse
      */
     public function execute(
@@ -37,6 +37,6 @@ public function execute(
         array $headers = [],
         ?int $expectedResponseStatusCode = null,
         ?ResponseInterface $fakedResponse = null,
-        Closure $shouldIgnoreLoggersOnError = null
+        ?Closure $shouldIgnoreLoggersOnError = null
     ): AbstractResponse;
 }
diff --git a/src/Endpoints/AbstractEndpoint.php b/src/Endpoints/AbstractEndpoint.php
@@ -27,7 +27,7 @@
 abstract class AbstractEndpoint implements EndpointInterface
 {
     /**
-     * @var IgnoreLoggersOnExceptionClosure
+     * @var IgnoreLoggersOnExceptionClosure|null
      */
     private Closure|null $shouldIgnoreLoggersOnException = null;
 
@@ -142,7 +142,7 @@ final protected function sendGet(
     final protected function sendPost(
         string $responseClass,
         UriInterface $uri,
-        OptionsInterface|StreamInterface|string $body = null,
+        OptionsInterface|StreamInterface|string|null $body = null,
         array $headers = [],
         ?int $expectedResponseStatusCode = null,
     ): AbstractResponse {
@@ -177,10 +177,10 @@ final protected function sendPost(
     final protected function sendPut(
         string $responseClass,
         UriInterface $uri,
-        OptionsInterface|StreamInterface|string $body = null,
+        OptionsInterface|StreamInterface|string|null $body = null,
         array $headers = [],
         ?int $expectedResponseStatusCode = null,
-        Closure $shouldIgnoreLoggersOnError = null,
+        ?Closure $shouldIgnoreLoggersOnError = null,
     ): AbstractResponse {
         $request = $this->factory()
             ->request()
@@ -215,7 +215,7 @@ final protected function sendPut(
     final protected function sendDelete(
         string $responseClass,
         UriInterface $uri,
-        OptionsInterface|StreamInterface|string $body = null,
+        OptionsInterface|StreamInterface|string|null $body = null,
         array $headers = [],
         ?int $expectedResponseStatusCode = null,
     ): AbstractResponse {
@@ -255,7 +255,7 @@ final protected function sendFake(
         ResponseInterface $response,
         string $responseClass,
         UriInterface $uri,
-        OptionsInterface|StreamInterface|string $body = null,
+        OptionsInterface|StreamInterface|string|null $body = null,
         array $headers = [],
         ?int $expectedResponseStatusCode = null,
     ): AbstractResponse {
diff --git a/src/Endpoints/AbstractFakeEndpoint.php b/src/Endpoints/AbstractFakeEndpoint.php
@@ -40,7 +40,7 @@ protected function basePath(): string
     final protected function makeResponse(
         string $responseClass,
         GetValue|StreamInterface|null $responseBody = null,
-        OptionsInterface|StreamInterface|string $requestBody = null,
+        OptionsInterface|StreamInterface|string|null $requestBody = null,
         array $headers = [],
         ?int $expectedResponseStatusCode = null
     ): AbstractResponse {
diff --git a/src/Factories/ApiFactory.php b/src/Factories/ApiFactory.php
@@ -15,19 +15,15 @@
 
 class ApiFactory implements ApiFactoryContract
 {
-    private readonly LoggerConfigEntity $loggerConfig;
-
     public function __construct(
         private readonly RequestFactoryInterface $request,
         private readonly ClientInterface $client,
         private readonly StreamFactoryInterface $stream,
         private readonly SDKContainerFactoryContract $container,
         private readonly ResponseFactoryInterface $response,
         private readonly ?EventDispatcherInterface $eventDispatcher = null,
-        LoggerConfigEntity $loggerConfig = null,
+        private ?LoggerConfigEntity $loggerConfig = null
     ) {
-        // By, default no logging is used
-        $this->loggerConfig = $loggerConfig ?? new LoggerConfigEntity();
     }
 
     public function response(): ResponseFactoryInterface
@@ -62,6 +58,10 @@ public function eventDispatcher(): ?EventDispatcherInterface
 
     public function loggerConfig(): LoggerConfigEntity
     {
+        if (! $this->loggerConfig instanceof LoggerConfigEntity) {
+            $this->loggerConfig = new LoggerConfigEntity();
+        }
+
         return $this->loggerConfig;
     }
 }
diff --git a/src/Testing/Assertions/SendTestRequestActionAssert.php b/src/Testing/Assertions/SendTestRequestActionAssert.php
@@ -42,7 +42,7 @@ public function execute(
         array $headers = [],
         ?int $expectedResponseStatusCode = null,
         ?ResponseInterface $fakedResponse = null,
-        Closure $shouldIgnoreLoggersOnError = null,
+        ?Closure $shouldIgnoreLoggersOnError = null,
     ): TResponse {
         Assert::assertEquals(
             expected: 'https://test.localhost' . $this->expectedUri,
diff --git a/src/Testing/Factories/ApiFactoryMock.php b/src/Testing/Factories/ApiFactoryMock.php
@@ -22,8 +22,8 @@ class ApiFactoryMock implements ApiFactoryContract
 
     public function __construct(
         public readonly Client $mockClient = new Client(),
-        ResponseFactoryInterface $responseFactory = null,
-        RequestFactoryInterface $requestFactory = null,
+        ?ResponseFactoryInterface $responseFactory = null,
+        ?RequestFactoryInterface $requestFactory = null,
         public readonly ?EventDispatcherInterface $eventDispatcher = null,
         public readonly TestSDKContainerFactory $testSDKContainerFactory = new TestSDKContainerFactory(),
     ) {
diff --git a/tests/Endpoints/TestShouldIgnoreLoggersSendRequestActionAssert.php b/tests/Endpoints/TestShouldIgnoreLoggersSendRequestActionAssert.php
@@ -36,7 +36,7 @@ public function execute(
         array $headers = [],
         ?int $expectedResponseStatusCode = null,
         ?ResponseInterface $fakedResponse = null,
-        Closure $shouldIgnoreLoggersOnError = null
+        ?Closure $shouldIgnoreLoggersOnError = null
     ): AbstractResponse {
         Assert::assertNotNull($shouldIgnoreLoggersOnError, 'AbstractEndpoint always builds closure');
         Assert::assertEquals($this->expectedIgnoreLoggers, $shouldIgnoreLoggersOnError($this->testException));
diff --git a/tests/TestApi/Endpoints/Json/JsonEndpoint.php b/tests/TestApi/Endpoints/Json/JsonEndpoint.php
@@ -21,7 +21,7 @@ public function success(): JsonResponse
         return $this->sendGet(responseClass: JsonResponse::class, uri: $this->uri(), headers: $this->headers());
     }
 
-    public function store(OptionsInterface $body = null): JsonResponse
+    public function store(?OptionsInterface $body = null): JsonResponse
     {
         $this->expectResponse();
 

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public function shouldIgnoreLoggersOnException(): ?Closure`
`77`	`77`	`*`
`78`	`78`	`* @return T`
`79`	`79`	`*/`
`80`		`- final protected function makeEndpoint(string $endpoint, string $implementation = null): EndpointInterface`
	`80`	`+ final protected function makeEndpoint(string $endpoint, ?string $implementation = null): EndpointInterface`
`81`	`81`	`{`
`82`	`82`	`if (array_key_exists($endpoint, $this->cachedEndpoints) === false) {`
`83`	`83`	`$endpoint = $this->getOverrideEndpointClassIfCan($endpoint, $implementation ?? $endpoint);`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function __construct(`
`27`	`27`	`/**`
`28`	`28`	`* Builds API factory using http discovery package`
`29`	`29`	`*/`
`30`		`- public function execute(LoggerConfigEntity $loggerConfig = null): ApiFactoryContract`
	`30`	`+ public function execute(?LoggerConfigEntity $loggerConfig = null): ApiFactoryContract`
`31`	`31`	`{`
`32`	`32`	`$request = $this->containerOr(`
`33`	`33`	`interface: RequestFactoryInterface::class,`
Original file line number	Diff line number	Diff line change
`@@ -15,19 +15,15 @@`
`15`	`15`
`16`	`16`	`class ApiFactory implements ApiFactoryContract`
`17`	`17`	`{`
`18`		`- private readonly LoggerConfigEntity $loggerConfig;`
`19`		`-`
`20`	`18`	`public function __construct(`
`21`	`19`	`private readonly RequestFactoryInterface $request,`
`22`	`20`	`private readonly ClientInterface $client,`
`23`	`21`	`private readonly StreamFactoryInterface $stream,`
`24`	`22`	`private readonly SDKContainerFactoryContract $container,`
`25`	`23`	`private readonly ResponseFactoryInterface $response,`
`26`	`24`	`private readonly ?EventDispatcherInterface $eventDispatcher = null,`
`27`		`- LoggerConfigEntity $loggerConfig = null,`
	`25`	`+ private ?LoggerConfigEntity $loggerConfig = null`
`28`	`26`	`) {`
`29`		`- // By, default no logging is used`
`30`		`- $this->loggerConfig = $loggerConfig ?? new LoggerConfigEntity();`
`31`	`27`	`}`
`32`	`28`
`33`	`29`	`public function response(): ResponseFactoryInterface`
`@@ -62,6 +58,10 @@ public function eventDispatcher(): ?EventDispatcherInterface`
`62`	`58`
`63`	`59`	`public function loggerConfig(): LoggerConfigEntity`
`64`	`60`	`{`
	`61`	`+ if (! $this->loggerConfig instanceof LoggerConfigEntity) {`
	`62`	`+ $this->loggerConfig = new LoggerConfigEntity();`
	`63`	`+ }`
	`64`	`+`
`65`	`65`	`return $this->loggerConfig;`
`66`	`66`	`}`
`67`	`67`	`}`