feat(#194): refactor cache to be device specific

tests/Feature/GenerateScreenJobTest.php

@@ -2,6 +2,8 @@
 
 use App\Jobs\GenerateScreenJob;
 use App\Models\Device;
+use App\Models\DeviceModel;
+use App\Models\Plugin;
 use Bnussbau\TrmnlPipeline\TrmnlPipeline;
 use Illuminate\Support\Facades\Storage;
 
@@ -58,3 +60,26 @@ test('it preserves gitignore file during cleanup', function (): void {
 
     Storage::disk('public')->assertExists('/images/generated/.gitignore');
 });
+
+test('it saves current_image_metadata for recipe plugins', function (): void {
+    $deviceModel = DeviceModel::factory()->create([
+        'width' => 800,
+        'height' => 480,
+        'rotation' => 0,
+        'mime_type' => 'image/png',
+        'palette_id' => null,
+    ]);
+    $device = Device::factory()->create(['device_model_id' => $deviceModel->id]);
+    $plugin = Plugin::factory()->create(['plugin_type' => 'recipe']);
+
+    $job = new GenerateScreenJob($device->id, $plugin->id, '<div>Test</div>');
+    $job->handle();
+
+    $plugin->refresh();
+    expect($plugin->current_image)->not->toBeNull();
+    expect($plugin->current_image_metadata)->toBeArray();
+    expect($plugin->current_image_metadata)->toHaveKeys(['width', 'height', 'rotation', 'palette_id', 'mime_type']);
+    expect($plugin->current_image_metadata['width'])->toBe(800);
+    expect($plugin->current_image_metadata['height'])->toBe(480);
+    expect($plugin->current_image_metadata['mime_type'])->toBe('image/png');
+});

tests/Feature/ImageGenerationServiceTest.php

@@ -8,6 +8,7 @@ use App\Models\DeviceModel;
 use App\Services\ImageGenerationService;
 use Bnussbau\TrmnlPipeline\TrmnlPipeline;
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Schema;
 use Illuminate\Support\Facades\Storage;
 
 uses(RefreshDatabase::class);
@@ -22,6 +23,10 @@ afterEach(function (): void {
     TrmnlPipeline::restore();
 });
 
+it('plugins table has current_image_metadata column', function (): void {
+    expect(Schema::hasColumn('plugins', 'current_image_metadata'))->toBeTrue();
+});
+
 it('generates image for device without device model', function (): void {
     // Create a device without a DeviceModel (legacy behavior)
     $device = Device::factory()->create([
@@ -270,39 +275,15 @@ it('cleanupFolder preserves .gitignore', function (): void {
     Storage::disk('public')->assertExists('/images/generated/.gitignore');
 });
 
-it('resetIfNotCacheable resets when device models exist', function (): void {
-    // Create a plugin
-    $plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
+it('resetIfNotCacheable does not reset recipe cache based on other devices', function (): void {
+    // Cache validity is now determined at use-time via current_image_metadata
+    $plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid', 'plugin_type' => 'recipe']);
 
-    // Create a device with DeviceModel (should trigger cache reset)
-    Device::factory()->create([
-        'device_model_id' => DeviceModel::factory()->create()->id,
-    ]);
-
-    // Run reset check
+    Device::factory()->create(['device_model_id' => DeviceModel::factory()->create()->id]);
     ImageGenerationService::resetIfNotCacheable($plugin);
 
-    // Assert plugin image was reset
     $plugin->refresh();
-    expect($plugin->current_image)->toBeNull();
-});
-
-it('resetIfNotCacheable resets when custom dimensions exist', function (): void {
-    // Create a plugin
-    $plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
-
-    // Create a device with custom dimensions (should trigger cache reset)
-    Device::factory()->create([
-        'width' => 1024, // Different from default 800
-        'height' => 768, // Different from default 480
-    ]);
-
-    // Run reset check
-    ImageGenerationService::resetIfNotCacheable($plugin);
-
-    // Assert plugin image was reset
-    $plugin->refresh();
-    expect($plugin->current_image)->toBeNull();
+    expect($plugin->current_image)->toBe('test-uuid');
 });
 
 it('resetIfNotCacheable preserves image for standard devices', function (): void {
@@ -325,27 +306,122 @@ it('resetIfNotCacheable preserves image for standard devices', function (): void
 });
 
 it('cache is reset when plugin markup changes', function (): void {
-    // Create a plugin with cached image
+    // Create a plugin with cached image and metadata
     $plugin = App\Models\Plugin::factory()->create([
         'current_image' => 'cached-uuid',
+        'current_image_metadata' => ['width' => 800, 'height' => 480, 'rotation' => 0, 'palette_id' => null, 'mime_type' => 'image/png'],
         'render_markup' => '<div>Original markup</div>',
     ]);
 
-    // Create devices with standard dimensions (cacheable)
-    Device::factory()->count(2)->create([
-        'width' => 800,
-        'height' => 480,
-        'rotate' => 0,
-    ]);
+    $plugin->update(['render_markup' => '<div>Updated markup</div>']);
 
-    // Update the plugin markup
-    $plugin->update([
-        'render_markup' => '<div>Updated markup</div>',
-    ]);
-
-    // Assert cache was reset when markup changed
     $plugin->refresh();
     expect($plugin->current_image)->toBeNull();
+    expect($plugin->current_image_metadata)->toBeNull();
+});
+
+it('buildImageMetadataFromDevice returns canonical metadata shape', function (): void {
+    $deviceModel = DeviceModel::factory()->create([
+        'width' => 800,
+        'height' => 480,
+        'rotation' => 0,
+        'mime_type' => 'image/png',
+        'palette_id' => null,
+    ]);
+    $device = Device::factory()->create(['device_model_id' => $deviceModel->id]);
+
+    $meta = ImageGenerationService::buildImageMetadataFromDevice($device);
+
+    expect($meta)->toHaveKeys(['width', 'height', 'rotation', 'palette_id', 'mime_type']);
+    expect($meta['width'])->toBe(800);
+    expect($meta['height'])->toBe(480);
+    expect($meta['rotation'])->toBe(0);
+    expect($meta['mime_type'])->toBe('image/png');
+});
+
+it('buildImageMetadataFromDeviceModel returns canonical metadata shape', function (): void {
+    $model = DeviceModel::factory()->create([
+        'width' => 1024,
+        'height' => 768,
+        'rotation' => 90,
+        'mime_type' => 'image/bmp',
+        'palette_id' => null,
+    ]);
+
+    $meta = ImageGenerationService::buildImageMetadataFromDeviceModel($model);
+
+    expect($meta)->toHaveKeys(['width', 'height', 'rotation', 'palette_id', 'mime_type']);
+    expect($meta['width'])->toBe(1024);
+    expect($meta['height'])->toBe(768);
+    expect($meta['rotation'])->toBe(90);
+    expect($meta['mime_type'])->toBe('image/bmp');
+});
+
+it('imageMetadataMatches returns false when stored is null or empty', function (): void {
+    $device = Device::factory()->create(['width' => 800, 'height' => 480, 'rotate' => 0]);
+
+    expect(ImageGenerationService::imageMetadataMatches(null, $device))->toBeFalse();
+    expect(ImageGenerationService::imageMetadataMatches([], $device))->toBeFalse();
+});
+
+it('imageMetadataMatches returns true when metadata matches device', function (): void {
+    $deviceModel = DeviceModel::factory()->create([
+        'width' => 800,
+        'height' => 480,
+        'rotation' => 0,
+        'mime_type' => 'image/png',
+        'palette_id' => null,
+    ]);
+    $device = Device::factory()->create(['device_model_id' => $deviceModel->id]);
+    $stored = ImageGenerationService::buildImageMetadataFromDevice($device);
+
+    expect(ImageGenerationService::imageMetadataMatches($stored, $device))->toBeTrue();
+});
+
+it('imageMetadataMatches returns false when metadata differs', function (): void {
+    $device = Device::factory()->create(['width' => 800, 'height' => 480, 'rotate' => 0]);
+    $stored = ['width' => 800, 'height' => 480, 'rotation' => 0, 'palette_id' => null, 'mime_type' => 'image/png'];
+
+    $device->update(['width' => 1024]);
+    $device->refresh();
+
+    expect(ImageGenerationService::imageMetadataMatches($stored, $device))->toBeFalse();
+});
+
+it('resetIfNotCacheable clears recipe cache when metadata does not match', function (): void {
+    $plugin = App\Models\Plugin::factory()->create([
+        'plugin_type' => 'recipe',
+        'current_image' => 'cached-uuid',
+        'current_image_metadata' => ['width' => 800, 'height' => 480, 'rotation' => 0, 'palette_id' => null, 'mime_type' => 'image/png'],
+    ]);
+    $device = Device::factory()->create(['width' => 1024, 'height' => 768, 'rotate' => 0]);
+
+    ImageGenerationService::resetIfNotCacheable($plugin, $device);
+
+    $plugin->refresh();
+    expect($plugin->current_image)->toBeNull();
+    expect($plugin->current_image_metadata)->toBeNull();
+});
+
+it('resetIfNotCacheable preserves cache when metadata matches', function (): void {
+    $deviceModel = DeviceModel::factory()->create([
+        'width' => 800,
+        'height' => 480,
+        'rotation' => 0,
+        'mime_type' => 'image/png',
+    ]);
+    $device = Device::factory()->create(['device_model_id' => $deviceModel->id]);
+    $meta = ImageGenerationService::buildImageMetadataFromDevice($device);
+    $plugin = App\Models\Plugin::factory()->create([
+        'plugin_type' => 'recipe',
+        'current_image' => 'cached-uuid',
+        'current_image_metadata' => $meta,
+    ]);
+
+    ImageGenerationService::resetIfNotCacheable($plugin, $device);
+
+    $plugin->refresh();
+    expect($plugin->current_image)->toBe('cached-uuid');
 });
 
 it('determines correct image format from device model', function (): void {

tests/Unit/Services/ImageGenerationServiceTest.php

@@ -176,37 +176,15 @@ it('cleanup_folder identifies active images correctly', function (): void {
     expect($activeImageUuids)->not->toContain(null);
 });
 
-it('reset_if_not_cacheable detects device models', function (): void {
-    // Create a plugin
-    $plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
+it('reset_if_not_cacheable does not reset recipe cache when other devices exist', function (): void {
+    // Cache validity is now determined at use-time via metadata
+    $plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid', 'plugin_type' => 'recipe']);
+    Device::factory()->create(['device_model_id' => DeviceModel::factory()->create()->id]);
 
-    // Create a device with DeviceModel
-    Device::factory()->create([
-        'device_model_id' => DeviceModel::factory()->create()->id,
-    ]);
-
-    // Test that the method detects DeviceModels and resets cache
     ImageGenerationService::resetIfNotCacheable($plugin);
 
     $plugin->refresh();
-    expect($plugin->current_image)->toBeNull();
-});
-
-it('reset_if_not_cacheable detects custom dimensions', function (): void {
-    // Create a plugin
-    $plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
-
-    // Create a device with custom dimensions
-    Device::factory()->create([
-        'width' => 1024, // Different from default 800
-        'height' => 768, // Different from default 480
-    ]);
-
-    // Test that the method detects custom dimensions and resets cache
-    ImageGenerationService::resetIfNotCacheable($plugin);
-
-    $plugin->refresh();
-    expect($plugin->current_image)->toBeNull();
+    expect($plugin->current_image)->toBe('test-uuid');
 });
 
 it('reset_if_not_cacheable preserves cache for standard devices', function (): void {
@@ -258,26 +236,21 @@ it('reset_if_not_cacheable preserves cache for og_png and og_plus device models'
     expect($plugin->current_image)->toBe('test-uuid');
 });
 
-it('reset_if_not_cacheable resets cache for non-standard device models', function (): void {
-    // Create a plugin
-    $plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid']);
-
-    // Create a non-standard device model (e.g., kindle)
+it('reset_if_not_cacheable does not reset cache for non-standard device models', function (): void {
+    // Cache is now validated at use-time via metadata comparison
+    $plugin = App\Models\Plugin::factory()->create(['current_image' => 'test-uuid', 'plugin_type' => 'recipe']);
     $kindleModel = DeviceModel::factory()->create([
         'name' => 'test_amazon_kindle_2024',
         'width' => 1400,
         'height' => 840,
         'rotation' => 90,
     ]);
-
-    // Create a device with the non-standard device model
     Device::factory()->create(['device_model_id' => $kindleModel->id]);
 
-    // Test that the method resets cache for non-standard device models
     ImageGenerationService::resetIfNotCacheable($plugin);
 
     $plugin->refresh();
-    expect($plugin->current_image)->toBeNull();
+    expect($plugin->current_image)->toBe('test-uuid');
 });
 
 it('reset_if_not_cacheable handles null plugin', function (): void {