Modernize codebase

- Require PHP 8.3
- Require Laravel 11
- Require Laravel Telescope 5
- Replace phpcs with php-cs-fixer to be able to use the PER-CS standard
- Set phpstan to the highest level and enable bleeding edge
- Use type-safe config functions from Laravel 11

.github/workflows/analysis.yml

@@ -1,31 +1,26 @@
 name: Analysis
 
-on:
-  push:
-    paths:
-      - '**.php'
-      - 'phpstan.neon.dist'
-      - 'phpcs.xml'
+on: [push]
 
 jobs:
   phpstan:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: shivammathur/setup-php@v2
         with:
           php-version: '8.3'
-      - uses: ramsey/composer-install@v2
+      - uses: ramsey/composer-install@v3
       - name: Run PHPStan
-        run: ./vendor/bin/phpstan --error-format=github
+        run: vendor/bin/phpstan
 
-  phpcs:
+  php-cs-fixer:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: shivammathur/setup-php@v2
         with:
           php-version: '8.3'
-      - uses: ramsey/composer-install@v2
-      - name: Run PHP CodeSniffer
-        run: ./vendor/bin/phpcs
+      - uses: ramsey/composer-install@v3
+      - name: Run PHP-CS-Fixer
+        run: vendor/bin/php-cs-fixer check --diff

.github/workflows/tests.yml

@@ -1,16 +1,16 @@
 name: Tests
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   phpunit:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: shivammathur/setup-php@v2
         with:
           php-version: '8.3'
-      - uses: ramsey/composer-install@v2
+      - uses: ramsey/composer-install@v3
       - name: Run PHPUnit tests
-        run: ./vendor/bin/phpunit
+        run: vendor/bin/phpunit

.gitignore

@@ -2,3 +2,4 @@ vendor/
 build/
 composer.lock
 .phpunit.result.cache
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,13 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+    ->append([__FILE__])
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PER-CS' => true,
+    ])
+    ->setFinder($finder)
+;

README.md

@@ -16,12 +16,18 @@ composer require adriaanzon/laravel-telescope-monitor
 
 ## Configuration
 
-The configuration channel can be configured by adding `TELESCOPE_MONITOR_LOG_CHANNEL` to your dotenv file, for example:
+The log channel can be configured by adding `TELESCOPE_MONITOR_LOG_CHANNEL` to your dotenv file, for example:
 
 ```dotenv
 TELESCOPE_MONITOR_LOG_CHANNEL=slack
 ```
 
+In your local development environment, you'd typically disable Laravel Telescope Monitor by excluding `TELESCOPE_MONITOR_LOG_CHANNEL` from your .env file or setting it to null:
+
+```dotenv
+TELESCOPE_MONITOR_LOG_CHANNEL=null
+```
+
 To configure other options, you can publish the [configuration file][]:
 
 ```shell

composer.json

@@ -11,13 +11,14 @@
     ],
     "license": "MIT",
     "require": {
-        "php": "^8.1",
-        "laravel/telescope": "^4.7|^5.0"
+        "php": "^8.3",
+        "laravel/framework": "^11.0",
+        "laravel/telescope": "^5.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^7.1",
-        "phpstan/phpstan": "^1.4",
-        "squizlabs/php_codesniffer": "^3.6"
+        "friendsofphp/php-cs-fixer": "^3.51",
+        "larastan/larastan": "^2.9",
+        "orchestra/testbench": "^9.0"
     },
     "autoload": {
         "psr-4": {

phpstan-baseline.neon

@@ -0,0 +1,6 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Access to an undefined property Laravel\\\\Telescope\\\\Storage\\\\EntryModel\\:\\:\\$content\\.$#"
+			count: 1
+			path: src/TelescopeEntryRepository.php

phpstan.neon.dist

@@ -1,5 +1,12 @@
+includes:
+    - vendor/phpstan/phpstan/conf/bleedingEdge.neon
+    - vendor/larastan/larastan/extension.neon
+    - phpstan-baseline.neon
+
 parameters:
-    level: 4
+    level: 9
     paths:
         - src
         - config
+    databaseMigrationsPath:
+        - vendor/laravel/telescope/database/migrations

src/ReportFailedJobListener.php

@@ -13,7 +13,7 @@ class ReportFailedJobListener
 {
     public function handle(JobFailed $event): void
     {
-        if (! config('telescope.enabled') || ! config('telescope-monitor.report_failed_jobs')) {
+        if (! config()->boolean('telescope.enabled') || ! config()->boolean('telescope-monitor.report_failed_jobs')) {
             return;
         }
 
@@ -32,9 +32,9 @@ public function handle(JobFailed $event): void
      */
     public function recordException(Throwable $exception): void
     {
-        $trace = collect($exception->getTrace())->map(function ($item) {
-            return Arr::only($item, ['file', 'line']);
-        })->toArray();
+        $trace = collect($exception->getTrace())
+            ->map(fn(array $item) => Arr::only($item, ['file', 'line']))
+            ->toArray();
 
         Telescope::recordException(new IncomingExceptionEntry($exception, [
             'class' => get_class($exception),

src/TelescopeExceptionLogger.php

@@ -3,21 +3,19 @@
 namespace AdriaanZon\TelescopeMonitor;
 
 use Illuminate\Support\Facades\Log;
+use Laravel\Telescope\IncomingEntry;
 use Laravel\Telescope\IncomingExceptionEntry;
 
-class TelescopeExceptionLogger
+readonly class TelescopeExceptionLogger
 {
-    protected TelescopeEntryRepository $entryRepository;
-
-    public function __construct(TelescopeEntryRepository $entryRepository)
-    {
-        $this->entryRepository = $entryRepository;
-    }
+    public function __construct(protected TelescopeEntryRepository $entryRepository) {}
 
     /**
      * Log new exceptions to a given channel, with a URL to the Telescope entry. By checking
      * whether the latest entry with the same "family hash" wasn't marked as resolved, it
      * prevents flooding the channel with subsequent occurrences of the same exception.
+     *
+     * @param list<IncomingEntry> $entries
      */
     public function log(array $entries, ?string $channel = null): void
     {
@@ -26,18 +24,21 @@ public function log(array $entries, ?string $channel = null): void
                 Log::channel($channel)->error($entry->content['message'], [
                     'type' => $entry->content['class'],
                     'location' => $entry->content['file'] . ':' . $entry->content['line'],
-                    'details' => url(config('telescope.path') . '/exceptions/' . $entry->uuid),
+                    'details' => url(config()->string('telescope.path') . '/exceptions/' . $entry->uuid),
                 ]);
             }
         }
     }
 
+    /**
+     * @param list<IncomingEntry> $entries
+     */
     public function logToConfiguredChannel(array $entries): void
     {
-        if (blank($channel = config('telescope-monitor.log_channel'))) {
+        if (blank(config('telescope-monitor.log_channel'))) {
             return;
         }
 
-        $this->log($entries, $channel);
+        $this->log($entries, config()->string('telescope-monitor.log_channel'));
     }
 }

src/TelescopeMonitorServiceProvider.php

@@ -9,7 +9,7 @@
 
 class TelescopeMonitorServiceProvider extends ServiceProvider
 {
-    public function register()
+    public function register(): void
     {
         $this->publishes([__DIR__ . '/../config/telescope-monitor.php' => config_path('telescope-monitor.php')]);
 
@@ -20,7 +20,7 @@ public function register()
         );
     }
 
-    public function boot()
+    public function boot(): void
     {
         Event::listen(JobFailed::class, ReportFailedJobListener::class);
     }

tests/Integration/LogTest.php

@@ -3,23 +3,25 @@
 namespace Tests\Integration;
 
 use Exception;
+use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Support\Facades\Log;
 use Laravel\Telescope\ExceptionContext;
 use Laravel\Telescope\IncomingExceptionEntry;
 use Laravel\Telescope\Telescope;
+use Orchestra\Testbench\Attributes\DefineEnvironment;
 use Tests\TestCase;
 
 class LogTest extends TestCase
 {
     use RefreshDatabase;
 
-    protected function usesNullLogChannel($app)
+    protected function usesNullLogChannel(Application $app): void
     {
         $app['config']->set('telescope-monitor.log_channel', 'null');
     }
 
-    public function testExceptionsDontGetLoggedWithoutConfiguration()
+    public function testExceptionsDontGetLoggedWithoutConfiguration(): void
     {
         $exception = new Exception('whoops');
 
@@ -37,8 +39,8 @@ public function testExceptionsDontGetLoggedWithoutConfiguration()
         $this->app->call(Telescope::store(...));
     }
 
-    /** @define-env usesNullLogChannel */
-    public function testExceptionsGetLoggedToLogConfiguredChannel()
+    #[DefineEnvironment('usesNullLogChannel')]
+    public function testExceptionsGetLoggedToLogConfiguredChannel(): void
     {
         $exception = new Exception('whoops');
 
@@ -53,7 +55,7 @@ public function testExceptionsGetLoggedToLogConfiguredChannel()
 
         Log::shouldReceive('channel->error')->once()->with('whoops', [
             'type' => Exception::class,
-            'location' => __FILE__ . ':' . 43,
+            'location' => __FILE__ . ':' . 45,
             'details' => 'http://localhost/telescope/exceptions/' . $entry->uuid,
         ]);
 

tests/database/migrations/2022_03_17_213655_create_jobs_table.php

@@ -4,8 +4,7 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class () extends Migration {
     /**
      * Run the migrations.
      *