kubernetes-fluent-client 3.0.4 → 3.1.0

package/dist/fluent/utils.test.js

@@ -1,215 +0,0 @@
-"use strict";
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
-Object.defineProperty(exports, "__esModule", { value: true });
-const globals_1 = require("@jest/globals");
-const node_fetch_1 = require("node-fetch");
-const fetch_1 = require("../fetch");
-const kinds_1 = require("../kinds");
-const upstream_1 = require("../upstream");
-const utils_1 = require("./utils");
-globals_1.jest.mock("https");
-globals_1.jest.mock("../fetch");
-(0, globals_1.describe)("pathBuilder Function", () => {
-    const serverUrl = "https://jest-test:8080";
-    (0, globals_1.it)("should throw an error if the kind is not specified and the model is not a KubernetesObject", () => {
-        const model = { name: "Unknown" };
-        const filters = {};
-        (0, globals_1.expect)(() => (0, utils_1.pathBuilder)("", model, filters)).toThrow("Kind not specified for Unknown");
-    });
-    (0, globals_1.it)("should generate a path with a set-based label selector", () => {
-        const filters = {
-            namespace: "default",
-            name: "mypod",
-            labels: { iamalabel: "" },
-        };
-        const result = (0, utils_1.pathBuilder)(serverUrl, upstream_1.Pod, filters);
-        const expected = new URL("/api/v1/namespaces/default/pods/mypod?labelSelector=iamalabel", serverUrl);
-        (0, globals_1.expect)(result.toString()).toEqual(expected.toString());
-    });
-    (0, globals_1.it)("should generate a path for core group kinds (with custom filters)", () => {
-        const filters = {
-            namespace: "default",
-            name: "mypod",
-            fields: { iamafield: "iamavalue" },
-            labels: { iamalabel: "iamalabelvalue" },
-        };
-        const result = (0, utils_1.pathBuilder)(serverUrl, upstream_1.Pod, filters);
-        const expected = new URL("/api/v1/namespaces/default/pods/mypod?fieldSelector=iamafield%3Diamavalue&labelSelector=iamalabel%3Diamalabelvalue", serverUrl);
-        (0, globals_1.expect)(result.toString()).toEqual(expected.toString());
-    });
-    (0, globals_1.it)("Version not specified in a Kind", () => {
-        const filters = {
-            namespace: "default",
-            name: "mypod",
-        };
-        class Fake {
-            name;
-            constructor() {
-                this.name = "Fake";
-            }
-        }
-        (0, kinds_1.RegisterKind)(Fake, {
-            kind: "Fake",
-            version: "",
-            group: "fake",
-        });
-        try {
-            (0, utils_1.pathBuilder)(serverUrl, Fake, filters);
-        }
-        catch (e) {
-            (0, globals_1.expect)(e.message).toEqual(`Version not specified for Fake`);
-        }
-    });
-    (0, globals_1.it)("should generate a path for core group kinds", () => {
-        const filters = { namespace: "default", name: "mypod" };
-        const result = (0, utils_1.pathBuilder)(serverUrl, upstream_1.Pod, filters);
-        const expected = new URL("/api/v1/namespaces/default/pods/mypod", serverUrl);
-        (0, globals_1.expect)(result).toEqual(expected);
-    });
-    (0, globals_1.it)("should generate a path for non-core group kinds", () => {
-        const filters = {
-            namespace: "default",
-            name: "myingress",
-        };
-        const result = (0, utils_1.pathBuilder)(serverUrl, upstream_1.Ingress, filters);
-        const expected = new URL("/apis/networking.k8s.io/v1/namespaces/default/ingresses/myingress", serverUrl);
-        (0, globals_1.expect)(result).toEqual(expected);
-    });
-    (0, globals_1.it)("should generate a path without a namespace if not provided", () => {
-        const filters = { name: "tester" };
-        const result = (0, utils_1.pathBuilder)(serverUrl, upstream_1.ClusterRole, filters);
-        const expected = new URL("/apis/rbac.authorization.k8s.io/v1/clusterroles/tester", serverUrl);
-        (0, globals_1.expect)(result).toEqual(expected);
-    });
-    (0, globals_1.it)("should generate a path without a name if excludeName is true", () => {
-        const filters = { namespace: "default", name: "mypod" };
-        const result = (0, utils_1.pathBuilder)(serverUrl, upstream_1.Pod, filters, true);
-        const expected = new URL("/api/v1/namespaces/default/pods", serverUrl);
-        (0, globals_1.expect)(result).toEqual(expected);
-    });
-});
-(0, globals_1.describe)("kubeExec Function", () => {
-    const mockedFetch = globals_1.jest.mocked(fetch_1.fetch);
-    const fakeFilters = { name: "fake", namespace: "default" };
-    const fakeMethod = "GET";
-    const fakePayload = {
-        metadata: { name: "fake", namespace: "default" },
-        status: { phase: "Ready" },
-    };
-    const fakeUrl = new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake");
-    const fakeOpts = {
-        body: JSON.stringify(fakePayload),
-        compress: true,
-        headers: new node_fetch_1.Headers({
-            "Content-Type": "application/json",
-            "User-Agent": `kubernetes-fluent-client`,
-        }),
-        method: fakeMethod,
-    };
-    (0, globals_1.beforeEach)(() => {
-        mockedFetch.mockClear();
-    });
-    (0, globals_1.it)("should make a successful fetch call", async () => {
-        mockedFetch.mockResolvedValueOnce({
-            ok: true,
-            data: fakePayload,
-            status: 200,
-            statusText: "OK",
-        });
-        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, fakeMethod, fakePayload);
-        (0, globals_1.expect)(result).toEqual(fakePayload);
-        (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(fakeUrl, globals_1.expect.objectContaining(fakeOpts));
-    });
-    (0, globals_1.it)("should handle PATCH_STATUS", async () => {
-        mockedFetch.mockResolvedValueOnce({
-            ok: true,
-            data: fakePayload,
-            status: 200,
-            statusText: "OK",
-        });
-        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, "PATCH_STATUS", fakePayload);
-        (0, globals_1.expect)(result).toEqual(fakePayload);
-        (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake/status"), globals_1.expect.objectContaining({
-            method: "PATCH",
-            compress: true,
-            headers: new node_fetch_1.Headers({
-                "Content-Type": "application/merge-patch+json",
-                "User-Agent": `kubernetes-fluent-client`,
-            }),
-            body: JSON.stringify({ status: fakePayload.status }),
-        }));
-    });
-    (0, globals_1.it)("should handle PATCH", async () => {
-        mockedFetch.mockResolvedValueOnce({
-            ok: true,
-            data: fakePayload,
-            status: 200,
-            statusText: "OK",
-        });
-        const patchPayload = [{ op: "replace", path: "/status/phase", value: "Ready" }];
-        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, "PATCH", patchPayload);
-        (0, globals_1.expect)(result).toEqual(fakePayload);
-        (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake"), globals_1.expect.objectContaining({
-            method: "PATCH",
-            compress: true,
-            headers: new node_fetch_1.Headers({
-                "Content-Type": "application/json-patch+json",
-                "User-Agent": `kubernetes-fluent-client`,
-            }),
-            body: JSON.stringify(patchPayload),
-        }));
-    });
-    (0, globals_1.it)("should handle APPLY", async () => {
-        mockedFetch.mockResolvedValueOnce({
-            ok: true,
-            data: fakePayload,
-            status: 200,
-            statusText: "OK",
-        });
-        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, "APPLY", fakePayload);
-        (0, globals_1.expect)(result).toEqual(fakePayload);
-        (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake?fieldManager=pepr&fieldValidation=Strict&force=false"), globals_1.expect.objectContaining({
-            method: "PATCH",
-            compress: true,
-            headers: new node_fetch_1.Headers({
-                "Content-Type": "application/apply-patch+yaml",
-                "User-Agent": `kubernetes-fluent-client`,
-            }),
-            body: JSON.stringify(fakePayload),
-        }));
-    });
-    (0, globals_1.it)("should handle APPLY with force", async () => {
-        mockedFetch.mockResolvedValueOnce({
-            ok: true,
-            data: fakePayload,
-            status: 200,
-            statusText: "OK",
-        });
-        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, "APPLY", fakePayload, { force: true });
-        (0, globals_1.expect)(result).toEqual(fakePayload);
-        (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake?fieldManager=pepr&fieldValidation=Strict&force=true"), globals_1.expect.objectContaining({
-            method: "PATCH",
-            compress: true,
-            headers: new node_fetch_1.Headers({
-                "Content-Type": "application/apply-patch+yaml",
-                "User-Agent": `kubernetes-fluent-client`,
-            }),
-            body: JSON.stringify(fakePayload),
-        }));
-    });
-    (0, globals_1.it)("should handle fetch call failure", async () => {
-        const fakeStatus = 404;
-        const fakeStatusText = "Not Found";
-        mockedFetch.mockResolvedValueOnce({
-            ok: false,
-            data: null,
-            status: fakeStatus,
-            statusText: fakeStatusText,
-        });
-        await (0, globals_1.expect)((0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, fakeMethod, fakePayload)).rejects.toEqual(globals_1.expect.objectContaining({
-            status: fakeStatus,
-            statusText: fakeStatusText,
-        }));
-    });
-});

package/dist/fluent/watch.d.ts

@@ -1,86 +0,0 @@
-import { EventEmitter } from "events";
-import { GenericClass } from "../types";
-import { Filters, WatchAction } from "./types";
-export declare enum WatchEvent {
-    /** Watch is connected successfully */
-    CONNECT = "connect",
-    /** Network error occurs */
-    NETWORK_ERROR = "network_error",
-    /** Error decoding data or running the callback */
-    DATA_ERROR = "data_error",
-    /** Reconnect is called */
-    RECONNECT = "reconnect",
-    /** Retry limit is exceeded */
-    GIVE_UP = "give_up",
-    /** Abort is called */
-    ABORT = "abort",
-    /** Data is received and decoded */
-    DATA = "data",
-    /** 410 (old resource version) occurs */
-    OLD_RESOURCE_VERSION = "old_resource_version",
-    /** A reconnect is already pending */
-    RECONNECT_PENDING = "reconnect_pending",
-    /** Resource list operation run */
-    LIST = "list",
-    /** List operation error */
-    LIST_ERROR = "list_error",
-    /** Cache Misses */
-    CACHE_MISS = "cache_miss",
-    /** Increment resync failure count */
-    INC_RESYNC_FAILURE_COUNT = "inc_resync_failure_count",
-    /** Initialize a relist window */
-    INIT_CACHE_MISS = "init_cache_miss"
-}
-/** Configuration for the watch function. */
-export type WatchCfg = {
-    /** The maximum number of times to retry the watch, the retry count is reset on success. Unlimited retries if not specified. */
-    resyncFailureMax?: number;
-    /** Seconds between each resync check. Defaults to 5. */
-    resyncDelaySec?: number;
-    /** Amount of seconds to wait before relisting the watch list. Defaults to 600 (10 minutes). */
-    relistIntervalSec?: number;
-    /** Max amount of seconds to go without receiving an event before reconciliation starts. Defaults to 300 (5 minutes). */
-    lastSeenLimitSeconds?: number;
-};
-/** A wrapper around the Kubernetes watch API. */
-export declare class Watcher<T extends GenericClass> {
-    #private;
-    $relistTimer?: NodeJS.Timeout;
-    /**
-     * 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: T, filters: Filters, callback: WatchAction<T>, watchCfg?: WatchCfg);
-    /**
-     * Start the watch.
-     *
-     * @returns The AbortController for the watch.
-     */
-    start(): Promise<AbortController>;
-    /** Close the watch. Also available on the AbortController returned by {@link Watcher.start}. */
-    close(): void;
-    /**
-     * 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(): string;
-    /**
-     * 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(): EventEmitter;
-}
-//# sourceMappingURL=watch.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAItC,OAAO,EAAE,YAAY,EAAwB,MAAM,UAAU,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D,oBAAY,UAAU;IACpB,sCAAsC;IACtC,OAAO,YAAY;IACnB,2BAA2B;IAC3B,aAAa,kBAAkB;IAC/B,kDAAkD;IAClD,UAAU,eAAe;IACzB,0BAA0B;IAC1B,SAAS,cAAc;IACvB,8BAA8B;IAC9B,OAAO,YAAY;IACnB,sBAAsB;IACtB,KAAK,UAAU;IACf,mCAAmC;IACnC,IAAI,SAAS;IACb,wCAAwC;IACxC,oBAAoB,yBAAyB;IAC7C,qCAAqC;IACrC,iBAAiB,sBAAsB;IACvC,kCAAkC;IAClC,IAAI,SAAS;IACb,2BAA2B;IAC3B,UAAU,eAAe;IACzB,mBAAmB;IACnB,UAAU,eAAe;IACzB,qCAAqC;IACrC,wBAAwB,6BAA6B;IACrD,iCAAiC;IACjC,eAAe,oBAAoB;CACpC;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG;IACrB,+HAA+H;IAC/H,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wDAAwD;IACxD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+FAA+F;IAC/F,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,wHAAwH;IACxH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAKF,iDAAiD;AACjD,qBAAa,OAAO,CAAC,CAAC,SAAS,YAAY;;IAyBzC,YAAY,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAc9B;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAE,QAAa;IA0CzF;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAM9C,gGAAgG;IACzF,KAAK;IAOZ;;;;;OAKG;IACI,UAAU;IAWjB;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;CAiUF"}