Merge pull request #123 from bfritscher/copilot/add-connection-timeout-config

Add connectionTimeoutSeconds configuration via UI and config file
fixes #122

Author: bfritscher

config.json.sample

@@ -7,6 +7,7 @@
     "path": "",
     "tls": false
   },
+  "connectionTimeoutSeconds": 10,
   "ui": {
     "hideProjectInfo": true
   },

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "typesense-dashboard",
-  "version": "2.4.5",
+  "version": "2.4.6",
   "description": "A Typesense Dashboard to manage and browse collections.",
   "productName": "Typesense-Dashboard",
   "author": "Boris Fritscher <boris@fritscher.ch>",
@@ -19,39 +19,39 @@
   },
   "dependencies": {
     "@quasar/extras": "1.17.0",
-    "axios": "1.13.2",
+    "axios": "1.13.5",
     "file-saver": "2.0.5",
-    "instantsearch.css": "8.9.0",
+    "instantsearch.css": "8.11.0",
     "monaco-editor": "0.55.1",
     "nanoid": "5.1.6",
     "pinia": "3.0.4",
     "pretty-bytes": "7.1.0",
     "quasar": "2.18.6",
     "typesense": "2.1.0",
     "typesense-instantsearch-adapter": "2.9.0",
-    "vue": "3.5.26",
-    "vue-instantsearch": "4.22.6",
+    "vue": "3.5.29",
+    "vue-instantsearch": "4.24.0",
     "vue-router": "4.6.4"
   },
   "devDependencies": {
     "@electron/packager": "18.4.4",
     "@eslint/js": "9.39.2",
     "@quasar/app-vite": "2.4.0",
     "@types/file-saver": "2.0.7",
-    "@types/node": "25.0.3",
-    "@vue/devtools": "8.0.5",
+    "@types/node": "25.3.2",
+    "@vue/devtools": "8.0.6",
     "@vue/eslint-config-prettier": "10.2.0",
-    "@vue/eslint-config-typescript": "14.6.0",
-    "autoprefixer": "10.4.23",
+    "@vue/eslint-config-typescript": "14.7.0",
+    "autoprefixer": "10.4.27",
     "electron": "39.2.7",
     "eslint": "9.39.2",
-    "eslint-plugin-vue": "10.6.2",
-    "globals": "16.5.0",
-    "prettier": "3.7.4",
+    "eslint-plugin-vue": "10.8.0",
+    "globals": "17.3.0",
+    "prettier": "3.8.1",
     "typescript": "5.9.3",
     "vite-plugin-checker": "0.12.0",
-    "vue-eslint-parser": "10.2.0",
-    "vue-tsc": "3.1.8"
+    "vue-eslint-parser": "10.4.0",
+    "vue-tsc": "3.2.5"
   },
   "engines": {
     "node": "^28 || ^26 || ^24 || ^22 || ^20",

package.json

@@ -40,6 +40,13 @@ function isCurrent(entry: NodeLoginDataInterface) {
 
 function connect(entry: NodeLoginDataInterface) {
   // Do not redirect to home from the cluster page
-  store.login({ node: entry.node, apiKey: entry.apiKey });
+  const payload: Parameters<typeof store.login>[0] = {
+    node: entry.node,
+    apiKey: entry.apiKey,
+  };
+  if (entry.connectionTimeoutSeconds !== undefined) {
+    payload.connectionTimeoutSeconds = entry.connectionTimeoutSeconds;
+  }
+  store.login(payload);
 }
 </script>

src/pages/ClusterStatus.vue

@@ -33,6 +33,23 @@
                 label="path"
                 hint="optional: leave blank or start with / and end without /"
               />
+              <q-expansion-item
+                v-model="showAdvancedSettings"
+                dense
+                dense-toggle
+                label="Advanced settings"
+                class="text-left"
+              >
+                <q-input
+                  v-model.number="connectionTimeoutSeconds"
+                  class="q-mt-sm"
+                  filled
+                  type="number"
+                  label="Connection Timeout (seconds)"
+                  hint="optional: leave blank to use default timeout"
+                  clearable
+                />
+              </q-expansion-item>
               <div class="text-left">
                 <q-toggle
                   v-if="$q.platform.is.electron && store.currentNodeConfig.protocol === 'https'"
@@ -75,15 +92,23 @@ const store = useNodeStore();
 
 const protocolOptions = ['http', 'https'];
 const apiKey = ref('');
+const showAdvancedSettings = ref(false);
+const connectionTimeoutSeconds = ref<number | null>(
+  store.loginData?.connectionTimeoutSeconds ?? null,
+);
 
 onMounted(() => {
   void store.connectionCheck();
 });
 
 function login() {
-  void store.login({
+  const payload: Parameters<typeof store.login>[0] = {
     apiKey: apiKey.value,
     node: store.currentNodeConfig,
-  });
+  };
+  if (connectionTimeoutSeconds.value !== null) {
+    payload.connectionTimeoutSeconds = connectionTimeoutSeconds.value;
+  }
+  void store.login(payload);
 }
 </script>

src/pages/Login.vue

@@ -163,6 +163,7 @@
           <div>Protocol: {{ store.loginData?.node.protocol }}</div>
           <div>Host: {{ store.loginData?.node.host }}</div>
           <div>Port: {{ store.loginData?.node.port }}</div>
+          <div>Connection Timeout: {{ connectionTimeoutDisplay }}</div>
           <div v-if="store.data.debug.version">Version: {{ store.data.debug.version }}</div>
           <div v-if="Object.hasOwnProperty.call(store.data.debug, 'state')">
             Role:
@@ -405,7 +406,20 @@ const systemNetworkSentLabel = computed(() => {
   return v === null ? '—' : prettyBytes(v);
 });
 
+const connectionTimeoutDisplay = computed(() => {
+  const timeout = store.loginData?.connectionTimeoutSeconds;
+  return timeout !== undefined ? `${timeout}s` : 'Default';
+});
+
 function connectTo(member: NodeLoginDataInterface) {
-  void store.login({ apiKey: member.apiKey, node: member.node, forceHomeRedirect: true });
+  const payload: Parameters<typeof store.login>[0] = {
+    apiKey: member.apiKey,
+    node: member.node,
+    forceHomeRedirect: true,
+  };
+  if (member.connectionTimeoutSeconds !== undefined) {
+    payload.connectionTimeoutSeconds = member.connectionTimeoutSeconds;
+  }
+  void store.login(payload);
 }
 </script>

src/pages/ServerStatus.vue

@@ -4,7 +4,10 @@ import * as Typesense from 'typesense';
 import type { CollectionAliasSchema } from 'typesense/lib/Typesense/Aliases';
 import type { CollectionCreateSchema } from 'typesense/lib/Typesense/Collections';
 import type { CollectionUpdateSchema } from 'typesense/lib/Typesense/Collection';
-import type { NodeConfiguration } from 'typesense/lib/Typesense/Configuration';
+import type {
+  ConfigurationOptions,
+  NodeConfiguration,
+} from 'typesense/lib/Typesense/Configuration';
 import type { SearchParams } from 'typesense/lib/Typesense/Documents';
 import type { KeyCreateSchema } from 'typesense/lib/Typesense/Key';
 import type { OverrideSchema } from 'typesense/lib/Typesense/Override';
@@ -19,20 +22,27 @@ export class Api {
   public axiosClient?: AxiosInstance;
   private typesenseClient?: Typesense.Client;
 
-  public init({ node, apiKey }: { node: NodeConfiguration; apiKey: string }): void {
+  public init({
+    node,
+    apiKey,
+    connectionTimeoutSeconds,
+  }: {
+    node: NodeConfiguration;
+    apiKey: string;
+    connectionTimeoutSeconds?: number;
+  }): void {
     this.axiosClient = axios.create({
       baseURL: `${node.protocol}://${node.host}:${node.port}${node.path || ''}`,
       headers: { 'x-typesense-api-key': apiKey },
     });
-    this.typesenseClient = new Typesense.Client({
-      nodes: [
-        {
-          ...node,
-        },
-      ],
+    const clientConfig: ConfigurationOptions = {
+      nodes: [{ ...node }],
       apiKey,
-      //connection_timeout_seconds: 3600,
-    });
+    };
+    if (connectionTimeoutSeconds !== undefined) {
+      clientConfig.connectionTimeoutSeconds = connectionTimeoutSeconds;
+    }
+    this.typesenseClient = new Typesense.Client(clientConfig);
   }
 
   public getDebug() {

src/shared/api.ts

@@ -64,6 +64,7 @@ export interface NodeLoginDataInterface {
   node: CustomNodeConfiguration;
   apiKey: string;
   clusterTag?: string;
+  connectionTimeoutSeconds?: number;
 }
 
 export interface NodeLoginPayloadInterface extends NodeLoginDataInterface {
@@ -179,10 +180,14 @@ export const useNodeStore = defineStore('node', {
           api = electron;
           (electron as any).rejectTLS(Number(state.loginData.node.tls));
         }
-        api.init({
+        const initConfig: Parameters<typeof api.init>[0] = {
           node: { ...state.loginData.node },
           apiKey: state.loginData.apiKey,
-        });
+        };
+        if (state.loginData.connectionTimeoutSeconds !== undefined) {
+          initConfig.connectionTimeoutSeconds = state.loginData.connectionTimeoutSeconds;
+        }
+        api.init(initConfig);
         return api;
       }
     },
@@ -474,7 +479,7 @@ export const useNodeStore = defineStore('node', {
         });
     },
     login(loginData: NodeLoginPayloadInterface) {
-      const { apiKey, node, forceHomeRedirect = false } = loginData;
+      const { apiKey, node, forceHomeRedirect = false, connectionTimeoutSeconds } = loginData;
       let { clusterTag } = loginData;
       // Recover clusterTag from history if not provided
       if (!clusterTag) {
@@ -493,7 +498,14 @@ export const useNodeStore = defineStore('node', {
       }
       this.setForceRedirect(forceHomeRedirect);
       this.setCurrentNodeConfig(node);
-      this.setNodeData({ apiKey, node, clusterTag } as NodeLoginDataInterface);
+      const nodeData: NodeLoginDataInterface = { apiKey, node };
+      if (clusterTag !== undefined) {
+        nodeData.clusterTag = clusterTag;
+      }
+      if (connectionTimeoutSeconds !== undefined) {
+        nodeData.connectionTimeoutSeconds = connectionTimeoutSeconds;
+      }
+      this.setNodeData(nodeData);
       void this.connectionCheck();
     },
     logout() {
@@ -898,6 +910,9 @@ export const useNodeStore = defineStore('node', {
         apiKey: parsed.apiKey,
         clusterTag: tag,
       };
+      if (parsed.connectionTimeoutSeconds !== undefined) {
+        updated.connectionTimeoutSeconds = parsed.connectionTimeoutSeconds;
+      }
       this.loginHistory.splice(index, 1, JSON.stringify(updated));
       LocalStorage.set(STORAGE_KEY_LOGIN_HISTORY, this.loginHistory);
       if (this.loginData) {
@@ -908,6 +923,9 @@ export const useNodeStore = defineStore('node', {
       if (index < 0 || index >= this.loginHistoryParsed.length) return;
       const base = this.loginHistoryParsed[index] as NodeLoginDataInterface;
       const noTag: NodeLoginDataInterface = { node: base.node, apiKey: base.apiKey };
+      if (base.connectionTimeoutSeconds !== undefined) {
+        noTag.connectionTimeoutSeconds = base.connectionTimeoutSeconds;
+      }
       this.loginHistory.splice(index, 1, JSON.stringify(noTag));
       LocalStorage.set(STORAGE_KEY_LOGIN_HISTORY, this.loginHistory);
       if (this.loginData) {