Merge pull request #241 from RoyalBoroughKingston/develop

v1.19.0

Author: matthew-inamdar

app/BatchUpload/BatchUploader.php

@@ -281,6 +281,7 @@ protected function processServices(array $services, EloquentCollection $organisa
                 'referral_button_text' => !$isNone ? 'Make referral' : null,
                 'referral_email' => $isInternal ? $serviceArray['Referral Email'] : null,
                 'referral_url' => $isExternal ? $serviceArray['Referral URL'] : null,
+                'last_modified_at' => now(),
             ]);
 
             $service->_id = $serviceArray['ID*'];

app/Console/Commands/Ck/AutoDelete/ServiceRefreshTokensCommand.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Console\Commands\Ck\AutoDelete;
+
+use App\Models\ServiceRefreshToken;
+use Illuminate\Console\Command;
+
+class ServiceRefreshTokensCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'ck:auto-delete:service-refresh-tokens';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Deletes any service refresh tokens that are due for deletion';
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        $months = ServiceRefreshToken::AUTO_DELETE_MONTHS;
+
+        $this->line("Deleting service refresh tokens created {$months} month(s) ago...");
+        $count = ServiceRefreshToken::dueForDeletion()->delete();
+        $this->info("Deleted {$count} service refresh token(s).");
+    }
+}

app/Console/Commands/Ck/Notify/StaleServicesCommand.php

@@ -0,0 +1,140 @@
+<?php
+
+namespace App\Console\Commands\Ck\Notify;
+
+use App\Emails\ServiceUpdatePrompt\NotifyGlobalAdminEmail;
+use App\Emails\ServiceUpdatePrompt\NotifyServiceAdminEmail;
+use App\Models\Notification;
+use App\Models\Role;
+use App\Models\Service;
+use Exception;
+use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+
+class StaleServicesCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'ck:notify:stale-services';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Sends notifications out for stale services';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): void
+    {
+        $this->handleServices6To12MonthsStale();
+        $this->handleServicesOver12MonthsStale();
+    }
+
+    protected function handleServices6To12MonthsStale(): void
+    {
+        Service::query()
+            ->with([
+                'users' => function (BelongsToMany $query): void {
+                    $query->where('user_roles.role_id', '=', Role::serviceAdmin()->id);
+                },
+            ])
+            ->where('status', '=', Service::STATUS_ACTIVE)
+            ->whereBetween(
+                'last_modified_at',
+                [now()->subMonths(12), now()->subMonths(6)]
+            )
+            ->chunk(200, function (Collection $services): void {
+                // Loop through each service in the current chunk.
+                $services->each(function (Service $service): void {
+                    $this->sendUpdatePromptEmailToServiceAdmins($service);
+                });
+            });
+    }
+
+    protected function handleServicesOver12MonthsStale(): void
+    {
+        Service::query()
+            ->with([
+                'users' => function (BelongsToMany $query): void {
+                    $query->where('user_roles.role_id', '=', Role::serviceAdmin()->id);
+                },
+                'organisation',
+            ])
+            ->where('status', '=', Service::STATUS_ACTIVE)
+            ->whereBetween(
+                'last_modified_at',
+                [now()->subMonths(13)->addDay(), now()->subMonths(12)]
+            )
+            ->chunk(200, function (Collection $services): void {
+                // Loop through each service in the current chunk.
+                $services->each(function (Service $service): void {
+                    $this->sendUpdatePromptEmailToGlobalAdmin($service);
+                });
+            });
+    }
+
+    /**
+     * @param \App\Models\Service $service
+     */
+    protected function sendUpdatePromptEmailToServiceAdmins(Service $service): void
+    {
+        // Create a refresh token for the service.
+        $refreshToken = $service->serviceRefreshTokens()->create();
+
+        /** @var \App\Models\User $user */
+        foreach ($service->users as $user) {
+            try {
+                $user->sendEmail(new NotifyServiceAdminEmail($user->email, [
+                    'SERVICE_NAME' => $service->name,
+                    'SERVICE_URL' => backend_uri("/services/{$service->id}"),
+                    'SERVICE_STILL_UP_TO_DATE_URL' => backend_uri("/services/{$service->id}/refresh?token={$refreshToken->id}"),
+                ]));
+
+                // Output a success message.
+                $this->info("Emails successfully sent for service [{$service->id}] to user [{$user->id}]");
+            } catch (Exception $exception) {
+                // Log the exception.
+                logger()->error($exception);
+
+                // Output an error message.
+                $this->error("Email failed sending for service [{$service->id}] to user [{$user->id}]");
+            }
+        }
+    }
+
+    /**
+     * @param \App\Models\Service $service
+     */
+    protected function sendUpdatePromptEmailToGlobalAdmin(Service $service): void
+    {
+        // Create a refresh token for the service.
+        $refreshToken = $service->serviceRefreshTokens()->create();
+
+        try {
+            Notification::sendEmail(
+                new NotifyGlobalAdminEmail(config('ck.global_admin.email'), [
+                    'SERVICE_NAME' => $service->name,
+                    'SERVICE_URL' => backend_uri("/services/{$service->id}"),
+                    'SERVICE_ADMIN_NAMES' => $service->users->implode(', ', 'full_name'),
+                    'SERVICE_STILL_UP_TO_DATE_URL' => backend_uri("/services/{$service->id}/refresh?token={$refreshToken->id}"),
+                ])
+            );
+
+            // Output a success message.
+            $this->info("Emails successfully sent to global admin for service [{$service->id}]");
+        } catch (Exception $exception) {
+            // Log the exception.
+            logger()->error($exception);
+
+            // Output an error message.
+            $this->error("Email failed sending to global admin for service [{$service->id}]");
+        }
+    }
+}

app/Console/Commands/Ck/Redis/ClearCommand.php

@@ -24,6 +24,9 @@ class Kernel extends ConsoleKernel
      */
     protected function schedule(Schedule $schedule)
     {
+        $schedule->command(Commands\Ck\Notify\StaleServicesCommand::class)
+            ->dailyAt('09:00');
+
         $schedule->command(Commands\Ck\Notify\UnactionedReferralsCommand::class)
             ->dailyAt('09:00');
 
@@ -41,6 +44,9 @@ protected function schedule(Schedule $schedule)
 
         $schedule->command(Commands\Ck\AutoDelete\ReferralsCommand::class)
             ->daily();
+
+        $schedule->command(Commands\Ck\AutoDelete\ServiceRefreshTokensCommand::class)
+            ->daily();
     }
 
     /**

app/Console/Kernel.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Emails\ServiceUpdatePrompt;
+
+use App\Emails\Email;
+
+class NotifyGlobalAdminEmail extends Email
+{
+    /**
+     * @return string
+     */
+    protected function getTemplateId(): string
+    {
+        return config('ck.notifications_template_ids.service_update_prompt.notify_global_admin.email');
+    }
+
+    /**
+     * @return string|null
+     */
+    protected function getReference(): ?string
+    {
+        return null;
+    }
+
+    /**
+     * @return string|null
+     */
+    protected function getReplyTo(): ?string
+    {
+        return null;
+    }
+
+    /**
+     * @return string
+     */
+    public function getContent(): string
+    {
+        return 'Pending to be sent. Content will be filled once sent.';
+    }
+}

app/Emails/ServiceUpdatePrompt/NotifyGlobalAdminEmail.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Emails\ServiceUpdatePrompt;
+
+use App\Emails\Email;
+
+class NotifyServiceAdminEmail extends Email
+{
+    /**
+     * @return string
+     */
+    protected function getTemplateId(): string
+    {
+        return config('ck.notifications_template_ids.service_update_prompt.notify_service_admin.email');
+    }
+
+    /**
+     * @return string|null
+     */
+    protected function getReference(): ?string
+    {
+        return null;
+    }
+
+    /**
+     * @return string|null
+     */
+    protected function getReplyTo(): ?string
+    {
+        return null;
+    }
+
+    /**
+     * @return string
+     */
+    public function getContent(): string
+    {
+        return 'Pending to be sent. Content will be filled once sent.';
+    }
+}