pepr 1.0.8 → 1.1.0

package/package.json

@@ -16,7 +16,7 @@
     "!src/fixtures/**",
     "!dist/**/*.test.d.ts*"
   ],
-  "version": "1.0.8",
+  "version": "1.1.0",
   "main": "dist/lib.js",
   "types": "dist/lib.d.ts",
   "scripts": {
@@ -34,7 +34,7 @@
     "format:prettier": "prettier --config config/.prettierrc src integration/cli/**/*.ts integration/helpers/**/*.ts",
     "format:src": "eslint --config config/eslint.root.config.mjs 'src/**/*.ts' --ignore-pattern '**/*.test.ts' --ignore-pattern 'src/templates/**'",
     "format:tests": "eslint --config config/eslint.test.config.mjs 'src/**/*.test.ts'",
-    "gen-data-json": "node hack/build-template-data.js",
+    "gen-data-json": "node hack/build-template-data.mjs",
     "prebuild": "rm -fr dist/* && npm run gen-data-json",
     "prepare": "if [ \"$NODE_ENV\" != 'production' ]; then husky; fi",
     "set-version": "bash -lc 'ver=${PEPR_VERSION:-}; if [ -z \"$ver\" ]; then git fetch --tags --force; ver=$(git describe --tags --abbrev=0); fi; ver=${ver#v}; echo Using version $ver; node ./scripts/set-version.js \"$ver\"'",
@@ -51,14 +51,14 @@
   "dependencies": {
     "@types/ramda": "0.31.1",
     "command-line-args": "^6.0.1",
-    "commander": "14.0.2",
+    "commander": "14.0.3",
     "express": "5.2.1",
     "fast-json-patch": "3.1.1",
     "heredoc": "^1.3.1",
     "http-status-codes": "^2.3.0",
     "json-pointer": "^0.6.2",
-    "kubernetes-fluent-client": "3.11.0",
-    "pino": "10.3.0",
+    "kubernetes-fluent-client": "3.11.2",
+    "pino": "10.3.1",
     "pino-pretty": "13.1.3",
     "prom-client": "15.1.3",
     "quicktype-core": "^23.2.6",
@@ -66,8 +66,8 @@
     "ts-morph": "^27.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "20.4.0",
-    "@commitlint/config-conventional": "20.4.0",
+    "@commitlint/cli": "20.4.1",
+    "@commitlint/config-conventional": "20.4.1",
     "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/npm": "^13.0.0",
@@ -87,9 +87,10 @@
     "globals": "^17.0.0",
     "husky": "^9.1.6",
     "js-yaml": "^4.1.0",
+    "selfsigned": "^5.5.0",
     "shellcheck": "^4.1.0",
     "tsx": "^4.20.3",
-    "undici": "7.19.2",
+    "undici": "7.21.0",
     "vitest": "^4.0.4"
   },
   "overrides": {

package/src/cli/build/build.helpers.ts

@@ -7,7 +7,7 @@ import { validateCapabilityNames } from "../../lib/helpers";
 import { BuildOptions, context, BuildContext } from "esbuild";
 import { Assets } from "../../lib/assets/assets";
 import { resolve } from "path";
-import { promises as fs, accessSync, constants, statSync } from "fs";
+import { promises as fs, accessSync, constants, statSync, readFileSync } from "fs";
 import { generateAllYaml } from "../../lib/assets/yaml/generateAllYaml";
 import { webhookConfigGenerator } from "../../lib/assets/webhooks";
 import { generateZarfYamlGeneric } from "../../lib/assets/yaml/generateZarfYaml";
@@ -42,6 +42,31 @@ export function fileExists(entryPoint: string = "pepr.ts"): string {
   return entryPoint;
 }
 
+/**
+ * Determine the module format based on package.json "type" field.
+ *
+ * @param packageJsonPath - Path to the package.json file for auto-detection
+ * @returns "cjs" or "esm"
+ */
+export function determineModuleFormat(packageJsonPath: string): "cjs" | "esm" {
+  try {
+    const pkg = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+    if (pkg.type === "module") {
+      return "esm";
+    }
+    if (pkg.type !== "commonjs") {
+      // No type field specified - warn user
+      Log.warn(
+        "No 'type' field specified in package.json. Defaulting to CommonJS format. To use ES modules, add '\"type\": \"module\"' to your tsconfig.json or package.json.",
+      );
+    }
+  } catch {
+    // If can't read package.json, default to cjs
+  }
+
+  return "cjs";
+}
+
 interface ImageOptions {
   customImage?: string;
   registryInfo?: string;

package/src/cli/build/buildModule.ts

@@ -17,6 +17,14 @@ export type BuildModuleReturn = {
   cfg: PeprConfig;
   uuid: string;
 };
+
+export interface BuildModuleOptions {
+  reloader?: Reloader;
+  entryPoint?: string;
+  embed?: boolean;
+  format?: "cjs" | "esm";
+}
+
 // Create a list of external libraries to exclude from the bundle, these are already stored in the container
 const externalLibs = Object.keys(dependencies);
 
@@ -26,29 +34,59 @@ externalLibs.push("pepr");
 // Add the kubernetes client to the list of external libraries as it is pulled in by kubernetes-fluent-client
 externalLibs.push("@kubernetes/client-node");
 
+/**
+ * Resolve the esbuild output format and file path for the build.
+ *
+ * Embedded builds are fork()ed by loadCapabilities() to extract capabilities, so they must
+ * use CJS format. When the user's package has "type": "module", Node.js treats .js files as
+ * ESM regardless of their content, so we also rename the output to .cjs for correct parsing.
+ */
+function resolveFormatAndPath(
+  embed: boolean,
+  requestedFormat: "cjs" | "esm",
+  loadedPath: string,
+): { format: "cjs" | "esm"; path: string } {
+  if (embed) {
+    return {
+      format: "cjs",
+      path: requestedFormat === "esm" ? loadedPath.replace(/\.js$/, ".cjs") : loadedPath,
+    };
+  }
+  return { format: requestedFormat, path: loadedPath };
+}
+
 export async function buildModule(
   outputDir: string,
-  reloader?: Reloader,
-  entryPoint = "pepr.ts",
-  embed = true,
+  options: BuildModuleOptions = {},
 ): Promise<BuildModuleReturn | void> {
+  const {
+    reloader,
+    entryPoint = "pepr.ts",
+    embed = true,
+    format: requestedFormat = "cjs",
+  } = options;
+
   try {
-    const { cfg, modulePath, path, uuid } = await loadModule(outputDir, entryPoint);
+    const { cfg, modulePath, path: loadedPath, uuid } = await loadModule(outputDir, entryPoint);
+    const { format, path } = resolveFormatAndPath(embed, requestedFormat, loadedPath);
 
     await checkFormat();
-    // Resolve node_modules folder (in support of npm workspaces!)
-    const npmRoot = execFileSync("npm", ["root"]).toString().trim();
 
-    // Run `tsc` to validate the module's types & output sourcemaps
-    const args = ["--project", `${modulePath}/tsconfig.json`, "--outdir", outputDir];
-    execFileSync(`${npmRoot}/.bin/tsc`, args);
+    // Resolve node_modules folder (in support of npm workspaces!) and run tsc
+    const npmRoot = execFileSync("npm", ["root"]).toString().trim();
+    execFileSync(`${npmRoot}/.bin/tsc`, [
+      "--project",
+      `${modulePath}/tsconfig.json`,
+      "--outdir",
+      outputDir,
+    ]);
 
     // Common build options for all builds
     const ctxCfg: BuildOptions = {
       bundle: true,
       entryPoints: [entryPoint],
       external: externalLibs,
-      format: "cjs",
+      format: format,
       keepNames: true,
       legalComments: "external",
       metafile: true,
@@ -87,8 +125,10 @@ export async function buildModule(
       // Don't minify
       ctxCfg.minify = false;
 
-      // Preserve the original file name
-      ctxCfg.outfile = resolve(outputDir, basename(entryPoint, extname(entryPoint))) + ".js";
+      // Preserve the original file name with appropriate extension for format
+      const outputExtension = format === "esm" ? ".mjs" : ".js";
+      ctxCfg.outfile =
+        resolve(outputDir, basename(entryPoint, extname(entryPoint))) + outputExtension;
 
       // Don't bundle
       ctxCfg.packages = "external";

package/src/cli/build/index.ts

@@ -7,6 +7,7 @@ import { Option } from "commander";
 import { parseTimeout } from "../../lib/helpers";
 import {
   determineRbacMode,
+  determineModuleFormat,
   assignImage,
   createOutputDirectory,
   handleValidCapabilityNames,
@@ -15,8 +16,79 @@ import {
   generateYamlAndWriteToDisk,
   fileExists,
 } from "./build.helpers";
-import { buildModule } from "./buildModule";
+import { buildModule, BuildModuleReturn } from "./buildModule";
 import Log from "../../lib/telemetry/logger";
+import { resolve } from "path";
+
+interface BuildOpts {
+  customName?: string;
+  customImage?: string;
+  registryInfo?: string;
+  registry?: string;
+  rbacMode?: string;
+  timeout?: number;
+  embed: boolean;
+  withPullSecret: string;
+  zarf: string;
+}
+
+async function generateDeploymentAssets(
+  buildResult: BuildModuleReturn,
+  opts: BuildOpts,
+  outputDir: string,
+): Promise<Assets> {
+  const { cfg, path } = buildResult;
+
+  const image = assignImage({
+    customImage: opts.customImage,
+    registryInfo: opts.registryInfo,
+    peprVersion: cfg.pepr.peprVersion,
+    registry: opts.registry,
+  });
+
+  if (opts.timeout !== undefined) {
+    cfg.pepr.webhookTimeout = opts.timeout;
+  }
+
+  if (opts.registryInfo !== undefined) {
+    Log.info(`Including ${cfg.pepr.includedFiles.length} files in controller image.`);
+    await handleCustomImageBuild(
+      cfg.pepr.includedFiles,
+      cfg.pepr.peprVersion,
+      cfg.description,
+      image,
+    );
+  }
+
+  const assets = new Assets(
+    {
+      ...cfg.pepr,
+      appVersion: cfg.version,
+      description: cfg.description,
+      alwaysIgnore: { namespaces: cfg.pepr.alwaysIgnore?.namespaces },
+      rbacMode: determineRbacMode(opts, cfg),
+    },
+    path,
+    opts.withPullSecret === "" ? [] : [opts.withPullSecret],
+  );
+
+  if (image !== "") assets.image = image;
+
+  if (!validImagePullSecret(opts.withPullSecret)) {
+    throw new Error("Invalid imagePullSecret. Please provide a valid name as defined in RFC 1123.");
+  }
+
+  handleValidCapabilityNames(assets.capabilities);
+  await generateYamlAndWriteToDisk({
+    uuid: cfg.pepr.uuid,
+    outputDir,
+    imagePullSecret: opts.withPullSecret,
+    zarf: opts.zarf,
+    assets,
+  });
+
+  return assets;
+}
 
 export default function (program: Command): void {
   program
@@ -77,83 +149,29 @@ export default function (program: Command): void {
     )
     .action(async opts => {
       const outputDir = await createOutputDirectory(opts.output);
+      const format = determineModuleFormat(resolve(process.cwd(), "package.json"));
 
-      // Build the module
-      const buildModuleResult = await buildModule(
-        outputDir,
-        undefined,
-        opts.entryPoint,
-        opts.embed,
-      );
-
-      const { cfg, path } = buildModuleResult!;
-      // override the name if provided
-      if (opts.customName) {
-        process.env.PEPR_CUSTOM_BUILD_NAME = opts.customName;
-      }
-
-      const image = assignImage({
-        customImage: opts.customImage,
-        registryInfo: opts.registryInfo,
-        peprVersion: cfg.pepr.peprVersion,
-        registry: opts.registry,
+      const buildModuleResult = await buildModule(outputDir, {
+        entryPoint: opts.entryPoint,
+        embed: opts.embed,
+        format,
       });
 
-      // Check if there is a custom timeout defined
-      if (opts.timeout !== undefined) {
-        cfg.pepr.webhookTimeout = opts.timeout;
+      if (!buildModuleResult) {
+        return;
       }
 
-      if (opts.registryInfo !== undefined) {
-        Log.info(`Including ${cfg.pepr.includedFiles.length} files in controller image.`);
+      const { path } = buildModuleResult;
 
-        // only actually build/push if there are files to include
-        await handleCustomImageBuild(
-          cfg.pepr.includedFiles,
-          cfg.pepr.peprVersion,
-          cfg.description,
-          image,
-        );
+      if (opts.customName) {
+        process.env.PEPR_CUSTOM_BUILD_NAME = opts.customName;
       }
 
-      // If building without embedding, exit after building
       if (!opts.embed) {
         Log.info(`Module built successfully at ${path}`);
         return;
       }
 
-      // Generate a secret for the module
-      const assets = new Assets(
-        {
-          ...cfg.pepr,
-          appVersion: cfg.version,
-          description: cfg.description,
-          alwaysIgnore: {
-            namespaces: cfg.pepr.alwaysIgnore?.namespaces,
-          },
-          // Can override the rbacMode with the CLI option
-          rbacMode: determineRbacMode(opts, cfg),
-        },
-        path,
-        opts.withPullSecret === "" ? [] : [opts.withPullSecret],
-      );
-
-      if (image !== "") assets.image = image;
-
-      // Ensure imagePullSecret is valid
-      if (!validImagePullSecret(opts.withPullSecret)) {
-        throw new Error(
-          "Invalid imagePullSecret. Please provide a valid name as defined in RFC 1123.",
-        );
-      }
-
-      handleValidCapabilityNames(assets.capabilities);
-      await generateYamlAndWriteToDisk({
-        uuid: cfg.pepr.uuid,
-        outputDir,
-        imagePullSecret: opts.withPullSecret,
-        zarf: opts.zarf,
-        assets,
-      });
+      await generateDeploymentAssets(buildModuleResult, opts, outputDir);
     });
 }

package/src/cli/deploy/buildAndDeploy.ts

@@ -7,7 +7,7 @@ import { CapabilityExport } from "../../lib/types";
 import { buildModule } from "../build/buildModule";
 
 export async function buildAndDeployModule(image: string, force: boolean): Promise<void> {
-  const builtModule = await buildModule("dist");
+  const builtModule = await buildModule("dist", {});
   if (!builtModule) {
     return;
   }

package/src/cli/dev.ts

@@ -105,18 +105,20 @@ export default function (program: Command): void {
           });
         };
 
-        await buildModule("dist", async r => {
-          if (r.errors.length > 0) {
-            Log.error(`Error compiling module: ${r.errors}`);
-            return;
-          }
+        await buildModule("dist", {
+          reloader: async r => {
+            if (r.errors.length > 0) {
+              Log.error(`Error compiling module: ${r.errors}`);
+              return;
+            }
 
-          if (program) {
-            program.once("exit", runFork);
-            program.kill("SIGKILL");
-          } else {
-            await runFork();
-          }
+            if (program) {
+              program.once("exit", runFork);
+              program.kill("SIGKILL");
+            } else {
+              await runFork();
+            }
+          },
         });
       } catch (e) {
         Log.error(`Error deploying module:`, e);

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

@@ -225,6 +225,7 @@ export type WatchEventArgs<K extends WatchEvent, T extends GenericClass> = {
   [WatchEvent.RECONNECT_PENDING]: undefined;
   [WatchEvent.DATA]: undefined;
   [WatchEvent.INC_RESYNC_FAILURE_COUNT]: number;
+  [WatchEvent.WATCH_ERROR]: Error;
 }[K];
 
 export type LogEventFunction = (event: WatchEvent, message?: string) => void;
@@ -245,6 +246,7 @@ export function registerWatchEventHandlers(
         { cause: err },
       );
     },
+    [WatchEvent.WATCH_ERROR]: err => logEvent(WatchEvent.WATCH_ERROR, err.message),
     [WatchEvent.CONNECT]: url => logEvent(WatchEvent.CONNECT, url),
     [WatchEvent.DATA_ERROR]: err => logEvent(WatchEvent.DATA_ERROR, err.message),
     [WatchEvent.RECONNECT]: retryCount =>

package/src/templates/tsconfig.module.json

@@ -6,8 +6,8 @@
     "emitDeclarationOnly": true,
     "esModuleInterop": true,
     "lib": ["ES2022"],
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
+    "module": "es2022",
+    "moduleResolution": "bundler",
     "outDir": "dist",
     "resolveJsonModule": true,
     "rootDir": ".",

package/src/templates/package.json

@@ -1,30 +0,0 @@
-{
-  "name": "pepr-dev-module",
-  "description": "static test package.json for local pepr core development",
-  "pepr": {
-    "name": "Development Module",
-    "uuid": "20e17cf6-a2e4-46b2-b626-75d88d96c88b",
-    "description": "Development module for pepr",
-    "onError": "reject",
-    "logLevel": "debug",
-    "customLabels": {
-      "namespace": {
-        "pepr.dev": ""
-      }
-    },
-    "alwaysIgnore": {
-      "namespaces": []
-    },
-    "admission": {
-      "alwaysIgnore": {
-        "namespaces": []
-      }
-    },
-    "watcher": {
-      "alwaysIgnore": {
-        "namespaces": []
-      }
-    },
-    "includedFiles": []
-  }
-}