-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathclient.ts
More file actions
445 lines (398 loc) · 13.3 KB
/
Copy pathclient.ts
File metadata and controls
445 lines (398 loc) · 13.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
import type { ClientOptions, ClientResponse, NgsiError } from "./types.js";
import { clientCredentialsGrant } from "./oauth.js";
import { getTokenStatus } from "./token.js";
export class DryRunSignal extends Error {
constructor() {
super("dry-run");
this.name = "DryRunSignal";
}
}
export class GdbClient {
private baseUrl: string;
private service?: string;
private token?: string;
private refreshToken?: string;
private apiKey?: string;
private clientId?: string;
private clientSecret?: string;
private onTokenRefresh?: (token: string, refreshToken?: string) => void;
private onBeforeRefresh?: () => { token?: string; refreshToken?: string };
private verbose: boolean;
private dryRun: boolean;
private refreshPromise?: Promise<boolean>;
constructor(options: ClientOptions) {
this.baseUrl = options.baseUrl.replace(/\/+$/, "");
this.service = options.service;
this.token = options.token;
this.refreshToken = options.refreshToken;
this.apiKey = options.apiKey;
this.clientId = options.clientId;
this.clientSecret = options.clientSecret;
this.onTokenRefresh = options.onTokenRefresh;
this.onBeforeRefresh = options.onBeforeRefresh;
this.verbose = options.verbose ?? false;
this.dryRun = options.dryRun ?? false;
}
private buildHeaders(extra?: Record<string, string>): Record<string, string> {
const headers: Record<string, string> = {};
headers["Content-Type"] = "application/ld+json";
headers["Accept"] = "application/ld+json";
if (this.service) headers["NGSILD-Tenant"] = this.service;
if (this.token) {
headers["Authorization"] = `Bearer ${this.token}`;
} else if (this.apiKey) {
headers["X-Api-Key"] = this.apiKey;
}
if (extra) {
Object.assign(headers, extra);
}
return headers;
}
private buildUrl(path: string, params?: Record<string, string>): string {
const url = new URL(path, this.baseUrl);
if (params) {
for (const [key, value] of Object.entries(params)) {
if (value !== undefined && value !== "") {
url.searchParams.set(key, value);
}
}
}
return url.toString();
}
private getBasePath(): string {
return "/ngsi-ld/v1";
}
private static readonly SENSITIVE_HEADERS = new Set(["authorization", "x-api-key"]);
private static readonly SENSITIVE_BODY_KEYS = new Set([
"password",
"refreshToken",
"token",
"client_secret",
"clientSecret",
"key",
"apiKey",
]);
private logRequest(
method: string,
url: string,
headers: Record<string, string>,
body?: string,
): void {
if (!this.verbose) return;
process.stderr.write(`> ${method} ${url}\n`);
for (const [k, v] of Object.entries(headers)) {
if (GdbClient.SENSITIVE_HEADERS.has(k.toLowerCase())) {
process.stderr.write(`> ${k}: ***\n`);
} else {
process.stderr.write(`> ${k}: ${v}\n`);
}
}
if (body) {
process.stderr.write(`> Body: ${GdbClient.maskBodySecrets(body)}\n`);
}
process.stderr.write("\n");
}
private static maskBodySecrets(raw: string): string {
try {
const obj = JSON.parse(raw) as Record<string, unknown>;
for (const key of Object.keys(obj)) {
if (GdbClient.SENSITIVE_BODY_KEYS.has(key)) {
obj[key] = "***";
}
}
return JSON.stringify(obj);
} catch {
return raw;
}
}
private logResponse(response: Response): void {
if (!this.verbose) return;
process.stderr.write(`< ${response.status} ${response.statusText}\n`);
response.headers.forEach((v, k) => {
process.stderr.write(`< ${k}: ${v}\n`);
});
process.stderr.write("\n");
}
private static shellQuote(value: string): string {
return `'${value.split("'").join("'\"'\"'")}'`;
}
static buildCurlCommand(
method: string,
url: string,
headers: Record<string, string>,
body?: string,
): string {
const parts: string[] = ["curl"];
if (method !== "GET") {
parts.push(`-X ${method}`);
}
for (const [key, value] of Object.entries(headers)) {
parts.push(`-H ${GdbClient.shellQuote(`${key}: ${value}`)}`);
}
if (body) {
parts.push(`-d ${GdbClient.shellQuote(body)}`);
}
parts.push(GdbClient.shellQuote(url));
return parts.join(" \\\n ");
}
private handleDryRun(
method: string,
url: string,
headers: Record<string, string>,
body?: string,
): void {
if (!this.dryRun) return;
console.log(GdbClient.buildCurlCommand(method, url, headers, body));
throw new DryRunSignal();
}
private canRefresh(): boolean {
if (!this.refreshToken && !(this.clientId && this.clientSecret)) return false;
// When authenticating solely via apiKey (no token), token refresh is unnecessary
if (!this.token && this.apiKey) return false;
return true;
}
/** Proactively refresh the token before making a request if it is expired or about to expire. */
private async proactiveRefresh(): Promise<void> {
if (!this.token || !this.canRefresh()) return;
const status = getTokenStatus(this.token);
if (status.isExpired || status.isExpiringSoon) {
await this.performTokenRefresh();
}
}
/** Check whether an error indicates an authentication/token problem that may be resolved by refreshing. */
private static isTokenError(err: GdbClientError): boolean {
if (err.status === 401) return true;
// The server returns 403 for malformed / expired JWTs in some cases
if (err.status === 403) {
const msg = (err.message ?? "").toLowerCase();
return msg.includes("not assigned to any tenant") || msg.includes("invalid token");
}
return false;
}
private async performTokenRefresh(): Promise<boolean> {
if (this.refreshPromise) return this.refreshPromise;
this.refreshPromise = this.doRefresh();
try {
return await this.refreshPromise;
} finally {
this.refreshPromise = undefined;
}
}
private async doRefresh(): Promise<boolean> {
// Re-read config to pick up tokens saved by another process
if (this.onBeforeRefresh) {
const latest = this.onBeforeRefresh();
if (latest.token && latest.token !== this.token) {
// Another process already refreshed — use the new token
this.token = latest.token;
if (latest.refreshToken) this.refreshToken = latest.refreshToken;
return true;
}
if (latest.refreshToken) {
this.refreshToken = latest.refreshToken;
}
}
// Try refreshToken first
if (this.refreshToken) {
try {
const url = this.buildUrl("/auth/refresh");
const response = await fetch(url, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ refreshToken: this.refreshToken }),
});
if (response.ok) {
const data = (await response.json()) as Record<string, unknown>;
const newToken = (data.accessToken ?? data.token) as string | undefined;
const newRefreshToken = data.refreshToken as string | undefined;
if (newToken) {
this.token = newToken;
if (newRefreshToken) this.refreshToken = newRefreshToken;
this.onTokenRefresh?.(newToken, newRefreshToken);
return true;
}
}
} catch {
// Fall through to client credentials
}
}
// Fallback: client_credentials grant
if (this.clientId && this.clientSecret) {
try {
const result = await clientCredentialsGrant({
baseUrl: this.baseUrl,
clientId: this.clientId,
clientSecret: this.clientSecret,
});
this.token = result.access_token;
this.onTokenRefresh?.(result.access_token);
return true;
} catch {
return false;
}
}
return false;
}
private async executeRequest<T>(
method: string,
path: string,
options?: {
body?: unknown;
params?: Record<string, string>;
headers?: Record<string, string>;
},
): Promise<ClientResponse<T>> {
const url = this.buildUrl(`${this.getBasePath()}${path}`, options?.params);
const headers = this.buildHeaders(options?.headers);
const body = options?.body ? JSON.stringify(options.body) : undefined;
this.logRequest(method, url, headers, body);
this.handleDryRun(method, url, headers, body);
const response = await fetch(url, { method, headers, body });
this.logResponse(response);
const countHeader = response.headers.get("NGSILD-Results-Count");
const count = countHeader ? parseInt(countHeader, 10) : undefined;
let data: T;
/* v8 ignore next -- null coalescing for missing content-type header */
const contentType = response.headers.get("content-type") ?? "";
const text = await response.text();
if (text && (contentType.includes("json") || contentType.includes("ld+json"))) {
data = JSON.parse(text) as T;
} else {
data = text as unknown as T;
}
if (!response.ok) {
const err = data as unknown as NgsiError;
const message =
err?.description || err?.detail || err?.error || err?.title || `HTTP ${response.status}`;
throw new GdbClientError(message, response.status, err);
}
return { status: response.status, headers: response.headers, data, count };
}
private async executeRawRequest<T>(
method: string,
path: string,
options?: {
body?: unknown;
params?: Record<string, string>;
headers?: Record<string, string>;
skipTenantHeader?: boolean;
},
): Promise<ClientResponse<T>> {
const url = this.buildUrl(path, options?.params);
const headers = this.buildHeaders(options?.headers);
if (options?.skipTenantHeader) {
delete headers["NGSILD-Tenant"];
}
const body = options?.body ? JSON.stringify(options.body) : undefined;
this.logRequest(method, url, headers, body);
this.handleDryRun(method, url, headers, body);
const response = await fetch(url, { method, headers, body });
this.logResponse(response);
let data: T;
/* v8 ignore next -- null coalescing for missing content-type header */
const contentType = response.headers.get("content-type") ?? "";
const text = await response.text();
if (text && (contentType.includes("json") || contentType.includes("ld+json"))) {
data = JSON.parse(text) as T;
} else {
data = text as unknown as T;
}
if (!response.ok) {
const err = data as unknown as NgsiError;
const message =
err?.description || err?.detail || err?.error || err?.title || `HTTP ${response.status}`;
throw new GdbClientError(message, response.status, err);
}
return { status: response.status, headers: response.headers, data };
}
async request<T = unknown>(
method: string,
path: string,
options?: {
body?: unknown;
params?: Record<string, string>;
headers?: Record<string, string>;
},
): Promise<ClientResponse<T>> {
await this.proactiveRefresh();
try {
return await this.executeRequest<T>(method, path, options);
} catch (err) {
if (err instanceof GdbClientError && GdbClient.isTokenError(err) && this.canRefresh()) {
const refreshed = await this.performTokenRefresh();
if (refreshed) {
return await this.executeRequest<T>(method, path, options);
}
}
throw err;
}
}
async get<T = unknown>(
path: string,
params?: Record<string, string>,
headers?: Record<string, string>,
): Promise<ClientResponse<T>> {
return this.request<T>("GET", path, { params, headers });
}
async post<T = unknown>(
path: string,
body?: unknown,
params?: Record<string, string>,
): Promise<ClientResponse<T>> {
return this.request<T>("POST", path, { body, params });
}
async patch<T = unknown>(
path: string,
body?: unknown,
params?: Record<string, string>,
): Promise<ClientResponse<T>> {
return this.request<T>("PATCH", path, { body, params });
}
async put<T = unknown>(
path: string,
body?: unknown,
params?: Record<string, string>,
): Promise<ClientResponse<T>> {
return this.request<T>("PUT", path, { body, params });
}
async delete<T = unknown>(
path: string,
params?: Record<string, string>,
): Promise<ClientResponse<T>> {
return this.request<T>("DELETE", path, { params });
}
/** Make a request to a raw URL path (not prefixed with API base path) */
async rawRequest<T = unknown>(
method: string,
path: string,
options?: {
body?: unknown;
params?: Record<string, string>;
headers?: Record<string, string>;
skipTenantHeader?: boolean;
},
): Promise<ClientResponse<T>> {
await this.proactiveRefresh();
try {
return await this.executeRawRequest<T>(method, path, options);
} catch (err) {
if (err instanceof GdbClientError && GdbClient.isTokenError(err) && this.canRefresh()) {
const refreshed = await this.performTokenRefresh();
if (refreshed) {
return await this.executeRawRequest<T>(method, path, options);
}
}
throw err;
}
}
}
export class GdbClientError extends Error {
constructor(
message: string,
public readonly status: number,
public readonly ngsiError?: NgsiError,
) {
super(message);
this.name = "GdbClientError";
}
}