fix(fluent): support deep partials for K8s().Apply() + return AbortController on K8s().Watch() (#8)

Author: jeff-mccoy

package-lock.json

@@ -37,7 +37,8 @@
     "@kubernetes/client-node": "1.0.0-rc3",
     "fast-json-patch": "3.1.1",
     "http-status-codes": "2.3.0",
-    "node-fetch": "2.7.0"
+    "node-fetch": "2.7.0",
+    "type-fest": "4.3.2"
   },
   "devDependencies": {
     "@commitlint/cli": "17.7.1",

package.json

@@ -133,4 +133,18 @@ describe("Kube", () => {
     const kube = K8s(Pod);
     await expect(kube.Patch([])).rejects.toThrow("No operations specified");
   });
+
+  it("should allow Apply of deep partials", async () => {
+    const kube = K8s(Pod);
+    const result = await kube.Apply({ metadata: { name: "fake" }, spec: { priority: 3 } });
+    expect(result).toEqual(fakeResource);
+  });
+
+  it("should throw an error if a Delete failed for a reason other than Not Found", async () => {
+    mockedKubeExec.mockRejectedValueOnce({ status: 500 }); // Internal Server Error on first call
+    const kube = K8s(Pod);
+    await expect(kube.Delete("fakeResource")).rejects.toEqual(
+      expect.objectContaining({ status: 500 }),
+    );
+  });
 });

src/fluent/index.test.ts

@@ -4,6 +4,7 @@
 import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
 import { Operation } from "fast-json-patch";
 import { StatusCodes } from "http-status-codes";
+import type { PartialDeep } from "type-fest";
 
 import { modelToGroupVersionKind } from "../kinds";
 import { GenericClass } from "../types";
@@ -99,8 +100,8 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
     }
   }
 
-  async function Apply(resource: K): Promise<K> {
-    syncFilters(resource);
+  async function Apply(resource: PartialDeep<K>): Promise<K> {
+    syncFilters(resource as K);
     return k8sExec(model, filters, "APPLY", resource);
   }
 
@@ -118,8 +119,8 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
     return k8sExec<T, K>(model, filters, "PATCH", payload);
   }
 
-  async function Watch(callback: WatchAction<T>): Promise<void> {
-    await ExecWatch(model, filters, callback);
+  async function Watch(callback: WatchAction<T>): Promise<AbortController> {
+    return ExecWatch(model, filters, callback);
   }
 
   return { InNamespace, Apply, Create, Patch, ...withFilters };

src/fluent/index.ts

@@ -3,6 +3,7 @@
 
 import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
 import { Operation } from "fast-json-patch";
+import type { PartialDeep } from "type-fest";
 
 import { GenericClass, GroupVersionKind } from "../types";
 
@@ -50,7 +51,7 @@ export type K8sFilteredActions<K extends KubernetesObject> = {
    * @param callback
    * @returns
    */
-  Watch: (callback: (payload: K, phase: WatchPhase) => void) => Promise<void>;
+  Watch: (callback: (payload: K, phase: WatchPhase) => void) => Promise<AbortController>;
 };
 
 export type K8sUnfilteredActions<K extends KubernetesObject> = {
@@ -60,7 +61,7 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
    * @param resource
    * @returns
    */
-  Apply: (resource: K) => Promise<K>;
+  Apply: (resource: PartialDeep<K>) => Promise<K>;
 
   /**
    * Create the provided K8s resource or throw an error if it already exists.
@@ -71,7 +72,7 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
   Create: (resource: K) => Promise<K>;
 
   /**
-   * Advanced JSON Patch operations for when Server Side Apply, Kube().Apply(), is insufficient.
+   * Advanced JSON Patch operations for when Server Side Apply, K8s().Apply(), is insufficient.
    *
    * Note: Throws an error on an empty list of patch operations.
    *
@@ -87,7 +88,7 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
    * Note multiple calls to this method will result in an AND condition. e.g.
    *
    * ```ts
-   * Kube(given.Deployment)
+   * K8s(kind.Deployment)
    *  .WithField("metadata.name", "bar")
    *  .WithField("metadata.namespace", "qux")
    *  .Delete(...)
@@ -106,7 +107,7 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
    * Note multiple calls to this method will result in an AND condition. e.g.
    *
    * ```ts
-   * Kube(given.Deployment)
+   * K8s(kind.Deployment)
    *   .WithLabel("foo", "bar")
    *   .WithLabel("baz", "qux")
    *   .Delete(...)

src/fluent/types.ts

@@ -20,3 +20,5 @@ export { K8s } from "./fluent";
 export { RegisterKind, modelToGroupVersionKind } from "./kinds";
 
 export * from "./types";
+
+export * as K8sClientNode from "@kubernetes/client-node";