pepr 0.3.1 → 0.4.0

package/dist/src/lib/processor.js

@@ -1,85 +0,0 @@
-"use strict";
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.processor = void 0;
-const fast_json_patch_1 = require("fast-json-patch");
-const filter_1 = require("./filter");
-const logger_1 = __importDefault(require("./logger"));
-const request_1 = require("./request");
-async function processor(config, capabilities, req) {
-    const wrapped = new request_1.PeprRequest(req);
-    const response = {
-        uid: req.uid,
-        warnings: [],
-        allowed: false,
-    };
-    logger_1.default.info(`Processing '${req.uid}' for '${req.kind.kind}' '${req.name}'`);
-    for (const { name, bindings } of capabilities) {
-        const prefix = `${req.uid} ${req.name}: ${name}`;
-        logger_1.default.info(`Processing capability ${name}`, prefix);
-        for (const action of bindings) {
-            // Continue to the next action without doing anything if this one should be skipped
-            if ((0, filter_1.shouldSkipRequest)(action, req)) {
-                continue;
-            }
-            logger_1.default.info(`Processing matched action ${action.kind.kind}`, prefix);
-            // Add annotations to the request to indicate that the capability started processing
-            // this will allow tracking of failed mutations that were permitted to continue
-            const updateStatus = (status) => {
-                // Only update the status if the request is a CREATE or UPDATE (we don't use CONNECT)
-                if (req.operation == "DELETE") {
-                    return;
-                }
-                const identifier = `${config.uuid}.pepr.dev/${name}`;
-                wrapped.Raw.metadata = wrapped.Raw.metadata || {};
-                wrapped.Raw.metadata.annotations = wrapped.Raw.metadata.annotations || {};
-                wrapped.Raw.metadata.annotations[identifier] = status;
-            };
-            updateStatus("started");
-            try {
-                // Run the action
-                await action.callback(wrapped);
-                logger_1.default.info(`Action succeeded`, prefix);
-                // Add annotations to the request to indicate that the capability succeeded
-                updateStatus("succeeded");
-            }
-            catch (e) {
-                // Annoying ts false positive
-                response.warnings = response.warnings || [];
-                response.warnings.push(`Action failed: ${e}`);
-                // If errors are not allowed, note the failure in the Response
-                if (config.onError) {
-                    logger_1.default.error(`Action failed: ${e}`, prefix);
-                    response.result = "Pepr module configured to reject on error";
-                    return response;
-                }
-                else {
-                    logger_1.default.warn(`Action failed: ${e}`, prefix);
-                    updateStatus("warning");
-                }
-            }
-        }
-    }
-    // If we've made it this far, the request is allowed
-    response.allowed = true;
-    // Compare the original request to the modified request to get the patches
-    const patches = (0, fast_json_patch_1.compare)(req.object, wrapped.Raw);
-    // Only add the patch if there are patches to apply
-    if (patches.length > 0) {
-        response.patchType = "JSONPatch";
-        // Webhook must be base64-encoded
-        // https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#response
-        response.patch = Buffer.from(JSON.stringify(patches)).toString("base64");
-    }
-    // Remove the warnings array if it's empty
-    if (response.warnings && response.warnings.length < 1) {
-        delete response.warnings;
-    }
-    logger_1.default.debug(patches);
-    return response;
-}
-exports.processor = processor;

package/dist/src/lib/request.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../src/lib/request.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;GAGG;AACH,qBAAa,WAAW,CAAC,CAAC,SAAS,gBAAgB;IACjD,OAAO,CAAC,MAAM,CAAa;IAEpB,GAAG,EAAE,CAAC,CAAC;IAEd,IAAI,iBAAiB,YAEpB;IAED;;;OAGG;IACH,IAAI,QAAQ,wBAEX;IAED;;;OAGG;IACH,IAAI,WAAW,kBAEd;IAED;;;OAGG;IACH,IAAI,OAAO,eAEV;IAED;;;OAGG;gBACS,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IAO7B;;;;OAIG;IACH,KAAK,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC;IAIzB;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAUnC;;;;;OAKG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAUxC;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM;IAOvB;;;;OAIG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM;IAO5B;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM;IAIpB;;;;;OAKG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM;CAG1B"}

package/dist/src/lib/request.js

@@ -1,124 +0,0 @@
-"use strict";
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PeprRequest = void 0;
-const ramda_1 = __importDefault(require("ramda"));
-/**
- * The RequestWrapper class provides methods to modify Kubernetes objects in the context
- * of a mutating webhook request.
- */
-class PeprRequest {
-    get PermitSideEffects() {
-        return !this._input.dryRun;
-    }
-    /**
-     * Indicates whether the request is a dry run.
-     * @returns true if the request is a dry run, false otherwise.
-     */
-    get IsDryRun() {
-        return this._input.dryRun;
-    }
-    /**
-     * Provides access to the old resource in the request if available.
-     * @returns The old Kubernetes resource object or null if not available.
-     */
-    get OldResource() {
-        return this._input.oldObject;
-    }
-    /**
-     * Provides access to the request object.
-     * @returns The request object containing the Kubernetes resource.
-     */
-    get Request() {
-        return this._input;
-    }
-    /**
-     * Creates a new instance of the Action class.
-     * @param input - The request object containing the Kubernetes resource to modify.
-     */
-    constructor(input) {
-        // Deep clone the object to prevent mutation of the original object
-        this.Raw = ramda_1.default.clone(input.object);
-        // Store the input
-        this._input = input;
-    }
-    /**
-     * Deep merges the provided object with the current resource.
-     *
-     * @param obj - The object to merge with the current resource.
-     */
-    Merge(obj) {
-        this.Raw = ramda_1.default.mergeDeepRight(this.Raw, obj);
-    }
-    /**
-     * Updates a label on the Kubernetes resource.
-     * @param key - The key of the label to update.
-     * @param value - The value of the label.
-     * @returns The current Action instance for method chaining.
-     */
-    SetLabel(key, value) {
-        const ref = this.Raw;
-        ref.metadata = ref.metadata ?? {};
-        ref.metadata.labels = ref.metadata.labels ?? {};
-        ref.metadata.labels[key] = value;
-        return this;
-    }
-    /**
-     * Updates an annotation on the Kubernetes resource.
-     * @param key - The key of the annotation to update.
-     * @param value - The value of the annotation.
-     * @returns The current Action instance for method chaining.
-     */
-    SetAnnotation(key, value) {
-        const ref = this.Raw;
-        ref.metadata = ref.metadata ?? {};
-        ref.metadata.annotations = ref.metadata.annotations ?? {};
-        ref.metadata.annotations[key] = value;
-        return this;
-    }
-    /**
-     * Removes a label from the Kubernetes resource.
-     * @param key - The key of the label to remove.
-     * @returns The current Action instance for method chaining.
-     */
-    RemoveLabel(key) {
-        if (this.Raw.metadata?.labels?.[key]) {
-            delete this.Raw.metadata.labels[key];
-        }
-        return this;
-    }
-    /**
-     * Removes an annotation from the Kubernetes resource.
-     * @param key - The key of the annotation to remove.
-     * @returns The current Action instance for method chaining.
-     */
-    RemoveAnnotation(key) {
-        if (this.Raw.metadata?.annotations?.[key]) {
-            delete this.Raw.metadata.annotations[key];
-        }
-        return this;
-    }
-    /**
-     * Check if a label exists on the Kubernetes resource.
-     *
-     * @param key the label key to check
-     * @returns
-     */
-    HasLabel(key) {
-        return this.Raw?.metadata?.labels?.[key] !== undefined;
-    }
-    /**
-     * Check if an annotation exists on the Kubernetes resource.
-     *
-     * @param key the annotation key to check
-     * @returns
-     */
-    HasAnnotation(key) {
-        return this.Raw?.metadata?.annotations?.[key] !== undefined;
-    }
-}
-exports.PeprRequest = PeprRequest;

package/dist/src/lib/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC;;GAEG;AACH,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;;;GAIG;AACH,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;KAC1B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAChE,CAAC;AAEF;;GAEG;AAEH,oBAAY,KAAK;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,cAAc,mBAAmB;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,SAAS,CAAC;CAC9B;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,sBAAsB,GAAG,eAAe,GAAG,MAAM,CAAC;IAClE;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,YAAY,GAAG;IACzB,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yFAAyF;IACzF,IAAI,EAAE,MAAM,CAAC;IACb,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,OAAO,EAAE,aAAa,GAAG,MAAM,CAAC;IAChC,wEAAwE;IACxE,YAAY,EAAE,aAAa,CAAC;IAC5B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG,QAAQ,WAAW,GAAG,CAAC;AAElD,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,YAAY,IAAI;IACjD,oGAAoG;IACpG,kBAAkB,EAAE,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC;IACxC,yFAAyF;IACzF,SAAS,EAAE,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC;IAC/B,yFAAyF;IACzF,SAAS,EAAE,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC;IAC/B,yFAAyF;IACzF,SAAS,EAAE,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACrC,CAAC;IACF,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,YAAY,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;CAC/E,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,YAAY,IAAI,iBAAiB,CAAC,CAAC,CAAC,GAAG;IACzE;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC;IAC7D;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC;CACnE,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,YAAY,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG;IACvE,wFAAwF;IACxF,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,YAAY,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG;IACpE,6FAA6F;IAC7F,WAAW,EAAE,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC;CAC5D,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,YAAY,IAAI;IACjD;;;;OAIG;IACH,IAAI,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC;CACzE,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,YAAY,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG;IACxE;;;;;;;;;;;;;;OAcG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC;CACjE,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CACnG,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,KAChB,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC"}

package/dist/src/lib/types.js

@@ -1,34 +0,0 @@
-"use strict";
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Event = exports.HookPhase = exports.ErrorBehavior = void 0;
-/**
- * The behavior of this module when an error occurs.
- */
-var ErrorBehavior;
-(function (ErrorBehavior) {
-    ErrorBehavior["ignore"] = "ignore";
-    ErrorBehavior["audit"] = "audit";
-    ErrorBehavior["reject"] = "reject";
-})(ErrorBehavior = exports.ErrorBehavior || (exports.ErrorBehavior = {}));
-/**
- * The phase of the Kubernetes admission webhook that the capability is registered for.
- *
- * Currently only `mutate` is supported.
- */
-var HookPhase;
-(function (HookPhase) {
-    HookPhase["mutate"] = "mutate";
-    HookPhase["validate"] = "validate";
-})(HookPhase = exports.HookPhase || (exports.HookPhase = {}));
-/**
- * The type of Kubernetes mutating webhook event that the capability action is registered for.
- */
-var Event;
-(function (Event) {
-    Event["Create"] = "CREATE";
-    Event["Update"] = "UPDATE";
-    Event["Delete"] = "DELETE";
-    Event["CreateOrUpdate"] = "CREATEORUPDATE";
-})(Event = exports.Event || (exports.Event = {}));