Merge pull request #12 from BinaryKitten/pstan-8

PStan level 8

Author: craigpotter

.gitignore

@@ -9,3 +9,4 @@ phpstan.neon
 testbench.yaml
 vendor
 node_modules
+pstan-error.json

config/barstool.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
 
     /*

database/factories/BarstoolFactory.php

@@ -1,17 +1,25 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CraigPotter\Barstool\Database\Factories;
 
 use CraigPotter\Barstool\Models\Barstool;
 use Saloon\Http\Connectors\NullConnector;
 use Illuminate\Database\Eloquent\Factories\Factory;
 use CraigPotter\Barstool\Tests\Fixtures\Requests\SoloUserRequest;
 
+/**
+ * @extends Factory<Barstool>
+ */
 class BarstoolFactory extends Factory
 {
     protected $model = Barstool::class;
 
-    public function definition()
+    /**
+     * @return array<string, mixed>
+     */
+    public function definition(): array
     {
         return [
             'uuid' => $this->faker->uuid,

phpstan.neon.dist

@@ -2,7 +2,7 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 5
+    level: 8
     paths:
         - src
         - config

pint.json

@@ -1,6 +1,7 @@
 {
     "preset": "laravel",
     "rules": {
-        "ordered_imports": {"sort_algorithm":"length"}
+        "ordered_imports": {"sort_algorithm":"length"},
+        "declare_strict_types": true
     }
 }

src/Barstool.php

@@ -1,11 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CraigPotter\Barstool;
 
 use Saloon\Http\Response;
 use Illuminate\Support\Str;
 use InvalidArgumentException;
 use Saloon\Http\PendingRequest;
+use Psr\Http\Message\UriInterface;
+use Saloon\Contracts\Body\BodyRepository;
 use Saloon\Repositories\Body\StreamBodyRepository;
 use Saloon\Exceptions\Request\FatalRequestException;
 
@@ -44,6 +48,17 @@ public static function record(PendingRequest|Response|FatalRequestException $dat
         };
     }
 
+    /**
+     * @return array{
+     *      connector_class: class-string,
+     *      request_class: class-string,
+     *      method: string,
+     *      url: string,
+     *      request_headers: array<string, string>|null,
+     *      request_body: BodyRepository|string|null,
+     *      successful: false
+     * }
+     */
     private static function getRequestData(PendingRequest $request): array
     {
         $body = $request->body();
@@ -63,6 +78,16 @@ private static function getRequestData(PendingRequest $request): array
         ];
     }
 
+    /**
+     * @return array{
+     *      url: UriInterface,
+     *      status: 'failed'|'successful',
+     *      response_headers: array<string, mixed>,
+     *      response_body: string,
+     *      response_status: int,
+     *      successful: bool
+     * }
+     */
     private static function getResponseData(Response $response): array
     {
         $responseBody = self::getResponseBody($response);
@@ -77,6 +102,17 @@ private static function getResponseData(Response $response): array
         ];
     }
 
+    /**
+     * @return array{
+     *      url: UriInterface,
+     *      status: 'fatal',
+     *      response_headers: null,
+     *      response_body: null,
+     *      response_status: null,
+     *      successful: false,
+     *      fatal_error: string
+     * }
+     */
     private static function getFatalData(FatalRequestException $exception): array
     {
         return [
@@ -102,14 +138,16 @@ private static function recordRequest(PendingRequest $data): void
         $entry->save();
     }
 
-    private static function recordResponse(Response|PendingRequest $data): void
+    private static function recordResponse(Response $data): void
     {
-        $uuid = $data->getPsrRequest()->getHeader('X-Barstool-UUID')[0] ?? null;
+        $psrRequest = $data->getPsrRequest();
+
+        $uuid = $psrRequest->getHeader('X-Barstool-UUID')[0] ?? null;
         if (is_null($uuid)) {
             return;
         }
 
-        $entry = Models\Barstool::where('uuid', $uuid)->first();
+        $entry = Models\Barstool::query()->firstWhere('uuid', $uuid);
 
         if ($entry) {
             $entry->fill([
@@ -120,20 +158,22 @@ private static function recordResponse(Response|PendingRequest $data): void
         }
     }
 
-    /**
-     * @param  Response|PendingRequest  $data
-     */
-    public static function calculateDuration(Response|PendingRequest|FatalRequestException $data): mixed
+    public static function calculateDuration(Response|PendingRequest $data): int
     {
-        return $data->getConnector()->config()->get('barstool-response-time', microtime(true) * 1000) - $data->getConnector()->config()->get('barstool-request-time');
+        $config = $data->getConnector()->config();
+
+        $requestTime = (int) $config->get('barstool-request-time');
+        $responseTime = (int) $config->get('barstool-response-time', microtime(true) * 1000);
+
+        return $responseTime - $requestTime;
     }
 
     private static function recordFatal(FatalRequestException $data): void
     {
         $pendingRequest = $data->getPendingRequest();
         $uuid = $pendingRequest->headers()->get('X-Barstool-UUID');
 
-        $entry = Models\Barstool::where('uuid', $uuid)->first();
+        $entry = Models\Barstool::query()->firstWhere('uuid', $uuid);
 
         if ($entry) {
             $entry->fill([
@@ -147,7 +187,7 @@ private static function recordFatal(FatalRequestException $data): void
     /**
      * Get the supported content types for response bodies.
      *
-     * @return array<string>
+     * @return string[]
      */
     private static function supportedContentTypes(): array
     {
@@ -160,6 +200,9 @@ private static function supportedContentTypes(): array
         ];
     }
 
+    /**
+     * @return array<string, string>|null
+     */
     public static function getRequestHeaders(PendingRequest $request): ?array
     {
         $excludedHeaders = config('barstool.excluded_request_headers', []);

src/BarstoolServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CraigPotter\Barstool;
 
 use Saloon\Config;
@@ -21,7 +23,7 @@ public function configurePackage(Package $package): void
             ->hasMigration('create_barstools_table');
     }
 
-    public function packageRegistered()
+    public function packageRegistered(): void
     {
         Config::globalMiddleware()
             ->onFatalException(function (FatalRequestException $exception) {

src/Models/Barstool.php

@@ -1,27 +1,28 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CraigPotter\Barstool\Models;
 
+use Carbon\CarbonInterface;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\MassPrunable;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use CraigPotter\Barstool\Database\Factories\BarstoolFactory;
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 
 /**
  * @property string $uuid
+ * @property CarbonInterface $created_at
  */
 class Barstool extends Model
 {
+    /** @use HasFactory<BarstoolFactory> */
     use HasFactory;
-    use MassPrunable;
-
-    const UPDATED_AT = null;
 
-    public function __construct(array $attributes = [])
-    {
-        parent::__construct($attributes);
+    use MassPrunable;
 
-        $this->setConnection(config('barstool.connection'));
-    }
+    public const string|null UPDATED_AT = null;
 
     protected $fillable = [
         'connector_class',
@@ -44,11 +45,28 @@ public function __construct(array $attributes = [])
         'successful' => 'boolean',
     ];
 
+    /**
+     * @param  array<string, mixed>  $attributes
+     */
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+
+        $this->setConnection(config('barstool.connection'));
+    }
+
     /**
      * Get the prunable model query.
+     *
+     * @return EloquentBuilder<static>
      */
-    public function prunable()
+    public function prunable(): EloquentBuilder
     {
-        return static::where('created_at', '<=', now()->subDays(config('barstool.keep_for_days')));
+        return static::query()
+            ->where(
+                'created_at',
+                '<=',
+                now()->subDays(config('barstool.keep_for_days', 0))
+            );
     }
 }

tests/ArchTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 it('will not use debugging functions')
     ->expect(['dd', 'dump', 'ray'])
     ->each->not->toBeUsed();

tests/BarstoolTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use Saloon\Http\Faking\MockClient;
 use Saloon\Http\Faking\MockResponse;
 use Illuminate\Support\Facades\Artisan;