perf: add PHP 8.4 to test matrix (#218)

* Update honeybadger-php to play nice with PHP 8.4 * Update missing files * ci: add 8.4 to test matrix and fix tests * ci: do not prefer lowest * chore: remove changelog entry It will be added by the release action. --------- Co-authored-by: PuLLi <[email protected]>
honeybadger-io · Dec 9, 2024 · de5747f · de5747f
1 parent 3f84e54
commit de5747f
Show file tree

Hide file tree

Showing 12 changed files with 35 additions and 24 deletions.
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -12,10 +12,11 @@ jobs:
     strategy:
       matrix:
         composer-flags: ["--prefer-stable", "--prefer-lowest"]
-        php-versions: ['7.3', '7.4', '8.0', '8.1', '8.2']
+        php-versions: ['7.3', '7.4', '8.0', '8.1', '8.2', '8.4']
         exclude:
           - {php-versions: '8.1', composer-flags: "--prefer-lowest"}
           - {php-versions: '8.2', composer-flags: "--prefer-lowest"}
+          - {php-versions: '8.4', composer-flags: "--prefer-lowest"}
     name: PHP ${{ matrix.php-versions }} Tests (${{ matrix.composer-flags }})
     steps:
     - name: Checkout

diff --git a/src/CheckInsClientWithErrorHandling.php b/src/CheckInsClientWithErrorHandling.php
@@ -18,7 +18,7 @@ class CheckInsClientWithErrorHandling
      */
     private $baseClient;
 
-    public function __construct(Config $config, Client $httpClient = null)
+    public function __construct(Config $config, ?Client $httpClient = null)
     {
         $this->config = $config;
         $this->baseClient = new CheckInsClient($config, $httpClient);

diff --git a/src/CheckInsManager.php b/src/CheckInsManager.php
@@ -24,7 +24,7 @@ class CheckInsManager implements SyncCheckIns {
      * @param array $config
      * @param CheckInsClient|null $client
      */
-    public function __construct(array $config, CheckInsClient $client = null) {
+    public function __construct(array $config, ?CheckInsClient $client = null) {
         $this->config = new Config($config);
         $this->client = $client ?? new CheckInsClient($this->config);
     }

diff --git a/src/Contracts/ApiClient.php b/src/Contracts/ApiClient.php
@@ -20,9 +20,9 @@ abstract class ApiClient {
 
     /**
      * @param Config $config
-     * @param Client|null $httpClient
+     * @param ?Client $httpClient
      */
-    public function __construct(Config $config, Client $httpClient = null) {
+    public function __construct(Config $config, ?Client $httpClient = null) {
         $this->config = $config;
         $this->client = $httpClient ?? $this->makeClient();
     }

diff --git a/src/Contracts/Reporter.php b/src/Contracts/Reporter.php
@@ -9,13 +9,13 @@ interface Reporter
 {
     /**
      * @param  \Throwable  $throwable
-     * @param  \Symfony\Component\HttpFoundation\Request  $request
+     * @param  ?\Symfony\Component\HttpFoundation\Request  $request
      * @param  array  $additionalParams
      * @return array
      *
      * @throws \Honeybadger\Exceptions\ServiceException
      */
-    public function notify(Throwable $throwable, FoundationRequest $request = null, array $additionalParams = []): array;
+    public function notify(Throwable $throwable, ?FoundationRequest $request = null, array $additionalParams = []): array;
 
     /**
      * @param  array  $payload
@@ -89,7 +89,7 @@ public function clear(): self;
      *
      * @return void
      */
-    public function event($eventTypeOrPayload, array $payload = null): void;
+    public function event($eventTypeOrPayload, ?array $payload = null): void;
 
     /**
      * Flush all events from the queue.

diff --git a/src/Environment.php b/src/Environment.php
@@ -52,7 +52,7 @@ class Environment
      */
     protected $server = [];
 
-    public function __construct(array $server = null, array $env = null)
+    public function __construct(?array $server = null, ?array $env = null)
     {
         $this->server = array_merge(
             $server ?? $_SERVER,

diff --git a/src/ExceptionNotification.php b/src/ExceptionNotification.php
@@ -65,11 +65,11 @@ public function __construct(Config $config, Repository $context, Breadcrumbs $br
 
     /**
      * @param  \Throwable  $e
-     * @param  \Symfony\Component\HttpFoundation\Request  $request
+     * @param  ?\Symfony\Component\HttpFoundation\Request  $request
      * @param  array  $additionalParams
      * @return array
      */
-    public function make(Throwable $e, FoundationRequest $request = null, array $additionalParams = []): array
+    public function make(Throwable $e, ?FoundationRequest $request = null, array $additionalParams = []): array
     {
         $this->throwable = $e;
         $this->backtrace = $this->makeBacktrace();
@@ -138,10 +138,10 @@ private function makeBacktrace(): BacktraceFactory
     }
 
     /**
-     * @param  \Symfony\Component\HttpFoundation\Request  $request
+     * @param  ?\Symfony\Component\HttpFoundation\Request  $request
      * @return \Honeybadger\Request
      */
-    private function makeRequest(FoundationRequest $request = null): Request
+    private function makeRequest(?FoundationRequest $request = null): Request
     {
         return (new Request($request))
             ->filterKeys($this->config['request']['filter']);

diff --git a/src/Exceptions/ServiceException.php b/src/Exceptions/ServiceException.php
@@ -60,7 +60,7 @@ public static function unexpectedResponseCode(int $code): self
      * @param Throwable|null $e
      * @return self
      */
-    public static function generic(Throwable $e = null): self
+    public static function generic(?Throwable $e = null): self
     {
         $message = $e
             ? 'There was an error sending the payload to Honeybadger: '.$e->getMessage()

diff --git a/src/Handlers/ErrorHandler.php b/src/Handlers/ErrorHandler.php
@@ -32,7 +32,7 @@ public function register(): void
         $this->previousHandler = set_error_handler([$this, 'handle']);
     }
 
-    public function handle(int $level, string $error, string $file = null, int $line = null)
+    public function handle(int $level, string $error, ?string $file = null, ?int $line = null)
     {
         // When the @ operator is used, it temporarily changes `error_reporting()`'s return value
         // to reflect what error types should be reported. This means we should get 0 (no errors).

diff --git a/src/Honeybadger.php b/src/Honeybadger.php
@@ -68,7 +68,7 @@ class Honeybadger implements Reporter
      */
     protected $events;
 
-    public function __construct(array $config = [], Client $client = null, BulkEventDispatcher $eventsDispatcher = null)
+    public function __construct(array $config = [], ?Client $client = null, ?BulkEventDispatcher $eventsDispatcher = null)
     {
         $this->config = new Config($config);
 
@@ -84,7 +84,7 @@ public function __construct(array $config = [], Client $client = null, BulkEvent
     /**
      * {@inheritdoc}
      */
-    public function notify(Throwable $throwable, FoundationRequest $request = null, array $additionalParams = []): array
+    public function notify(Throwable $throwable, ?FoundationRequest $request = null, array $additionalParams = []): array
     {
         if (! $this->shouldReport($throwable)) {
             return [];
@@ -223,7 +223,7 @@ public function clear(): Reporter
     /**
      * {@inheritdoc}
      */
-    public function event($eventTypeOrPayload, array $payload = null): void
+    public function event($eventTypeOrPayload, ?array $payload = null): void
     {
         if (empty($this->config['api_key']) || ! $this->config['events']['enabled']) {
             return;

diff --git a/src/Request.php b/src/Request.php
@@ -15,10 +15,10 @@ class Request
     protected $request;
 
     /**
-     * @param  \Symfony\Component\HttpFoundation\Request  $request
+     * @param  ?\Symfony\Component\HttpFoundation\Request  $request
      * @param  array  $options
      */
-    public function __construct(FoundationRequest $request = null)
+    public function __construct(?FoundationRequest $request = null)
     {
         $this->request = $request ?? FoundationRequest::createFromGlobals();
 

diff --git a/tests/BacktraceFactoryTest.php b/tests/BacktraceFactoryTest.php
@@ -40,7 +40,12 @@ public function it_correctly_formats_annonymous_functions()
             $backtrace = (new BacktraceFactory($e, new Config))->trace();
         }
 
-        $this->assertEquals('Honeybadger\Tests\{closure}', $backtrace[0]['method']);
+        // if php version is 8.4.0 or higher, then we need to check for a more specific closure name
+        if (version_compare(PHP_VERSION, '8.4.0', '>=')) {
+            $this->assertEquals('{closure:Honeybadger\Tests\BacktraceFactoryTest::it_correctly_formats_annonymous_functions():33}', $backtrace[0]['method']);
+        } else {
+            $this->assertEquals('Honeybadger\Tests\{closure}', $backtrace[0]['method']);
+        }
         $this->assertEquals(['bar'], $backtrace[0]['args']);
     }
 
@@ -62,7 +67,7 @@ function throwTestException()
     }
 
     /** @test */
-    public function bactraces_send_class()
+    public function backtraces_send_class()
     {
         try {
             throw new Exception('test');
@@ -74,7 +79,7 @@ public function bactraces_send_class()
     }
 
     /** @test */
-    public function bactraces_send_type()
+    public function backtraces_send_type()
     {
         try {
             throw new Exception('test');
@@ -153,7 +158,12 @@ public function args_with_object_should_be_literals()
             $backtrace = (new BacktraceFactory($e, new Config))->trace();
         }
 
-        $this->assertEquals('Honeybadger\Tests\{closure}', $backtrace[0]['method']);
+        // if php version is 8.4.0 or higher, then we need to check for a more specific closure name
+        if (version_compare(PHP_VERSION, '8.4.0', '>=')) {
+            $this->assertEquals('{closure:Honeybadger\Tests\BacktraceFactoryTest::args_with_object_should_be_literals():151}', $backtrace[0]['method']);
+        } else {
+            $this->assertEquals('Honeybadger\Tests\{closure}', $backtrace[0]['method']);
+        }
         $this->assertEquals(['bar', '[LITERAL]Object('.TestClass::class.')'], $backtrace[0]['args']);
     }
 }