@takaro/apiclient 0.0.0-dev.f545766 → 0.0.0-dev.f62bfa1

package/src/lib/__tests__/baseClient.unit.test.ts

@@ -0,0 +1,17 @@
+import { describe, it } from 'node:test';
+import { expect } from '@takaro/test/unit';
+import { BaseApiClient, DEFAULT_REQUEST_TIMEOUT_MS } from '../baseClient.js';
+
+describe('BaseApiClient timeouts', () => {
+  it('sets a default request timeout so a stalled request cannot hang forever', () => {
+    const client = new BaseApiClient({ url: 'http://localhost:3000', log: false });
+
+    expect(client.axiosInstance.defaults.timeout).to.equal(DEFAULT_REQUEST_TIMEOUT_MS);
+  });
+
+  it('lets a caller override the timeout', () => {
+    const client = new BaseApiClient({ url: 'http://localhost:3000', log: false, timeoutMs: 5000 });
+
+    expect(client.axiosInstance.defaults.timeout).to.equal(5000);
+  });
+});

package/src/lib/adminClient.ts

@@ -1,6 +1,6 @@
 import { DomainApi } from '../generated/index.js';
-import { BaseApiClient, IBaseApiClientConfig } from './baseClient.js';
-import { AxiosInstance } from 'axios';
+import { BaseApiClient, type IBaseApiClientConfig } from './baseClient.js';
+import { type AxiosInstance } from 'axios';
 
 export interface IAdminApiClientConfig extends IBaseApiClientConfig {
   auth: {
@@ -16,7 +16,9 @@ export class AdminClient extends BaseApiClient<IAdminApiClientConfig> {
 
   private addAuthInterceptor(token: string, axios: AxiosInstance): AxiosInstance {
     axios.interceptors.request.use(async (request) => {
-      if (request.url?.includes('health')) return request;
+      if (request.url?.includes('health')) {
+        return request;
+      }
 
       request.headers['X-Takaro-Admin-Token'] = token;
       return request;

package/src/lib/baseClient.ts

@@ -1,9 +1,24 @@
 import { MetaApi } from '../generated/api.js';
-import axios, { AxiosError, AxiosInstance, AxiosRequestConfig } from 'axios';
+import axios, { type AxiosError, type AxiosInstance, type AxiosRequestConfig } from 'axios';
+
+/**
+ * Axios defaults to NO timeout, so a request whose TCP connection stalls blocks its
+ * await forever. During incident run-29688761260 a single POST hung for ~80 minutes
+ * (Tempo trace 15f5708701c38676355a0e42cb9f7ffe: a client span with no server span),
+ * freezing 3 of 4 CI shards until the 53-minute job timeout.
+ *
+ * 120s is deliberately generous — the goal is "not infinite", not "tight". The slowest
+ * legitimate single call is a domain create under full 4-shard CI load at roughly 30s.
+ * Individual long-running calls should pass a per-request `{ timeout }` override rather
+ * than raising this.
+ */
+export const DEFAULT_REQUEST_TIMEOUT_MS = 120_000;
 
 export interface IBaseApiClientConfig {
   url: string;
   log?: Logger | false;
+  /** Per-request timeout in ms. Defaults to DEFAULT_REQUEST_TIMEOUT_MS. */
+  timeoutMs?: number;
 }
 
 interface Logger {
@@ -27,8 +42,8 @@ export class BaseApiClient<T extends IBaseApiClientConfig> {
     // Only include it when running outside a browser context (Node.js / server-side).
     // Use globalThis so this compiles under both DOM and non-DOM TypeScript lib targets.
     const isBrowser =
-      typeof (globalThis as Record<string, unknown>)['window'] !== 'undefined' &&
-      typeof (globalThis as Record<string, unknown>)['document'] !== 'undefined';
+      (globalThis as Record<string, unknown>).window !== undefined &&
+      (globalThis as Record<string, unknown>).document !== undefined;
     const axiosConfig: AxiosRequestConfig = {
       baseURL: this.config.url,
       headers: {
@@ -36,10 +51,13 @@ export class BaseApiClient<T extends IBaseApiClientConfig> {
         ...(!isBrowser && { 'User-Agent': 'Takaro-API-Client' }),
       },
       withCredentials: true,
+      timeout: this.config.timeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS,
     };
     this.axios = this.addLoggers(axios.create(axiosConfig));
 
-    if (this.config.log) this.log = this.config.log;
+    if (this.config.log) {
+      this.log = this.config.log;
+    }
   }
 
   setHeader(key: string, value: string) {

package/src/lib/client.ts

@@ -23,7 +23,7 @@ import {
   AnalyticsApi,
   InviteLinkApi,
 } from '../generated/api.js';
-import { BaseApiClient, IBaseApiClientConfig } from './baseClient.js';
+import { BaseApiClient, type IBaseApiClientConfig } from './baseClient.js';
 
 export interface IApiClientConfig extends IBaseApiClientConfig {
   auth: {
@@ -64,13 +64,13 @@ export class Client extends BaseApiClient<IApiClientConfig> {
     this.config.auth.token = loginRes.data.data.token;
     this.token = loginRes.data.data.token;
 
-    this.axios.defaults.headers.common['Authorization'] = `Bearer ${loginRes.data.data.token}`;
+    this.axios.defaults.headers.common.Authorization = `Bearer ${loginRes.data.data.token}`;
 
     return loginRes.data.data.token;
   }
 
   public logout() {
-    delete this.axios.defaults.headers.common['Authorization'];
+    delete this.axios.defaults.headers.common.Authorization;
   }
 
   public async permissionCodesToInputs(permissions: string[]) {
@@ -81,8 +81,9 @@ export class Client extends BaseApiClient<IApiClientConfig> {
         permissionId: p.id,
       }));
 
-    if (records.length !== permissions.length)
+    if (records.length !== permissions.length) {
       throw new Error(`Not all permissions were found: ${permissions.join(', ')}`);
+    }
 
     return records;
   }

package/src/main.ts

@@ -1,4 +1,4 @@
-import { AxiosResponse } from 'axios';
+import { type AxiosResponse } from 'axios';
 
 export { AxiosResponse } from 'axios';
 export { isAxiosError } from 'axios';