arvo-event-handler 1.0.3 → 1.0.4

package/CHANGELOG.md

@@ -15,7 +15,7 @@
 ## [1.0.0] - 2024-09-10
 
 - First version rrelease
+
 ## [1.0.2] - 2024-09-10
 
 - Added ArvoEventRouter as a mechanism to group ArvoEventHandlers
-

package/README.md

@@ -55,7 +55,6 @@ There 2 main types of event handlers in Arvo event driven system
 - [ArvoEventRouter](src/ArvoEventRouter/README.md) is designed to route ArvoEvents to appropriate ArvoEventHandlers. It provides a centralized mechanism for managing and executing multiple event handlers based on event types.
 - [MultiArvoEventHandler](src/MultiArvoEventHandler/README.md) is a flexible and powerful event handling class designed to process multiple event types across different ArvoContracts. This handler offers greater versatility compared to the more specialized `ArvoEventHandler`, as it's not bound to a specific contract or event type.
 
-
 ## Getting Started
 
 To start using Arvo Event Handlers in your project:
@@ -75,7 +74,7 @@ import {
   createArvoEventHandler,
   createMultiArvoEventHandler,
   createArvoEventRouter,
-} from 'arvo-event-handler'
+} from 'arvo-event-handler';
 ```
 
 - Begin defining your events, contracts, and handlers using the provided classes.

package/dist/ArvoEventHandler/index.js

@@ -1,15 +1,4 @@
 "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 __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) {
@@ -46,17 +35,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-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 });
 var arvo_core_1 = require("arvo-core");
 var schema_1 = require("arvo-core/dist/ArvoEvent/schema");
@@ -182,7 +160,6 @@ var ArvoEventHandler = /** @class */ (function () {
                         eventFactory = (0, arvo_core_1.createArvoEventFactory)(this.contract);
                         return [4 /*yield*/, api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () { return __awaiter(_this, void 0, void 0, function () {
                                 var otelSpanHeaders, inputEventValidation, _handleOutput, outputs, error_1, result;
-                                var _this = this;
                                 return __generator(this, function (_a) {
                                     switch (_a.label) {
                                         case 0:
@@ -214,19 +191,12 @@ var ArvoEventHandler = /** @class */ (function () {
                                             else {
                                                 outputs = [_handleOutput];
                                             }
-                                            return [2 /*return*/, outputs.map(function (output, index) {
-                                                    var __extensions = output.__extensions, handlerResult = __rest(output, ["__extensions"]);
-                                                    var result = eventFactory.emits(__assign(__assign({}, handlerResult), { traceparent: otelSpanHeaders.traceparent || undefined, tracestate: otelSpanHeaders.tracestate || undefined, source: _this.source, subject: event.subject, 
-                                                        // The user should be able to override the `to` field
-                                                        // If that is not present then the 'redirectto' field
-                                                        // is referred to. Then, after all else, 'source' field
-                                                        // is used as a form of reply.
-                                                        to: (0, utils_1.coalesceOrDefault)([handlerResult.to, event.redirectto], event.source), executionunits: (0, utils_1.coalesce)(handlerResult.executionunits, _this.executionunits) }), __extensions);
-                                                    Object.entries(result.otelAttributes).forEach(function (_a) {
-                                                        var key = _a[0], value = _a[1];
-                                                        return span.setAttribute("to_emit.".concat(index, ".").concat(key), value);
-                                                    });
-                                                    return result;
+                                            return [2 /*return*/, (0, utils_1.eventHandlerOutputEventCreator)(outputs, otelSpanHeaders, this.source, event, this.executionunits, function () {
+                                                    var args = [];
+                                                    for (var _i = 0; _i < arguments.length; _i++) {
+                                                        args[_i] = arguments[_i];
+                                                    }
+                                                    return eventFactory.emits.apply(eventFactory, args);
                                                 })];
                                         case 3:
                                             error_1 = _a.sent();

package/dist/ArvoEventRouter/index.js

@@ -40,9 +40,9 @@ exports.ArvoEventRouter = void 0;
 var arvo_core_1 = require("arvo-core");
 var utils_1 = require("../utils");
 var api_1 = require("@opentelemetry/api");
-var OpenTelemetry_1 = require("../OpenTelemetry");
 var utils_2 = require("./utils");
 var schema_1 = require("arvo-core/dist/ArvoEvent/schema");
+var utils_3 = require("../OpenTelemetry/utils");
 /**
  * ArvoEventRouter class handles routing of ArvoEvents to appropriate event handlers.
  */
@@ -130,28 +130,17 @@ var ArvoEventRouter = /** @class */ (function () {
      */
     ArvoEventRouter.prototype.execute = function (event) {
         return __awaiter(this, void 0, void 0, function () {
-            var spanName, spanOptions, span, inheritedContext;
-            var _a;
+            var span;
             var _this = this;
-            var _b;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        spanName = "ArvoEventRouter.source<".concat((_b = this.source) !== null && _b !== void 0 ? _b : 'arvo.event.router', ">.execute<").concat(event.type, ">");
-                        spanOptions = {
+                        span = (0, utils_3.createSpanFromEvent)("ArvoEventRouter.source<".concat((_a = this.source) !== null && _a !== void 0 ? _a : 'arvo.event.router', ">.execute<").concat(event.type, ">"), event, {
                             kind: this.openTelemetrySpanKind,
-                            attributes: (_a = {},
-                                _a[arvo_core_1.OpenInference.ATTR_SPAN_KIND] = this.openInferenceSpanKind,
-                                _a[arvo_core_1.ArvoExecution.ATTR_SPAN_KIND] = this.arvoExecutionSpanKind,
-                                _a),
-                        };
-                        if (event.traceparent) {
-                            inheritedContext = (0, OpenTelemetry_1.extractContext)(event.traceparent, event.tracestate);
-                            span = OpenTelemetry_1.ArvoEventHandlerTracer.startSpan(spanName, spanOptions, inheritedContext);
-                        }
-                        else {
-                            span = OpenTelemetry_1.ArvoEventHandlerTracer.startSpan(spanName, spanOptions);
-                        }
+                            openInference: this.openInferenceSpanKind,
+                            arvoExecution: this.arvoExecutionSpanKind,
+                        });
                         return [4 /*yield*/, api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () { return __awaiter(_this, void 0, void 0, function () {
                                 var otelSpanHeaders, newEvent, results, error_1, result;
                                 var _this = this;
@@ -232,7 +221,7 @@ var ArvoEventRouter = /** @class */ (function () {
                                     }
                                 });
                             }); })];
-                    case 1: return [2 /*return*/, _c.sent()];
+                    case 1: return [2 /*return*/, _b.sent()];
                 }
             });
         });

package/dist/MultiArvoEventHandler/index.js

@@ -1,15 +1,4 @@
 "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 __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) {
@@ -46,23 +35,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-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 });
 var api_1 = require("@opentelemetry/api");
 var arvo_core_1 = require("arvo-core");
 var schema_1 = require("arvo-core/dist/ArvoEvent/schema");
-var OpenTelemetry_1 = require("../OpenTelemetry");
 var utils_1 = require("../utils");
+var utils_2 = require("../OpenTelemetry/utils");
 /**
  * Represents a Multi ArvoEvent handler that can process multiple event types.
  *
@@ -155,30 +133,18 @@ var MultiArvoEventHandler = /** @class */ (function () {
      */
     MultiArvoEventHandler.prototype.execute = function (event) {
         return __awaiter(this, void 0, void 0, function () {
-            var spanName, spanOptions, span, inheritedContext;
-            var _a;
+            var span;
             var _this = this;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
-                        spanName = "MutliArvoEventHandler.source<".concat(this.source, ">.execute<").concat(event.type, ">");
-                        spanOptions = {
+                        span = (0, utils_2.createSpanFromEvent)("MutliArvoEventHandler.source<".concat(this.source, ">.execute<").concat(event.type, ">"), event, {
                             kind: this.openTelemetrySpanKind,
-                            attributes: (_a = {},
-                                _a[arvo_core_1.OpenInference.ATTR_SPAN_KIND] = this.openInferenceSpanKind,
-                                _a[arvo_core_1.ArvoExecution.ATTR_SPAN_KIND] = this.arvoExecutionSpanKind,
-                                _a),
-                        };
-                        if (event.traceparent) {
-                            inheritedContext = (0, OpenTelemetry_1.extractContext)(event.traceparent, event.tracestate);
-                            span = OpenTelemetry_1.ArvoEventHandlerTracer.startSpan(spanName, spanOptions, inheritedContext);
-                        }
-                        else {
-                            span = OpenTelemetry_1.ArvoEventHandlerTracer.startSpan(spanName, spanOptions);
-                        }
+                            openInference: this.openInferenceSpanKind,
+                            arvoExecution: this.arvoExecutionSpanKind,
+                        });
                         return [4 /*yield*/, api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () { return __awaiter(_this, void 0, void 0, function () {
                                 var otelSpanHeaders, _handlerOutput, outputs, error_1, result;
-                                var _this = this;
                                 var _a, _b, _c;
                                 return __generator(this, function (_d) {
                                     switch (_d.label) {
@@ -210,19 +176,12 @@ var MultiArvoEventHandler = /** @class */ (function () {
                                             else {
                                                 outputs = [_handlerOutput];
                                             }
-                                            return [2 /*return*/, outputs.map(function (output, index) {
-                                                    var __extensions = output.__extensions, handlerResult = __rest(output, ["__extensions"]);
-                                                    var result = (0, arvo_core_1.createArvoEvent)(__assign(__assign({}, handlerResult), { traceparent: otelSpanHeaders.traceparent || undefined, tracestate: otelSpanHeaders.tracestate || undefined, source: _this.source, subject: event.subject, 
-                                                        // The user should be able to override the `to` field
-                                                        // If that is not present then the 'redirectto' field
-                                                        // is referred to. Then, after all else, 'source' field
-                                                        // is used as a form of reply.
-                                                        to: (0, utils_1.coalesceOrDefault)([handlerResult.to, event.redirectto], event.source), executionunits: (0, utils_1.coalesce)(handlerResult.executionunits, _this.executionunits) }), __extensions);
-                                                    Object.entries(result.otelAttributes).forEach(function (_a) {
-                                                        var key = _a[0], value = _a[1];
-                                                        return span.setAttribute("to_emit.".concat(index, ".").concat(key), value);
-                                                    });
-                                                    return result;
+                                            return [2 /*return*/, (0, utils_1.eventHandlerOutputEventCreator)(outputs, otelSpanHeaders, this.source, event, this.executionunits, function () {
+                                                    var args = [];
+                                                    for (var _i = 0; _i < arguments.length; _i++) {
+                                                        args[_i] = arguments[_i];
+                                                    }
+                                                    return arvo_core_1.createArvoEvent.apply(void 0, args);
                                                 })];
                                         case 3:
                                             error_1 = _d.sent();
@@ -235,8 +194,6 @@ var MultiArvoEventHandler = /** @class */ (function () {
                                                 type: "sys.".concat(this.source, ".error"),
                                                 source: this.source,
                                                 subject: event.subject,
-                                                // The system error must always got back to
-                                                // the source
                                                 to: event.source,
                                                 executionunits: this.executionunits,
                                                 traceparent: (_a = otelSpanHeaders.traceparent) !== null && _a !== void 0 ? _a : undefined,
@@ -259,7 +216,7 @@ var MultiArvoEventHandler = /** @class */ (function () {
                                     }
                                 });
                             }); })];
-                    case 1: return [2 /*return*/, _b.sent()];
+                    case 1: return [2 /*return*/, _a.sent()];
                 }
             });
         });

package/dist/OpenTelemetry/utils.d.ts

@@ -1,4 +1,11 @@
+import { Span, SpanKind } from '@opentelemetry/api';
+import { ArvoEvent, ArvoExecutionSpanKind, OpenInferenceSpanKind } from 'arvo-core';
 export declare function getPackageInfo(): {
     name: string;
     version: string;
 };
+export declare const createSpanFromEvent: (spanName: string, event: ArvoEvent, spanKinds: {
+    kind: SpanKind;
+    openInference: OpenInferenceSpanKind;
+    arvoExecution: ArvoExecutionSpanKind;
+}) => Span;

package/dist/OpenTelemetry/utils.js

@@ -23,9 +23,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSpanFromEvent = void 0;
 exports.getPackageInfo = getPackageInfo;
+var arvo_core_1 = require("arvo-core");
 var fs = __importStar(require("fs"));
 var path = __importStar(require("path"));
+var _1 = require(".");
 function getPackageInfo() {
     try {
         // Read the package.json file
@@ -42,3 +45,23 @@ function getPackageInfo() {
         return { name: 'Unknown', version: 'Unknown' };
     }
 }
+var createSpanFromEvent = function (spanName, event, spanKinds) {
+    var _a;
+    var spanOptions = {
+        kind: spanKinds.kind,
+        attributes: (_a = {},
+            _a[arvo_core_1.OpenInference.ATTR_SPAN_KIND] = spanKinds.openInference,
+            _a[arvo_core_1.ArvoExecution.ATTR_SPAN_KIND] = spanKinds.arvoExecution,
+            _a),
+    };
+    var span;
+    if (event.traceparent) {
+        var inheritedContext = (0, _1.extractContext)(event.traceparent, event.tracestate);
+        span = _1.ArvoEventHandlerTracer.startSpan(spanName, spanOptions, inheritedContext);
+    }
+    else {
+        span = _1.ArvoEventHandlerTracer.startSpan(spanName, spanOptions);
+    }
+    return span;
+};
+exports.createSpanFromEvent = createSpanFromEvent;

package/dist/utils.d.ts

@@ -1,3 +1,6 @@
+import { ArvoEvent, CreateArvoEvent, OpenTelemetryHeaders } from "arvo-core";
+import { ArvoEventHandlerFunctionOutput } from "./ArvoEventHandler/types";
+import { MultiArvoEventHandlerFunctionOutput } from "./MultiArvoEventHandler/types";
 /**
  * Checks if the item is null or undefined.
  *
@@ -41,3 +44,17 @@ export declare function coalesce<T>(...values: (T | null | undefined)[]): T | un
  * console.log(result); // Output: 'default'
  */
 export declare function coalesceOrDefault<T>(values: (T | null | undefined)[], _default: NonNullable<T>): NonNullable<T>;
+/**
+ * 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 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.
+ */
+export declare const eventHandlerOutputEventCreator: (events: Array<ArvoEventHandlerFunctionOutput<any> | MultiArvoEventHandlerFunctionOutput>, otelSpanHeaders: OpenTelemetryHeaders, source: string, originalEvent: ArvoEvent, handlerExectionUnits: number, factory: (param: CreateArvoEvent<any, any> & {
+    to: string;
+}, extensions?: Record<string, string | number | boolean>) => ArvoEvent<any, any, any>) => ArvoEvent<any, any, any>[];

package/dist/utils.js

@@ -1,9 +1,33 @@
 "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.eventHandlerOutputEventCreator = void 0;
 exports.isNullOrUndefined = isNullOrUndefined;
 exports.getValueOrDefault = getValueOrDefault;
 exports.coalesce = coalesce;
 exports.coalesceOrDefault = coalesceOrDefault;
+var api_1 = require("@opentelemetry/api");
 /**
  * Checks if the item is null or undefined.
  *
@@ -65,3 +89,30 @@ function coalesce() {
 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 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 __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) }), __extensions);
+        Object.entries(result.otelAttributes).forEach(function (_a) {
+            var _b;
+            var key = _a[0], value = _a[1];
+            return (_b = api_1.trace.getActiveSpan()) === null || _b === void 0 ? void 0 : _b.setAttribute("to_emit.".concat(index, ".").concat(key), value);
+        });
+        return result;
+    });
+};
+exports.eventHandlerOutputEventCreator = eventHandlerOutputEventCreator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arvo-event-handler",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "This package contains class and function for event handlers in an Arvo Event Driven system",
   "main": "dist/index.js",
   "scripts": {