Merge pull request #20 from itk-dev/hotfix/DW-553

DW-553: Handle missing submission

Author: rimi-itk

os2forms_digital_post.services.yml

@@ -9,4 +9,10 @@ services:
 
   os2forms_digital_post.webform_helper:
     class: Drupal\os2forms_digital_post\Helper\WebformHelper
-    arguments: ["@entity_type.manager", "@renderer", "@os2forms_cpr_lookup.service", "@os2forms_digital_post.print_service_consumer", "@os2forms_digital_post.template_manager"]
+    arguments:
+      - "@entity_type.manager"
+      - "@renderer"
+      - "@os2forms_cpr_lookup.service"
+      - "@os2forms_digital_post.print_service_consumer"
+      - "@os2forms_digital_post.template_manager"
+      - "@logger.factory"

src/Exception/SubmissionNotFoundException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Drupal\os2forms_digital_post\Exception;
+
+/**
+ * Submission not found exception.
+ */
+class SubmissionNotFoundException extends \Exception {
+
+}

src/Helper/WebformHelper.php

@@ -2,8 +2,10 @@
 
 namespace Drupal\os2forms_digital_post\Helper;
 
+use Drupal\Core\Logger\LoggerChannelFactoryInterface;
 use Drupal\os2forms_cpr_lookup\CPR\CprServiceResult;
 use Drupal\os2forms_digital_post\Exception\CprElementNotFoundInSubmissionException;
+use Drupal\os2forms_digital_post\Exception\SubmissionNotFoundException;
 use Drupal\webform\WebformSubmissionInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Render\Renderer;
@@ -51,15 +53,23 @@ final class WebformHelper {
    */
   protected $templateManager;
 
+  /**
+   * The logger.
+   *
+   * @var \Drupal\Core\Logger\LoggerChannelInterface
+   */
+  protected $logger;
+
   /**
    * Constructor.
    */
-  public function __construct(EntityTypeManagerInterface $entity_type_manager, Renderer $renderer, CprServiceInterface $cprService, PrintServiceConsumer $printServiceConsumer, TemplateManager $templateManager) {
+  public function __construct(EntityTypeManagerInterface $entity_type_manager, Renderer $renderer, CprServiceInterface $cprService, PrintServiceConsumer $printServiceConsumer, TemplateManager $templateManager, LoggerChannelFactoryInterface $loggerChannelFactory) {
     $this->entityTypeManager = $entity_type_manager;
     $this->renderer = $renderer;
     $this->cprService = $cprService;
     $this->printServiceConsumer = $printServiceConsumer;
     $this->templateManager = $templateManager;
+    $this->logger = $loggerChannelFactory->get('os2forms_digital_post');
   }
 
   /**
@@ -92,7 +102,7 @@ public function getTemplateContext(WebformSubmissionInterface $webformSubmission
     return [
       'label' => $webform->label(),
       'recipient' => $recipient,
-      'submission' => $webformSubmissionRendered
+      'submission' => $webformSubmissionRendered,
     ];
   }
 
@@ -104,19 +114,28 @@ public function getTemplateContext(WebformSubmissionInterface $webformSubmission
    * @param array $handlerConfiguration
    *   Handler config.
    *
-   * @throws CprElementNotFoundInSubmissionException
+   * @throws \Drupal\os2forms_digital_post\Exception\CprElementNotFoundInSubmissionException
+   * @throws \Drupal\os2forms_digital_post\Exception\SubmissionNotFoundException
    * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
    * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
    * @throws \ItkDev\Serviceplatformen\Service\Exception\ServiceException
    */
   public function sendDigitalPost(string $submissionId, array $handlerConfiguration) {
     /** @var \Drupal\webform\Entity\WebformSubmission $submission */
     $webform_submission = $this->getSubmission($submissionId);
+    if (empty($webform_submission)) {
+      $this->logger->error(
+        'Cannot load submission @submissionId',
+        ['@submissionId' => $submissionId]
+      );
+
+      throw new SubmissionNotFoundException(sprintf('Submission %s not found', $submissionId));
+    }
 
     $submissionData = $webform_submission->getData();
 
     if (!array_key_exists($handlerConfiguration['cpr_element'], $submissionData)) {
-      $this->getLogger()->error(
+      $this->logger->error(
         'The chosen CPR element not found in submission!'
       );
 
@@ -178,4 +197,5 @@ private function getSubmission(string $submissionId) {
     $storage = $this->entityTypeManager->getStorage('webform_submission');
     return $storage->load($submissionId);
   }
+
 }

src/Plugin/AdvancedQueue/JobType/SendDigitalPost.php

@@ -67,4 +67,3 @@ public function process(Job $job): JobResult {
   }
 
 }
-

src/Plugin/WebformHandler/DigitalPostWebformHandler.php

@@ -5,7 +5,6 @@
 use Drupal\advancedqueue\Job;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Render\Element;
-use Drupal\os2forms_digital_post\Exception\CprElementNotFoundInSubmissionException;
 use Drupal\os2forms_digital_post\Plugin\AdvancedQueue\JobType\SendDigitalPost;
 use Drupal\webform\Plugin\WebformHandlerBase;
 use Drupal\webform\WebformInterface;
@@ -308,6 +307,7 @@ public function postSave(WebformSubmissionInterface $webform_submission, $update
     /** @var \Drupal\advancedqueue\Entity\Queue $queue */
     $queue = $queueStorage->load('send_digital_post');
     $job = Job::create(SendDigitalPost::class, [
+      'formId' => $webform_submission->getWebform()->id(),
       'submissionId' => $webform_submission->id(),
       'handlerConfiguration' => $this->configuration,
     ]);