-
Notifications
You must be signed in to change notification settings - Fork 565
Expand file tree
/
Copy pathcache.ts
More file actions
384 lines (355 loc) · 12.5 KB
/
cache.ts
File metadata and controls
384 lines (355 loc) · 12.5 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
import {
ADD,
CHANGE,
CONNECT,
DELETE,
ERROR,
ErrorCallback,
Informer,
ListPromise,
ObjectCallback,
UPDATE,
} from './informer.js';
import { KubernetesObject, KubernetesListObject } from './types.js';
import { ObjectSerializer } from './serializer.js';
import { setTimeout } from 'node:timers/promises';
import { Watch } from './watch.js';
export interface ObjectCache<T> {
get(name: string, namespace?: string): T | undefined;
list(namespace?: string): ReadonlyArray<T>;
}
// exported for testing
export type CacheMap<T extends KubernetesObject> = Map<string, Map<string, T>>;
export interface ListWatchOptions {
delayFn?: (ms: number) => Promise<void>;
}
export class ListWatch<T extends KubernetesObject> implements ObjectCache<T>, Informer<T> {
private static readonly BASE_RECONNECT_DELAY_MS = 1000;
private static readonly MAX_RECONNECT_DELAY_MS = 30000;
private objects: CacheMap<T> = new Map();
private resourceVersion: string;
private readonly indexCache: { [key: string]: T[] } = {};
private readonly callbackCache: { [key: string]: (ObjectCallback<T> | ErrorCallback)[] } = {};
private request: AbortController | undefined;
private stopped: boolean = false;
private reconnectDelayMs: number = 0;
private hasConnected: boolean = false;
private readonly delayFn: (ms: number) => Promise<void>;
private readonly path: string;
private readonly watch: Watch;
private readonly listFn: ListPromise<T>;
private readonly labelSelector?: string;
private readonly fieldSelector?: string;
// TODO: collapse autoStart, labelSelector, fieldSelector into ListWatchOptions
public constructor(
path: string,
watch: Watch,
listFn: ListPromise<T>,
autoStart: boolean = true,
labelSelector?: string,
fieldSelector?: string,
options?: ListWatchOptions,
) {
this.path = path;
this.watch = watch;
this.listFn = listFn;
this.labelSelector = labelSelector;
this.fieldSelector = fieldSelector;
this.delayFn = options?.delayFn ?? setTimeout;
this.callbackCache[ADD] = [];
this.callbackCache[UPDATE] = [];
this.callbackCache[DELETE] = [];
this.callbackCache[ERROR] = [];
this.callbackCache[CONNECT] = [];
this.resourceVersion = '';
if (autoStart) {
this.doneHandler(null);
}
}
public async start(): Promise<void> {
this.stopped = false;
this.reconnectDelayMs = 0;
this.hasConnected = false;
await this.doneHandler(null);
}
public async stop(): Promise<void> {
this.stopped = true;
this._stop();
}
public on(verb: ADD | UPDATE | DELETE | CHANGE, cb: ObjectCallback<T>): void;
public on(verb: ERROR | CONNECT, cb: ErrorCallback): void;
public on(
verb: ADD | UPDATE | DELETE | CHANGE | ERROR | CONNECT,
cb: ObjectCallback<T> | ErrorCallback,
): void {
if (verb === CHANGE) {
this.on(ADD, cb);
this.on(UPDATE, cb);
this.on(DELETE, cb);
return;
}
if (this.callbackCache[verb] === undefined) {
throw new Error(`Unknown verb: ${verb}`);
}
this.callbackCache[verb].push(cb);
}
public off(verb: 'add' | 'update' | 'delete' | 'change', cb: ObjectCallback<T>): void;
public off(verb: 'error' | 'connect', cb: ErrorCallback): void;
public off(verb: string, cb: any): void {
if (verb === CHANGE) {
this.off('add', cb);
this.off('update', cb);
this.off('delete', cb);
return;
}
if (this.callbackCache[verb] === undefined) {
throw new Error(`Unknown verb: ${verb}`);
}
const indexToRemove: number = this.callbackCache[verb].findIndex(
(cachedCb: ObjectCallback<T>) => cachedCb === cb,
);
if (indexToRemove === -1) {
return;
}
this.callbackCache[verb].splice(indexToRemove, 1);
}
public get(name: string, namespace?: string): T | undefined {
const nsObjects = this.objects.get(namespace || '');
if (nsObjects) {
return nsObjects.get(name);
}
return undefined;
}
public list(namespace?: string | undefined): ReadonlyArray<T> {
if (!namespace) {
const allObjects: T[] = [];
for (const nsObjects of this.objects.values()) {
allObjects.push(...nsObjects.values());
}
return allObjects;
}
const namespaceObjects = this.objects.get(namespace || '');
if (!namespaceObjects) {
return [];
}
return Array.from(namespaceObjects.values());
}
public latestResourceVersion(): string {
return this.resourceVersion;
}
private _stop(): void {
if (this.request) {
this.request.abort();
this.request = undefined;
}
}
private async doneHandler(err: any): Promise<void> {
this._stop();
if (
err &&
((err as { statusCode?: number }).statusCode === 410 || (err as { code?: number }).code === 410)
) {
this.resourceVersion = '';
} else if (err && (err as { name?: string }).name === 'TimeoutError') {
// Watch client-side timeout — reconnect from last known resourceVersion
} else if (err) {
this.callbackCache[ERROR].forEach((elt: ErrorCallback) => elt(err));
return;
}
if (this.stopped) {
// do not auto-restart
return;
}
this.callbackCache[CONNECT].forEach((elt: ErrorCallback) => elt(undefined));
if (!this.resourceVersion) {
let list: KubernetesListObject<T>;
try {
const promise = this.listFn();
list = await promise;
} catch (err) {
this.callbackCache[ERROR].forEach((elt: ErrorCallback) => elt(err));
return;
}
this.objects = deleteItems(this.objects, list.items, this.callbackCache[DELETE].slice());
this.addOrUpdateItems(list.items);
this.resourceVersion = list.metadata ? list.metadata!.resourceVersion || '' : '';
}
const queryParams = {
resourceVersion: this.resourceVersion,
} as {
resourceVersion: string | undefined;
labelSelector: string | undefined;
fieldSelector: string | undefined;
};
if (this.labelSelector !== undefined) {
queryParams.labelSelector = ObjectSerializer.serialize(this.labelSelector, 'string');
}
if (this.fieldSelector !== undefined) {
queryParams.fieldSelector = ObjectSerializer.serialize(this.fieldSelector, 'string');
}
if (this.reconnectDelayMs > 0 && this.hasConnected) {
await this.delayFn(this.reconnectDelayMs);
}
if (this.hasConnected) {
this.reconnectDelayMs = Math.min(
this.reconnectDelayMs > 0 ? this.reconnectDelayMs * 2 : ListWatch.BASE_RECONNECT_DELAY_MS,
ListWatch.MAX_RECONNECT_DELAY_MS,
);
}
this.hasConnected = true;
this.request = await this.watch.watch(
this.path,
queryParams,
this.watchHandler.bind(this),
this.doneHandler.bind(this),
);
}
private addOrUpdateItems(items: T[]): void {
if (items === undefined || items === null) {
return;
}
items.forEach((obj: T) => {
addOrUpdateObject(
this.objects,
obj,
this.callbackCache[ADD].slice(),
this.callbackCache[UPDATE].slice(),
);
});
}
private async watchHandler(
phase: string,
obj: T,
watchObj?: { type: string; object: KubernetesObject },
): Promise<void> {
switch (phase) {
case 'ERROR':
if ((obj as { code?: number }).code === 410) {
this.resourceVersion = '';
}
// We don't restart here, because it should be handled by the watch exiting if necessary
return;
case 'ADDED':
case 'MODIFIED':
addOrUpdateObject(
this.objects,
obj,
this.callbackCache[ADD].slice(),
this.callbackCache[UPDATE].slice(),
);
break;
case 'DELETED':
deleteObject(this.objects, obj, this.callbackCache[DELETE].slice());
break;
case 'BOOKMARK':
// nothing to do, here for documentation, mostly.
break;
}
this.reconnectDelayMs = 0;
this.resourceVersion = obj.metadata ? obj.metadata!.resourceVersion || '' : '';
}
}
// exported for testing
export function cacheMapFromList<T extends KubernetesObject>(newObjects: T[]): CacheMap<T> {
const objects: CacheMap<T> = new Map();
if (newObjects === undefined || newObjects === null) {
return objects;
}
// build up the new list
for (const obj of newObjects) {
let namespaceObjects = objects.get(obj.metadata!.namespace || '');
if (!namespaceObjects) {
namespaceObjects = new Map();
objects.set(obj.metadata!.namespace || '', namespaceObjects);
}
const name = obj.metadata!.name || '';
namespaceObjects.set(name, obj);
}
return objects;
}
// external for testing
export function deleteItems<T extends KubernetesObject>(
oldObjects: CacheMap<T>,
newObjects: T[],
deleteCallback?: ObjectCallback<T>[],
): CacheMap<T> {
const newObjectsMap = cacheMapFromList(newObjects);
for (const [namespace, oldNamespaceObjects] of oldObjects.entries()) {
const newNamespaceObjects = newObjectsMap.get(namespace);
if (newNamespaceObjects) {
for (const [name, oldObj] of oldNamespaceObjects.entries()) {
if (!newNamespaceObjects.has(name)) {
oldNamespaceObjects.delete(name);
if (deleteCallback) {
deleteCallback.forEach((fn: ObjectCallback<T>) => fn(oldObj));
}
}
}
} else {
oldObjects.delete(namespace);
oldNamespaceObjects.forEach((obj: T) => {
if (deleteCallback) {
deleteCallback.forEach((fn: ObjectCallback<T>) => fn(obj));
}
});
}
}
return oldObjects;
}
// Only public for testing.
export function addOrUpdateObject<T extends KubernetesObject>(
objects: CacheMap<T>,
obj: T,
addCallbacks?: ObjectCallback<T>[],
updateCallbacks?: ObjectCallback<T>[],
): void {
let namespaceObjects = objects.get(obj.metadata!.namespace || '');
if (!namespaceObjects) {
namespaceObjects = new Map();
objects.set(obj.metadata!.namespace || '', namespaceObjects);
}
const name = obj.metadata!.name || '';
const found = namespaceObjects.get(name);
if (!found) {
namespaceObjects.set(name, obj);
if (addCallbacks) {
addCallbacks.forEach((elt: ObjectCallback<T>) => elt(obj));
}
} else {
if (!isSameVersion(found, obj)) {
namespaceObjects.set(name, obj);
if (updateCallbacks) {
updateCallbacks.forEach((elt: ObjectCallback<T>) => elt(obj));
}
}
}
}
function isSameVersion<T extends KubernetesObject>(o1: any, o2: T): boolean {
return (
o1.metadata!.resourceVersion !== undefined &&
o1.metadata!.resourceVersion !== null &&
o1.metadata!.resourceVersion === o2.metadata!.resourceVersion
);
}
// Public for testing.
export function deleteObject<T extends KubernetesObject>(
objects: CacheMap<T>,
obj: T,
deleteCallbacks?: ObjectCallback<T>[],
): void {
const namespace = obj.metadata!.namespace || '';
const name = obj.metadata!.name || '';
const namespaceObjects = objects.get(namespace);
if (!namespaceObjects) {
return;
}
const deleted = namespaceObjects.delete(name);
if (deleted) {
if (deleteCallbacks) {
deleteCallbacks.forEach((elt: ObjectCallback<T>) => elt(obj));
}
if (namespaceObjects.size === 0) {
objects.delete(namespace);
}
}
}