kubernetes-fluent-client 2.5.1 → 2.6.0

package/dist/fluent/watch.spec.js

@@ -20,17 +20,23 @@ const types_1 = require("./types");
     let watcher;
     (0, globals_1.beforeEach)(() => {
         globals_1.jest.resetAllMocks();
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            retryDelaySec: 1,
+        (0, nock_1.default)("http://jest-test:8080")
+            .get("/api/v1/pods")
+            .reply(200, {
+            kind: "PodList",
+            apiVersion: "v1",
+            metadata: {
+                resourceVersion: "10",
+            },
+            items: [createMockPod(`pod-0`, `1`)],
         });
         (0, nock_1.default)("http://jest-test:8080")
             .get("/api/v1/pods")
-            .query({ watch: "true", allowWatchBookmarks: "true" })
+            .query({ watch: "true", resourceVersion: "10" })
             .reply(200, () => {
             const stream = new readable_stream_1.PassThrough();
             const resources = [
                 { type: "ADDED", object: createMockPod(`pod-0`, `1`) },
-                { type: "BOOKMARK", object: { metadata: { resourceVersion: "1" } } },
                 { type: "MODIFIED", object: createMockPod(`pod-0`, `2`) },
             ];
             resources.forEach(resource => {
@@ -47,26 +53,17 @@ const types_1 = require("./types");
         nock_1.default.cleanAll();
         (0, nock_1.default)("http://jest-test:8080")
             .get("/api/v1/namespaces/tester/pods")
-            .query({ watch: "true", allowWatchBookmarks: "true", fieldSelector: "metadata.name=demo" })
-            .reply(200);
-        watcher = (0, _1.K8s)(__1.kind.Pod, { name: "demo" }).InNamespace("tester").Watch(evtMock);
-        setupAndStartWatcher(__1.WatchEvent.CONNECT, () => {
-            done();
-        });
-    });
-    (0, globals_1.it)("should start the watch at the specified resource version", done => {
-        nock_1.default.cleanAll();
+            .query({ fieldSelector: "metadata.name=demo" })
+            .reply(200, createMockPod(`demo`, `15`));
         (0, nock_1.default)("http://jest-test:8080")
-            .get("/api/v1/pods")
+            .get("/api/v1/namespaces/tester/pods")
             .query({
             watch: "true",
-            allowWatchBookmarks: "true",
-            resourceVersion: "25",
+            fieldSelector: "metadata.name=demo",
+            resourceVersion: "15",
         })
             .reply(200);
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resourceVersion: "25",
-        });
+        watcher = (0, _1.K8s)(__1.kind.Pod, { name: "demo" }).InNamespace("tester").Watch(evtMock);
         setupAndStartWatcher(__1.WatchEvent.CONNECT, () => {
             done();
         });
@@ -75,7 +72,17 @@ const types_1 = require("./types");
         nock_1.default.cleanAll();
         (0, nock_1.default)("http://jest-test:8080")
             .get("/api/v1/pods")
-            .query({ watch: "true", allowWatchBookmarks: "true", resourceVersion: "45" })
+            .reply(200, {
+            kind: "PodList",
+            apiVersion: "v1",
+            metadata: {
+                resourceVersion: "25",
+            },
+            items: [createMockPod(`pod-0`, `1`)],
+        });
+        (0, nock_1.default)("http://jest-test:8080")
+            .get("/api/v1/pods")
+            .query({ watch: "true", resourceVersion: "25" })
             .reply(200, () => {
             const stream = new readable_stream_1.PassThrough();
             stream.write(JSON.stringify({
@@ -93,11 +100,9 @@ const types_1 = require("./types");
             stream.end();
             return stream;
         });
-        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resourceVersion: "45",
-        });
+        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock);
         setupAndStartWatcher(__1.WatchEvent.OLD_RESOURCE_VERSION, res => {
-            (0, globals_1.expect)(res).toEqual("45");
+            (0, globals_1.expect)(res).toEqual("25");
             done();
         });
     });
@@ -110,90 +115,110 @@ const types_1 = require("./types");
         watcher.start().catch(errMock);
     });
     (0, globals_1.it)("should return the cache id", () => {
-        (0, globals_1.expect)(watcher.getCacheID()).toEqual("d69b75a611");
-    });
-    (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();
+        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
+            retryDelaySec: 1,
         });
+        (0, globals_1.expect)(watcher.getCacheID()).toEqual("d69b75a611");
     });
     (0, globals_1.it)("should handle the CONNECT event", done => {
+        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
+            retryDelaySec: 1,
+        });
         setupAndStartWatcher(__1.WatchEvent.CONNECT, () => {
             done();
         });
     });
     (0, globals_1.it)("should handle the DATA event", done => {
+        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
+            retryDelaySec: 1,
+        });
         setupAndStartWatcher(__1.WatchEvent.DATA, (pod, phase) => {
             (0, globals_1.expect)(pod.metadata?.name).toEqual(`pod-0`);
             (0, globals_1.expect)(phase).toEqual(types_1.WatchPhase.Added);
             done();
         });
     });
-    (0, globals_1.it)("should handle the BOOKMARK event", done => {
-        setupAndStartWatcher(__1.WatchEvent.BOOKMARK, bookmark => {
-            (0, globals_1.expect)(bookmark.metadata?.resourceVersion).toEqual("1");
-            done();
-        });
-    });
     (0, globals_1.it)("should handle the NETWORK_ERROR event", done => {
         nock_1.default.cleanAll();
         (0, nock_1.default)("http://jest-test:8080")
             .get("/api/v1/pods")
-            .query({ watch: "true", allowWatchBookmarks: "true" })
+            .reply(200, {
+            kind: "PodList",
+            apiVersion: "v1",
+            metadata: {
+                resourceVersion: "45",
+            },
+            items: [createMockPod(`pod-0`, `1`)],
+        });
+        (0, nock_1.default)("http://jest-test:8080")
+            .get("/api/v1/pods")
+            .query({ watch: "true", resourceVersion: "45" })
             .replyWithError("Something bad happened");
-        setupAndStartWatcher(__1.WatchEvent.NETWORK_ERROR, error => {
-            (0, globals_1.expect)(error.message).toEqual("request to http://jest-test:8080/api/v1/pods?watch=true&allowWatchBookmarks=true failed, reason: Something bad happened");
-            done();
+        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
+            retryDelaySec: 1,
         });
-    });
-    (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");
+        setupAndStartWatcher(__1.WatchEvent.NETWORK_ERROR, error => {
+            (0, globals_1.expect)(error.message).toEqual("request to http://jest-test:8080/api/v1/pods?watch=true&resourceVersion=45 failed, reason: Something bad happened");
             done();
         });
     });
-    (0, globals_1.it)("should handle the RECONNECT event", done => {
+    (0, globals_1.it)("should handle the RECONNECT event on an error", done => {
         nock_1.default.cleanAll();
         (0, nock_1.default)("http://jest-test:8080")
             .get("/api/v1/pods")
-            .query({ watch: "true", allowWatchBookmarks: "true" })
+            .reply(200, {
+            kind: "PodList",
+            apiVersion: "v1",
+            metadata: {
+                resourceVersion: "65",
+            },
+            items: [createMockPod(`pod-0`, `1`)],
+        });
+        (0, nock_1.default)("http://jest-test:8080")
+            .get("/api/v1/pods")
+            .query({ watch: "true", resourceVersion: "65" })
             .replyWithError("Something bad happened");
-        setupAndStartWatcher(__1.WatchEvent.RECONNECT, error => {
-            (0, globals_1.expect)(error.message).toEqual("request to http://jest-test:8080/api/v1/pods?watch=true&allowWatchBookmarks=true failed, reason: Something bad happened");
+        watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
+            retryDelaySec: 0.01,
+        });
+        setupAndStartWatcher(__1.WatchEvent.RECONNECT, count => {
+            (0, globals_1.expect)(count).toEqual(1);
             done();
         });
     });
     (0, globals_1.it)("should perform a resync after the resync interval", done => {
         watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
-            resyncIntervalSec: 1,
+            retryDelaySec: 0.01,
+            resyncIntervalSec: 0.01,
         });
-        setupAndStartWatcher(__1.WatchEvent.RESYNC, err => {
-            (0, globals_1.expect)(err.name).toEqual("Resync");
-            (0, globals_1.expect)(err.message).toEqual("Resync triggered by resyncIntervalSec");
+        setupAndStartWatcher(__1.WatchEvent.RECONNECT, count => {
+            (0, globals_1.expect)(count).toEqual(1);
             done();
         });
     });
     (0, globals_1.it)("should handle the GIVE_UP event", done => {
         nock_1.default.cleanAll();
-        (0, nock_1.default)("http://jest-test:8080");
+        (0, nock_1.default)("http://jest-test:8080")
+            .get("/api/v1/pods")
+            .reply(200, {
+            kind: "PodList",
+            apiVersion: "v1",
+            metadata: {
+                resourceVersion: "75",
+            },
+            items: [createMockPod(`pod-0`, `1`)],
+        });
+        (0, nock_1.default)("http://jest-test:8080")
+            .get("/api/v1/pods")
+            .query({ watch: "true", resourceVersion: "75" })
+            .replyWithError("Something bad happened");
         watcher = (0, _1.K8s)(__1.kind.Pod).Watch(evtMock, {
             retryMax: 1,
-            retryDelaySec: 1,
+            retryDelaySec: 0.01,
+            resyncIntervalSec: 1,
         });
         setupAndStartWatcher(__1.WatchEvent.GIVE_UP, error => {
-            (0, globals_1.expect)(error.message).toContain("request to http://jest-test:8080/api/v1/pods?watch=true&allowWatchBookmarks=true failed");
+            (0, globals_1.expect)(error.message).toContain("Retry limit (1) exceeded, giving up");
             done();
         });
     });
@@ -212,6 +237,7 @@ function createMockPod(name, resourceVersion) {
         metadata: {
             name: name,
             resourceVersion: resourceVersion,
+            uid: Math.random().toString(36).substring(7),
             // ... other metadata fields
         },
         spec: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply.",
   "bin": "./dist/cli.js",
   "main": "dist/index.js",
@@ -51,14 +51,14 @@
     "@types/byline": "4.2.36",
     "@types/readable-stream": "4.0.14",
     "@types/yargs": "17.0.32",
-    "@typescript-eslint/eslint-plugin": "7.9.0",
-    "@typescript-eslint/parser": "7.9.0",
-    "eslint-plugin-jsdoc": "48.2.4",
+    "@typescript-eslint/eslint-plugin": "7.10.0",
+    "@typescript-eslint/parser": "7.10.0",
+    "eslint-plugin-jsdoc": "48.2.5",
     "jest": "29.7.0",
     "nock": "13.5.4",
     "prettier": "3.2.5",
     "semantic-release": "23.1.1",
-    "ts-jest": "29.1.2",
+    "ts-jest": "29.1.3",
     "typescript": "5.4.5"
   },
   "release": {

package/src/fluent/watch.spec.ts

@@ -22,19 +22,26 @@ describe("Watcher", () => {
 
   beforeEach(() => {
     jest.resetAllMocks();
-    watcher = K8s(kind.Pod).Watch(evtMock, {
-      retryDelaySec: 1,
-    });
 
     nock("http://jest-test:8080")
       .get("/api/v1/pods")
-      .query({ watch: "true", allowWatchBookmarks: "true" })
+      .reply(200, {
+        kind: "PodList",
+        apiVersion: "v1",
+        metadata: {
+          resourceVersion: "10",
+        },
+        items: [createMockPod(`pod-0`, `1`)],
+      });
+
+    nock("http://jest-test:8080")
+      .get("/api/v1/pods")
+      .query({ watch: "true", resourceVersion: "10" })
       .reply(200, () => {
         const stream = new PassThrough();
 
         const resources = [
           { type: "ADDED", object: createMockPod(`pod-0`, `1`) },
-          { type: "BOOKMARK", object: { metadata: { resourceVersion: "1" } } },
           { type: "MODIFIED", object: createMockPod(`pod-0`, `2`) },
         ];
 
@@ -56,30 +63,19 @@ describe("Watcher", () => {
     nock.cleanAll();
     nock("http://jest-test:8080")
       .get("/api/v1/namespaces/tester/pods")
-      .query({ watch: "true", allowWatchBookmarks: "true", fieldSelector: "metadata.name=demo" })
-      .reply(200);
-
-    watcher = K8s(kind.Pod, { name: "demo" }).InNamespace("tester").Watch(evtMock);
+      .query({ fieldSelector: "metadata.name=demo" })
+      .reply(200, createMockPod(`demo`, `15`));
 
-    setupAndStartWatcher(WatchEvent.CONNECT, () => {
-      done();
-    });
-  });
-
-  it("should start the watch at the specified resource version", done => {
-    nock.cleanAll();
     nock("http://jest-test:8080")
-      .get("/api/v1/pods")
+      .get("/api/v1/namespaces/tester/pods")
       .query({
         watch: "true",
-        allowWatchBookmarks: "true",
-        resourceVersion: "25",
+        fieldSelector: "metadata.name=demo",
+        resourceVersion: "15",
       })
       .reply(200);
 
-    watcher = K8s(kind.Pod).Watch(evtMock, {
-      resourceVersion: "25",
-    });
+    watcher = K8s(kind.Pod, { name: "demo" }).InNamespace("tester").Watch(evtMock);
 
     setupAndStartWatcher(WatchEvent.CONNECT, () => {
       done();
@@ -90,7 +86,17 @@ describe("Watcher", () => {
     nock.cleanAll();
     nock("http://jest-test:8080")
       .get("/api/v1/pods")
-      .query({ watch: "true", allowWatchBookmarks: "true", resourceVersion: "45" })
+      .reply(200, {
+        kind: "PodList",
+        apiVersion: "v1",
+        metadata: {
+          resourceVersion: "25",
+        },
+        items: [createMockPod(`pod-0`, `1`)],
+      });
+    nock("http://jest-test:8080")
+      .get("/api/v1/pods")
+      .query({ watch: "true", resourceVersion: "25" })
       .reply(200, () => {
         const stream = new PassThrough();
         stream.write(
@@ -112,12 +118,10 @@ describe("Watcher", () => {
         return stream;
       });
 
-    watcher = K8s(kind.Pod).Watch(evtMock, {
-      resourceVersion: "45",
-    });
+    watcher = K8s(kind.Pod).Watch(evtMock);
 
     setupAndStartWatcher(WatchEvent.OLD_RESOURCE_VERSION, res => {
-      expect(res).toEqual("45");
+      expect(res).toEqual("25");
       done();
     });
   });
@@ -133,35 +137,25 @@ describe("Watcher", () => {
   });
 
   it("should return the cache id", () => {
-    expect(watcher.getCacheID()).toEqual("d69b75a611");
-  });
-
-  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();
+    watcher = K8s(kind.Pod).Watch(evtMock, {
+      retryDelaySec: 1,
     });
+    expect(watcher.getCacheID()).toEqual("d69b75a611");
   });
 
   it("should handle the CONNECT event", done => {
+    watcher = K8s(kind.Pod).Watch(evtMock, {
+      retryDelaySec: 1,
+    });
     setupAndStartWatcher(WatchEvent.CONNECT, () => {
       done();
     });
   });
 
   it("should handle the DATA event", done => {
+    watcher = K8s(kind.Pod).Watch(evtMock, {
+      retryDelaySec: 1,
+    });
     setupAndStartWatcher(WatchEvent.DATA, (pod, phase) => {
       expect(pod.metadata?.name).toEqual(`pod-0`);
       expect(phase).toEqual(WatchPhase.Added);
@@ -169,76 +163,99 @@ describe("Watcher", () => {
     });
   });
 
-  it("should handle the BOOKMARK event", done => {
-    setupAndStartWatcher(WatchEvent.BOOKMARK, bookmark => {
-      expect(bookmark.metadata?.resourceVersion).toEqual("1");
-      done();
-    });
-  });
-
   it("should handle the NETWORK_ERROR event", done => {
     nock.cleanAll();
     nock("http://jest-test:8080")
       .get("/api/v1/pods")
-      .query({ watch: "true", allowWatchBookmarks: "true" })
+      .reply(200, {
+        kind: "PodList",
+        apiVersion: "v1",
+        metadata: {
+          resourceVersion: "45",
+        },
+        items: [createMockPod(`pod-0`, `1`)],
+      });
+    nock("http://jest-test:8080")
+      .get("/api/v1/pods")
+      .query({ watch: "true", resourceVersion: "45" })
       .replyWithError("Something bad happened");
 
+    watcher = K8s(kind.Pod).Watch(evtMock, {
+      retryDelaySec: 1,
+    });
+
     setupAndStartWatcher(WatchEvent.NETWORK_ERROR, error => {
       expect(error.message).toEqual(
-        "request to http://jest-test:8080/api/v1/pods?watch=true&allowWatchBookmarks=true failed, reason: Something bad happened",
+        "request to http://jest-test:8080/api/v1/pods?watch=true&resourceVersion=45 failed, reason: Something bad happened",
       );
       done();
     });
   });
 
-  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 => {
+  it("should handle the RECONNECT event on an error", done => {
     nock.cleanAll();
     nock("http://jest-test:8080")
       .get("/api/v1/pods")
-      .query({ watch: "true", allowWatchBookmarks: "true" })
+      .reply(200, {
+        kind: "PodList",
+        apiVersion: "v1",
+        metadata: {
+          resourceVersion: "65",
+        },
+        items: [createMockPod(`pod-0`, `1`)],
+      });
+    nock("http://jest-test:8080")
+      .get("/api/v1/pods")
+      .query({ watch: "true", resourceVersion: "65" })
       .replyWithError("Something bad happened");
 
-    setupAndStartWatcher(WatchEvent.RECONNECT, error => {
-      expect(error.message).toEqual(
-        "request to http://jest-test:8080/api/v1/pods?watch=true&allowWatchBookmarks=true failed, reason: Something bad happened",
-      );
+    watcher = K8s(kind.Pod).Watch(evtMock, {
+      retryDelaySec: 0.01,
+    });
+
+    setupAndStartWatcher(WatchEvent.RECONNECT, count => {
+      expect(count).toEqual(1);
       done();
     });
   });
 
   it("should perform a resync after the resync interval", done => {
     watcher = K8s(kind.Pod).Watch(evtMock, {
-      resyncIntervalSec: 1,
+      retryDelaySec: 0.01,
+      resyncIntervalSec: 0.01,
     });
 
-    setupAndStartWatcher(WatchEvent.RESYNC, err => {
-      expect(err.name).toEqual("Resync");
-      expect(err.message).toEqual("Resync triggered by resyncIntervalSec");
+    setupAndStartWatcher(WatchEvent.RECONNECT, count => {
+      expect(count).toEqual(1);
       done();
     });
   });
 
   it("should handle the GIVE_UP event", done => {
     nock.cleanAll();
-    nock("http://jest-test:8080");
+    nock("http://jest-test:8080")
+      .get("/api/v1/pods")
+      .reply(200, {
+        kind: "PodList",
+        apiVersion: "v1",
+        metadata: {
+          resourceVersion: "75",
+        },
+        items: [createMockPod(`pod-0`, `1`)],
+      });
+    nock("http://jest-test:8080")
+      .get("/api/v1/pods")
+      .query({ watch: "true", resourceVersion: "75" })
+      .replyWithError("Something bad happened");
 
     watcher = K8s(kind.Pod).Watch(evtMock, {
       retryMax: 1,
-      retryDelaySec: 1,
+      retryDelaySec: 0.01,
+      resyncIntervalSec: 1,
     });
 
     setupAndStartWatcher(WatchEvent.GIVE_UP, error => {
-      expect(error.message).toContain(
-        "request to http://jest-test:8080/api/v1/pods?watch=true&allowWatchBookmarks=true failed",
-      );
+      expect(error.message).toContain("Retry limit (1) exceeded, giving up");
       done();
     });
   });
@@ -258,6 +275,7 @@ function createMockPod(name: string, resourceVersion: string): kind.Pod {
     metadata: {
       name: name,
       resourceVersion: resourceVersion,
+      uid: Math.random().toString(36).substring(7),
       // ... other metadata fields
     },
     spec: {