Enhancement: handle immich v1.118 breaking API change (#4110)

gethomepage · Oct 10, 2024 · 19bdc0e · 19bdc0e
1 parent cd8c224
commit 19bdc0e
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 12 deletions.
diff --git a/docs/widgets/services/immich.md b/docs/widgets/services/immich.md
@@ -5,6 +5,11 @@ description: Immich Widget Configuration
 
 Learn more about [Immich](https://github.com/immich-app/immich).
 
+| Immich Version | Homepage Widget Version |
+| -------------- | ----------------------- |
+| < v1.118       | 1 (default)             |
+| >= v1.118      | 2                       |
+
 Find your API key under `Account Settings > API Keys`.
 
 Allowed fields: `["users" ,"photos", "videos", "storage"]`.
@@ -16,4 +21,5 @@ widget:
   type: immich
   url: http://immich.host.or.ip
   key: adminapikeyadminapikeyadminapikey
+  version: 2 # optional, default is 1
 ```
diff --git a/src/utils/config/service-helpers.js b/src/utils/config/service-helpers.js
@@ -406,7 +406,7 @@ export function cleanServiceGroups(groups) {
           // frigate
           enableRecentEvents,
 
-          // glances, mealie, pihole, pfsense
+          // glances, immich, mealie, pihole, pfsense
           version,
 
           // glances
@@ -568,8 +568,8 @@ export function cleanServiceGroups(groups) {
           if (snapshotHost) cleanedService.widget.snapshotHost = snapshotHost;
           if (snapshotPath) cleanedService.widget.snapshotPath = snapshotPath;
         }
-        if (["glances", "mealie", "pfsense", "pihole"].includes(type)) {
-          if (version) cleanedService.widget.version = version;
+        if (["glances", "immich", "mealie", "pfsense", "pihole"].includes(type)) {
+          if (version) cleanedService.widget.version = parseInt(version, 10);
         }
         if (type === "glances") {
           if (metric) cleanedService.widget.metric = metric;

diff --git a/src/widgets/immich/component.jsx b/src/widgets/immich/component.jsx
@@ -8,11 +8,19 @@ export default function Component({ service }) {
   const { t } = useTranslation();
   const { widget } = service;
 
-  const { data: versionData, error: versionError } = useWidgetAPI(widget, "version");
-  // see https://github.com/gethomepage/homepage/issues/2282
-  const endpoint =
-    versionData?.major > 1 || (versionData?.major === 1 && versionData?.minor > 84) ? "statistics" : "stats";
-  const { data: immichData, error: immichError } = useWidgetAPI(widget, endpoint);
+  const { version = 1 } = widget;
+
+  const versionEndpoint = version === 2 ? "version_v2" : "version";
+
+  const { data: versionData, error: versionError } = useWidgetAPI(widget, versionEndpoint);
+
+  let statsEndpoint = version === 2 ? "statistics_v2" : "stats";
+  if (version === 1) {
+    // see https://github.com/gethomepage/homepage/issues/2282
+    statsEndpoint =
+      versionData?.major > 1 || (versionData?.major === 1 && versionData?.minor > 84) ? "statistics" : "stats";
+  }
+  const { data: immichData, error: immichError } = useWidgetAPI(widget, statsEndpoint);
 
   if (immichError || versionError || immichData?.statusCode === 401) {
     return <Container service={service} error={immichData ?? immichError ?? versionError} />;

diff --git a/src/widgets/immich/widget.js b/src/widgets/immich/widget.js
@@ -1,18 +1,24 @@
 import credentialedProxyHandler from "utils/proxy/handlers/credentialed";
 
 const widget = {
-  api: "{url}/api/server-info/{endpoint}",
+  api: "{url}/api/{endpoint}",
   proxyHandler: credentialedProxyHandler,
 
   mappings: {
     version: {
-      endpoint: "version",
+      endpoint: "server-info/version",
     },
     statistics: {
-      endpoint: "statistics",
+      endpoint: "server-info/statistics",
     },
     stats: {
-      endpoint: "stats",
+      endpoint: "server-info/stats",
+    },
+    version_v2: {
+      endpoint: "server/version",
+    },
+    statistics_v2: {
+      endpoint: "server/statistics",
     },
   },
 };