kubernetes-fluent-client 3.1.0 → 3.1.1

package/dist/fluent/watch.js

@@ -0,0 +1,546 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Watcher = exports.WatchEvent = void 0;
+const byline_1 = __importDefault(require("byline"));
+const crypto_1 = require("crypto");
+const events_1 = require("events");
+const https_1 = __importDefault(require("https"));
+const http2_1 = __importDefault(require("http2"));
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const fetch_1 = require("../fetch");
+const types_1 = require("./types");
+const utils_1 = require("./utils");
+const fs_1 = __importDefault(require("fs"));
+var WatchEvent;
+(function (WatchEvent) {
+    /** Watch is connected successfully */
+    WatchEvent["CONNECT"] = "connect";
+    /** Network error occurs */
+    WatchEvent["NETWORK_ERROR"] = "network_error";
+    /** Error decoding data or running the callback */
+    WatchEvent["DATA_ERROR"] = "data_error";
+    /** Reconnect is called */
+    WatchEvent["RECONNECT"] = "reconnect";
+    /** Retry limit is exceeded */
+    WatchEvent["GIVE_UP"] = "give_up";
+    /** Abort is called */
+    WatchEvent["ABORT"] = "abort";
+    /** Data is received and decoded */
+    WatchEvent["DATA"] = "data";
+    /** 410 (old resource version) occurs */
+    WatchEvent["OLD_RESOURCE_VERSION"] = "old_resource_version";
+    /** A reconnect is already pending */
+    WatchEvent["RECONNECT_PENDING"] = "reconnect_pending";
+    /** Resource list operation run */
+    WatchEvent["LIST"] = "list";
+    /** List operation error */
+    WatchEvent["LIST_ERROR"] = "list_error";
+    /** Cache Misses */
+    WatchEvent["CACHE_MISS"] = "cache_miss";
+    /** Increment resync failure count */
+    WatchEvent["INC_RESYNC_FAILURE_COUNT"] = "inc_resync_failure_count";
+    /** Initialize a relist window */
+    WatchEvent["INIT_CACHE_MISS"] = "init_cache_miss";
+})(WatchEvent || (exports.WatchEvent = WatchEvent = {}));
+const NONE = 50;
+const OVERRIDE = 100;
+/** A wrapper around the Kubernetes watch API. */
+class Watcher {
+    // User-provided properties
+    #model;
+    #filters;
+    #callback;
+    #watchCfg;
+    #latestRelistWindow = "";
+    #useHTTP2 = false;
+    // Track the last time data was received
+    #lastSeenTime = NONE;
+    #lastSeenLimit;
+    // Create a wrapped AbortController to allow the watch to be aborted externally
+    #abortController;
+    // Track the number of retries
+    #resyncFailureCount = 0;
+    // Create a stream to read the response body
+    #stream;
+    // Create an EventEmitter to emit events
+    #events = new events_1.EventEmitter();
+    // Create a timer to relist the watch
+    $relistTimer;
+    // Create a timer to resync the watch
+    #resyncTimer;
+    // Track if a reconnect is pending
+    #pendingReconnect = false;
+    // The resource version to start the watch at, this will be updated after the list operation.
+    #resourceVersion;
+    // Track the list of items in the cache
+    #cache = new Map();
+    // Token Path
+    #TOKEN_PATH = "/var/run/secrets/kubernetes.io/serviceaccount/token";
+    /**
+     * Setup a Kubernetes watcher for the specified model and filters. The callback function will be called for each event received.
+     * The watch can be aborted by calling {@link Watcher.close} or by calling abort() on the AbortController returned by {@link Watcher.start}.
+     *
+     *
+     * Kubernetes API docs: {@link https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes}
+     *
+     * @param model - the model to use for the API
+     * @param filters - (optional) filter overrides, can also be chained
+     * @param callback - the callback function to call when an event is received
+     * @param watchCfg - (optional) watch configuration
+     */
+    constructor(model, filters, callback, watchCfg = {}) {
+        // Set the retry delay to 5 seconds if not specified
+        watchCfg.resyncDelaySec ??= 5;
+        // Set the relist interval to 10 minutes if not specified
+        watchCfg.relistIntervalSec ??= 600;
+        // Set the resync interval to 10 minutes if not specified
+        watchCfg.lastSeenLimitSeconds ??= 600;
+        // Set the last seen limit to the resync interval
+        this.#lastSeenLimit = watchCfg.lastSeenLimitSeconds * 1000;
+        // Set the latest relist interval to now
+        this.#latestRelistWindow = new Date().toISOString();
+        // Set the latest relist interval to now
+        this.#useHTTP2 = watchCfg.useHTTP2 ?? false;
+        // Add random jitter to the relist/resync intervals (up to 1 second)
+        const jitter = Math.floor(Math.random() * 1000);
+        // Check every relist interval for cache staleness
+        this.$relistTimer = setInterval(() => {
+            this.#latestRelistWindow = new Date().toISOString();
+            this.#events.emit(WatchEvent.INIT_CACHE_MISS, this.#latestRelistWindow);
+            void this.#list();
+        }, watchCfg.relistIntervalSec * 1000 + jitter);
+        // Rebuild the watch every resync delay interval
+        this.#resyncTimer = setInterval(this.#checkResync, watchCfg.resyncDelaySec * 1000 + jitter);
+        // Bind class properties
+        this.#model = model;
+        this.#filters = filters;
+        this.#callback = callback;
+        this.#watchCfg = watchCfg;
+        // Create a new AbortController
+        this.#abortController = new AbortController();
+    }
+    /**
+     * Start the watch.
+     *
+     * @returns The AbortController for the watch.
+     */
+    async start() {
+        this.#events.emit(WatchEvent.INIT_CACHE_MISS, this.#latestRelistWindow);
+        if (this.#useHTTP2) {
+            await this.#http2Watch();
+        }
+        else {
+            await this.#watch();
+        }
+        return this.#abortController;
+    }
+    /** Close the watch. Also available on the AbortController returned by {@link Watcher.start}. */
+    close() {
+        clearInterval(this.$relistTimer);
+        clearInterval(this.#resyncTimer);
+        this.#streamCleanup();
+        this.#abortController.abort();
+    }
+    /**
+     * Get a unique ID for the watch based on the model and filters.
+     * This is useful for caching the watch data or resource versions.
+     *
+     * @returns the watch CacheID
+     */
+    getCacheID() {
+        // Build the URL, we don't care about the server URL or resourceVersion
+        const url = (0, utils_1.pathBuilder)("https://ignore", this.#model, this.#filters, false);
+        // Hash and truncate the ID to 10 characters, cache the result
+        return (0, crypto_1.createHash)("sha224")
+            .update(url.pathname + url.search)
+            .digest("hex")
+            .substring(0, 10);
+    }
+    /**
+     * Subscribe to watch events. This is an EventEmitter that emits the following events:
+     *
+     * Use {@link WatchEvent} for the event names.
+     *
+     * @returns an EventEmitter
+     */
+    get events() {
+        return this.#events;
+    }
+    /**
+     * Read the serviceAccount Token
+     *
+     * @returns token or null
+     */
+    async #getToken() {
+        try {
+            return (await fs_1.default.promises.readFile(this.#TOKEN_PATH, "utf8")).trim();
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Build the URL and request options for the watch.
+     *
+     * @param isWatch - whether the request is for a watch operation
+     * @param resourceVersion - the resource version to use for the watch
+     * @param continueToken - the continue token for the watch
+     *
+     * @returns the URL and request options
+     */
+    #buildURL = async (isWatch, resourceVersion, continueToken) => {
+        // Build the path and query params for the resource, excluding the name
+        const { opts, serverUrl } = await (0, utils_1.k8sCfg)("GET");
+        const url = (0, utils_1.pathBuilder)(serverUrl, this.#model, this.#filters, true);
+        // Enable the watch query param
+        if (isWatch) {
+            url.searchParams.set("watch", "true");
+        }
+        if (continueToken) {
+            url.searchParams.set("continue", continueToken);
+        }
+        // If a name is specified, add it to the query params
+        if (this.#filters.name) {
+            url.searchParams.set("fieldSelector", `metadata.name=${this.#filters.name}`);
+        }
+        // If a resource version is specified, add it to the query params
+        if (resourceVersion) {
+            url.searchParams.set("resourceVersion", resourceVersion);
+        }
+        // Add the abort signal to the request options
+        opts.signal = this.#abortController.signal;
+        return { opts, url };
+    };
+    /**
+     * Retrieve the list of resources and process the events.
+     *
+     * @param continueToken - the continue token for the list
+     * @param removedItems - the list of items that have been removed
+     */
+    #list = async (continueToken, removedItems) => {
+        try {
+            const { opts, url } = await this.#buildURL(false, undefined, continueToken);
+            // Make the request to list the resources
+            const response = await (0, fetch_1.fetch)(url, opts);
+            const list = response.data;
+            // If the request fails, emit an error event and return
+            if (!response.ok) {
+                this.#events.emit(WatchEvent.LIST_ERROR, new Error(`list failed: ${response.status} ${response.statusText}`));
+                return;
+            }
+            // Gross hack, thanks upstream library :<
+            if (list.metadata.continue) {
+                continueToken = list.metadata.continue;
+            }
+            // Emit the list event
+            this.#events.emit(WatchEvent.LIST, list);
+            // Update the resource version from the list metadata
+            this.#resourceVersion = list.metadata?.resourceVersion;
+            // If removed items are not provided, clone the cache
+            removedItems = removedItems || new Map(this.#cache.entries());
+            // Process each item in the list
+            for (const item of list.items || []) {
+                const { uid } = item.metadata;
+                // Remove the item from the removed items list
+                const alreadyExists = removedItems.delete(uid);
+                // If the item does not exist, it is new and should be added
+                if (!alreadyExists) {
+                    this.#events.emit(WatchEvent.CACHE_MISS, this.#latestRelistWindow);
+                    // Send added event. Use void here because we don't care about the result (no consequences here if it fails)
+                    void this.#process(item, types_1.WatchPhase.Added);
+                    continue;
+                }
+                // Check if the resource version has changed for items that already exist
+                const cachedRV = parseInt(this.#cache.get(uid)?.metadata?.resourceVersion);
+                const itemRV = parseInt(item.metadata.resourceVersion);
+                // Check if the resource version is newer than the cached version
+                if (itemRV > cachedRV) {
+                    this.#events.emit(WatchEvent.CACHE_MISS, this.#latestRelistWindow);
+                    // Send a modified event if the resource version has changed
+                    void this.#process(item, types_1.WatchPhase.Modified);
+                }
+            }
+            // If there is a continue token, call the list function again with the same removed items
+            if (continueToken) {
+                // If there is a continue token, call the list function again with the same removed items
+                // @todo: using all voids here is important for freshness, but is naive with regard to API load & pod resources
+                await this.#list(continueToken, removedItems);
+            }
+            else {
+                // Otherwise, process the removed items
+                for (const item of removedItems.values()) {
+                    this.#events.emit(WatchEvent.CACHE_MISS, this.#latestRelistWindow);
+                    void this.#process(item, types_1.WatchPhase.Deleted);
+                }
+            }
+        }
+        catch (err) {
+            this.#events.emit(WatchEvent.LIST_ERROR, err);
+        }
+    };
+    /**
+     * Process the event payload.
+     *
+     * @param payload - the event payload
+     * @param phase - the event phase
+     */
+    #process = async (payload, phase) => {
+        try {
+            switch (phase) {
+                // If the event is added or modified, update the cache
+                case types_1.WatchPhase.Added:
+                case types_1.WatchPhase.Modified:
+                    this.#cache.set(payload.metadata.uid, payload);
+                    break;
+                // If the event is deleted, remove the item from the cache
+                case types_1.WatchPhase.Deleted:
+                    this.#cache.delete(payload.metadata.uid);
+                    break;
+            }
+            // Emit the data event
+            this.#events.emit(WatchEvent.DATA, payload, phase);
+            // Call the callback function with the parsed payload
+            await this.#callback(payload, phase);
+        }
+        catch (err) {
+            this.#events.emit(WatchEvent.DATA_ERROR, err);
+        }
+    };
+    // process a line from the chunk
+    #processLine = async (line, process) => {
+        try {
+            // Parse the event payload
+            const { object: payload, type: phase } = JSON.parse(line);
+            // Update the last seen time
+            this.#lastSeenTime = Date.now();
+            // If the watch is too old, remove the resourceVersion and reload the watch
+            if (phase === types_1.WatchPhase.Error && payload.code === 410) {
+                throw {
+                    name: "TooOld",
+                    message: this.#resourceVersion,
+                };
+            }
+            // Process the event payload, do not update the resource version as that is handled by the list operation
+            await process(payload, phase);
+        }
+        catch (err) {
+            if (err.name === "TooOld") {
+                // Reload the watch
+                void this.#errHandler(err);
+                return;
+            }
+            this.#events.emit(WatchEvent.DATA_ERROR, err);
+        }
+    };
+    /**
+     * Watch for changes to the resource.
+     */
+    #watch = async () => {
+        try {
+            // Start with a list operation
+            await this.#list();
+            // Build the URL and request options
+            const { opts, url } = await this.#buildURL(true, this.#resourceVersion);
+            // Create a stream to read the response body
+            this.#stream = byline_1.default.createStream();
+            // Bind the stream events
+            this.#stream.on("error", this.#errHandler);
+            this.#stream.on("close", this.#streamCleanup);
+            this.#stream.on("finish", this.#streamCleanup);
+            // Make the actual request
+            const response = await (0, node_fetch_1.default)(url, { ...opts });
+            // Reset the pending reconnect flag
+            this.#pendingReconnect = false;
+            // If the request is successful, start listening for events
+            if (response.ok) {
+                this.#events.emit(WatchEvent.CONNECT, url.pathname);
+                const { body } = response;
+                // Reset the retry count
+                this.#resyncFailureCount = 0;
+                this.#events.emit(WatchEvent.INC_RESYNC_FAILURE_COUNT, this.#resyncFailureCount);
+                // Listen for events and call the callback function
+                this.#stream.on("data", async (line) => {
+                    await this.#processLine(line, this.#process);
+                });
+                // Bind the body events
+                body.on("error", this.#errHandler);
+                body.on("close", this.#streamCleanup);
+                body.on("finish", this.#streamCleanup);
+                // Pipe the response body to the stream
+                body.pipe(this.#stream);
+            }
+            else {
+                throw new Error(`watch connect failed: ${response.status} ${response.statusText}`);
+            }
+        }
+        catch (e) {
+            void this.#errHandler(e);
+        }
+    };
+    /**
+     * Watch for changes to the resource.
+     */
+    #http2Watch = async () => {
+        try {
+            // Start with a list operation
+            await this.#list();
+            // Build the URL and request options
+            const { opts, url } = await this.#buildURL(true, this.#resourceVersion);
+            let agentOptions;
+            if (opts.agent && opts.agent instanceof https_1.default.Agent) {
+                agentOptions = {
+                    key: opts.agent.options.key,
+                    cert: opts.agent.options.cert,
+                    ca: opts.agent.options.ca,
+                    rejectUnauthorized: false,
+                };
+            }
+            // HTTP/2 client connection setup
+            const client = http2_1.default.connect(url.origin, {
+                ca: agentOptions?.ca,
+                cert: agentOptions?.cert,
+                key: agentOptions?.key,
+                rejectUnauthorized: agentOptions?.rejectUnauthorized,
+            });
+            // Set up headers for the HTTP/2 request
+            const token = await this.#getToken();
+            const headers = {
+                ":method": "GET",
+                ":path": url.pathname + url.search,
+                "content-type": "application/json",
+                "user-agent": "kubernetes-fluent-client",
+            };
+            if (token) {
+                headers["Authorization"] = `Bearer ${token}`;
+            }
+            // Make the HTTP/2 request
+            const req = client.request(headers);
+            req.setEncoding("utf8");
+            let buffer = "";
+            // Handle response data
+            req.on("response", headers => {
+                const statusCode = headers[":status"];
+                if (statusCode && statusCode >= 200 && statusCode < 300) {
+                    this.#pendingReconnect = false;
+                    this.#events.emit(WatchEvent.CONNECT, url.pathname);
+                    // Reset the retry count
+                    this.#resyncFailureCount = 0;
+                    this.#events.emit(WatchEvent.INC_RESYNC_FAILURE_COUNT, this.#resyncFailureCount);
+                    req.on("data", async (chunk) => {
+                        try {
+                            buffer += chunk;
+                            const lines = buffer.split("\n");
+                            // Avoid  Watch event data_error received. Unexpected end of JSON input.
+                            buffer = lines.pop();
+                            for (const line of lines) {
+                                await this.#processLine(line, this.#process);
+                            }
+                        }
+                        catch (err) {
+                            void this.#errHandler(err);
+                        }
+                    });
+                    req.on("end", () => {
+                        client.close();
+                        this.#streamCleanup();
+                    });
+                    req.on("close", () => {
+                        client.close();
+                        this.#streamCleanup();
+                    });
+                    req.on("error", err => {
+                        void this.#errHandler(err);
+                    });
+                }
+                else {
+                    const statusMessage = headers[":status-text"] || "Unknown";
+                    throw new Error(`watch connect failed: ${statusCode} ${statusMessage}`);
+                }
+            });
+            req.on("error", err => {
+                void this.#errHandler(err);
+            });
+        }
+        catch (e) {
+            void this.#errHandler(e);
+        }
+    };
+    /** Clear the resync timer and schedule a new one. */
+    #checkResync = () => {
+        // Ignore if the last seen time is not set
+        if (this.#lastSeenTime === NONE) {
+            return;
+        }
+        const now = Date.now();
+        // If the last seen time is greater than the limit, trigger a resync
+        if (this.#lastSeenTime == OVERRIDE || now - this.#lastSeenTime > this.#lastSeenLimit) {
+            // Reset the last seen time to now to allow the resync to be called again in case of failure
+            this.#lastSeenTime = now;
+            // If there are more attempts, retry the watch (undefined is unlimited retries)
+            if (this.#watchCfg.resyncFailureMax === undefined ||
+                this.#watchCfg.resyncFailureMax > this.#resyncFailureCount) {
+                // Increment the retry count
+                this.#resyncFailureCount++;
+                this.#events.emit(WatchEvent.INC_RESYNC_FAILURE_COUNT, this.#resyncFailureCount);
+                if (this.#pendingReconnect) {
+                    // wait for the connection to be re-established
+                    this.#events.emit(WatchEvent.RECONNECT_PENDING);
+                }
+                else {
+                    this.#pendingReconnect = true;
+                    this.#events.emit(WatchEvent.RECONNECT, this.#resyncFailureCount);
+                    this.#streamCleanup();
+                    if (!this.#useHTTP2) {
+                        void this.#watch();
+                    }
+                }
+            }
+            else {
+                // Otherwise, call the finally function if it exists
+                this.#events.emit(WatchEvent.GIVE_UP, new Error(`Retry limit (${this.#watchCfg.resyncFailureMax}) exceeded, giving up`));
+                this.close();
+            }
+        }
+    };
+    /**
+     * Handle errors from the stream.
+     *
+     * @param err - the error that occurred
+     */
+    #errHandler = async (err) => {
+        switch (err.name) {
+            case "AbortError":
+                clearInterval(this.$relistTimer);
+                clearInterval(this.#resyncTimer);
+                this.#streamCleanup();
+                this.#events.emit(WatchEvent.ABORT, err);
+                return;
+            case "TooOld":
+                // Purge the resource version if it is too old
+                this.#resourceVersion = undefined;
+                this.#events.emit(WatchEvent.OLD_RESOURCE_VERSION, err.message);
+                break;
+            default:
+                this.#events.emit(WatchEvent.NETWORK_ERROR, err);
+                break;
+        }
+        // Force a resync
+        this.#lastSeenTime = OVERRIDE;
+    };
+    /** Cleanup the stream and listeners. */
+    #streamCleanup = () => {
+        if (this.#stream) {
+            this.#stream.removeAllListeners();
+            this.#stream.destroy();
+        }
+        if (this.#useHTTP2) {
+            void this.#http2Watch();
+        }
+    };
+}
+exports.Watcher = Watcher;

package/dist/fluent/watch.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=watch.spec.d.ts.map

package/dist/fluent/watch.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch.spec.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.spec.ts"],"names":[],"mappings":""}