From 2c19e13c09a301315ecf82671ae3b2c1fefba334 Mon Sep 17 00:00:00 2001
From: DecDuck <declanahofmeyr@gmail.com>
Date: Wed, 25 Dec 2024 23:36:39 +1100
Subject: [PATCH] feat(admin ui): improve feedback when metadata fails

---
 pages/admin/library/import.vue                | 195 +++++++-----------
 server/api/v1/admin/import/game/search.get.ts |  10 +-
 server/internal/metadata/index.ts             |  24 ++-
 3 files changed, 96 insertions(+), 133 deletions(-)

diff --git a/pages/admin/library/import.vue b/pages/admin/library/import.vue
index 794c0ca..8af86a0 100644
--- a/pages/admin/library/import.vue
+++ b/pages/admin/library/import.vue
@@ -1,70 +1,39 @@
 <template>
   <div class="flex flex-col gap-y-4">
-    <Listbox
-      as="div"
-      class="max-w-md"
-      v-on:update:model-value="(value) => updateSelectedGame(value)"
-      :model="currentlySelectedGame"
-    >
-      <ListboxLabel class="block text-sm font-medium leading-6 text-zinc-100"
-        >Select game to import</ListboxLabel
-      >
+    <Listbox as="div" class="max-w-md" v-on:update:model-value="(value) => updateSelectedGame_wrapper(value)"
+      :model="currentlySelectedGame">
+      <ListboxLabel class="block text-sm font-medium leading-6 text-zinc-100">Select game to import</ListboxLabel>
       <div class="relative mt-2">
         <ListboxButton
-          class="relative w-full cursor-default rounded-md bg-zinc-950 py-1.5 pl-3 pr-10 text-left text-zinc-100 shadow-sm ring-1 ring-inset ring-zinc-800 focus:outline-none focus:ring-2 focus:ring-blue-600 sm:text-sm sm:leading-6"
-        >
+          class="relative w-full cursor-default rounded-md bg-zinc-950 py-1.5 pl-3 pr-10 text-left text-zinc-100 shadow-sm ring-1 ring-inset ring-zinc-800 focus:outline-none focus:ring-2 focus:ring-blue-600 sm:text-sm sm:leading-6">
           <span v-if="currentlySelectedGame != -1" class="block truncate">{{
             games.unimportedGames[currentlySelectedGame]
           }}</span>
-          <span v-else class="block truncate text-zinc-400"
-            >Please select a directory...</span
-          >
-          <span
-            class="pointer-events-none absolute inset-y-0 right-0 flex items-center pr-2"
-          >
-            <ChevronUpDownIcon
-              class="h-5 w-5 text-gray-400"
-              aria-hidden="true"
-            />
+          <span v-else class="block truncate text-zinc-400">Please select a directory...</span>
+          <span class="pointer-events-none absolute inset-y-0 right-0 flex items-center pr-2">
+            <ChevronUpDownIcon class="h-5 w-5 text-gray-400" aria-hidden="true" />
           </span>
         </ListboxButton>
 
-        <transition
-          leave-active-class="transition ease-in duration-100"
-          leave-from-class="opacity-100"
-          leave-to-class="opacity-0"
-        >
+        <transition leave-active-class="transition ease-in duration-100" leave-from-class="opacity-100"
+          leave-to-class="opacity-0">
           <ListboxOptions
-            class="absolute z-10 mt-1 max-h-60 w-full overflow-auto rounded-md bg-zinc-900 py-1 text-base shadow-lg ring-1 ring-zinc-800 focus:outline-none sm:text-sm"
-          >
-            <ListboxOption
-              as="template"
-              v-for="(game, gameIdx) in games.unimportedGames"
-              :key="game"
-              :value="gameIdx"
-              v-slot="{ active, selected }"
-            >
-              <li
-                :class="[
-                  active ? 'bg-blue-600 text-white' : 'text-zinc-100',
-                  'relative cursor-default select-none py-2 pl-3 pr-9',
-                ]"
-              >
-                <span
-                  :class="[
-                    selected ? 'font-semibold' : 'font-normal',
-                    'block truncate',
-                  ]"
-                  >{{ game }}</span
-                >
+            class="absolute z-10 mt-1 max-h-60 w-full overflow-auto rounded-md bg-zinc-900 py-1 text-base shadow-lg ring-1 ring-zinc-800 focus:outline-none sm:text-sm">
+            <ListboxOption as="template" v-for="(game, gameIdx) in games.unimportedGames" :key="game" :value="gameIdx"
+              v-slot="{ active, selected }">
+              <li :class="[
+                active ? 'bg-blue-600 text-white' : 'text-zinc-100',
+                'relative cursor-default select-none py-2 pl-3 pr-9',
+              ]">
+                <span :class="[
+                  selected ? 'font-semibold' : 'font-normal',
+                  'block truncate',
+                ]">{{ game }}</span>
 
-                <span
-                  v-if="selected"
-                  :class="[
-                    active ? 'text-white' : 'text-blue-600',
-                    'absolute inset-y-0 right-0 flex items-center pr-4',
-                  ]"
-                >
+                <span v-if="selected" :class="[
+                  active ? 'text-white' : 'text-blue-600',
+                  'absolute inset-y-0 right-0 flex items-center pr-4',
+                ]">
                   <CheckIcon class="h-5 w-5" aria-hidden="true" />
                 </span>
               </li>
@@ -74,57 +43,30 @@
       </div>
     </Listbox>
 
-    <Listbox
-      as="div"
-      class="max-w-md"
-      v-if="metadataResults"
-      v-model="currentlySelectedMetadata"
-    >
-      <ListboxLabel class="block text-sm font-medium leading-6 text-zinc-100"
-        >Select game</ListboxLabel
-      >
+    <Listbox as="div" class="max-w-md" v-if="metadataResults && metadataResults.length > 0"
+      v-model="currentlySelectedMetadata">
+      <ListboxLabel class="block text-sm font-medium leading-6 text-zinc-100">Select game</ListboxLabel>
       <div class="relative mt-2">
         <ListboxButton
-          class="relative w-full cursor-default rounded-md bg-zinc-950 py-1.5 pl-3 pr-10 text-left text-zinc-100 shadow-sm ring-1 ring-inset ring-zinc-800 focus:outline-none focus:ring-2 focus:ring-blue-600 sm:text-sm sm:leading-6"
-        >
-          <GameSearchResultWidget
-            v-if="currentlySelectedMetadata != -1"
-            :game="metadataResults[currentlySelectedMetadata]"
-          />
-          <span v-else class="block truncate text-zinc-600"
-            >Please select a game...</span
-          >
-          <span
-            class="pointer-events-none absolute inset-y-0 right-0 flex items-center pr-2"
-          >
-            <ChevronUpDownIcon
-              class="h-5 w-5 text-gray-400"
-              aria-hidden="true"
-            />
+          class="relative w-full cursor-default rounded-md bg-zinc-950 py-1.5 pl-3 pr-10 text-left text-zinc-100 shadow-sm ring-1 ring-inset ring-zinc-800 focus:outline-none focus:ring-2 focus:ring-blue-600 sm:text-sm sm:leading-6">
+          <GameSearchResultWidget v-if="currentlySelectedMetadata != -1"
+            :game="metadataResults[currentlySelectedMetadata]" />
+          <span v-else class="block truncate text-zinc-600">Please select a game...</span>
+          <span class="pointer-events-none absolute inset-y-0 right-0 flex items-center pr-2">
+            <ChevronUpDownIcon class="h-5 w-5 text-gray-400" aria-hidden="true" />
           </span>
         </ListboxButton>
 
-        <transition
-          leave-active-class="transition ease-in duration-100"
-          leave-from-class="opacity-100"
-          leave-to-class="opacity-0"
-        >
+        <transition leave-active-class="transition ease-in duration-100" leave-from-class="opacity-100"
+          leave-to-class="opacity-0">
           <ListboxOptions
-            class="absolute z-10 mt-1 max-h-60 w-full overflow-auto rounded-md bg-zinc-900 py-1 text-base shadow-lg ring-1 ring-black ring-opacity-5 focus:outline-none sm:text-sm"
-          >
-            <ListboxOption
-              as="template"
-              v-for="(result, resultIdx) in metadataResults"
-              :key="result.id"
-              :value="resultIdx"
-              v-slot="{ active, selected }"
-            >
-              <li
-                :class="[
-                  active ? 'bg-blue-600 text-white' : 'text-zinc-100',
-                  'relative cursor-default select-none py-2 pl-3 pr-9',
-                ]"
-              >
+            class="absolute z-10 mt-1 max-h-60 w-full overflow-auto rounded-md bg-zinc-900 py-1 text-base shadow-lg ring-1 ring-black ring-opacity-5 focus:outline-none sm:text-sm">
+            <ListboxOption as="template" v-for="(result, resultIdx) in metadataResults" :key="result.id"
+              :value="resultIdx" v-slot="{ active, selected }">
+              <li :class="[
+                active ? 'bg-blue-600 text-white' : 'text-zinc-100',
+                'relative cursor-default select-none py-2 pl-3 pr-9',
+              ]">
                 <GameSearchResultWidget :game="result" />
               </li>
             </ListboxOption>
@@ -132,38 +74,36 @@
         </transition>
       </div>
     </Listbox>
-    <div
-      v-else-if="currentlySelectedGame != -1"
-      role="status"
-      class="inline-flex text-zinc-100 font-display font-semibold items-center gap-x-4"
-    >
+    <div v-else-if="gameSearchResultsLoading" role="status"
+      class="inline-flex text-zinc-100 font-display font-semibold items-center gap-x-4">
       Loading game results...
-      <svg
-        aria-hidden="true"
-        class="w-6 h-6 text-transparent animate-spin fill-white"
-        viewBox="0 0 100 101"
-        fill="none"
-        xmlns="http://www.w3.org/2000/svg"
-      >
+      <svg aria-hidden="true" class="w-6 h-6 text-transparent animate-spin fill-white" viewBox="0 0 100 101" fill="none"
+        xmlns="http://www.w3.org/2000/svg">
         <path
           d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z"
-          fill="currentColor"
-        />
+          fill="currentColor" />
         <path
           d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z"
-          fill="currentFill"
-        />
+          fill="currentFill" />
       </svg>
       <span class="sr-only">Loading...</span>
     </div>
 
+    <div v-if="gameSearchResultsError" class="w-fit rounded-md bg-red-600/10 p-4">
+      <div class="flex">
+        <div class="flex-shrink-0">
+          <XCircleIcon class="h-5 w-5 text-red-600" aria-hidden="true" />
+        </div>
+        <div class="ml-3">
+          <h3 class="text-sm font-medium text-red-600">
+            {{ gameSearchResultsError }}
+          </h3>
+        </div>
+      </div>
+    </div>
+
     <div v-if="currentlySelectedGame !== -1 && currentlySelectedMetadata !== -1">
-      <LoadingButton
-        @click="() => importGame_wrapper()"
-        class="w-fit"
-        :loading="importLoading"
-        >Import</LoadingButton
-      >
+      <LoadingButton @click="() => importGame_wrapper()" class="w-fit" :loading="importLoading">Import</LoadingButton>
 
       <div v-if="importError" class="mt-4 w-fit rounded-md bg-red-600/10 p-4">
         <div class="flex">
@@ -201,6 +141,8 @@ const headers = useRequestHeaders(["cookie"]);
 const games = await $fetch("/api/v1/admin/import/game", { headers });
 
 const currentlySelectedGame = ref(-1);
+const gameSearchResultsLoading = ref(false);
+const gameSearchResultsError = ref<string | undefined>();
 
 async function updateSelectedGame(value: number) {
   if (currentlySelectedGame.value == value) return;
@@ -218,6 +160,15 @@ async function updateSelectedGame(value: number) {
   metadataResults.value = results;
 }
 
+function updateSelectedGame_wrapper(value: number) {
+  gameSearchResultsLoading.value = true;
+  updateSelectedGame(value).catch((error) => {
+    gameSearchResultsError.value = error.statusMessage || "An unknown error occurred";
+  }).finally(() => {
+    gameSearchResultsLoading.value = false;
+  })
+}
+
 const metadataResults = ref<Array<GameMetadataSearchResult> | undefined>();
 const currentlySelectedMetadata = ref(-1);
 
diff --git a/server/api/v1/admin/import/game/search.get.ts b/server/api/v1/admin/import/game/search.get.ts
index 8cee3e2..90c9344 100644
--- a/server/api/v1/admin/import/game/search.get.ts
+++ b/server/api/v1/admin/import/game/search.get.ts
@@ -9,5 +9,13 @@ export default defineEventHandler(async (h3) => {
   if (!search)
     throw createError({ statusCode: 400, statusMessage: "Invalid search" });
 
-  return await h3.context.metadataHandler.search(search);
+  const results = await h3.context.metadataHandler.search(search);
+
+  if (results.length == 0)
+    throw createError({
+      statusCode: 500,
+      statusMessage: "No metadata provider returned search results.",
+    });
+
+  return results;
 });
diff --git a/server/internal/metadata/index.ts b/server/internal/metadata/index.ts
index c77d97a..cd39915 100644
--- a/server/internal/metadata/index.ts
+++ b/server/internal/metadata/index.ts
@@ -50,15 +50,19 @@ export class MetadataHandler {
       const queryTransformationPromise = new Promise<
         InternalGameMetadataResult[]
       >(async (resolve, reject) => {
-        const results = await provider.search(query);
-        const mappedResults: InternalGameMetadataResult[] = results.map(
-          (result) =>
-            Object.assign({}, result, {
-              sourceId: provider.id(),
-              sourceName: provider.name(),
-            })
-        );
-        resolve(mappedResults);
+        try {
+          const results = await provider.search(query);
+          const mappedResults: InternalGameMetadataResult[] = results.map(
+            (result) =>
+              Object.assign({}, result, {
+                sourceId: provider.id(),
+                sourceName: provider.name(),
+              })
+          );
+          resolve(mappedResults);
+        } catch (e) {
+          reject(e);
+        }
       });
       promises.push(queryTransformationPromise);
     }
@@ -68,7 +72,7 @@ export class MetadataHandler {
       .filter((result) => result.status === "fulfilled")
       .map((result) => result.value)
       .flat();
-
+      
     return successfulResults;
   }