From 109c28afa485dd98418ebe8f7f8be9eed8f295e1 Mon Sep 17 00:00:00 2001
From: Dermot Duffy <dermot.duffy@gmail.com>
Date: Sat, 5 Mar 2022 19:56:21 -0800
Subject: [PATCH] Show an error message / stock image on image error.

---
 src/components/image.ts        | 38 ++++++++++++++++++++++++++++++----
 src/localize/languages/en.json |  1 +
 2 files changed, 35 insertions(+), 4 deletions(-)

diff --git a/src/components/image.ts b/src/components/image.ts
index 8794bf71..621a0aa9 100644
--- a/src/components/image.ts
+++ b/src/components/image.ts
@@ -12,7 +12,13 @@ import { customElement, property, query, state } from 'lit/decorators.js';
 import { CachedValueController } from '../cached-value-controller.js';
 import { CameraConfig, ImageViewConfig } from '../types.js';
 import { View } from '../view.js';
-import { dispatchMediaShowEvent, shouldUpdateBasedOnHass } from '../common.js';
+import {
+  dispatchErrorMessageEvent,
+  dispatchMediaShowEvent,
+  shouldUpdateBasedOnHass,
+} from '../common.js';
+import { localize } from '../localize/localize.js';
+
 import defaultImage from '../images/frigate-bird-in-sky.jpg';
 
 import imageStyle from '../scss/image.scss';
@@ -150,7 +156,7 @@ export class FrigateCardImage extends LitElement {
       // (401), see:
       // https://github.com/dermotduffy/frigate-hass-card/issues/398
       this._cachedValueController?.clearValue();
-      this._image.src = defaultImage;
+      this._forceStockImage();
     } else {
       // If the document is freshly re-visible, immediately re-render it to
       // restore the image src. If the HASS object is old (i.e. browser tab was
@@ -186,13 +192,37 @@ export class FrigateCardImage extends LitElement {
     return defaultImage;
   }
 
+  /**
+   * Force the img element to the stock image.
+   */
+  protected _forceStockImage(): void {
+    if (this._image) {
+      this._image.src = defaultImage;
+    }
+  }
+
   protected render(): TemplateResult | void {
     const src = this._cachedValueController?.value;
     return src
       ? html` <img
           src=${src}
-          @load=${(e) => {
-            dispatchMediaShowEvent(this, e);
+          @load=${(ev) => {
+            dispatchMediaShowEvent(this, ev);
+          }}
+          @error=${() => {
+            if (this._imageConfig?.mode === 'camera') {
+              // In camera mode, the user has likely not made an error, but HA
+              // may be unavailble, so show the stock image.
+              this._forceStockImage();
+            } else if (this._imageConfig?.mode === 'url') {
+              // In url mode, the user likely specified a URL that cannot be
+              // resolved. Show an error message.
+              dispatchErrorMessageEvent(
+                this,
+                localize('error.image_load_error'),
+                this._imageConfig,
+              );
+            }
           }}
         />`
       : html``;
diff --git a/src/localize/languages/en.json b/src/localize/languages/en.json
index ac2c2159..fee462b2 100644
--- a/src/localize/languages/en.json
+++ b/src/localize/languages/en.json
@@ -214,6 +214,7 @@
     "could_not_resolve": "Could not resolve media URL",
     "no_live_camera": "The camera_entity parameter must be set and valid for this live provider",
     "live_camera_unavailable": "The configured camera_entity is unavailable",
+    "image_load_error": "The image could not be loaded",
     "invalid_configuration": "Invalid configuration",
     "invalid_configuration_no_hint": "No location hint available (bad or missing type?)",
     "upgrade_available": "An automated card configuration upgrade is available, please visit the visual card editor",