Review of irrdb warning email post merge

Author: barryo

.env.example

@@ -82,6 +82,11 @@ IDENTITY_SUPPORT_EMAIL="${IDENTITY_EMAIL}"
 IDENTITY_SUPPORT_PHONE="+1 111 555 5555"
 IDENTITY_SUPPORT_HOURS="24x7"
 
+# IXP Manager will need to send alert emails. This is the recipient email for these alerts.
+IDENTITY_ALERTS_EMAIL=${IDENTITY_SUPPORT_EMAIL}
+IDENTITY_ALERTS_NAME="IXP Manager Alerts"
+
+
 IDENTITY_BILLING_EMAIL="${IDENTITY_EMAIL}"
 IDENTITY_BILLING_PHONE="+1 111 555 5555"
 IDENTITY_BILLING_HOURS="24x7"

app/Console/Commands/Irrdb/UpdateDb.php

@@ -24,7 +24,10 @@
  */
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Facades\Mail;
 use IXP\Console\Commands\Command;
+use IXP\Events\User\UserWarning as UserWarningEvent;
+use IXP\Mail\User\UserWarning;
 use IXP\Models\Customer;
 
 /**
@@ -94,7 +97,7 @@ protected function resolveCustomers( array $options ): mixed
      *
      * @return void
      */
-    public function printResults( Customer $c, array $r, string $irrdbType = 'prefix' ): void
+    protected function printResults( Customer $c, array $r, string $irrdbType = 'prefix' ): void
     {
         $this->netTime  += $r[ 'netTime' ];
         $this->dbTime   += $r[ 'dbTime' ];
@@ -136,4 +139,30 @@ public function printResults( Customer $c, array $r, string $irrdbType = 'prefix
             }
         }
     }
+
+    /**
+     * Handle exceptions
+     */
+    protected function handleException( Customer $c, \Exception $e, string $type ): void
+    {
+        $this->error( "IRRDB {$type} update failed for {$c->name}/AS{$c->autsys}" );
+        $this->error( $e->getMessage() );
+
+        if( !$this->option('alert-email') ) {
+            return;
+        }
+
+        if( !config('mail.alerts_recipient.address') ) {
+            $this->warn( "Alert email not sent as IDENTITY_ALERTS_EMAIL .env option not set." );
+            return;
+        }
+
+        Mail::to( [ [ 'name' => config( 'mail.alerts_recipient.name' ), 'email' => config( 'mail.alerts_recipient.address' ) ] ] )
+            ->send( new UserWarning(
+                new UserWarningEvent( "IRRDB {$type} update failed for {$c->name}/AS{$c->autsys}", $e->getMessage() )
+            ) );
+
+        $this->info( "Alert email sent to " . config( 'mail.alerts_recipient.address' ) );
+    }
+
 }

app/Events/User/UserWarning.php

@@ -3,7 +3,7 @@
 namespace IXP\Events\User;
 
 /*
- * Copyright (C) 2009 - 2020 Internet Neutral Exchange Association Company Limited By Guarantee.
+ * Copyright (C) 2009 - 2025 Internet Neutral Exchange Association Company Limited By Guarantee.
  * All Rights Reserved.
  *
  * This file is part of IXP Manager.
@@ -31,52 +31,24 @@
 /**
  * User Warning Event
  * @author     Barry O'Donovan <[email protected]>
- * @author     Yann Robin <[email protected]>
  * @author     Laszlo Kiss <[email protected]>
  * @category   Events\User
- * @copyright  Copyright (C) 2009 - 2020 Internet Neutral Exchange Association Company Limited By Guarantee
+ * @copyright  Copyright (C) 2009 - 2025 Internet Neutral Exchange Association Company Limited By Guarantee
  * @license    http://www.gnu.org/licenses/gpl-2.0.html GNU GPL V2.0
  */
 class UserWarning implements ShouldQueue
 {
     use Dispatchable, SerializesModels, InteractsWithQueue;
 
-    /**
-     * @var string
-     * @var string
-     */
-    public string $warningTitle;
-    public string $errorMessage;
-
     /**
      * Create a new event instance.
      *
      * @param string $warningTitle
      * @param string $errorMessage
      */
-    public function __construct(  string $warningTitle, string $errorMessage )
-    {
-        $this->warningTitle = $warningTitle;
-        $this->errorMessage = $errorMessage;
-    }
-
-    /**
-     * Get asn string
-     *
-     * @return string
-     */
-    public function getTitle(): string
-    {
-        return $this->warningTitle;
-    }
+    public function __construct(
+        public string $warningTitle,
+        public string $errorMessage )
+    {}
 
-    /**
-     * Get error message string
-     *
-     * @return string
-     */
-    public function getErrorMessage(): string
-    {
-        return $this->errorMessage;
-    }
 }

app/Mail/User/UserWarning.php

@@ -3,7 +3,7 @@
 namespace IXP\Mail\User;
 
 /*
- * Copyright (C) 2009 - 2020 Internet Neutral Exchange Association Company Limited By Guarantee.
+ * Copyright (C) 2009 - 2025 Internet Neutral Exchange Association Company Limited By Guarantee.
  * All Rights Reserved.
  *
  * This file is part of IXP Manager.
@@ -31,7 +31,6 @@
  * Mailable for warning email User
  *
  * @author     Barry O'Donovan <[email protected]>
- * @author     Yann Robin <[email protected]>
  * @author     Laszlo Kiss <[email protected]>
  * @category   User
  * @package    IXP\Mail\User
@@ -42,26 +41,15 @@ class UserWarning extends Mailable
 {
     use Queueable, SerializesModels;
 
-    /**
-     *
-     * @var UserWarningEvent
-     */
-    public UserWarningEvent $event;
-
-    public string $warningTitle;
-    public string $errorMessage;
-
     /**
      * Create a new message instance.
      *
      * @param UserWarningEvent $e
-     *
      * @return void
      */
-    public function __construct( UserWarningEvent $e )
-    {
-        $this->event = $e;
-    }
+    public function __construct(
+        public UserWarningEvent $event
+    ) {}
 
     /**
      * Build the message.
@@ -70,9 +58,7 @@ public function __construct( UserWarningEvent $e )
      */
     public function build(): self
     {
-        $this->warningTitle = $this->event->getTitle();
-        $this->errorMessage = $this->event->getErrorMessage();
-
-        return $this->markdown( 'user.emails.warning' )->subject( config('identity.sitename' ) . " - Warning" );
+        return $this->markdown( 'user.emails.warning' )
+            ->subject( config('identity.sitename' ) . " - Alert" );
     }
 }

config/mail.php

@@ -117,9 +117,11 @@
         'name' => env('IDENTITY_NAME', 'Newly Installed IXP Manager'),
     ],
 
+    // IXP Manager will need to send alert emails. This is the recipient email for these alerts.
+    // E.g. [email protected]
     'alerts_recipient' => [
-        'address' => env('IDENTITY_ALERTS_EMAIL','[email protected]'),
-        'name' => env('IDENTITY_ALERTS_NAME','IXP Ops Alerts'),
+        'address' => env('IDENTITY_ALERTS_EMAIL',false ),
+        'name' => env('IDENTITY_ALERTS_NAME','IXP Manager Alerts'),
     ],
 
     /*

resources/views/user/emails/warning.blade.php

@@ -1,22 +1,12 @@
 @component('mail::message')
 
-    ## Warning Message
+    ## {{ config('identity.sitename') }} Alert
 
-    {{ $warningTitle }}
+    {{ $event->warningTitle }}
 
     @component('mail::panel')
-        {{ $errorMessage }}
+        {{ $event->errorMessage }}
     @endcomponent
 
-    @component('mail::subcopy')
-         
-    @endcomponent
-
-    Thanks and kind regards,
-
-
-    {{ config( 'identity.name' ) }}
-
-    [{{ config( 'identity.email' ) }}](mailto:{{ config( 'identity.email' ) }})
 
 @endcomponent