Skip to content

Commit 8cf9830

Browse files
committed
feat: add request timeout call options
1 parent 7f7d7ab commit 8cf9830

5 files changed

Lines changed: 60 additions & 20 deletions

File tree

‎examples/timeout-example.js‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import * as k8s from '@kubernetes/client-node';
2+
3+
const kc = new k8s.KubeConfig();
4+
kc.loadFromDefault();
5+
6+
const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
7+
8+
try {
9+
const pods = await k8sApi.listNamespacedPod(
10+
{ namespace: 'default' },
11+
k8s.setRequestTimeoutOptions(5_000),
12+
);
13+
console.log(`Found ${pods.items.length} pods.`);
14+
} catch (err) {
15+
if (err instanceof Error && err.name === 'TimeoutError') {
16+
console.error('The Kubernetes API request timed out.');
17+
} else {
18+
throw err;
19+
}
20+
}

‎examples/typescript/timeout/timeout-example.ts‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
1-
import { CoreV1Api, KubeConfig, requestTimeoutMiddleware } from '@kubernetes/client-node';
1+
import { CoreV1Api, KubeConfig, setRequestTimeoutOptions } from '@kubernetes/client-node';
22

33
const kc = new KubeConfig();
44
kc.loadFromDefault();
55

66
const k8sApi = kc.makeApiClient(CoreV1Api);
77

88
try {
9-
const pods = await k8sApi.listNamespacedPod(
10-
{ namespace: 'default' },
11-
{
12-
middleware: [requestTimeoutMiddleware(5_000)],
13-
middlewareMergeStrategy: 'append',
14-
},
15-
);
9+
const pods = await k8sApi.listNamespacedPod({ namespace: 'default' }, setRequestTimeoutOptions(5_000));
1610
console.log(`Found ${pods.items.length} pods.`);
1711
} catch (err) {
1812
if (err instanceof Error && err.name === 'TimeoutError') {

‎src/fullrequest_test.ts‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { MockAgent, setGlobalDispatcher, getGlobalDispatcher, type Dispatcher }
55
import { CoreV1Api } from './api.js';
66
import { KubeConfig } from './config.js';
77
import { Cluster, User } from './config_types.js';
8-
import { requestTimeoutMiddleware } from './middleware.js';
8+
import { requestTimeoutMiddleware, setRequestTimeoutOptions } from './middleware.js';
99

1010
describe('FullRequest', () => {
1111
describe('getPods', () => {
@@ -81,16 +81,9 @@ describe('FullRequest', () => {
8181
.reply(200, { kind: 'PodList', apiVersion: 'v1', items: [] })
8282
.delay(100);
8383

84-
await rejects(
85-
k8sApi.listNamespacedPod(
86-
{ namespace: 'default' },
87-
{
88-
middleware: [requestTimeoutMiddleware(10)],
89-
middlewareMergeStrategy: 'append',
90-
},
91-
),
92-
{ name: 'TimeoutError' },
93-
);
84+
await rejects(k8sApi.listNamespacedPod({ namespace: 'default' }, setRequestTimeoutOptions(10)), {
85+
name: 'TimeoutError',
86+
});
9487
});
9588
});
9689
});

‎src/middleware.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,19 @@ export function requestTimeoutMiddleware(milliseconds: number): ObservableMiddle
3737
};
3838
}
3939

40+
/** Returns call options that abort a request after the given number of milliseconds. */
41+
export function setRequestTimeoutOptions(
42+
milliseconds: number,
43+
opt?: ConfigurationOptions<ObservableMiddleware>,
44+
): ConfigurationOptions<ObservableMiddleware> {
45+
const existingMiddleware = opt?.middleware || [];
46+
return {
47+
...opt,
48+
middleware: existingMiddleware.concat(requestTimeoutMiddleware(milliseconds)),
49+
middlewareMergeStrategy: 'append',
50+
};
51+
}
52+
4053
// Returns ConfigurationOptions that set a header
4154
export function setHeaderOptions(
4255
key: string,

‎src/middleware_test.ts‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@ import { describe, it } from 'node:test';
22
import { RequestContext, ConfigurationOptions, HttpMethod, ObservableMiddleware } from './gen/index.js';
33
import { deepStrictEqual, strictEqual } from 'node:assert';
44
import { once } from 'node:events';
5-
import { requestTimeoutMiddleware, setHeaderMiddleware, setHeaderOptions } from './middleware.js';
5+
import {
6+
requestTimeoutMiddleware,
7+
setHeaderMiddleware,
8+
setHeaderOptions,
9+
setRequestTimeoutOptions,
10+
} from './middleware.js';
611

712
describe('Middleware', async () => {
813
describe('setHeaderMiddleware', async () => {
@@ -63,4 +68,19 @@ describe('Middleware', async () => {
6368
strictEqual(signal?.reason.name, 'TimeoutError');
6469
});
6570
});
71+
72+
describe('setRequestTimeoutOptions', () => {
73+
it('should append timeout middleware to existing call options', async () => {
74+
const existingMiddleware = setHeaderMiddleware('test-key', 'test-value');
75+
const options = setRequestTimeoutOptions(10, { middleware: [existingMiddleware] });
76+
77+
strictEqual(options.middlewareMergeStrategy, 'append');
78+
strictEqual(options.middleware?.[0], existingMiddleware);
79+
strictEqual(options.middleware?.length, 2);
80+
81+
const reqContext = new RequestContext('http://nowhere.com', HttpMethod.GET);
82+
const postMiddlewareRequest = await options.middleware?.[1].pre(reqContext).toPromise();
83+
strictEqual(postMiddlewareRequest?.getSignal()?.aborted, false);
84+
});
85+
});
6686
});

0 commit comments

Comments
 (0)