feat: allow to delay ticket email (#223)

Added delay for ticket email ( attendee ) if its a single order
and ticket is assigned to someone else.
this is configurable by new ENV var REGISTRATION_ATTENDEE_INVITATION_EMAIL_DELAY ( minutes )
default 10 minutes.

Change-Id: I66873834394743ff12b1c57cf02366a8a6af5b43

Author: smarcet

.env.example

@@ -185,4 +185,6 @@ AWS_ENDPOINT=
 REGISTRATION_ORDER_PUBLIC_EDIT_TTL=10
 DEFAULT_PROFILE_IMAGE=
 SCHEDULE_USE_REALTIME_UPDATE=1
-SAMSUNG_REGISTRATION_API_ENDPOINT=
+SAMSUNG_REGISTRATION_API_ENDPOINT=
+# in minutes
+REGISTRATION_ATTENDEE_INVITATION_EMAIL_DELAY=10

app/Jobs/SendAttendeeInvitationEmail.php

@@ -0,0 +1,91 @@
+<?php namespace App\Jobs;
+/*
+ * Copyright 2023 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Log;
+use models\exceptions\EntityNotFoundException;
+use models\summit\ISummitAttendeeTicketRepository;
+use models\summit\SummitAttendeeTicket;
+
+/**
+ * Class SendAttendeeInvitationEmail
+ * @package App\Jobs
+ */
+final class SendAttendeeInvitationEmail implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    public $tries = 3;
+
+    public $ticket_id;
+
+
+    /**
+     * @param int $ticket_id
+     */
+    public function __construct(int $ticket_id)
+    {
+        Log::debug(sprintf("SendAttendeeInvitationEmail::constructor ticket_id %s", $ticket_id));
+        $this->ticket_id = $ticket_id;
+    }
+
+    public function handle
+    (
+        ISummitAttendeeTicketRepository $ticketRepository
+    )
+    {
+        Log::debug(sprintf( "SendAttendeeInvitationEmail::handle ticket_id %s", $this->ticket_id));
+
+        try {
+            $ticket = $ticketRepository->getById($this->ticket_id);
+
+            if (!$ticket instanceof SummitAttendeeTicket) {
+
+                throw new EntityNotFoundException(sprintf("Ticket %s not found.", $this->ticket_id));
+            }
+
+            if (!$ticket->hasOwner()) {
+
+                Log::warning
+                (
+                    sprintf
+                    (
+                        "SendAttendeeInvitationEmail::handle ticket %s has no owner",
+                        $this->ticket_id
+                    )
+                );
+
+                return;
+            }
+
+            $attendee = $ticket->getOwner();
+
+            $attendee->sendInvitationEmail($ticket);
+        }
+        catch (\Exception $ex){
+            Log::error($ex);
+            throw $ex;
+        }
+    }
+
+    public function failed(\Throwable $exception)
+    {
+        Log::error($exception);
+    }
+
+}

app/Models/Foundation/Summit/Registration/SummitOrder.php

@@ -753,6 +753,10 @@ public function getTickets()
         return $this->tickets;
     }
 
+    public function isSingleTicket():bool{
+        return $this->tickets->count() === 1;
+    }
+
     /**
      * @param SummitAttendeeTicket $ticket
      */

app/Services/Model/Imp/SummitOrderService.php

@@ -23,6 +23,7 @@
 use App\Jobs\Emails\UnregisteredMemberOrderPaidMail;
 use App\Jobs\IngestSummitExternalRegistrationData;
 use App\Jobs\ProcessTicketDataImport;
+use App\Jobs\SendAttendeeInvitationEmail;
 use App\Models\Foundation\Summit\Factories\SummitOrderFactory;
 use App\Models\Foundation\Summit\Registration\IBuildDefaultPaymentGatewayProfileStrategy;
 use App\Models\Foundation\Summit\Repositories\ISummitAttendeeBadgePrintRuleRepository;
@@ -35,6 +36,7 @@
 use App\Services\Utils\CSVReader;
 use App\Services\Utils\ILockManagerService;
 use Illuminate\Http\UploadedFile;
+use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Log;
@@ -4068,9 +4070,37 @@ private function sendAttendeesInvitationEmail(SummitOrder $order): void
                     Log::debug(sprintf("SummitOrderService::sendAttendeesInvitationEmail ticket %s has not owner set", $ticket->getNumber()));
                     continue;
                 }
+                $attendee = $ticket->getOwner();
                 $ticket->generateQRCode();
                 $ticket->generateHash();
-                $ticket->getOwner()->sendInvitationEmail($ticket);
+                $delay = 0;
+                if($order->isSingleTicket() && $attendee->getEmail() !== $order->getOwnerEmail()){
+                    Log::debug
+                    (
+                        sprintf
+                        (
+                            "SummitOrderService::sendAttendeesInvitationEmail ticket %s attendee %s is not the same as order owner %s (SOMEONE_ELSE_FLOW)",
+                            $ticket->getId(),
+                            $attendee->getEmail(),
+                            $order->getOwnerEmail()
+                        )
+                    );
+                    // delay invitation by N Minutes ....
+                    $delay = Config::get("registration.attendee_invitation_email_delay", 10);
+                }
+                Log::debug
+                (
+                    sprintf
+                    (
+                        "SummitOrderService::sendAttendeesInvitationEmail ticket %s sending invitation email to attendee %s with delay %s minutes",
+                        $ticket->getNumber(),
+                        $attendee->getEmail(),
+                        $delay
+                    )
+                );
+
+                SendAttendeeInvitationEmail::dispatch($ticket->getId())->delay(now()->addMinutes($delay));
+
             } catch (\Exception $ex) {
                 Log::warning($ex);
             }

config/registration.php

@@ -42,4 +42,6 @@
     'send_ticket_attachments' => env('REGISTRATION_SEND_TICKET_ATTACHMENTS', false),
     'admin_ticket_edit_url' => env('REGISTRATION_ADMIN_TICKET_EDIT_URL', null),
     'order_public_edit_ttl' => env('REGISTRATION_ORDER_PUBLIC_EDIT_TTL', 10),
+    // in minutes
+    'attendee_invitation_email_delay' => env('REGISTRATION_ATTENDEE_INVITATION_EMAIL_DELAY', 10),
 ];