kubernetes-fluent-client 2.0.0 → 2.0.1

package/README.md

@@ -20,13 +20,15 @@ async function demo() {
   // Now, we can use the fluent API to query for the resources we just created
 
   // You can use watch to monitor resources in the cluster and react to changes
-  // This will run until the process is terminated or the watch is aborted
-  const ctrl = await K8s(kind.Pod).Watch((pod, phase) => {
+  const watcher = K8s(kind.Pod).Watch((pod, phase) => {
     console.log(`Pod ${pod.metadata?.name} is ${phase}`);
   });
 
+  // This will run until the process is terminated or the watch is aborted
+  await watcher.start();
+
   // Let's abort the watch after 5 seconds
-  setTimeout(ctrl.abort, 5 * 1000);
+  setTimeout(watcher.close, 5 * 1000);
 
   // Passing the name to Get() will return a single resource
   const ns = await K8s(kind.Namespace).Get(namespace);

package/dist/fluent/watch.d.ts

@@ -68,9 +68,21 @@ export declare class Watcher<T extends GenericClass> {
      * 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 ID
+     * @returns the watch CacheID
      */
-    get id(): string;
+    getCacheID(): string;
+    /**
+     * Get the current resource version.
+     *
+     * @returns the current resource version
+     */
+    get resourceVersion(): string | undefined;
+    /**
+     * Set the current resource version.
+     *
+     * @param resourceVersion - the new resource version
+     */
+    set resourceVersion(resourceVersion: string | undefined);
     /**
      * Subscribe to watch events. This is an EventEmitter that emits the following events:
      *

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

@@ -1 +1 @@
-{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";;AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,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,uBAAuB;IACvB,MAAM,WAAW;IACjB,mCAAmC;IACnC,IAAI,SAAS;IACb,2BAA2B;IAC3B,QAAQ,aAAa;IACrB,iCAAiC;IACjC,gBAAgB,qBAAqB;IACrC,wCAAwC;IACxC,oBAAoB,yBAAyB;IAC7C,qCAAqC;IACrC,iBAAiB,sBAAsB;CACxC;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG;IACrB,sFAAsF;IACtF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,iDAAiD;AACjD,qBAAa,OAAO,CAAC,CAAC,SAAS,YAAY;;IA6BzC;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAE,QAAa;IAiBzF;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAK9C,gGAAgG;IACzF,KAAK;IAMZ;;;;;OAKG;IACH,IAAW,EAAE,WAYZ;IAED;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;CAyOF"}
+{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";;AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,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,uBAAuB;IACvB,MAAM,WAAW;IACjB,mCAAmC;IACnC,IAAI,SAAS;IACb,2BAA2B;IAC3B,QAAQ,aAAa;IACrB,iCAAiC;IACjC,gBAAgB,qBAAqB;IACrC,wCAAwC;IACxC,oBAAoB,yBAAyB;IAC7C,qCAAqC;IACrC,iBAAiB,sBAAsB;CACxC;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG;IACrB,sFAAsF;IACtF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,iDAAiD;AACjD,qBAAa,OAAO,CAAC,CAAC,SAAS,YAAY;;IAyBzC;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAE,QAAa;IAiBzF;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAK9C,gGAAgG;IACzF,KAAK;IAMZ;;;;;OAKG;IACI,UAAU;IAWjB;;;;OAIG;IACH,IAAW,eAAe,IASkB,MAAM,GAAG,SAAS,CAP7D;IAED;;;;OAIG;IACH,IAAW,eAAe,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,EAE7D;IAED;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;CAoOF"}

package/dist/fluent/watch.js

@@ -56,9 +56,6 @@ class Watcher {
     #events = new events_1.EventEmitter();
     // Create a timer to resync the watch
     #resyncTimer;
-    // Unique ID for the watch
-    #id;
-    #hashedID;
     // Track if a reconnect is pending
     #pendingReconnect = false;
     /**
@@ -105,18 +102,32 @@ class Watcher {
      * 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 ID
+     * @returns the watch CacheID
      */
-    get id() {
-        // The ID must exist at this point
-        if (!this.#id) {
-            throw new Error("watch not started");
-        }
+    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
-        if (!this.#hashedID) {
-            this.#hashedID = (0, crypto_1.createHash)("sha224").update(this.#id).digest("hex").substring(0, 10);
-        }
-        return this.#hashedID;
+        return (0, crypto_1.createHash)("sha224")
+            .update(url.pathname + url.search)
+            .digest("hex")
+            .substring(0, 10);
+    }
+    /**
+     * Get the current resource version.
+     *
+     * @returns the current resource version
+     */
+    get resourceVersion() {
+        return this.#watchCfg.resourceVersion;
+    }
+    /**
+     * Set the current resource version.
+     *
+     * @param resourceVersion - the new resource version
+     */
+    set resourceVersion(resourceVersion) {
+        this.#watchCfg.resourceVersion = resourceVersion;
     }
     /**
      * Subscribe to watch events. This is an EventEmitter that emits the following events:
@@ -137,10 +148,6 @@ class Watcher {
         // 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);
-        // Set the watch ID if it does not exist (this does not change on reconnect)
-        if (!this.#id) {
-            this.#id = url.pathname + url.search;
-        }
         // Enable the watch query param
         url.searchParams.set("watch", "true");
         // If a name is specified, add it to the query params

package/dist/fluent/watch.spec.js

@@ -109,17 +109,24 @@ const types_1 = require("./types");
         });
         watcher.start().catch(errMock);
     });
-    (0, globals_1.it)("should return the cache id", done => {
-        watcher
-            .start()
-            .then(() => {
-            (0, globals_1.expect)(watcher.id).toEqual("d69b75a611");
-            done();
-        })
-            .catch(errMock);
+    (0, globals_1.it)("should return the cache id", () => {
+        (0, globals_1.expect)(watcher.getCacheID()).toEqual("d69b75a611");
     });
-    (0, globals_1.it)("should handle calling .id() before .start()", () => {
-        (0, globals_1.expect)(() => watcher.id).toThrowError("watch not started");
+    (0, globals_1.it)("should use an updated resourceVersion", done => {
+        nock_1.default.cleanAll();
+        (0, nock_1.default)("http://jest-test:8080")
+            .get("/api/v1/pods")
+            .query({
+            watch: "true",
+            allowWatchBookmarks: "true",
+            resourceVersion: "35",
+        })
+            .reply(200);
+        // Update the resource version, could be combined with getCacheID to store the value
+        watcher.resourceVersion = "35";
+        setupAndStartWatcher(__1.WatchEvent.CONNECT, () => {
+            done();
+        });
     });
     (0, globals_1.it)("should handle the CONNECT event", done => {
         setupAndStartWatcher(__1.WatchEvent.CONNECT, () => {
@@ -150,6 +157,13 @@ const types_1 = require("./types");
             done();
         });
     });
+    (0, globals_1.it)("should handle the RESOURCE_VERSION event", done => {
+        setupAndStartWatcher(__1.WatchEvent.RESOURCE_VERSION, resourceVersion => {
+            (0, globals_1.expect)(watcher.resourceVersion).toEqual("2");
+            (0, globals_1.expect)(resourceVersion).toEqual("2");
+            done();
+        });
+    });
     (0, globals_1.it)("should handle the RECONNECT event", done => {
         nock_1.default.cleanAll();
         (0, nock_1.default)("http://jest-test:8080")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
   "bin": "./dist/cli.js",
   "main": "dist/index.js",
@@ -51,8 +51,8 @@
     "@types/byline": "4.2.36",
     "@types/readable-stream": "4.0.10",
     "@types/yargs": "17.0.32",
-    "@typescript-eslint/eslint-plugin": "6.15.0",
-    "@typescript-eslint/parser": "6.15.0",
+    "@typescript-eslint/eslint-plugin": "6.16.0",
+    "@typescript-eslint/parser": "6.16.0",
     "eslint-plugin-jsdoc": "46.9.1",
     "jest": "29.7.0",
     "nock": "13.4.0",

package/src/fluent/watch.spec.ts

@@ -132,18 +132,27 @@ describe("Watcher", () => {
     watcher.start().catch(errMock);
   });
 
-  it("should return the cache id", done => {
-    watcher
-      .start()
-      .then(() => {
-        expect(watcher.id).toEqual("d69b75a611");
-        done();
-      })
-      .catch(errMock);
+  it("should return the cache id", () => {
+    expect(watcher.getCacheID()).toEqual("d69b75a611");
   });
 
-  it("should handle calling .id() before .start()", () => {
-    expect(() => watcher.id).toThrowError("watch not started");
+  it("should use an updated resourceVersion", done => {
+    nock.cleanAll();
+    nock("http://jest-test:8080")
+      .get("/api/v1/pods")
+      .query({
+        watch: "true",
+        allowWatchBookmarks: "true",
+        resourceVersion: "35",
+      })
+      .reply(200);
+
+    // Update the resource version, could be combined with getCacheID to store the value
+    watcher.resourceVersion = "35";
+
+    setupAndStartWatcher(WatchEvent.CONNECT, () => {
+      done();
+    });
   });
 
   it("should handle the CONNECT event", done => {
@@ -182,6 +191,14 @@ describe("Watcher", () => {
     });
   });
 
+  it("should handle the RESOURCE_VERSION event", done => {
+    setupAndStartWatcher(WatchEvent.RESOURCE_VERSION, resourceVersion => {
+      expect(watcher.resourceVersion).toEqual("2");
+      expect(resourceVersion).toEqual("2");
+      done();
+    });
+  });
+
   it("should handle the RECONNECT event", done => {
     nock.cleanAll();
     nock("http://jest-test:8080")

package/src/fluent/watch.ts

@@ -72,10 +72,6 @@ export class Watcher<T extends GenericClass> {
   // Create a timer to resync the watch
   #resyncTimer?: NodeJS.Timeout;
 
-  // Unique ID for the watch
-  #id?: string;
-  #hashedID?: string;
-
   // Track if a reconnect is pending
   #pendingReconnect = false;
 
@@ -129,20 +125,35 @@ export class Watcher<T extends GenericClass> {
    * 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 ID
+   * @returns the watch CacheID
    */
-  public get id() {
-    // The ID must exist at this point
-    if (!this.#id) {
-      throw new Error("watch not started");
-    }
+  public getCacheID() {
+    // Build the URL, we don't care about the server URL or resourceVersion
+    const url = pathBuilder("https://ignore", this.#model, this.#filters, false);
 
     // Hash and truncate the ID to 10 characters, cache the result
-    if (!this.#hashedID) {
-      this.#hashedID = createHash("sha224").update(this.#id).digest("hex").substring(0, 10);
-    }
+    return createHash("sha224")
+      .update(url.pathname + url.search)
+      .digest("hex")
+      .substring(0, 10);
+  }
+
+  /**
+   * Get the current resource version.
+   *
+   * @returns the current resource version
+   */
+  public get resourceVersion() {
+    return this.#watchCfg.resourceVersion;
+  }
 
-    return this.#hashedID;
+  /**
+   * Set the current resource version.
+   *
+   * @param resourceVersion - the new resource version
+   */
+  public set resourceVersion(resourceVersion: string | undefined) {
+    this.#watchCfg.resourceVersion = resourceVersion;
   }
 
   /**
@@ -166,11 +177,6 @@ export class Watcher<T extends GenericClass> {
     const { opts, serverUrl } = await k8sCfg("GET");
     const url = pathBuilder(serverUrl, this.#model, this.#filters, true);
 
-    // Set the watch ID if it does not exist (this does not change on reconnect)
-    if (!this.#id) {
-      this.#id = url.pathname + url.search;
-    }
-
     // Enable the watch query param
     url.searchParams.set("watch", "true");