Queued emails: Handle non-submission saving webforms and cleanup

Author: jekuaitk

CHANGELOG.md

@@ -6,6 +6,12 @@ Nedenfor ses dato for release og beskrivelse af opgaver som er implementeret.
 
 ## [Under udvikling]
 
+## [4.2.2] 2025-05-07
+
+* OS2Forms kø emails
+  * Håndterede formularer der ikke gemmer indsendelser.
+  * Opdaterede fejlbeskeder.
+
 ## [4.2.1] 2025-05-06
 
 * Sikrede at OS2Forms attachment elementer bliver detekteret korrekt
@@ -633,7 +639,8 @@ og [OS2Forms 3.7.0](https://github.com/OS2Forms/os2forms/releases/tag/3.7.0)
 
 * GO borgersager
 
-[Under udvikling]: https://github.com/itk-dev/os2forms_selvbetjening/compare/4.2.1...HEAD
+[Under udvikling]: https://github.com/itk-dev/os2forms_selvbetjening/compare/4.2.2...HEAD
+[4.2.2]: https://github.com/itk-dev/os2forms_selvbetjening/compare/4.2.1...4.2.2
 [4.2.1]: https://github.com/itk-dev/os2forms_selvbetjening/compare/4.2.0...4.2.1
 [4.2.0]: https://github.com/itk-dev/os2forms_selvbetjening/compare/4.1.0...4.2.0
 [4.1.0]: https://github.com/itk-dev/os2forms_selvbetjening/compare/4.0.1...4.1.0

web/modules/custom/os2forms_queued_email/src/Plugin/AdvancedQueue/JobType/QueuedEmail.php

@@ -77,9 +77,6 @@ public function process(Job $job): JobResult {
       $payload = $job->getPayload();
       $message = json_decode($payload['message'], TRUE);
 
-      // Load the Webform submission entity by ID.
-      $submission = WebformSubmission::load($payload['submissionId']);
-
       // Gather filenames for os2forms attachments for deletion later.
       $os2formsAttachmentFilenames = [];
 
@@ -88,10 +85,15 @@ public function process(Job $job): JobResult {
         // Handle OS2Forms attachments.
         if (isset($attachment[self::OS2FORMS_QUEUED_EMAIL_CONFIG_NAME])) {
           $os2formsAttachmentFilenames[] = $attachment[self::OS2FORMS_QUEUED_EMAIL_CONFIG_NAME];
+
+          if (FALSE === file_exists($attachment[self::OS2FORMS_QUEUED_EMAIL_CONFIG_NAME])) {
+            throw new \Exception('OS2Forms attachment file not found: ' . $attachment[self::OS2FORMS_QUEUED_EMAIL_CONFIG_NAME]);
+          }
+
           $attachment[self::FILECONTENT] = file_get_contents($attachment[self::OS2FORMS_QUEUED_EMAIL_CONFIG_NAME]);
 
           if (FALSE === $attachment[self::FILECONTENT]) {
-            throw new \Exception('OS2Forms attachment file not found: ' . $attachment[self::OS2FORMS_QUEUED_EMAIL_CONFIG_NAME]);
+            throw new \Exception('OS2Forms attachment file cannot be read: ' . $attachment[self::OS2FORMS_QUEUED_EMAIL_CONFIG_NAME]);
           }
 
           unset($attachment[self::OS2FORMS_QUEUED_EMAIL_CONFIG_NAME]);
@@ -110,42 +112,56 @@ public function process(Job $job): JobResult {
 
       }
 
-      $this->mailManager->createInstance('SMTPMailSystem')->mail($message);
+      $result = $this->mailManager->createInstance('SMTPMailSystem')->mail($message);
 
-      $logger_context = [
-        'handler_id' => 'os2forms_queued_email',
-        'channel' => 'webform_submission',
-        'webform_submission' => $submission,
-        'operation' => 'email sent',
-      ];
+      // Logging of failed mail is handled in catch.
+      if (!$result) {
+        throw new \Exception('Failed sending email');
+      }
 
-      $this->submissionLogger->notice($this->t('The submission #@serial was successfully delivered', ['@serial' => $submission->serial()]), $logger_context);
+      // Load the Webform submission entity by ID.
+      // Be aware that some webforms may be configured to NOT save submissions,
+      // submission may therefore be null.
+      $submission = WebformSubmission::load($payload['submissionId']);
+
+      if ($submission) {
+        $logger_context = [
+          'handler_id' => 'os2forms_queued_email',
+          'channel' => 'webform_submission',
+          'webform_submission' => $submission,
+          'operation' => 'email sent',
+        ];
+
+        $this->submissionLogger->notice($this->t('The submission #@serial was successfully delivered', ['@serial' => $submission->serial()]), $logger_context);
+      }
 
       // Remove OS2Forms attachments.
       foreach ($os2formsAttachmentFilenames as $os2formsAttachmentFilename) {
         unlink($os2formsAttachmentFilename);
       }
 
-      $msg = sprintf('Email, %s, sent to %s. Webform id: %s.', $message['subject'], $message['to'], $submission->getWebform()->id());
+      $msg = sprintf('Email, %s, sent to %s. Webform id: %s.', $payload['subject'] ?? NULL, $payload['to'] ?? NULL, $payload['webformId'] ?? NULL);
       $this->auditLogger->info('Email', $msg);
 
       return JobResult::success();
     }
     catch (\Exception $e) {
 
-      $submission = $payload['submissionId'] ? WebformSubmission::load($payload['submissionId']) : NULL;
-
-      $logger_context = [
-        'handler_id' => 'os2forms_queued_email',
-        'channel' => 'webform_submission',
-        'webform_submission' => $submission,
-        'operation' => 'email failed',
-      ];
+      $submission = WebformSubmission::load($payload['submissionId']);
 
-      $this->submissionLogger->error($this->t('The submission #@serial failed (@message)', [
-        '@serial' => $submission?->serial(),
-        '@message' => $e->getMessage(),
-      ]), $logger_context);
+      if ($submission) {
+        $logger_context = [
+          'handler_id' => 'os2forms_queued_email',
+          'channel' => 'webform_submission',
+          'webform_submission' => $submission,
+          'operation' => 'email failed',
+        ];
+
+        $this->submissionLogger->error($this->t('The submission #@serial failed (@message)', [
+          '@serial' => $submission->serial(),
+          '@message' => $e->getMessage(),
+        ]), $logger_context);
+      }
 
       return JobResult::failure($e->getMessage());
     }

web/modules/custom/os2forms_queued_email/src/Plugin/Mail/QueuedSmtpPhpMail.php

@@ -115,7 +115,9 @@ public function mail(array $message) {
         'key' => $message['key'],
         'to' => $message['to'],
         'subject' => $message['subject'],
+        // Note that submissions may not exist later when job is processed.
         'submissionId' => $submission->id(),
+        'webformId' => $submission->getWebform()->id(),
         'message' => json_encode($message),
       ]);