arvo-event-handler 2.3.3 → 3.0.2

package/dist/MultiArvoEventHandler/index.js

@@ -1,205 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var api_1 = require("@opentelemetry/api");
-var arvo_core_1 = require("arvo-core");
-var AbstractArvoEventHandler_1 = __importDefault(require("../AbstractArvoEventHandler"));
-var errors_1 = require("../errors");
-var utils_1 = require("../utils");
-/**
- * MultiArvoEventHandler processes multiple event types without being bound to specific contracts.
- * Manages event execution, telemetry tracking, and error handling for diverse event streams.
- *
- * @example
- * const handler = createMultiArvoEventHandler({
- *   source: "order.handler",
- *   executionunits: 1,
- *   handler: async ({ event }) => {
- *     // Handle multiple event types
- *   }
- * });
- */
-var MultiArvoEventHandler = /** @class */ (function (_super) {
-    __extends(MultiArvoEventHandler, _super);
-    /**
-     * Creates handler instance with specified configuration.
-     * @param param Handler configuration including source and execution parameters
-     * @throws When source contains invalid characters
-     */
-    function MultiArvoEventHandler(param) {
-        var _a;
-        var _b, _c;
-        var _this = _super.call(this) || this;
-        _this.executionunits = param.executionunits;
-        _this.handler = param.handler;
-        if (!(0, utils_1.isLowerAlphanumeric)(param.source)) {
-            throw new Error("Invalid source identifier '".concat(param.source, "': Must contain only alphanumeric characters (example: order.handler)"));
-        }
-        _this.source = param.source;
-        _this.spanOptions = __assign(__assign({ kind: api_1.SpanKind.CONSUMER }, param.spanOptions), { attributes: __assign(__assign((_a = {}, _a[arvo_core_1.ArvoExecution.ATTR_SPAN_KIND] = arvo_core_1.ArvoExecutionSpanKind.EVENT_HANDLER, _a[arvo_core_1.OpenInference.ATTR_SPAN_KIND] = arvo_core_1.OpenInferenceSpanKind.CHAIN, _a), ((_c = (_b = param.spanOptions) === null || _b === void 0 ? void 0 : _b.attributes) !== null && _c !== void 0 ? _c : {})), { 'arvo.handler.source': _this.source }) });
-        return _this;
-    }
-    /**
-     * Processes an event through configured handler function. Creates telemetry span,
-     * validates event destination, executes handler, and manages errors.
-     *
-     * @param event Event to process
-     * @param opentelemetry Telemetry context configuration
-     * @returns Resulting events or error events
-     *
-     * @throws {ConfigViolation} When event destination does not match handler source
-     * @throws Other Violation error which are thrown by the event handler function
-     */
-    MultiArvoEventHandler.prototype.execute = function (event_1) {
-        return __awaiter(this, arguments, void 0, function (event, opentelemetry) {
-            var otelConfig;
-            var _this = this;
-            if (opentelemetry === void 0) { opentelemetry = {
-                inheritFrom: 'EVENT',
-            }; }
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        otelConfig = (0, utils_1.createEventHandlerTelemetryConfig)('MutliArvoEventHandler', this.spanOptions, opentelemetry, event);
-                        return [4 /*yield*/, arvo_core_1.ArvoOpenTelemetry.getInstance().startActiveSpan(__assign(__assign({}, otelConfig), { fn: function (span) { return __awaiter(_this, void 0, void 0, function () {
-                                    var otelSpanHeaders, _i, _a, _b, key, value, _handlerOutput, outputs, resultingEvents, error_1, events;
-                                    return __generator(this, function (_c) {
-                                        switch (_c.label) {
-                                            case 0:
-                                                otelSpanHeaders = (0, arvo_core_1.currentOpenTelemetryHeaders)();
-                                                _c.label = 1;
-                                            case 1:
-                                                _c.trys.push([1, 3, 4, 5]);
-                                                span.setStatus({ code: api_1.SpanStatusCode.OK });
-                                                for (_i = 0, _a = Object.entries(event.otelAttributes); _i < _a.length; _i++) {
-                                                    _b = _a[_i], key = _b[0], value = _b[1];
-                                                    span.setAttribute("to_process.0.".concat(key), value);
-                                                }
-                                                (0, arvo_core_1.logToSpan)({
-                                                    level: 'INFO',
-                                                    message: "Initiating event resolution - Type: ".concat(event.type, ", Source: ").concat(event.source, ", Destination: ").concat(event.to),
-                                                });
-                                                if (event.to !== this.source) {
-                                                    throw new errors_1.ConfigViolation("Event destination mismatch: Expected '".concat(this.source, "', received '").concat(event.to, "'"));
-                                                }
-                                                return [4 /*yield*/, this.handler({
-                                                        event: event,
-                                                        source: this.source,
-                                                        span: span,
-                                                    })];
-                                            case 2:
-                                                _handlerOutput = _c.sent();
-                                                if (!_handlerOutput)
-                                                    return [2 /*return*/, {
-                                                            events: [],
-                                                        }];
-                                                outputs = [];
-                                                if (Array.isArray(_handlerOutput)) {
-                                                    outputs = _handlerOutput;
-                                                }
-                                                else {
-                                                    outputs = [_handlerOutput];
-                                                }
-                                                resultingEvents = (0, utils_1.eventHandlerOutputEventCreator)(outputs, otelSpanHeaders, this.source, event, this.executionunits, function (param, extensions) { return (0, arvo_core_1.createArvoEvent)(param, extensions); });
-                                                (0, arvo_core_1.logToSpan)({
-                                                    level: 'INFO',
-                                                    message: "Event processing completed successfully - Generated ".concat(resultingEvents.length, " new event(s)"),
-                                                });
-                                                return [2 /*return*/, { events: resultingEvents }];
-                                            case 3:
-                                                error_1 = _c.sent();
-                                                events = (0, utils_1.handleArvoEventHandlerCommonError)(error_1, otelSpanHeaders, "sys.".concat(this.source, ".error"), this.source, event, this.executionunits, function (param, extensions) { return (0, arvo_core_1.createArvoEvent)(param, extensions); });
-                                                return [2 /*return*/, { events: events }];
-                                            case 4:
-                                                span.end();
-                                                return [7 /*endfinally*/];
-                                            case 5: return [2 /*return*/];
-                                        }
-                                    });
-                                }); } }))];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    Object.defineProperty(MultiArvoEventHandler.prototype, "systemErrorSchema", {
-        /**
-         * System error schema configuration.
-         * Error events follow format: sys.<handler-source>.error
-         */
-        get: function () {
-            return {
-                type: "sys.".concat(this.source, ".error"),
-                schema: arvo_core_1.ArvoErrorSchema,
-            };
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return MultiArvoEventHandler;
-}(AbstractArvoEventHandler_1.default));
-exports.default = MultiArvoEventHandler;

package/dist/MultiArvoEventHandler/types.d.ts

@@ -1,64 +0,0 @@
-import type { Span, SpanOptions } from '@opentelemetry/api';
-import type { ArvoEvent, CreateArvoEvent } from 'arvo-core';
-/**
- * Represents the input for a Multi ArvoEvent handler function.
- */
-export type MultiArvoEventHandlerFunctionInput = {
-    /** The ArvoEvent object. */
-    event: ArvoEvent;
-    /** The source field data of the handler */
-    source: string;
-    /** The OpenTelemetry span */
-    span: Span;
-};
-/**
- * Represents the output of a Multi ArvoEvent handler function.
- * @template TContract - The type of ArvoContract that the handler is associated with.
- */
-export type MultiArvoEventHandlerFunctionOutput = Omit<CreateArvoEvent<Record<string, any>, string>, 'subject' | 'source' | 'executionunits' | 'traceparent' | 'tracestate'> & {
-    /**
-     * An optional override for the execution units of this specific event.
-     *
-     * @remarks
-     * Execution units represent the computational cost or resources required to process this event.
-     * If not provided, the default value defined in the handler's constructor will be used.
-     */
-    executionunits?: number;
-    /** Optional extensions for the event. */
-    __extensions?: Record<string, string | number | boolean>;
-};
-/**
- * Defines the structure of a Multi ArvoEvent handler function.
- * @template TContract - The type of ArvoContract that the handler is associated with.
- */
-export type MultiArvoEventHandlerFunction = (param: MultiArvoEventHandlerFunctionInput) => Promise<Array<MultiArvoEventHandlerFunctionOutput> | MultiArvoEventHandlerFunctionOutput | void>;
-/**
- * Interface for an Multi ArvoEvent handler.
- */
-export interface IMultiArvoEventHandler {
-    /**
-     * The source identifier for events produced by this handler
-     *
-     * @remarks
-     * The handler listens to the events with field `event.to` equal
-     * to the this `source` value. If the event does not confirm to
-     * this, a system error event is returned
-     *
-     * For all the events which are emitted by the handler, this is
-     * the source field value of them all.
-     */
-    source: string;
-    /**
-     * The default execution cost of the function.
-     * This can represent a dollar value or some other number with a rate card.
-     */
-    executionunits: number;
-    /**
-     * The functional handler of the event which takes the input, performs an action, and returns the result.
-     * @param params - The input parameters for the handler function.
-     * @returns A promise of object containing the created ArvoEvent and optional extensions.
-     */
-    handler: MultiArvoEventHandlerFunction;
-    /** The OpenTelemetry span options */
-    spanOptions?: SpanOptions;
-}

package/dist/utils.js

@@ -1,191 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createEventHandlerTelemetryConfig = exports.handleArvoEventHandlerCommonError = exports.eventHandlerOutputEventCreator = void 0;
-exports.isNullOrUndefined = isNullOrUndefined;
-exports.getValueOrDefault = getValueOrDefault;
-exports.coalesce = coalesce;
-exports.coalesceOrDefault = coalesceOrDefault;
-exports.isLowerAlphanumeric = isLowerAlphanumeric;
-var api_1 = require("@opentelemetry/api");
-var arvo_core_1 = require("arvo-core");
-/**
- * Checks if the item is null or undefined.
- *
- * @param item - The value to check.
- * @returns True if the item is null or undefined, false otherwise.
- */
-function isNullOrUndefined(item) {
-    return item === null || item === undefined;
-}
-/**
- * Returns the provided value if it's not null or undefined; otherwise, returns the default value.
- *
- * @template T - The type of the value and default value.
- * @param value - The value to check.
- * @param defaultValue - The default value to return if the provided value is null or undefined.
- * @returns The provided value if it's not null or undefined; otherwise, the default value.
- */
-function getValueOrDefault(value, defaultValue) {
-    return isNullOrUndefined(value) ? defaultValue : value;
-}
-/**
- * Returns the first non-null and non-undefined value from the provided arguments.
- * If all arguments are null or undefined, returns undefined.
- *
- * @template T - The type of the values.
- * @param values - The values to coalesce.
- * @returns The first non-null and non-undefined value, or undefined if all are null or undefined.
- */
-function coalesce() {
-    var values = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        values[_i] = arguments[_i];
-    }
-    for (var _a = 0, values_1 = values; _a < values_1.length; _a++) {
-        var value = values_1[_a];
-        if (!isNullOrUndefined(value)) {
-            return value;
-        }
-    }
-    return undefined;
-}
-/**
- * Returns the first non-null and non-undefined value from the provided array of values.
- * If all values in the array are null or undefined, returns the specified default value.
- *
- * @template T - The type of the values and the default value.
- * @param values - An array of values to coalesce.
- * @param _default - The default value to return if all values in the array are null or undefined.
- * @returns The first non-null and non-undefined value from the array, or the default value if all are null or undefined.
- *
- * @example
- * const result = coalesceOrDefault([null, undefined, 'hello', 'world'], 'default');
- * console.log(result); // Output: 'hello'
- *
- * @example
- * const result = coalesceOrDefault([null, undefined], 'default');
- * console.log(result); // Output: 'default'
- */
-function coalesceOrDefault(values, _default) {
-    return getValueOrDefault(coalesce.apply(void 0, values), _default);
-}
-/**
- * Creates ArvoEvents from event handler output.
- *
- * @param events - An array of event handler function outputs.
- * @param otelSpanHeaders - OpenTelemetry headers for tracing.
- * @param source - The source of the event.
- * @param defaultAccessControl - The default access control string for the events
- * @param originalEvent - The original ArvoEvent that triggered the handler.
- * @param handlerExectionUnits - The number of execution units for the handler.
- * @param factory - A function to create ArvoEvents.
- * @returns An array of ArvoEvents created from the handler output.
- */
-var eventHandlerOutputEventCreator = function (events, otelSpanHeaders, source, originalEvent, handlerExectionUnits, factory) {
-    return events.map(function (item, index) {
-        var _a, _b;
-        var __extensions = item.__extensions, handlerResult = __rest(item, ["__extensions"]);
-        var result = factory(__assign(__assign({}, handlerResult), { traceparent: otelSpanHeaders.traceparent || undefined, tracestate: otelSpanHeaders.tracestate || undefined, source: source, subject: originalEvent.subject, 
-            // prioritise returned 'to', 'redirectto' and then
-            // 'source'
-            to: coalesceOrDefault([handlerResult.to, originalEvent.redirectto], originalEvent.source), executionunits: coalesce(handlerResult.executionunits, handlerExectionUnits), accesscontrol: (_b = (_a = handlerResult.accesscontrol) !== null && _a !== void 0 ? _a : originalEvent.accesscontrol) !== null && _b !== void 0 ? _b : undefined, parentid: originalEvent.id }), __extensions);
-        var activeSpan = api_1.trace.getActiveSpan();
-        for (var _i = 0, _c = Object.entries(result.otelAttributes); _i < _c.length; _i++) {
-            var _d = _c[_i], key = _d[0], value = _d[1];
-            activeSpan === null || activeSpan === void 0 ? void 0 : activeSpan.setAttribute("to_emit.".concat(index, ".").concat(key), value);
-        }
-        return result;
-    });
-};
-exports.eventHandlerOutputEventCreator = eventHandlerOutputEventCreator;
-var handleArvoEventHandlerCommonError = function (error, otelSpanHeaders, type, source, originalEvent, handlerExectionUnits, factory) {
-    var _a, _b, _c, _d, _e;
-    (0, arvo_core_1.exceptionToSpan)(error);
-    (_a = api_1.trace.getActiveSpan()) === null || _a === void 0 ? void 0 : _a.setStatus({
-        code: api_1.SpanStatusCode.ERROR,
-        message: error.message,
-    });
-    if (error.name.includes('ViolationError')) {
-        throw error;
-    }
-    var result = factory({
-        type: type,
-        source: source,
-        subject: originalEvent.subject,
-        to: originalEvent.source,
-        executionunits: handlerExectionUnits,
-        traceparent: (_b = otelSpanHeaders.traceparent) !== null && _b !== void 0 ? _b : undefined,
-        tracestate: (_c = otelSpanHeaders.tracestate) !== null && _c !== void 0 ? _c : undefined,
-        data: {
-            errorName: error.name,
-            errorMessage: error.message,
-            errorStack: (_d = error.stack) !== null && _d !== void 0 ? _d : null,
-        },
-        accesscontrol: (_e = originalEvent.accesscontrol) !== null && _e !== void 0 ? _e : undefined,
-        parentid: originalEvent.id,
-    });
-    var activeSpan = api_1.trace.getActiveSpan();
-    for (var _i = 0, _f = Object.entries(result.otelAttributes); _i < _f.length; _i++) {
-        var _g = _f[_i], key = _g[0], value = _g[1];
-        activeSpan === null || activeSpan === void 0 ? void 0 : activeSpan.setAttribute("to_emit.0.".concat(key), value);
-    }
-    return [result];
-};
-exports.handleArvoEventHandlerCommonError = handleArvoEventHandlerCommonError;
-/**
- * Validates if a string contains only uppercase or lowercase alphanumeric characters.
- *
- * This function checks if the input string consists solely of:
- * - Lowercase letters (a-z)
- * - Numbers (0-9)
- * - Dot (.)
- *
- * It does not allow any special characters, spaces, or other non-alphanumeric characters.
- *
- * @param input - The string to be validated.
- * @returns True if the string contains only alphanumeric characters, false otherwise.
- */
-function isLowerAlphanumeric(input) {
-    var alphanumericRegex = /^[a-z0-9.]+$/;
-    return alphanumericRegex.test(input);
-}
-var createEventHandlerTelemetryConfig = function (name, options, contextConfig, event) { return ({
-    name: name,
-    disableSpanManagement: true,
-    spanOptions: options,
-    context: contextConfig.inheritFrom === 'EVENT'
-        ? {
-            inheritFrom: 'TRACE_HEADERS',
-            traceHeaders: {
-                traceparent: event.traceparent,
-                tracestate: event.tracestate,
-            },
-        }
-        : {
-            inheritFrom: 'CONTEXT',
-            context: api_1.context.active(),
-        },
-}); };
-exports.createEventHandlerTelemetryConfig = createEventHandlerTelemetryConfig;