pepr 0.13.2 → 0.13.4

package/package.json

@@ -9,7 +9,7 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "version": "0.13.2",
+  "version": "0.13.4",
   "main": "dist/lib.js",
   "types": "dist/lib.d.ts",
   "scripts": {
@@ -27,28 +27,28 @@
     "format:fix": "eslint src --fix && prettier src --write"
   },
   "dependencies": {
-    "@kubernetes/client-node": "0.18.1",
+    "@kubernetes/client-node": "0.19.0",
     "express": "4.18.2",
     "fast-json-patch": "3.1.1",
     "http-status-codes": "2.2.0",
     "node-fetch": "2.7.0",
-    "pino": "8.15.0",
+    "pino": "8.15.1",
     "pino-pretty": "10.2.0",
     "prom-client": "14.2.0",
     "ramda": "0.29.0"
   },
   "devDependencies": {
-    "@jest/globals": "29.6.4",
+    "@jest/globals": "29.7.0",
     "@types/eslint": "8.44.2",
     "@types/express": "4.17.17",
     "@types/node": "18.x.x",
     "@types/node-fetch": "2.6.4",
-    "@types/node-forge": "1.3.4",
+    "@types/node-forge": "1.3.5",
     "@types/prettier": "3.0.0",
     "@types/prompts": "2.4.4",
-    "@types/ramda": "0.29.3",
-    "@types/uuid": "9.0.3",
-    "jest": "29.6.4",
+    "@types/ramda": "0.29.4",
+    "@types/uuid": "9.0.4",
+    "jest": "29.7.0",
     "nock": "13.3.3",
     "ts-jest": "29.1.1"
   },

package/src/lib/filter.ts

@@ -12,13 +12,14 @@ import { Binding, Event } from "./types";
  * @param req the incoming request
  * @returns
  */
-export function shouldSkipRequest(binding: Binding, req: Request) {
+export function shouldSkipRequest(binding: Binding, req: Request, capabilityNamespaces: string[]) {
   const { group, kind, version } = binding.kind || {};
   const { namespaces, labels, annotations, name } = binding.filters || {};
   const operation = req.operation.toUpperCase();
   // Use the old object if the request is a DELETE operation
   const srcObject = operation === Operation.DELETE ? req.oldObject : req.object;
   const { metadata } = srcObject || {};
+  const combinedNamespaces = [...namespaces, ...capabilityNamespaces];
 
   // Test for matching operation
   if (!binding.event.includes(operation) && !binding.event.includes(Event.Any)) {
@@ -46,7 +47,7 @@ export function shouldSkipRequest(binding: Binding, req: Request) {
   }
 
   // Test for matching namespaces
-  if (namespaces.length && !namespaces.includes(req.namespace || "")) {
+  if (combinedNamespaces.length && !combinedNamespaces.includes(req.namespace || "")) {
     logger.debug("Namespace does not match");
     return true;
   }

package/src/lib/mutate-processor.ts

@@ -40,7 +40,7 @@ export async function mutateProcessor(
 
   Log.info(reqMetadata, `Processing request`);
 
-  for (const { name, bindings } of capabilities) {
+  for (const { name, bindings, namespaces } of capabilities) {
     const actionMetadata = { ...reqMetadata, name };
 
     for (const action of bindings) {
@@ -50,7 +50,7 @@ export async function mutateProcessor(
       }
 
       // Continue to the next action without doing anything if this one should be skipped
-      if (shouldSkipRequest(action, req)) {
+      if (shouldSkipRequest(action, req, namespaces)) {
         continue;
       }
 

package/src/lib/validate-processor.ts

@@ -28,7 +28,7 @@ export async function validateProcessor(
 
   Log.info(reqMetadata, `Processing validation request`);
 
-  for (const { name, bindings } of capabilities) {
+  for (const { name, bindings, namespaces } of capabilities) {
     const actionMetadata = { ...reqMetadata, name };
 
     for (const action of bindings) {
@@ -38,7 +38,7 @@ export async function validateProcessor(
       }
 
       // Continue to the next action without doing anything if this one should be skipped
-      if (shouldSkipRequest(action, req)) {
+      if (shouldSkipRequest(action, req, namespaces)) {
         continue;
       }
 

package/src/runtime/controller.ts

@@ -9,7 +9,7 @@ import fs from "fs";
 import { gunzipSync } from "zlib";
 
 import Log from "../lib/logger";
-import { packageJSON } from "../cli/init/templates/data.json";
+import { packageJSON } from "../templates/data.json";
 
 const { version } = packageJSON;
 

package/src/templates/.eslintrc.template.json

@@ -0,0 +1,18 @@
+{
+  "env": {
+    "browser": false,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": ["./tsconfig.json"],
+    "ecmaVersion": 2022
+  },
+  "plugins": ["@typescript-eslint"],
+  "ignorePatterns": ["node_modules", "dist"],
+  "root": true,
+  "rules": {
+    "@typescript-eslint/no-floating-promises": ["error"]
+  }
+}

package/src/templates/.prettierrc.json

@@ -0,0 +1,13 @@
+{
+  "arrowParens": "avoid",
+  "bracketSameLine": false,
+  "bracketSpacing": true,
+  "embeddedLanguageFormatting": "auto",
+  "insertPragma": false,
+  "printWidth": 80,
+  "quoteProps": "as-needed",
+  "requirePragma": false,
+  "semi": true,
+  "tabWidth": 2,
+  "useTabs": false
+}

package/src/templates/README.md

@@ -0,0 +1,21 @@
+# Pepr Module
+
+This is a Pepr Module. [Pepr](https://github.com/defenseunicorns/pepr) is a type-safe Kubernetes middleware system.
+
+The `capabilities` directory contains all the capabilities for this module. By default,
+a capability is a single typescript file in the format of `capability-name.ts` that is
+imported in the root `pepr.ts` file as `import { HelloPepr } from "./capabilities/hello-pepr";`.
+Because this is typescript, you can organize this however you choose, e.g. creating a sub-folder
+per-capability or common logic in shared files or folders.
+
+Example Structure:
+
+```
+Module Root
+├── package.json
+├── pepr.ts
+└── capabilities
+    ├── example-one.ts
+    ├── example-three.ts
+    └── example-two.ts
+```

package/src/templates/capabilities/hello-pepr.samples.json

@@ -0,0 +1,160 @@
+[
+  {
+    "apiVersion": "v1",
+    "kind": "Namespace",
+    "metadata": {
+      "name": "pepr-demo",
+      "labels": {
+        "keep-me": "please",
+        "remove-me": "please"
+      }
+    }
+  },
+  {
+    "apiVersion": "v1",
+    "kind": "Namespace",
+    "metadata": {
+      "name": "pepr-demo-2"
+    }
+  },
+  {
+    "apiVersion": "v1",
+    "kind": "Secret",
+    "metadata": {
+      "name": "secret-1",
+      "namespace": "pepr-demo"
+    },
+    "data": {
+      "example": "dW5pY29ybiBtYWdpYw==",
+      "binary-data": "iCZQUg8xYucNUqD+8lyl2YcKjYYygvTtiDSEV9b9WKUkxSSLFJTgIWMJ9GcFFYs4T9JCdda51u74jfq8yHzRuEASl60EdTS/NfWgIIFTGqcNRfqMw+vgpyTMmCyJVaJEDFq6AA==",
+      "ascii-with-white-space": "VGhpcyBpcyBzb21lIHJhbmRvbSB0ZXh0OgoKICAgIC0gd2l0aCBsaW5lIGJyZWFrcwogICAgLSBhbmQgdGFicw=="
+    }
+  },
+  {
+    "apiVersion": "v1",
+    "kind": "ConfigMap",
+    "metadata": {
+      "name": "example-1",
+      "namespace": "pepr-demo"
+    },
+    "data": {
+      "key": "ex-1-val"
+    }
+  },
+  {
+    "apiVersion": "v1",
+    "kind": "ConfigMap",
+    "metadata": {
+      "name": "example-2",
+      "namespace": "pepr-demo"
+    },
+    "data": {
+      "key": "ex-2-val"
+    }
+  },
+  {
+    "apiVersion": "v1",
+    "kind": "ConfigMap",
+    "metadata": {
+      "name": "example-evil-cm",
+      "namespace": "pepr-demo",
+      "annotations": {
+        "evil": "true"
+      }
+    },
+    "data": {
+      "key": "ex-evil-cm-val"
+    }
+  },
+  {
+    "apiVersion": "v1",
+    "kind": "ConfigMap",
+    "metadata": {
+      "name": "example-3",
+      "namespace": "pepr-demo",
+      "labels": {
+        "change": "by-label"
+      }
+    },
+    "data": {
+      "key": "ex-3-val"
+    }
+  },
+  {
+    "apiVersion": "v1",
+    "kind": "ConfigMap",
+    "metadata": {
+      "name": "example-4",
+      "namespace": "pepr-demo"
+    },
+    "data": {
+      "key": "ex-4-val"
+    }
+  },
+  {
+    "apiVersion": "v1",
+    "kind": "ConfigMap",
+    "metadata": {
+      "name": "example-4a",
+      "namespace": "pepr-demo-2"
+    },
+    "data": {
+      "key": "ex-4-val"
+    }
+  },
+  {
+    "apiVersion": "v1",
+    "kind": "ConfigMap",
+    "metadata": {
+      "name": "example-5",
+      "namespace": "pepr-demo",
+      "labels": {
+        "chuck-norris": "test"
+      }
+    },
+    "data": {
+      "key": "ex-5-val"
+    }
+  },
+  {
+    "apiVersion": "apiextensions.k8s.io/v1",
+    "kind": "CustomResourceDefinition",
+    "metadata": {
+      "name": "unicorns.pepr.dev"
+    },
+    "spec": {
+      "group": "pepr.dev",
+      "versions": [
+        {
+          "name": "v1",
+          "served": true,
+          "storage": true,
+          "schema": {
+            "openAPIV3Schema": {
+              "type": "object",
+              "properties": {
+                "spec": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "counter": {
+                      "type": "number"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      ],
+      "scope": "Namespaced",
+      "names": {
+        "plural": "unicorns",
+        "singular": "unicorn",
+        "kind": "Unicorn"
+      }
+    }
+  }
+]