feat: rewrite image picker (#6556)

* feat: rewrite image picker

* style: auto-fix lint and format

* fix: address image picker review

* fix: preserve unicode icon searches

* test: stabilize custom widget login

* fix: suggest image searches only on create

packages/api/src/router/icons.ts

@@ -1,4 +1,4 @@
-import { and, like } from "@homarr/db";
+import { getImageMatchRank, normalizeImageName } from "@homarr/common";
 import { icons } from "@homarr/db/schema";
 import { iconsFindSchema } from "@homarr/validation/icons";
 
@@ -15,38 +15,41 @@ export const iconsRouter = createTRPCRouter({
     })
     .input(iconsFindSchema)
     .query(async ({ ctx, input }) => {
-      const term = input.searchText?.toLowerCase().trim() ?? "";
-      const keywords = (input.searchText ?? "").split(" ").filter((keyword) => keyword.length > 0);
-
-      let whereCondition = undefined;
-      if (term.length > 0) {
-        whereCondition = and(...keywords.map((keyword) => like(icons.name, `%${keyword}%`)));
-      }
+      const term = normalizeImageName(input.searchText ?? "");
+      const repositories = await ctx.db.query.iconRepositories.findMany({
+        orderBy: (table, { asc, sql }) => [sql`CASE WHEN ${table.slug} = 'local' THEN 0 ELSE 1 END`, asc(table.slug)],
+        with: {
+          icons: {
+            columns: { id: true, name: true, url: true },
+            orderBy: (table, { asc, sql }) => [
+              sql`CASE WHEN ${table.name} LIKE '%.svg' THEN 0 ELSE 1 END`,
+              asc(table.name),
+            ],
+            limit: term.length === 0 ? input.limitPerGroup : undefined,
+          },
+        },
+      });
 
       return {
-        icons: await ctx.db.query.iconRepositories.findMany({
-          with: {
-            icons: {
-              columns: { id: true, name: true, url: true },
-              where: whereCondition,
-              orderBy: (table, { asc, sql }) => {
-                const svgFirst = sql`CASE WHEN ${table.name} LIKE '%.svg' THEN 0 ELSE 1 END`;
-                const nameAsc = asc(table.name);
-                if (term.length === 0) {
-                  return [svgFirst, nameAsc];
-                }
-                const tier = sql`CASE
-                  WHEN LOWER(${table.name}) = ${term} THEN 0
-                  WHEN LOWER(${table.name}) LIKE ${term + "%"} THEN 1
-                  WHEN LOWER(${table.name}) LIKE ${`%${term}%`} THEN 2
-                  ELSE 3
-                END`;
-                return [tier, svgFirst, nameAsc];
-              },
-              limit: input.limitPerGroup,
-            },
-          },
-        }),
+        icons:
+          term.length === 0
+            ? repositories
+            : repositories.map((repository) => ({
+                ...repository,
+                icons: repository.icons
+                  .flatMap((icon) => {
+                    const rank = getImageMatchRank(term, icon.name || icon.url);
+                    return rank === null ? [] : [{ icon, rank }];
+                  })
+                  .toSorted((a, b) =>
+                    a.rank !== b.rank
+                      ? a.rank - b.rank
+                      : Number(b.icon.name.toLowerCase().endsWith(".svg")) -
+                          Number(a.icon.name.toLowerCase().endsWith(".svg")) || a.icon.name.localeCompare(b.icon.name),
+                  )
+                  .slice(0, input.limitPerGroup)
+                  .map(({ icon }) => icon),
+              })),
         countIcons: await ctx.db.$count(icons),
       };
     }),

packages/api/src/router/test/icons.spec.ts

@@ -0,0 +1,44 @@
+import { describe, expect, test } from "vitest";
+
+import { iconRepositories, icons } from "@homarr/db/schema";
+import { createDb } from "@homarr/db/test";
+
+import { iconsRouter } from "../icons";
+
+describe("findIcons", () => {
+  test.each(["homeassistant", "home_assistant", "home assistant.png"])(
+    "matches normalized search %s before applying the group limit",
+    async (searchText) => {
+      const db = createDb();
+      const caller = iconsRouter.createCaller({ db, deviceType: undefined, session: null });
+
+      await db.insert(iconRepositories).values({ id: "repository", slug: "dashboard-icons" });
+      await db.insert(icons).values([
+        {
+          id: "irrelevant",
+          name: "000-unrelated.svg",
+          url: "https://example.com/000-unrelated.svg",
+          checksum: "irrelevant",
+          iconRepositoryId: "repository",
+        },
+        {
+          id: "home-assistant",
+          name: "home-assistant.svg",
+          url: "https://example.com/home-assistant.svg",
+          checksum: "home-assistant",
+          iconRepositoryId: "repository",
+        },
+      ]);
+
+      const result = await caller.findIcons({ searchText, limitPerGroup: 1 });
+
+      expect(result.icons[0]?.icons).toEqual([
+        {
+          id: "home-assistant",
+          name: "home-assistant.svg",
+          url: "https://example.com/home-assistant.svg",
+        },
+      ]);
+    },
+  );
+});