Merge branch 'v3' into feat/assert-sent-typehint

Author: Sammyjo20

.github/workflows/phpstan.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.3'
           coverage: none
 
       - name: Install composer dependencies

.github/workflows/tests.yml

@@ -24,7 +24,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ ubuntu-latest, windows-latest ]
-        php: [ 8.1, 8.2, 8.3 ]
+        php: [ 8.1, 8.2, 8.3, 8.4 ]
         stability: [ prefer-lowest, prefer-stable ]
 
     name: P${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Sam Carré
+Copyright (c) 2024 Sam Carré
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

composer.json

@@ -31,7 +31,7 @@
         "friendsofphp/php-cs-fixer": "^3.5",
         "illuminate/collections": "^9.39 || ^10.0",
         "league/flysystem": "^3.0",
-        "pestphp/pest": "^2.6",
+        "pestphp/pest": "^2.10",
         "phpstan/phpstan": "^1.11.4",
         "saloonphp/xml-wrangler": "^1.1",
         "spatie/ray": "^1.33",

phpstan.baseline.neon

@@ -20,11 +20,6 @@ parameters:
 			count: 1
 			path: src/Http/Faking/MockClient.php
 
-		-
-		 message: "#^Result of \\&\\& is always false.$#"
-		 count: 1
-		 path: src/Data/MultipartValue.php
-
 		-
 		 message: "#^Parameter \\#1 \\$response of method Saloon\\\\Http\\\\PendingRequest\\:\\:executeResponsePipeline\\(\\) expects Saloon\\\\Http\\\\Response\\, GuzzleHttp\\\\Promise\\\\PromiseInterface\\|Saloon\\\\Http\\\\Response given.$#"
 		 count: 1

src/Exceptions/InvalidResponseClassException.php

@@ -11,7 +11,7 @@ class InvalidResponseClassException extends SaloonException
     /**
      * Constructor
      */
-    public function __construct(string $message = null)
+    public function __construct(?string $message = null)
     {
         parent::__construct($message ?? sprintf('The provided response must exist and implement the %s contract.', Response::class));
     }

src/Exceptions/InvalidStateException.php

@@ -8,7 +8,7 @@
 
 class InvalidStateException extends SaloonException
 {
-    public function __construct(string $message = null, int $code = 0, ?Throwable $previous = null)
+    public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null)
     {
         parent::__construct($message ?? 'Invalid state.', $code, $previous);
     }

src/Exceptions/Request/Statuses/PaymentRequiredException.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Saloon\Exceptions\Request\Statuses;
+
+use Saloon\Exceptions\Request\ClientException;
+
+class PaymentRequiredException extends ClientException
+{
+    //
+}

src/Helpers/FixtureHelper.php

@@ -24,7 +24,7 @@ public static function recursivelyReplaceAttributes(array $source, array $rules,
 
         array_walk_recursive($source, static function (&$value, $key) use ($rules, $caseSensitiveKeys) {
             if ($caseSensitiveKeys === false) {
-                $key = mb_strtolower($key);
+                $key = mb_strtolower((string) $key);
             }
 
             if (! array_key_exists($key, $rules)) {

src/Helpers/MiddlewarePipeline.php

@@ -8,6 +8,7 @@
 use Saloon\Enums\PipeOrder;
 use Saloon\Http\PendingRequest;
 use Saloon\Contracts\FakeResponse;
+use Saloon\Exceptions\Request\FatalRequestException;
 
 class MiddlewarePipeline
 {
@@ -21,13 +22,19 @@ class MiddlewarePipeline
      */
     protected Pipeline $responsePipeline;
 
+    /**
+     * Fatal Pipeline
+     */
+    protected Pipeline $fatalPipeline;
+
     /**
      * Constructor
      */
     public function __construct()
     {
         $this->requestPipeline = new Pipeline;
         $this->responsePipeline = new Pipeline;
+        $this->fatalPipeline = new Pipeline;
     }
 
     /**
@@ -92,6 +99,33 @@ public function onResponse(callable $callable, ?string $name = null, ?PipeOrder
         return $this;
     }
 
+    /**
+     * Add a middleware to run on fatal errors
+     *
+     * @param callable(FatalRequestException): (void) $callable
+     * @return $this
+     */
+    public function onFatalException(callable $callable, ?string $name = null, ?PipeOrder $order = null): static
+    {
+        /**
+         * For some reason, PHP is not destructing non-static Closures, or 'things' using non-static Closures, correctly, keeping unused objects intact.
+         * Using a *static* Closure, or re-binding it to an empty, anonymous class/object is a workaround for the issue.
+         * If we don't, things using the MiddlewarePipeline, in turn, won't destruct.
+         * Concretely speaking, for Saloon, this means that the Connector will *not* get destructed, and thereby also not the underlying client.
+         * Which in turn leaves open file handles until the process terminates.
+         *
+         * Do note that this is entirely about our *wrapping* Closure below.
+         * The provided callable doesn't affect the MiddlewarePipeline.
+         */
+        $this->fatalPipeline->pipe(static function (FatalRequestException $throwable) use ($callable): FatalRequestException {
+            $callable($throwable);
+
+            return $throwable;
+        }, $name, $order);
+
+        return $this;
+    }
+
     /**
      * Process the request pipeline.
      */
@@ -108,6 +142,15 @@ public function executeResponsePipeline(Response $response): Response
         return $this->responsePipeline->process($response);
     }
 
+    /**
+     * Process the fatal pipeline.
+     * @throws \Saloon\Exceptions\Request\FatalRequestException
+     */
+    public function executeFatalPipeline(FatalRequestException $throwable): void
+    {
+        $this->fatalPipeline->process($throwable);
+    }
+
     /**
      * Merge in another middleware pipeline.
      *
@@ -125,8 +168,14 @@ public function merge(MiddlewarePipeline $middlewarePipeline): static
             $middlewarePipeline->getResponsePipeline()->getPipes()
         );
 
+        $fatalPipes = array_merge(
+            $this->getFatalPipeline()->getPipes(),
+            $middlewarePipeline->getFatalPipeline()->getPipes()
+        );
+
         $this->requestPipeline->setPipes($requestPipes);
         $this->responsePipeline->setPipes($responsePipes);
+        $this->fatalPipeline->setPipes($fatalPipes);
 
         return $this;
     }
@@ -146,4 +195,12 @@ public function getResponsePipeline(): Pipeline
     {
         return $this->responsePipeline;
     }
+
+    /**
+     * Get the fatal pipeline
+     */
+    public function getFatalPipeline(): Pipeline
+    {
+        return $this->fatalPipeline;
+    }
 }