pepr 0.44.0 → 0.45.0-nightly.1

package/src/lib/core/module.ts

@@ -2,69 +2,14 @@
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
 import { clone } from "ramda";
 import { Capability } from "./capability";
-import { Controller } from "../controller";
+import { Controller, ControllerHooks } from "../controller";
 import { ValidateError } from "../errors";
-import { MutateResponse, ValidateResponse, WebhookIgnore } from "../k8s";
-import { CapabilityExport, AdmissionRequest } from "../types";
+import { CapabilityExport } from "../types";
 import { setupWatch } from "../processors/watch-processor";
 import { Log } from "../../lib";
-import { V1PolicyRule as PolicyRule } from "@kubernetes/client-node";
 import { resolveIgnoreNamespaces } from "../assets/webhooks";
-
-/** Custom Labels Type for package.json */
-export interface CustomLabels {
-  namespace?: Record<string, string>;
-}
-/** Global configuration for the Pepr runtime. */
-export type ModuleConfig = {
-  /** The Pepr version this module uses */
-  peprVersion?: string;
-  /** The user-defined version of the module */
-  appVersion?: string;
-  /** A unique identifier for this Pepr module. This is automatically generated by Pepr. */
-  uuid: string;
-  /** A description of the Pepr module and what it does. */
-  description?: string;
-  /** The webhookTimeout */
-  webhookTimeout?: number;
-  /** Reject K8s resource AdmissionRequests on error. */
-  onError?: string;
-  /** Configure global exclusions that will never be processed by Pepr. */
-  alwaysIgnore: WebhookIgnore;
-  /** Define the log level for the in-cluster controllers */
-  logLevel?: string;
-  /** Propagate env variables to in-cluster controllers */
-  env?: Record<string, string>;
-  /** Custom Labels for Kubernetes Objects */
-  customLabels?: CustomLabels;
-  /** Custom RBAC rules */
-  rbac?: PolicyRule[];
-  /** The RBAC mode; if "scoped", generates scoped rules, otherwise uses wildcard rules. */
-  rbacMode?: string;
-};
-
-export type PackageJSON = {
-  description: string;
-  pepr: ModuleConfig;
-};
-
-export type PeprModuleOptions = {
-  deferStart?: boolean;
-
-  /** A user-defined callback to pre-process or intercept a Pepr request from K8s immediately before it is processed */
-  beforeHook?: (req: AdmissionRequest) => void;
-
-  /** A user-defined callback to post-process or intercept a Pepr response just before it is returned to K8s */
-  afterHook?: (res: MutateResponse | ValidateResponse) => void;
-};
-
-// Track if this is a watch mode controller
-export const isWatchMode = (): boolean => process.env.PEPR_WATCH_MODE === "true";
-
-// Track if Pepr is running in build mode
-export const isBuildMode = (): boolean => process.env.PEPR_MODE === "build";
-
-export const isDevMode = (): boolean => process.env.PEPR_MODE === "dev";
+import { isBuildMode, isDevMode, isWatchMode } from "./envChecks";
+import { PackageJSON, PeprModuleOptions, ModuleConfig } from "../types";
 
 export class PeprModule {
   #controller!: Controller;
@@ -110,17 +55,23 @@ export class PeprModule {
       return;
     }
 
-    this.#controller = new Controller(config, capabilities, opts.beforeHook, opts.afterHook, () => {
-      // Wait for the controller to be ready before setting up watches
-      if (isWatchMode() || isDevMode()) {
-        try {
-          setupWatch(capabilities, resolveIgnoreNamespaces(pepr?.alwaysIgnore?.namespaces));
-        } catch (e) {
-          Log.error(e, "Error setting up watch");
-          process.exit(1);
+    const controllerHooks: ControllerHooks = {
+      beforeHook: opts.beforeHook,
+      afterHook: opts.afterHook,
+      onReady: (): void => {
+        // Wait for the controller to be ready before setting up watches
+        if (isWatchMode() || isDevMode()) {
+          try {
+            setupWatch(capabilities, resolveIgnoreNamespaces(pepr?.alwaysIgnore?.namespaces));
+          } catch (e) {
+            Log.error(e, "Error setting up watch");
+            process.exit(1);
+          }
         }
-      }
-    });
+      },
+    };
+
+    this.#controller = new Controller(config, capabilities, controllerHooks);
 
     // Stop processing if deferStart is set to true
     if (opts.deferStart) {

package/src/lib/core/schedule.ts

@@ -91,7 +91,7 @@ export class OnSchedule implements Schedule {
       lastTimestamp: new Date(),
       name: this.name,
     };
-    this.store && this.store.setItem(this.name, JSON.stringify(schedule));
+    if (this.store) this.store.setItem(this.name, JSON.stringify(schedule));
   }
 
   /**
@@ -170,6 +170,6 @@ export class OnSchedule implements Schedule {
       clearInterval(this.intervalId);
       this.intervalId = null;
     }
-    this.store && this.store.removeItem(this.name);
+    if (this.store) this.store.removeItem(this.name);
   }
 }

package/src/lib/core/storage.ts

@@ -110,11 +110,12 @@ export class Storage implements PeprStore {
   };
 
   clear = (): void => {
-    Object.keys(this.#store).length > 0 &&
+    if (Object.keys(this.#store).length > 0) {
       this.#dispatchUpdate(
         "remove",
         Object.keys(this.#store).map(key => pointer.escape(key)),
       );
+    }
   };
 
   removeItem = (key: string): void => {

package/src/lib/processors/mutate-processor.ts

@@ -10,7 +10,7 @@ import { shouldSkipRequest } from "../filter/filter";
 import { MutateResponse } from "../k8s";
 import { AdmissionRequest, Binding } from "../types";
 import Log from "../telemetry/logger";
-import { ModuleConfig } from "../core/module";
+import { ModuleConfig } from "../types";
 import { PeprMutateRequest } from "../mutate-request";
 import { base64Encode, convertFromBase64Map, convertToBase64Map } from "../utils";
 import { OnError } from "../../cli/init/enums";
@@ -55,7 +55,7 @@ export function logMutateErrorMessage(e: Error): string {
     } else {
       throw new Error("An error occurred in the mutate action.");
     }
-  } catch (e) {
+  } catch {
     return "An error occurred with the mutate action.";
   }
 }

package/src/lib/processors/validate-processor.ts

@@ -9,7 +9,7 @@ import { AdmissionRequest, Binding } from "../types";
 import Log from "../telemetry/logger";
 import { convertFromBase64Map } from "../utils";
 import { PeprValidateRequest } from "../validate-request";
-import { ModuleConfig } from "../core/module";
+import { ModuleConfig } from "../types";
 import { resolveIgnoreNamespaces } from "../assets/webhooks";
 import { MeasureWebhookTimeout } from "../telemetry/webhookTimeouts";
 import { WebhookType } from "../enums";

package/src/lib/processors/watch-processor.ts

@@ -137,9 +137,11 @@ async function runBinding(
 
       // [ true, void, undefined ] SHOULD remove finalizer
       // [ false ] should NOT remove finalizer
-      shouldRemoveFinalizer === false
-        ? Log.debug({ obj: kubernetesObject }, `Skipping removal of finalizer '${peprFinal}' from '${resource}'`)
-        : await removeFinalizer(binding, kubernetesObject);
+      if (shouldRemoveFinalizer === false) {
+        Log.debug({ obj: kubernetesObject }, `Skipping removal of finalizer '${peprFinal}' from '${resource}'`);
+      } else {
+        await removeFinalizer(binding, kubernetesObject);
+      }
     }
   };
 

package/src/lib/telemetry/metrics.ts

@@ -66,9 +66,7 @@ export class MetricsCollector {
   #addMetric = <T extends Counter<string> | Gauge<string> | Summary<string>>(
     collection: Map<string, T>,
     MetricType: new (args: MetricArgs) => T,
-    name: string,
-    help: string,
-    labelNames?: string[],
+    { name, help, labelNames }: Omit<MetricArgs, "registers">,
   ): void => {
     if (collection.has(this.#getMetricName(name))) {
       Log.debug(`Metric for ${name} already exists`, loggingPrefix);
@@ -86,15 +84,15 @@ export class MetricsCollector {
   };
 
   addCounter = (name: string, help: string): void => {
-    this.#addMetric(this.#counters, promClient.Counter, name, help, []);
+    this.#addMetric(this.#counters, promClient.Counter, { name, help, labelNames: [] });
   };
 
   addSummary = (name: string, help: string): void => {
-    this.#addMetric(this.#summaries, promClient.Summary, name, help, []);
+    this.#addMetric(this.#summaries, promClient.Summary, { name, help, labelNames: [] });
   };
 
   addGauge = (name: string, help: string, labelNames?: string[]): void => {
-    this.#addMetric(this.#gauges, promClient.Gauge, name, help, labelNames);
+    this.#addMetric(this.#gauges, promClient.Gauge, { name, help, labelNames });
   };
 
   incCounter = (name: string): void => {

package/src/lib/types.ts

@@ -8,6 +8,7 @@ import { Logger } from "pino";
 import { PeprMutateRequest } from "./mutate-request";
 import { PeprValidateRequest } from "./validate-request";
 import { V1PolicyRule as PolicyRule } from "@kubernetes/client-node";
+import { WebhookIgnore, MutateResponse, ValidateResponse } from "./k8s";
 
 /**
  * Specifically for deploying images with a private registry
@@ -356,4 +357,51 @@ export interface GroupVersionResource {
 // DeepPartial utility type for deep optional properties
 export type DeepPartial<T> = {
   [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+}; /** Custom Labels Type for package.json */
+
+export type CustomLabels = { namespace: Record<string, string> } | Record<string, never>;
+/** Configuration that MAY be set a Pepr module's package.json. */
+export type ModuleConfigOptions = {
+  /** The Pepr version this module uses */
+  peprVersion: string;
+  /** The user-defined version of the module */
+  appVersion: string;
+  /** A description of the Pepr module and what it does. */
+  description: string;
+  /** The webhookTimeout */
+  webhookTimeout: number;
+  /** Reject K8s resource AdmissionRequests on error. */
+  onError: string;
+  /** Define the log level for the in-cluster controllers */
+  logLevel: string;
+  /** Propagate env variables to in-cluster controllers */
+  env: Record<string, string>;
+  /** Custom RBAC rules */
+  rbac: PolicyRule[];
+  /** The RBAC mode; if "scoped", generates scoped rules, otherwise uses wildcard rules. */
+  rbacMode: string;
+  /** Custom Labels for Kubernetes Objects */
+  customLabels: CustomLabels;
+};
+/** Global configuration for the Pepr runtime. */
+export type ModuleConfig = {
+  /** A unique identifier for this Pepr module. This is automatically generated by Pepr. */
+  uuid: string;
+  /** Configure global exclusions that will never be processed by Pepr. */
+  alwaysIgnore: WebhookIgnore;
+} & Partial<ModuleConfigOptions>;
+
+export type PackageJSON = {
+  description: string;
+  pepr: ModuleConfig;
 };
+
+export type PeprModuleOptions = {
+  deferStart?: boolean;
+
+  /** A user-defined callback to pre-process or intercept a Pepr request from K8s immediately before it is processed */
+  beforeHook?: (req: AdmissionRequest) => void;
+
+  /** A user-defined callback to post-process or intercept a Pepr response just before it is returned to K8s */
+  afterHook?: (res: MutateResponse | ValidateResponse) => void;
+}; // Track if this is a watch mode controller

package/src/sdk/heredoc.ts

@@ -14,8 +14,8 @@ export function heredoc(strings: TemplateStringsArray, ...values: string[]): str
   const asLines = zipped.join("").split(/[\r\n]+/);
 
   // strip whitespace-only first & last lines
-  asLines[0].trim().length === 0 ? asLines.shift() : null;
-  asLines.slice(-1)[0].trim().length === 0 ? asLines.pop() : null;
+  if (asLines[0].trim().length === 0) asLines.shift();
+  if (asLines.slice(-1)[0].trim().length === 0) asLines.pop();
 
   // find smallest indent
   const indent = asLines.reduce((acc, cur) => {