refactor: enhance API query handling with timeout and improve service exports

elibosley · elibosley · commit ef8a13621de5 · 2025-07-23T08:39:13.000-04:00
Updated the ApiReportService to implement a timeout for GraphQL queries, enhancing reliability during data fetching. Modified the CliInternalClientService to include a fetch timeout mechanism. Additionally, improved the export structure in the shared package to include the ApiKeyService and other relevant modules for better accessibility.
diff --git a/.claude/settings.local.json b/.claude/settings.local.json
@@ -39,7 +39,9 @@
       "Bash(pnpm --filter @unraid/shared build)",
       "Bash(pnpm --filter ./api test src/unraid-api/cli/__test__/report.command.test.ts --run)",
       "Bash(pnpm:*)",
-      "Bash(git checkout:*)"
+      "Bash(git checkout:*)",
+      "Bash(node:*)",
+      "Bash(time node:*)"
     ]
   },
   "enableAllProjectMcpServers": false
diff --git a/api/src/unraid-api/cli/admin-key.service.ts b/api/src/unraid-api/cli/admin-key.service.ts
@@ -1,7 +1,7 @@
 import { Inject, Injectable, Logger, OnModuleInit } from '@nestjs/common';
 
+import type { ApiKeyService } from '@unraid/shared/services/api-key.js';
 import { Role } from '@unraid/shared/graphql.model.js';
-import { ApiKeyService } from '@unraid/shared/services/api-key.js';
 import { API_KEY_SERVICE_TOKEN } from '@unraid/shared/tokens.js';
 
 /**
diff --git a/api/src/unraid-api/cli/api-report.service.ts b/api/src/unraid-api/cli/api-report.service.ts
@@ -140,9 +140,14 @@ export class ApiReportService {
         // Query system data
         let systemResult: { data: SystemReportQuery } | null = null;
         try {
-            systemResult = await client.query({
-                query: SYSTEM_REPORT_QUERY,
-            });
+            systemResult = await Promise.race([
+                client.query({
+                    query: SYSTEM_REPORT_QUERY,
+                }),
+                new Promise<never>((_, reject) =>
+                    setTimeout(() => reject(new Error('Query timeout after 3 seconds')), 3000)
+                ),
+            ]);
         } catch (error) {
             this.logger.error('Error querying system data: ' + error);
             return this.createApiReportData({
@@ -154,9 +159,14 @@ export class ApiReportService {
         // Try to query connect status
         let connectData: ConnectStatusQuery['connect'] | null = null;
         try {
-            const connectResult = await client.query({
-                query: CONNECT_STATUS_QUERY,
-            });
+            const connectResult = await Promise.race([
+                client.query({
+                    query: CONNECT_STATUS_QUERY,
+                }),
+                new Promise<never>((_, reject) =>
+                    setTimeout(() => reject(new Error('Connect query timeout after 3 seconds')), 3000)
+                ),
+            ]);
             connectData = connectResult.data.connect;
         } catch (error) {
             this.logger.debug('Connect plugin not available: ' + error);
@@ -165,9 +175,14 @@ export class ApiReportService {
         // Query services
         let servicesData: ServiceInfo[] = [];
         try {
-            const servicesResult = await client.query({
-                query: SERVICES_QUERY,
-            });
+            const servicesResult = await Promise.race([
+                client.query({
+                    query: SERVICES_QUERY,
+                }),
+                new Promise<never>((_, reject) =>
+                    setTimeout(() => reject(new Error('Services query timeout after 3 seconds')), 3000)
+                ),
+            ]);
             servicesData = servicesResult.data.services || [];
         } catch (error) {
             this.logger.debug('Error querying services: ' + error);
diff --git a/api/src/unraid-api/cli/internal-client.service.ts b/api/src/unraid-api/cli/internal-client.service.ts
@@ -79,7 +79,15 @@ export class CliInternalClientService {
 
         const httpLink = new HttpLink({
             uri: httpUri,
-            fetch,
+            fetch: (uri, options) => {
+                const controller = new AbortController();
+                const timeoutId = setTimeout(() => controller.abort(), 3000); // 3 second timeout
+
+                return fetch(uri, {
+                    ...options,
+                    signal: controller.signal,
+                }).finally(() => clearTimeout(timeoutId));
+            },
             headers: {
                 Origin: '/var/run/unraid-cli.sock',
                 'x-api-key': apiKey,
diff --git a/packages/unraid-shared/src/index.ts b/packages/unraid-shared/src/index.ts
@@ -1 +1,4 @@
-export {}
+export { ApiKeyService } from './services/api-key.js';
+export * from './graphql.model.js';
+export * from './tokens.js';
+export * from './use-permissions.directive.js';
