pepr 0.52.3-nightly.5 → 0.52.3-nightly.7

package/package.json

@@ -16,7 +16,7 @@
     "!src/fixtures/**",
     "!dist/**/*.test.d.ts*"
   ],
-  "version": "0.52.3-nightly.5",
+  "version": "0.52.3-nightly.7",
   "main": "dist/lib.js",
   "types": "dist/lib.d.ts",
   "scripts": {
@@ -79,7 +79,7 @@
     "globals": "^16.0.0",
     "husky": "^9.1.6",
     "js-yaml": "^4.1.0",
-    "shellcheck": "^3.0.0",
+    "shellcheck": "^4.1.0",
     "tsx": "^4.20.3",
     "undici": "^7.0.1",
     "vitest": "^3.2.3"

package/src/cli/init/createProjectFiles.ts

@@ -0,0 +1,45 @@
+import { resolve } from "path/posix";
+import {
+  peprPackageJSON,
+  gitignore,
+  eslint,
+  prettier,
+  readme,
+  tsConfig,
+  peprTSTemplate,
+  snippet,
+  codeSettings,
+  samplesYaml,
+  helloPepr,
+} from "./templates";
+import { write } from "./utils";
+
+export async function createProjectFiles(
+  dirName: string,
+  packageJSON: peprPackageJSON,
+): Promise<void> {
+  const files = [
+    { path: gitignore.path, data: gitignore.data },
+    { path: eslint.path, data: eslint.data },
+    { path: prettier.path, data: prettier.data },
+    { path: packageJSON.path, data: packageJSON.data },
+    { path: readme.path, data: readme.data },
+    { path: tsConfig.path, data: tsConfig.data },
+    { path: peprTSTemplate.path, data: peprTSTemplate.data },
+  ];
+
+  const nestedFiles = [
+    { dir: ".vscode", path: snippet.path, data: snippet.data },
+    { dir: ".vscode", path: codeSettings.path, data: codeSettings.data },
+    { dir: "capabilities", path: samplesYaml.path, data: samplesYaml.data },
+    { dir: "capabilities", path: helloPepr.path, data: helloPepr.data },
+  ];
+
+  for (const file of files) {
+    await write(resolve(dirName, file.path), file.data);
+  }
+
+  for (const file of nestedFiles) {
+    await write(resolve(dirName, file.dir, file.path), file.data);
+  }
+}

package/src/cli/init/doPostInitActions.ts

@@ -0,0 +1,23 @@
+import { execSync } from "child_process";
+
+export const doPostInitActions = (dirName: string): void => {
+  // run npm install from the new directory
+  process.chdir(dirName);
+  execSync("npm install", {
+    stdio: "inherit",
+  });
+
+  // setup git
+  execSync("git init --initial-branch=main", {
+    stdio: "inherit",
+  });
+
+  // try to open vscode
+  try {
+    execSync("code .", {
+      stdio: "inherit",
+    });
+  } catch {
+    console.warn("VSCode was not found, IDE will not automatically open.");
+  }
+};

package/src/cli/init/index.ts

@@ -1,35 +1,23 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
 
-import { execSync } from "child_process";
-import { resolve } from "path";
-
 import { Command } from "commander";
-import {
-  codeSettings,
-  eslint,
-  peprTSTemplate,
-  genPkgJSON,
-  gitignore,
-  helloPepr,
-  peprPackageJSON,
-  prettier,
-  readme,
-  samplesYaml,
-  snippet,
-  tsConfig,
-} from "./templates";
-import { createDir, sanitizeName, write } from "./utils";
+import { peprTSTemplate, genPkgJSON } from "./templates";
+import { sanitizeName } from "./utils";
 import { confirm, PromptOptions, walkthrough } from "./walkthrough";
 import { ErrorList } from "../../lib/errors";
 import { UUID_LENGTH_LIMIT } from "./enums";
 import { Option } from "commander";
+import { setupProjectStructure } from "./setupProjectStructure";
+import { doPostInitActions } from "./doPostInitActions";
+import { createProjectFiles } from "./createProjectFiles";
+import { v4 as uuidv4 } from "uuid";
+import Log from "../../lib/telemetry/logger";
 
-export default function (program: Command): void {
+export default function (): Command {
   let response = {} as PromptOptions;
 
-  program
-    .command("init")
+  return new Command("init")
     .description("Initialize a new Pepr Module")
     .option("-d, --description <string>", "Explain the purpose of the new module.")
     .addOption(
@@ -41,6 +29,10 @@ export default function (program: Command): void {
       "-u, --uuid <string>",
       "Unique identifier for your module with a max length of 36 characters.",
       (uuid: string): string => {
+        if (typeof uuid === "undefined" || uuid === "") {
+          uuid = uuidv4();
+          Log.warn(`The UUID was empty. Generated new UUID: '${uuid}'`);
+        }
         if (uuid.length > UUID_LENGTH_LIMIT) {
           throw new Error("The UUID must be 36 characters or fewer.");
         }
@@ -59,7 +51,7 @@ export default function (program: Command): void {
       const confirmed = await confirm(dirName, packageJSON, peprTSTemplate.path, opts.yes);
 
       if (confirmed) {
-        console.log("Creating new Pepr module...");
+        Log.info("Creating new Pepr module...");
 
         try {
           await setupProjectStructure(dirName);
@@ -69,69 +61,11 @@ export default function (program: Command): void {
             doPostInitActions(dirName);
           }
 
-          console.log(`New Pepr module created at ${dirName}`);
-          console.log(`Open VSCode or your editor of choice in ${dirName} to get started!`);
-        } catch (e) {
-          if (e instanceof Error) {
-            console.error(`Error creating Pepr module:`, e);
-          }
-          process.exit(1);
+          Log.info(`New Pepr module created at ${dirName}`);
+          Log.info(`Open VSCode or your editor of choice in ${dirName} to get started!`);
+        } catch (error) {
+          throw new Error(`Error creating Pepr module:`, { cause: error });
         }
       }
     });
 }
-
-async function setupProjectStructure(dirName: string): Promise<void> {
-  await createDir(dirName);
-  await createDir(resolve(dirName, ".vscode"));
-  await createDir(resolve(dirName, "capabilities"));
-}
-
-async function createProjectFiles(dirName: string, packageJSON: peprPackageJSON): Promise<void> {
-  const files = [
-    { path: gitignore.path, data: gitignore.data },
-    { path: eslint.path, data: eslint.data },
-    { path: prettier.path, data: prettier.data },
-    { path: packageJSON.path, data: packageJSON.data },
-    { path: readme.path, data: readme.data },
-    { path: tsConfig.path, data: tsConfig.data },
-    { path: peprTSTemplate.path, data: peprTSTemplate.data },
-  ];
-
-  const nestedFiles = [
-    { dir: ".vscode", path: snippet.path, data: snippet.data },
-    { dir: ".vscode", path: codeSettings.path, data: codeSettings.data },
-    { dir: "capabilities", path: samplesYaml.path, data: samplesYaml.data },
-    { dir: "capabilities", path: helloPepr.path, data: helloPepr.data },
-  ];
-
-  for (const file of files) {
-    await write(resolve(dirName, file.path), file.data);
-  }
-
-  for (const file of nestedFiles) {
-    await write(resolve(dirName, file.dir, file.path), file.data);
-  }
-}
-
-const doPostInitActions = (dirName: string): void => {
-  // run npm install from the new directory
-  process.chdir(dirName);
-  execSync("npm install", {
-    stdio: "inherit",
-  });
-
-  // setup git
-  execSync("git init --initial-branch=main", {
-    stdio: "inherit",
-  });
-
-  // try to open vscode
-  try {
-    execSync("code .", {
-      stdio: "inherit",
-    });
-  } catch {
-    console.warn("VSCode was not found, IDE will not automatically open.");
-  }
-};

package/src/cli/init/setupProjectStructure.ts

@@ -0,0 +1,8 @@
+import { createDir } from "./utils";
+import { resolve } from "path";
+
+export async function setupProjectStructure(dirName: string): Promise<void> {
+  await createDir(dirName);
+  await createDir(resolve(dirName, ".vscode"));
+  await createDir(resolve(dirName, "capabilities"));
+}

package/src/cli/init/templates.ts

@@ -3,7 +3,6 @@
 
 import { dumpYaml } from "@kubernetes/client-node";
 import { inspect } from "util";
-import { v4 as uuidv4 } from "uuid";
 import { readFileSync } from "fs";
 import path from "path";
 
@@ -50,8 +49,7 @@ export type peprPackageJSON = {
 };
 
 export function genPkgJSON(opts: InitOptions): peprPackageJSON {
-  // Generate a random UUID for the module based on the module name if it is not provided
-  const uuid = !opts.uuid ? uuidv4() : opts.uuid;
+  const uuid = opts.uuid;
   // Generate a name for the module based on the module name
   const name = sanitizeName(opts.name);
   // Make typescript a dev dependency

package/src/cli/init/walkthrough.ts

@@ -33,6 +33,9 @@ async function setUUID(uuid?: string): Promise<Answers<string>> {
     name: "uuid",
     message: "Enter a unique identifier for the new Pepr module.\n",
     validate: (val: string) => {
+      if (typeof val === "undefined" || val === "") {
+        return "The UUID must be at least 1 character long";
+      }
       return (
         val.length <= UUID_LENGTH_LIMIT ||
         `The UUID must be ${UUID_LENGTH_LIMIT} characters or fewer.`

package/src/cli.ts

@@ -30,6 +30,7 @@ program
   .version(version)
   .description(`Pepr (v${version}) - Type safe K8s middleware for humans`)
   .addCommand(crd())
+  .addCommand(init())
   .action(() => {
     if (program.args.length < 1) {
       console.log(banner);
@@ -41,7 +42,6 @@ program
     }
   });
 
-init(program);
 build(program);
 deploy(program);
 dev(program);

package/src/lib/assets/k8sObjects.ts

@@ -85,9 +85,9 @@ export function getWatcher(
           serviceAccountName: name,
           securityContext: {
             runAsUser: image.includes("private") ? 1000 : 65532,
-            runAsGroup: 65532,
+            runAsGroup: image.includes("private") ? 1000 : 65532,
             runAsNonRoot: true,
-            fsGroup: 65532,
+            fsGroup: image.includes("private") ? 1000 : 65532,
           },
           containers: [
             {
@@ -128,7 +128,7 @@ export function getWatcher(
               },
               securityContext: {
                 runAsUser: image.includes("private") ? 1000 : 65532,
-                runAsGroup: 65532,
+                runAsGroup: image.includes("private") ? 1000 : 65532,
                 runAsNonRoot: true,
                 allowPrivilegeEscalation: false,
                 capabilities: {
@@ -228,9 +228,9 @@ export function getDeployment(
           serviceAccountName: name,
           securityContext: {
             runAsUser: image.includes("private") ? 1000 : 65532,
-            runAsGroup: 65532,
+            runAsGroup: image.includes("private") ? 1000 : 65532,
             runAsNonRoot: true,
-            fsGroup: 65532,
+            fsGroup: image.includes("private") ? 1000 : 65532,
           },
           containers: [
             {
@@ -272,7 +272,7 @@ export function getDeployment(
               env: genEnv(config),
               securityContext: {
                 runAsUser: image.includes("private") ? 1000 : 65532,
-                runAsGroup: 65532,
+                runAsGroup: image.includes("private") ? 1000 : 65532,
                 runAsNonRoot: true,
                 allowPrivilegeEscalation: false,
                 capabilities: {

package/src/lib/assets/yaml/overridesFile.ts

@@ -60,9 +60,9 @@ export async function overridesFile(
       },
       securityContext: {
         runAsUser: image.includes("private") ? 1000 : 65532,
-        runAsGroup: 65532,
+        runAsGroup: image.includes("private") ? 1000 : 65532,
         runAsNonRoot: true,
-        fsGroup: 65532,
+        fsGroup: image.includes("private") ? 1000 : 65532,
       },
       readinessProbe: {
         httpGet: {
@@ -92,7 +92,7 @@ export async function overridesFile(
       },
       containerSecurityContext: {
         runAsUser: image.includes("private") ? 1000 : 65532,
-        runAsGroup: 65532,
+        runAsGroup: image.includes("private") ? 1000 : 65532,
         runAsNonRoot: true,
         allowPrivilegeEscalation: false,
         capabilities: {
@@ -128,9 +128,9 @@ export async function overridesFile(
       },
       securityContext: {
         runAsUser: image.includes("private") ? 1000 : 65532,
-        runAsGroup: 65532,
+        runAsGroup: image.includes("private") ? 1000 : 65532,
         runAsNonRoot: true,
-        fsGroup: 65532,
+        fsGroup: image.includes("private") ? 1000 : 65532,
       },
       readinessProbe: {
         httpGet: {
@@ -160,7 +160,7 @@ export async function overridesFile(
       },
       containerSecurityContext: {
         runAsUser: image.includes("private") ? 1000 : 65532,
-        runAsGroup: 65532,
+        runAsGroup: image.includes("private") ? 1000 : 65532,
         runAsNonRoot: true,
         allowPrivilegeEscalation: false,
         capabilities: {

package/src/lib/controller/index.ts

@@ -50,6 +50,7 @@ export class Controller {
     const { beforeHook, afterHook, onReady } = hooks;
     this.#config = config;
     this.#capabilities = capabilities;
+    Log.info({ config }, "Controller configuration");
 
     // Initialize the Pepr store for each capability
     new StoreController(capabilities, `pepr-${config.uuid}-store`, () => {