pepr 0.51.6 → 0.52.0

package/src/cli/crd/generate.ts

@@ -4,6 +4,7 @@
 import { Command } from "commander";
 import fs from "fs";
 import path from "path";
+import Log from "../../lib/telemetry/logger";
 import { stringify } from "yaml";
 import {
   Project,
@@ -20,8 +21,10 @@ import { V1JSONSchemaProps } from "@kubernetes/client-node";
 import { WarningMessages, ErrorMessages } from "./messages";
 
 export default new Command("generate")
-  .description("Generate CRD manifests from TypeScript definitions")
-  .option("--output <output>", "Output directory for generated CRDs", "./crds")
+  .description(
+    "Generate CRD manifests from TypeScript definitions stored in 'api/' of the current directory.",
+  )
+  .option("-o, --output <directory>", "Output directory for generated CRDs", "./crds")
   .action(generateCRDs);
 
 export function extractCRDDetails(
@@ -48,7 +51,7 @@ export function extractCRDDetails(
 }
 
 export async function generateCRDs(options: { output: string }): Promise<void> {
-  console.log("This feature is currently in alpha.\n");
+  Log.warn("This feature is currently in alpha.\n");
   const outputDir = path.resolve(options.output);
   await createDirectoryIfNotExists(outputDir);
 
@@ -83,13 +86,13 @@ export function processSourceFile(
   const { kind, fqdn, scope, plural, shortNames } = extractCRDDetails(content, sourceFile);
 
   if (!kind) {
-    console.warn(WarningMessages.MISSING_KIND_COMMENT(sourceFile.getBaseName()));
+    Log.warn(WarningMessages.MISSING_KIND_COMMENT(sourceFile.getBaseName()));
     return;
   }
 
   const spec = sourceFile.getInterface(`${kind}Spec`);
   if (!spec) {
-    console.warn(WarningMessages.MISSING_INTERFACE(sourceFile.getBaseName(), kind));
+    Log.warn(WarningMessages.MISSING_INTERFACE(sourceFile.getBaseName(), kind));
     return;
   }
 
@@ -110,7 +113,7 @@ export function processSourceFile(
 
   const outPath = path.join(outputDir, `${kind.toLowerCase()}.yaml`);
   fs.writeFileSync(outPath, stringify(crd), "utf8");
-  console.log(`✔ Created ${outPath}`);
+  Log.info(`✔ Created ${outPath}`);
 }
 
 // Extracts a comment from the content of a file based on a label.

package/src/cli/crd/index.ts

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
 
-import { RootCmd } from "../root";
+import { Command } from "commander";
 import createCmd from "./create";
 import generateCmd from "./generate";
 
-export default function (program: RootCmd): void {
+export default function (program: Command): void {
   const crd = program
     .command("crd")
     .description("Scaffold and generate Kubernetes CRDs from structured TypeScript definitions");

package/src/cli/deploy.ts

@@ -5,7 +5,7 @@ import prompt from "prompts";
 import { CapabilityExport } from "../lib/types";
 import { Assets } from "../lib/assets/assets";
 import { ImagePullSecret } from "../lib/types";
-import { RootCmd } from "./root";
+import { Command } from "commander";
 import { buildModule } from "./build";
 import { deployImagePullSecret, deployWebhook } from "../lib/assets/deploy";
 import { namespaceDeploymentsReady } from "../lib/deploymentChecks";
@@ -54,7 +54,7 @@ export function validateImagePullSecretDetails(details: ImagePullSecretDetails):
   if (missing.length > 0) {
     return {
       valid: false,
-      error: `Error: Must provide ${missing.join(", ")} when providing --pullSecret`,
+      error: `Error: Must provide ${missing.join(", ")} when providing --pull-secret`,
     };
   }
 
@@ -79,19 +79,19 @@ function generateImagePullSecret(details: ValidatedImagePullSecretDetails): Imag
   };
 }
 
-export async function getUserConfirmation(opts: { confirm: boolean }): Promise<boolean> {
-  if (opts.confirm) {
+export async function getUserConfirmation(opts: { yes: boolean }): Promise<boolean> {
+  if (opts.yes) {
     return true;
   }
 
   // Prompt the user to confirm
-  const confirm = await prompt({
+  const confirmation = await prompt({
     type: "confirm",
-    name: "confirm",
+    name: "yes",
     message: "This will remove and redeploy the module. Continue?",
   });
 
-  return confirm.confirm ? true : false;
+  return confirmation.yes ? true : false;
 }
 
 async function buildAndDeployModule(image: string, force: boolean): Promise<void> {
@@ -126,18 +126,18 @@ async function buildAndDeployModule(image: string, force: boolean): Promise<void
   }
 }
 
-export default function (program: RootCmd): void {
+export default function (program: Command): void {
   program
     .command("deploy")
     .description("Deploy a Pepr Module")
-    .option("-i, --image [image]", "Override the image tag")
-    .option("--confirm", "Skip confirmation prompt")
-    .option("--pullSecret <name>", "Deploy imagePullSecret for Controller private registry")
-    .option("--docker-server <server>", "Docker server address")
-    .option("--docker-username <username>", "Docker registry username")
-    .option("--docker-email <email>", "Email for Docker registry")
-    .option("--docker-password <password>", "Password for Docker registry")
-    .option("--force", "Force deploy the module, override manager field")
+    .option("-E, --docker-email <email>", "Email for Docker registry.")
+    .option("-P, --docker-password <password>", "Password for Docker registry.")
+    .option("-S, --docker-server <server>", "Docker server address.")
+    .option("-U, --docker-username <username>", "Docker registry username.")
+    .option("-f, --force", "Force deploy the module, override manager field.")
+    .option("-i, --image <image>", "Override the image tag.")
+    .option("-p, --pull-secret <name>", "Deploy imagePullSecret for Controller private registry.")
+    .option("-y, --yes", "Skip confirmation prompts.")
     .action(async opts => {
       const valResp = validateImagePullSecretDetails(opts);
       if (!valResp.valid) {

package/src/cli/dev.ts

@@ -5,30 +5,30 @@ import prompt from "prompts";
 import { Assets } from "../lib/assets/assets";
 import { ChildProcess, fork } from "child_process";
 import { K8s, kind } from "kubernetes-fluent-client";
-import { RootCmd } from "./root";
+import { Command } from "commander";
 import { Store } from "../lib/k8s";
 import { buildModule, loadModule } from "./build";
 import { deployWebhook } from "../lib/assets/deploy";
 import { promises as fs } from "fs";
 import { validateCapabilityNames } from "../lib/helpers";
 
-export default function (program: RootCmd): void {
+export default function (program: Command): void {
   program
     .command("dev")
     .description("Setup a local webhook development environment")
-    .option("-h, --host [host]", "Host to listen on", "host.k3d.internal")
-    .option("--confirm", "Skip confirmation prompt")
+    .option("-H, --host <host>", "Host to listen on", "host.k3d.internal")
+    .option("-y, --yes", "Skip confirmation prompt")
     .action(async opts => {
-      // Prompt the user to confirm if they didn't pass the --confirm flag
-      if (!opts.confirm) {
+      // Prompt the user to confirm if they didn't pass the --yes flag
+      if (!opts.yes) {
         const confirm = await prompt({
           type: "confirm",
-          name: "confirm",
+          name: "yes",
           message: "This will remove and redeploy the module. Continue?",
         });
 
         // Exit if the user doesn't confirm
-        if (!confirm.confirm) {
+        if (!confirm.yes) {
           process.exitCode = 0;
           return;
         }

package/src/cli/format/index.ts

@@ -4,9 +4,10 @@
 import { ESLint } from "eslint";
 import { formatWithPrettier } from "./format.helpers";
 
-import { RootCmd } from "../root";
+import { Command } from "commander";
+import Log from "../../lib/telemetry/logger";
 
-export default function (program: RootCmd): void {
+export default function (program: Command): void {
   program
     .command("format")
     .description("Lint and format this Pepr module")
@@ -47,7 +48,7 @@ export async function peprFormat(validateOnly: boolean): Promise<boolean> {
       const resultText = await formatter.format(results, {} as ESLint.LintResultData);
 
       if (resultText) {
-        console.log(resultText);
+        Log.info(resultText);
       }
 
       // Write the fixes if not in validate-only mode
@@ -55,7 +56,7 @@ export async function peprFormat(validateOnly: boolean): Promise<boolean> {
         await ESLint.outputFixes(results);
       }
 
-      hasFailure = await formatWithPrettier(results, validateOnly);
+      hasFailure = hasFailure || (await formatWithPrettier(results, validateOnly));
 
       return !hasFailure;
     } catch (e) {

package/src/cli/init/index.ts

@@ -5,7 +5,7 @@ import { execSync } from "child_process";
 import { resolve } from "path";
 import prompts from "prompts";
 
-import { RootCmd } from "../root";
+import { Command } from "commander";
 import {
   codeSettings,
   eslint,
@@ -24,20 +24,22 @@ import { createDir, sanitizeName, write } from "./utils";
 import { confirm, PromptOptions, walkthrough } from "./walkthrough";
 import { ErrorList } from "../../lib/errors";
 import { UUID_LENGTH_LIMIT } from "./enums";
+import { Option } from "commander";
 
-export default function (program: RootCmd): void {
+export default function (program: Command): void {
   let response = {} as PromptOptions;
   let pkgOverride = "";
   program
     .command("init")
     .description("Initialize a new Pepr Module")
-    .option("--confirm", "Skip verification prompt when creating a new module.")
-    .option("--description <string>", "Explain the purpose of the new module.")
-    .option("--name <string>", "Set the name of the new module.")
-    .option("--skip-post-init", "Skip npm install, git init, and VSCode launch.")
-    .option(`--errorBehavior <${ErrorList.join("|")}>`, "Set an errorBehavior.")
+    .option("-d, --description <string>", "Explain the purpose of the new module.")
+    .addOption(
+      new Option("-e, --error-behavior <behavior>", "Set an error behavior.").choices(ErrorList),
+    )
+    .option("-n, --name <string>", "Set the name of the new module.")
+    .option("-s, --skip-post-init", "Skip npm install, git init, and VSCode launch.")
     .option(
-      "--uuid [string]",
+      "-u, --uuid <string>",
       "Unique identifier for your module with a max length of 36 characters.",
       (uuid: string): string => {
         if (uuid.length > UUID_LENGTH_LIMIT) {
@@ -46,6 +48,7 @@ export default function (program: RootCmd): void {
         return uuid.toLocaleLowerCase();
       },
     )
+    .option("-y, --yes", "Skip verification prompt when creating a new module.")
     .hook("preAction", async thisCommand => {
       // TODO: Overrides for testing. Don't be so gross with Node CLI testing
       // TODO: See pepr/#1140
@@ -68,7 +71,7 @@ export default function (program: RootCmd): void {
       const dirName = sanitizeName(response.name);
       const packageJSON = genPkgJSON(response, pkgOverride);
 
-      const confirmed = await confirm(dirName, packageJSON, peprTSTemplate.path, opts.confirm);
+      const confirmed = await confirm(dirName, packageJSON, peprTSTemplate.path, opts.yes);
 
       if (confirmed) {
         console.log("Creating new Pepr module...");

package/src/cli/init/walkthrough.ts

@@ -137,7 +137,7 @@ export async function confirm(
 ): Promise<boolean> {
   const confirmationPrompt: PromptObject = {
     type: "confirm",
-    name: "confirm",
+    name: "yes",
     message: "Create the new Pepr module?",
   };
   const confirmationMessage = `To be generated:
@@ -162,9 +162,7 @@ ${packageJSON.print.replace(/^/gm, "    │   ")}
     console.log(confirmationMessage);
     const confirm = await prompt([confirmationPrompt]);
     const shouldCreateModule =
-      confirm.confirm === "y" || confirm.confirm === "yes" || confirm.confirm === true
-        ? true
-        : false;
+      confirm.yes === "y" || confirm.yes === "yes" || confirm.yes === true ? true : false;
     return shouldCreateModule;
   }
 }

package/src/cli/kfc.ts

@@ -4,24 +4,28 @@
 import { execSync } from "child_process";
 import prompt from "prompts";
 
-import { RootCmd } from "./root";
+import { Command } from "commander";
 
-export default function (program: RootCmd): void {
+export default function (program: Command): void {
   program
     .command("kfc [args...]")
     .description("Execute Kubernetes Fluent Client commands")
-    .action(async (args: string[]) => {
-      const { confirm } = await prompt({
-        type: "confirm",
-        name: "confirm",
-        message:
-          "For commands that generate files, this may overwrite any previously generated files.\n" +
-          "Are you sure you want to continue?",
-      });
+    .option("-y, --yes", "Skip confirmation prompt.")
+    .action(async (args: string[], options) => {
+      // Skip confirmation if yes flag is provided
+      if (!options.yes) {
+        const { confirm } = await prompt({
+          type: "confirm",
+          name: "confirm",
+          message:
+            "For commands that generate files, this may overwrite any previously generated files.\n" +
+            "Are you sure you want to continue?",
+        });
 
-      // If the user doesn't confirm, exit
-      if (!confirm) {
-        return;
+        // If the user doesn't confirm, exit
+        if (!confirm) {
+          return;
+        }
       }
 
       try {

package/src/cli/monitor.ts

@@ -5,7 +5,7 @@ import { Log as K8sLog, KubeConfig, KubernetesListObject } from "@kubernetes/cli
 import { K8s, kind } from "kubernetes-fluent-client";
 import stream from "stream";
 import { ResponseItem } from "../lib/types";
-import { RootCmd } from "./root";
+import { Command } from "commander";
 
 interface LogPayload {
   namespace: string;
@@ -22,7 +22,7 @@ interface LogPayload {
   };
 }
 
-export default function (program: RootCmd): void {
+export default function (program: Command): void {
   program
     .command("monitor [module-uuid]")
     .description("Monitor a Pepr Module")

package/src/cli/update/index.ts

@@ -15,13 +15,14 @@ import {
   tsConfig,
 } from "../init/templates";
 import { write } from "../init/utils";
-import { RootCmd } from "../root";
+import { Command } from "commander";
+import Log from "../../lib/telemetry/logger";
 
-export default function (program: RootCmd): void {
+export default function (program: Command): void {
   program
     .command("update")
     .description("Update this Pepr module. Not recommended for prod as it may change files.")
-    .option("--skip-template-update", "Skip updating the template files")
+    .option("-s, --skip-template-update", "Do not update template files")
     .action(async opts => {
       if (!opts.skipTemplateUpdate) {
         const { confirm } = await prompt({
@@ -38,7 +39,7 @@ export default function (program: RootCmd): void {
         }
       }
 
-      console.log("Updating the Pepr module...");
+      Log.info("Updating the Pepr module...");
 
       try {
         // Update Pepr for the module
@@ -53,9 +54,9 @@ export default function (program: RootCmd): void {
           });
         }
 
-        console.log(`✅ Module updated successfully`);
-      } catch (e) {
-        console.error(`Error updating Pepr module:`, e);
+        Log.info(`✅ Module updated successfully`);
+      } catch (error) {
+        Log.error(error, `Error updating Pepr module:`);
         process.exitCode = 1;
       }
     });
@@ -64,7 +65,7 @@ export default function (program: RootCmd): void {
     .command("update-templates", { hidden: true })
     .description("Perform template updates")
     .action(async opts => {
-      console.log("Updating Pepr config and template tiles...");
+      Log.info("Updating Pepr config and template files...");
 
       try {
         // Don't update the template files if the user specified the --skip-template-update flag
@@ -87,9 +88,8 @@ export default function (program: RootCmd): void {
             await write(tsPath, helloPepr.data);
           }
         }
-        throw new Error("another error, for testing");
-      } catch (e) {
-        console.error(`Error updating template files:`, e);
+      } catch (error) {
+        Log.error(error, `Error updating template files:`);
         process.exitCode = 1;
       }
     });

package/src/cli/uuid.ts

@@ -3,9 +3,9 @@
 
 import { KubernetesListObject } from "@kubernetes/client-node";
 import { K8s, kind } from "kubernetes-fluent-client";
-import { RootCmd } from "./root";
+import { Command } from "commander";
 
-export default function (program: RootCmd): void {
+export default function (program: Command): void {
   program
     .command("uuid [uuid]")
     .description("Module UUID(s) currently deployed in the cluster")

package/src/cli.ts

@@ -12,7 +12,7 @@ import monitor from "./cli/monitor";
 import init from "./cli/init/index";
 import uuid from "./cli/uuid";
 import { version } from "./cli/init/templates";
-import { RootCmd } from "./cli/root";
+import { Command } from "commander";
 import update from "./cli/update";
 import kfc from "./cli/kfc";
 import crd from "./cli/crd";
@@ -21,7 +21,7 @@ if (process.env.npm_lifecycle_event !== "npx") {
   console.info("Pepr should be run via `npx pepr <command>` instead of `pepr <command>`.");
 }
 
-const program = new RootCmd();
+const program = new Command();
 if (!process.env.PEPR_NODE_WARNINGS) {
   process.removeAllListeners("warning");
 }

package/src/lib/assets/assets.ts

@@ -8,6 +8,7 @@ import {
   namespaceTemplate,
   clusterRoleTemplate,
   admissionDeployTemplate,
+  serviceTemplate,
   serviceMonitorTemplate,
   watcherDeployTemplate,
 } from "./helm";
@@ -23,10 +24,39 @@ import { loadCapabilities } from "./loader";
 import { namespaceComplianceValidator, dedent } from "../helpers";
 import { promises as fs } from "fs";
 import { storeRole, storeRoleBinding, clusterRoleBinding, serviceAccount } from "./rbac";
-import { watcherService, service, tlsSecret, apiPathSecret } from "./networking";
+import { tlsSecret, apiPathSecret } from "./networking";
 import { WebhookType } from "../enums";
 import { kind } from "kubernetes-fluent-client";
 
+export function norWatchOrAdmission(capabilities: CapabilityExport[]): boolean {
+  return !isAdmission(capabilities) && !isWatcher(capabilities);
+}
+export function isAdmission(capabilities: CapabilityExport[]): boolean {
+  for (const capability of capabilities) {
+    const admissionBindings = capability.bindings.filter(
+      binding => binding.isFinalize || binding.isMutate || binding.isValidate,
+    );
+    if (admissionBindings.length > 0) {
+      return true;
+    }
+  }
+  return false;
+}
+export function isWatcher(capabilities: CapabilityExport[]): boolean {
+  for (const capability of capabilities) {
+    if (capability.hasSchedule) {
+      return true;
+    }
+    const watcherBindings = capability.bindings.filter(
+      binding => binding.isFinalize || binding.isWatch || binding.isQueue,
+    );
+    if (watcherBindings.length > 0) {
+      return true;
+    }
+  }
+  return false;
+}
+
 export class Assets {
   readonly name: string;
   readonly tls: TLSOut;
@@ -82,20 +112,25 @@ export class Assets {
   allYaml = async (
     yamlGenerationFunction: (
       assets: Assets,
-      deployments: { default: V1Deployment; watch: V1Deployment | null },
+      deployments: { admission: V1Deployment | null; watch: V1Deployment | null },
+      services: { admission: kind.Service | null; watch: kind.Service | null },
     ) => Promise<string>,
-    getDeploymentFunction: (
-      assets: Assets,
-      hash: string,
-      buildTimestamp: string,
-      imagePullSecret?: string,
-    ) => kind.Deployment,
-    getWatcherFunction: (
-      assets: Assets,
-      hash: string,
-      buildTimestamp: string,
-      imagePullSecret?: string,
-    ) => kind.Deployment | null,
+    getControllerManifests: {
+      getDeploymentFunction: (
+        assets: Assets,
+        hash: string,
+        buildTimestamp: string,
+        imagePullSecret?: string,
+      ) => kind.Deployment | null;
+      getWatcherFunction: (
+        assets: Assets,
+        hash: string,
+        buildTimestamp: string,
+        imagePullSecret?: string,
+      ) => kind.Deployment | null;
+      getServiceFunction: (name: string, assets: Assets) => kind.Service | null;
+      getWatcherServiceFunction: (name: string, assets: Assets) => kind.Service | null;
+    },
     imagePullSecret?: string,
   ): Promise<string> => {
     this.capabilities = await loadCapabilities(this.path);
@@ -116,11 +151,26 @@ export class Assets {
     const moduleHash = crypto.createHash("sha256").update(code).digest("hex");
 
     const deployments = {
-      default: getDeploymentFunction(this, moduleHash, this.buildTimestamp, imagePullSecret),
-      watch: getWatcherFunction(this, moduleHash, this.buildTimestamp, imagePullSecret),
+      admission: getControllerManifests.getDeploymentFunction(
+        this,
+        moduleHash,
+        this.buildTimestamp,
+        imagePullSecret,
+      ),
+      watch: getControllerManifests.getWatcherFunction(
+        this,
+        moduleHash,
+        this.buildTimestamp,
+        imagePullSecret,
+      ),
     };
 
-    return yamlGenerationFunction(this, deployments);
+    const services = {
+      admission: getControllerManifests.getServiceFunction(this.name, this),
+      watch: getControllerManifests.getWatcherServiceFunction(this.name, this),
+    };
+
+    return yamlGenerationFunction(this, deployments, services);
   };
 
   writeWebhookFiles = async (
@@ -131,7 +181,7 @@ export class Assets {
     if (validateWebhook || mutateWebhook) {
       await fs.writeFile(
         helm.files.admissionDeploymentYaml,
-        dedent(admissionDeployTemplate(this.buildTimestamp)),
+        dedent(admissionDeployTemplate(this.buildTimestamp, "admission")),
       );
       await fs.writeFile(
         helm.files.admissionServiceMonitorYaml,
@@ -194,8 +244,14 @@ export class Assets {
           (): string => dedent(chartYaml(this.config.uuid, this.config.description || "")),
         ],
         [helm.files.namespaceYaml, (): string => dedent(namespaceTemplate())],
-        [helm.files.watcherServiceYaml, (): string => toYaml(watcherService(this.name))],
-        [helm.files.admissionServiceYaml, (): string => toYaml(service(this.name))],
+        [
+          helm.files.watcherServiceYaml,
+          (): string => dedent(serviceTemplate(this.name, "watcher")),
+        ],
+        [
+          helm.files.admissionServiceYaml,
+          (): string => dedent(serviceTemplate(this.name, "admission")),
+        ],
         [helm.files.tlsSecretYaml, (): string => toYaml(tlsSecret(this.name, this.tls))],
         [
           helm.files.apiPathSecretYaml,
@@ -221,7 +277,10 @@ export class Assets {
         apiPath: this.apiPath,
         capabilities: this.capabilities,
       };
-      await overridesFile(overrideData, helm.files.valuesYaml, this.imagePullSecrets);
+      await overridesFile(overrideData, helm.files.valuesYaml, this.imagePullSecrets, {
+        admission: isAdmission(this.capabilities) || norWatchOrAdmission(this.capabilities),
+        watcher: isWatcher(this.capabilities),
+      });
 
       const webhooks = {
         mutate: await webhookGeneratorFunction(
@@ -242,7 +301,7 @@ export class Assets {
       if (watchDeployment) {
         await fs.writeFile(
           helm.files.watcherDeploymentYaml,
-          dedent(watcherDeployTemplate(this.buildTimestamp)),
+          dedent(watcherDeployTemplate(this.buildTimestamp, "watcher")),
         );
         await fs.writeFile(
           helm.files.watcherServiceMonitorYaml,