device_display_default setting should invalidate device display names cache

Author: murrant

app/ConfigRepository.php

@@ -26,6 +26,7 @@
 
 namespace App;
 
+use App\Events\SettingChanged;
 use App\Models\Callback;
 use App\Models\GraphType;
 use Exception;
@@ -263,7 +264,9 @@ public function erase(string $key): bool
             $deleted = Models\Config::withChildren($key)->delete();
 
             if ($deleted > 0) {
+                // delete statement above doens't trigger Eloquent events
                 $this->invalidateCache();
+                event("setting.changed.$key", new SettingChanged($key, $this->get($key)));
             }
 
             return true;

app/Events/SettingChanged.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class SettingChanged
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(
+        public readonly string $key,
+        public readonly mixed $value = null,
+    ) {
+    }
+}

app/Listeners/RegenerateDeviceDisplayNames.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Events\SettingChanged;
+use App\Models\Device;
+use Illuminate\Support\Facades\Log;
+
+class RegenerateDeviceDisplayNames
+{
+    /**
+     * Handle the event.
+     */
+    public function handle(SettingChanged $event): void
+    {
+        Device::withoutEvents(function () {
+            Device::whereNull('display_template')
+                ->orWhere('display_template', '')
+                ->select(['device_id', 'display_template', 'hostname', 'sysName', 'ip', 'overwrite_ip'])
+                ->chunkById(500, function ($devices) {
+                    foreach ($devices as $device) {
+                        try {
+                            $device->regenerateDisplayName();
+                            $device->timestamps = false;
+                            $device->save();
+                        } catch (\Throwable $e) {
+                            Log::error("Failed to regen device {$device->device_id}: " . $e->getMessage());
+                        }
+                    }
+                });
+        });
+    }
+}

app/Observers/ConfigObserver.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Observers;
+
+use App\Events\SettingChanged;
+use App\Facades\LibrenmsConfig;
+use App\Models\Config;
+
+class ConfigObserver
+{
+    public function saved(Config $config): void
+    {
+        event("setting.changed.$config->config_name", new SettingChanged($config->config_name, $config->config_value));
+    }
+
+    /**
+     * Handle the config "deleted" event.
+     */
+    public function deleted(Config $config): void
+    {
+        LibrenmsConfig::invalidateCache();
+        event("setting.changed.$config->config_name", new SettingChanged($config->config_name, LibrenmsConfig::get($config->config_name)));
+    }
+}

app/Providers/AppServiceProvider.php

@@ -149,6 +149,7 @@ private function registerGeocoder()
 
     private function bootObservers()
     {
+        \App\Models\Config::observe(\App\Observers\ConfigObserver::class);
         \App\Models\Device::observe(\App\Observers\DeviceObserver::class);
         \App\Models\Mempool::observe(\App\Observers\MempoolObserver::class);
         \App\Models\Package::observe(\App\Observers\PackageObserver::class);

app/Providers/ConfigServiceProvider.php

@@ -4,6 +4,8 @@
 
 use App\ConfigRepository;
 use App\Facades\LibrenmsConfig;
+use App\Listeners\RegenerateDeviceDisplayNames;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\ServiceProvider;
 
@@ -26,4 +28,12 @@ public function register(): void
             }
         });
     }
+
+    /**
+     * Bootstrap services.
+     */
+    public function boot(): void
+    {
+        Event::listen('setting.changed.device_display_default', RegenerateDeviceDisplayNames::class);
+    }
 }