Skip to content

Commit cc4cbe9

Browse files
committed
user agent
1 parent b289970 commit cc4cbe9

2 files changed

Lines changed: 71 additions & 0 deletions

File tree

‎src/config.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,19 @@ import WebSocket from 'isomorphic-ws';
3636
import child_process from 'node:child_process';
3737
import { SocksProxyAgent } from 'socks-proxy-agent';
3838
import { HttpProxyAgent, HttpProxyAgentOptions, HttpsProxyAgent, HttpsProxyAgentOptions } from 'hpagent';
39+
import packagejson from '../package.json' with { type: 'json' };
40+
import { setHeaderMiddleware } from './middleware.js';
3941

4042
const SERVICEACCOUNT_ROOT: string = '/var/run/secrets/kubernetes.io/serviceaccount';
4143
const SERVICEACCOUNT_CA_PATH: string = SERVICEACCOUNT_ROOT + '/ca.crt';
4244
const SERVICEACCOUNT_TOKEN_PATH: string = SERVICEACCOUNT_ROOT + '/token';
4345
const SERVICEACCOUNT_NAMESPACE_PATH: string = SERVICEACCOUNT_ROOT + '/namespace';
46+
const USER_AGENT_KEY = 'User-Agent';
47+
48+
function getUserAgent(): string {
49+
const version = packagejson.version || '';
50+
return `kubernetes-javascript-client/${version}`;
51+
}
4452

4553
// fs.existsSync was removed in node 10
4654
function fileExists(filepath: string): boolean {
@@ -491,6 +499,7 @@ export class KubeConfig implements SecurityAuthentication {
491499
const config: Configuration = createConfiguration({
492500
baseServer: baseServerConfig,
493501
authMethods: authConfig,
502+
middleware: [setHeaderMiddleware(USER_AGENT_KEY, getUserAgent())],
494503
});
495504

496505
const apiClient = new apiClientType(config);

‎src/config_test.ts‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1674,6 +1674,68 @@ describe('KubeConfig', () => {
16741674
const client = kc.makeApiClient(CoreV1Api);
16751675
strictEqual(client instanceof CoreV1Api, true);
16761676
});
1677+
1678+
it('should include User-Agent header with version', async () => {
1679+
let capturedUserAgent: string | undefined;
1680+
1681+
const { server, host, port } = await createTestHttpsServer((req, res) => {
1682+
capturedUserAgent = req.headers['user-agent'];
1683+
1684+
res.setHeader('Content-Type', 'application/json');
1685+
res.writeHead(200);
1686+
res.end(
1687+
JSON.stringify({
1688+
apiVersion: 'v1',
1689+
kind: 'NamespaceList',
1690+
items: [],
1691+
}),
1692+
);
1693+
});
1694+
1695+
try {
1696+
const kc = new KubeConfig();
1697+
kc.loadFromClusterAndUser(
1698+
{
1699+
name: 'test-cluster',
1700+
server: `https://${host}:${port}`,
1701+
skipTLSVerify: true,
1702+
} as Cluster,
1703+
{
1704+
name: 'test-user',
1705+
token: 'test-token',
1706+
} as User,
1707+
);
1708+
1709+
const coreV1Api = kc.makeApiClient(CoreV1Api);
1710+
await coreV1Api.listNamespace();
1711+
1712+
// Read version from package.json
1713+
const packageJsonPath = join(__dirname, '..', 'package.json');
1714+
const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
1715+
const expectedVersion = packageJson.version;
1716+
1717+
// Verify version is not blank
1718+
strictEqual(typeof expectedVersion, 'string');
1719+
strictEqual(expectedVersion.length > 0, true, 'package.json version should not be blank');
1720+
1721+
// Verify User-Agent header contains client name and version
1722+
strictEqual(typeof capturedUserAgent, 'string');
1723+
strictEqual(
1724+
capturedUserAgent?.startsWith('kubernetes-javascript-client/'),
1725+
true,
1726+
'capturedUserAgent should start with "kubernetes-javascript-client/"',
1727+
);
1728+
strictEqual(
1729+
capturedUserAgent?.includes(expectedVersion),
1730+
true,
1731+
`User-Agent should include version ${expectedVersion}`,
1732+
);
1733+
} finally {
1734+
await new Promise<void>((resolve) => {
1735+
server.close(() => resolve());
1736+
});
1737+
}
1738+
});
16771739
});
16781740

16791741
describe('EmptyConfig', () => {

0 commit comments

Comments
 (0)