@takaro/apiclient 0.0.0-dev.bf507a2 → 0.0.0-dev.bfbcbc4

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/baseClient.ts

@@ -1,9 +1,24 @@
 import { MetaApi } from '../generated/api.js';
 import axios, { AxiosError, AxiosInstance, 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 {
@@ -36,6 +51,7 @@ 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));
 

package/src/lib/client.ts

@@ -21,6 +21,7 @@ import {
   TrackingApi,
   EntityApi,
   AnalyticsApi,
+  InviteLinkApi,
 } from '../generated/api.js';
 import { BaseApiClient, IBaseApiClientConfig } from './baseClient.js';
 
@@ -305,4 +306,14 @@ export class Client extends BaseApiClient<IApiClientConfig> {
       this.axios,
     );
   }
+
+  get inviteLink() {
+    return new InviteLinkApi(
+      {
+        isJsonMime: this.isJsonMime,
+      },
+      '',
+      this.axios,
+    );
+  }
 }