Increase Phpstan Level to 9 (#21)

* Update .gitignore

* Add some Types

* Make Phpstan happy

* Handle Models that no longer exist

Author: stefanzweifel

.gitignore

@@ -2,6 +2,7 @@
 .php_cs
 .php_cs.cache
 .phpunit.result.cache
+.phpunit.cache/test-results
 build
 composer.lock
 coverage

phpstan.neon.dist

@@ -2,7 +2,7 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 8
+    level: 9
     paths:
         - src
         - config
@@ -11,4 +11,5 @@ parameters:
     checkOctaneCompatibility: true
     checkModelProperties: true
     checkMissingIterableValueType: false
+    checkGenericClassInNonGenericObjectType: false
 

src/Listeners/AttachSendUuidListener.php

@@ -11,10 +11,13 @@ class AttachSendUuidListener
 {
     public function handle(MessageSending $event): void
     {
-        if ($event->message->getHeaders()->has(config('sends.headers.send_uuid'))) {
+        /** @var string $sendUuidHeader */
+        $sendUuidHeader = config('sends.headers.send_uuid');
+
+        if ($event->message->getHeaders()->has($sendUuidHeader)) {
             return;
         }
 
-        $event->message->getHeaders()->addTextHeader(config('sends.headers.send_uuid'), Str::uuid()->toString());
+        $event->message->getHeaders()->addTextHeader($sendUuidHeader, Str::uuid()->toString());
     }
 }

src/Listeners/StoreOutgoingMailListener.php

@@ -26,7 +26,10 @@ public function handle(MessageSent $event): void
 
     protected function createSendModel(MessageSent $event): Send
     {
-        return config('sends.send_model')::forceCreate(
+        /** @var Send $modelClass */
+        $modelClass = config('sends.send_model');
+
+        return $modelClass::forceCreate(
             $this->getSendAttributes($event, $this->getDefaultSendAttributes($event))
         );
     }
@@ -55,15 +58,18 @@ protected function getDefaultSendAttributes(MessageSent $event): array
 
     protected function getSendUuid(MessageSent $event): ?string
     {
-        if (config('sends.headers.send_uuid') === 'Message-ID') {
+        /** @var string $sendUuidHeader */
+        $sendUuidHeader = config('sends.headers.send_uuid');
+
+        if ($sendUuidHeader === 'Message-ID') {
             return $event->sent->getMessageId();
         }
 
-        if (! $event->message->getHeaders()->has(config('sends.headers.send_uuid'))) {
+        if (! $event->message->getHeaders()->has($sendUuidHeader)) {
             return null;
         }
 
-        $headerValue = $event->message->getHeaders()->get(config('sends.headers.send_uuid'));
+        $headerValue = $event->message->getHeaders()->get($sendUuidHeader);
 
         if (is_null($headerValue)) {
             return null;
@@ -74,16 +80,20 @@ protected function getSendUuid(MessageSent $event): ?string
 
     protected function getMailClassHeaderValue(MessageSent $event): ?string
     {
-        if (! $event->message->getHeaders()->has(config('sends.headers.mail_class'))) {
+        /** @var string $mailClassHeader */
+        $mailClassHeader = config('sends.headers.mail_class');
+
+        if (! $event->message->getHeaders()->has($mailClassHeader)) {
             return null;
         }
 
-        $headerValue = $event->message->getHeaders()->get(config('sends.headers.mail_class'));
+        $headerValue = $event->message->getHeaders()->get($mailClassHeader);
 
         if (is_null($headerValue)) {
             return null;
         }
 
+        /** @phpstan-var string */
         return decrypt($headerValue->getBodyAsString());
     }
 
@@ -93,6 +103,7 @@ protected function getMailClassHeaderValue(MessageSent $event): ?string
     protected function attachModelsToSendModel(MessageSent $event, Send $send): void
     {
         $this->getModels($event)
+            /** @phpstan-ignore-next-line  */
             ->each(fn (HasSends $model) => $model->sends()->attach($send));
     }
 
@@ -101,25 +112,35 @@ protected function attachModelsToSendModel(MessageSent $event, Send $send): void
      */
     protected function getModels(MessageSent $event): Collection
     {
-        if (! $event->message->getHeaders()->has(config('sends.headers.models'))) {
+        /** @var string $modelsHeader */
+        $modelsHeader = config('sends.headers.models');
+
+        if (! $event->message->getHeaders()->has($modelsHeader)) {
             return collect([]);
         }
 
-        $headerValue = $event->message->getHeaders()->get(config('sends.headers.models'));
+        $headerValue = $event->message->getHeaders()->get($modelsHeader);
 
         if (is_null($headerValue)) {
             return collect([]);
         }
 
+        /** @var string $models */
         $models = decrypt($headerValue->getBodyAsString());
 
-        return collect(json_decode($models, true, 512, JSON_THROW_ON_ERROR))
-            ->map(function (array $tuple): Model {
+        /** @var array<array<string, mixed>> $modelsArray */
+        $modelsArray = json_decode($models, true, 512, JSON_THROW_ON_ERROR);
+
+        return collect($modelsArray)
+            ->map(function (array $tuple): ?Model {
+                /** @var Model $model */
                 $model = $tuple['model'];
                 $id = $tuple['id'];
 
+                /** @phpstan-var ?Model */
                 return $model::find($id);
             })
+            ->filter()
             ->filter(fn (Model $model) => (new ReflectionClass($model))->implementsInterface(HasSends::class));
     }
 
@@ -129,6 +150,7 @@ protected function getContent(MessageSent $event): ?string
             return null;
         }
 
+        /** @phpstan-ignore-next-line  */
         return $event->message->getHtmlBody();
     }
 

src/Models/Send.php

@@ -78,7 +78,7 @@ class Send extends Model
         'rejected_at' => 'immutable_datetime',
     ];
 
-    protected static function newFactory()
+    protected static function newFactory(): SendFactory
     {
         return new SendFactory();
     }

tests/Listeners/StoreOutgoingMailListenerTest.php

@@ -181,6 +181,37 @@
     ]);
 });
 
+it('attaches related models to a send model by passing arguments to associateWith method but discard models that no longer exist', function () {
+    $testModel = TestModel::create();
+    $anotherTestModel = AnotherTestModel::create();
+
+    $mailable = new TestMailWithRelatedModelsHeaderPassAsArguments($testModel, $anotherTestModel);
+
+    $testModel->delete();
+
+    Mail::to('[email protected]')
+        ->send($mailable);
+
+    assertDatabaseHas('sends', [
+        'mail_class' => null,
+        'subject' => '::subject::',
+        'to' => json_encode(['[email protected]' => null]),
+        'cc' => null,
+        'bcc' => null,
+        ['sent_at', '!=', null],
+    ]);
+    assertDatabaseMissing('sendables', [
+        'send_id' => 1,
+        'sendable_type' => TestModel::class,
+        'sendable_id' => 1,
+    ]);
+    assertDatabaseHas('sendables', [
+        'send_id' => 1,
+        'sendable_type' => AnotherTestModel::class,
+        'sendable_id' => 2,
+    ]);
+});
+
 it('attaches related models to a send model based on the public properties of the mail class', function () {
     $testModel = TestModel::create();