arvo-event-handler 1.1.6 → 1.1.8

package/CHANGELOG.md

@@ -19,7 +19,7 @@
 ## [1.0.2] - 2024-09-10
 
 - Added ArvoEventRouter as a mechanism to group ArvoEventHandlers
+
 ## [1.1.0] - 2024-09-30
 
 - Added Abstract handler class and bound all handlers to it
-

package/README.md

@@ -27,12 +27,11 @@ Whether you're building a small microservice or a large-scale distributed system
 
 Arvo is a collection of libraries which allows you to build the event driven system in the Arvo pattern. However, if you feel you don't have to use them or you can use them as you see fit.
 
-| Scope       | NPM                                                                | Github                                                                | Documentation                                                                |
-| ------------ | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
-| Orchestration      | https://www.npmjs.com/package/arvo-xstate?activeTab=readme | https://github.com/SaadAhmad123/arvo-xstate | https://saadahmad123.github.io/arvo-xstate/index.html |
-| Core       | https://www.npmjs.com/package/arvo-core?activeTab=readme                | https://github.com/SaadAhmad123/arvo-core | https://saadahmad123.github.io/arvo-core/index.html |
-| Event Handling | https://www.npmjs.com/package/arvo-event-handler?activeTab=readme      | https://github.com/SaadAhmad123/arvo-event-handler | https://saadahmad123.github.io/arvo-event-handler/index.html |
-
+| Scope          | NPM                                                               | Github                                             | Documentation                                                |
+| -------------- | ----------------------------------------------------------------- | -------------------------------------------------- | ------------------------------------------------------------ |
+| Orchestration  | https://www.npmjs.com/package/arvo-xstate?activeTab=readme        | https://github.com/SaadAhmad123/arvo-xstate        | https://saadahmad123.github.io/arvo-xstate/index.html        |
+| Core           | https://www.npmjs.com/package/arvo-core?activeTab=readme          | https://github.com/SaadAhmad123/arvo-core          | https://saadahmad123.github.io/arvo-core/index.html          |
+| Event Handling | https://www.npmjs.com/package/arvo-event-handler?activeTab=readme | https://github.com/SaadAhmad123/arvo-event-handler | https://saadahmad123.github.io/arvo-event-handler/index.html |
 
 # Arvo - Event Handler
 

package/dist/AbstractArvoEventHandler/index.d.ts

@@ -1,4 +1,4 @@
-import { ArvoContractRecord, ArvoEvent } from "arvo-core";
+import { ArvoContractRecord, ArvoEvent } from 'arvo-core';
 /**
  * Abstract base class for Arvo event handlers.
  *

package/dist/ArvoEventHandler/index.d.ts

@@ -1,6 +1,6 @@
 import { ArvoContract, ArvoEvent, ArvoExecutionSpanKind, OpenInferenceSpanKind, ResolveArvoContractRecord } from 'arvo-core';
 import { IArvoEventHandler } from './types';
-import { SpanKind } from '@opentelemetry/api';
+import { SpanKind, Tracer } from '@opentelemetry/api';
 import AbstractArvoEventHandler from '../AbstractArvoEventHandler';
 /**
  * Represents an event handler for Arvo contracts.
@@ -88,7 +88,10 @@ export default class ArvoEventHandler<TContract extends ArvoContract> extends Ab
      * - Propagates trace context to output events
      * - Handles error cases and sets appropriate span status
      */
-    execute(event: ArvoEvent<ResolveArvoContractRecord<TContract['accepts']>, Record<string, any>, TContract['accepts']['type']>): Promise<ArvoEvent[]>;
+    execute(event: ArvoEvent<ResolveArvoContractRecord<TContract['accepts']>, Record<string, any>, TContract['accepts']['type']>, opentelemetry?: {
+        inheritFrom: 'event' | 'execution';
+        tracer?: Tracer;
+    }): Promise<ArvoEvent[]>;
     /**
      * Provides the schema for system error events.
      *

package/dist/ArvoEventHandler/index.js

@@ -60,6 +60,7 @@ var api_1 = require("@opentelemetry/api");
 var utils_1 = require("../utils");
 var utils_2 = require("../OpenTelemetry/utils");
 var AbstractArvoEventHandler_1 = __importDefault(require("../AbstractArvoEventHandler"));
+var OpenTelemetry_1 = require("../OpenTelemetry");
 /**
  * Represents an event handler for Arvo contracts.
  *
@@ -156,18 +157,35 @@ var ArvoEventHandler = /** @class */ (function (_super) {
      * - Propagates trace context to output events
      * - Handles error cases and sets appropriate span status
      */
-    ArvoEventHandler.prototype.execute = function (event) {
-        return __awaiter(this, void 0, void 0, function () {
-            var span, eventFactory;
+    ArvoEventHandler.prototype.execute = function (event_1) {
+        return __awaiter(this, arguments, void 0, function (event, opentelemetry) {
+            var spanName, spanKinds, spanOptions, span, eventFactory;
+            var _a;
             var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var _b;
+            if (opentelemetry === void 0) { opentelemetry = {
+                inheritFrom: 'event',
+                tracer: OpenTelemetry_1.ArvoEventHandlerTracer,
+            }; }
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
-                        span = (0, utils_2.createSpanFromEvent)("ArvoEventHandler<".concat(this.contract.uri, ">.execute<").concat(event.type, ">"), event, {
+                        spanName = "ArvoEventHandler<".concat(this.contract.uri, ">.execute<").concat(event.type, ">");
+                        spanKinds = {
                             kind: this.openTelemetrySpanKind,
                             openInference: this.openInferenceSpanKind,
-                            arvoExecution: this.arvoExecutionSpanKind
-                        });
+                            arvoExecution: this.arvoExecutionSpanKind,
+                        };
+                        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),
+                        };
+                        span = opentelemetry.inheritFrom === 'event'
+                            ? (0, utils_2.createSpanFromEvent)(spanName, event, spanKinds, opentelemetry.tracer)
+                            : ((_b = opentelemetry.tracer) !== null && _b !== void 0 ? _b : OpenTelemetry_1.ArvoEventHandlerTracer).startSpan(spanName, spanOptions);
                         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;
@@ -241,7 +259,7 @@ var ArvoEventHandler = /** @class */ (function (_super) {
                                     }
                                 });
                             }); })];
-                    case 1: return [2 /*return*/, _a.sent()];
+                    case 1: return [2 /*return*/, _c.sent()];
                 }
             });
         });

package/dist/ArvoEventRouter/index.d.ts

@@ -1,7 +1,7 @@
 import { ArvoContract, ArvoEvent, ArvoExecutionSpanKind, OpenInferenceSpanKind } from 'arvo-core';
 import ArvoEventHandler from '../ArvoEventHandler';
 import { IArvoEventRouter } from './types';
-import { SpanKind } from '@opentelemetry/api';
+import { SpanKind, Tracer } from '@opentelemetry/api';
 import AbstractArvoEventHandler from '../AbstractArvoEventHandler';
 /**
  * ArvoEventRouter class handles routing of ArvoEvents to appropriate event handlers.
@@ -89,7 +89,10 @@ export declare class ArvoEventRouter extends AbstractArvoEventHandler {
      * - Execution units are tracked for both successful executions and errors.
      * - The router's default execution units are used for error events.
      */
-    execute(event: ArvoEvent): Promise<ArvoEvent[]>;
+    execute(event: ArvoEvent, opentelemetry?: {
+        inheritFrom: 'event' | 'execution';
+        tracer?: Tracer;
+    }): Promise<ArvoEvent[]>;
     /**
      * Provides the schema for system error events.
      *

package/dist/ArvoEventRouter/index.js

@@ -61,6 +61,7 @@ var api_1 = require("@opentelemetry/api");
 var utils_2 = require("./utils");
 var utils_3 = require("../OpenTelemetry/utils");
 var AbstractArvoEventHandler_1 = __importDefault(require("../AbstractArvoEventHandler"));
+var OpenTelemetry_1 = require("../OpenTelemetry");
 /**
  * ArvoEventRouter class handles routing of ArvoEvents to appropriate event handlers.
  */
@@ -163,19 +164,35 @@ var ArvoEventRouter = /** @class */ (function (_super) {
      * - Execution units are tracked for both successful executions and errors.
      * - The router's default execution units are used for error events.
      */
-    ArvoEventRouter.prototype.execute = function (event) {
-        return __awaiter(this, void 0, void 0, function () {
-            var span;
-            var _this = this;
+    ArvoEventRouter.prototype.execute = function (event_1) {
+        return __awaiter(this, arguments, void 0, function (event, opentelemetry) {
+            var spanName, spanKinds, spanOptions, span;
             var _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var _this = this;
+            var _b, _c;
+            if (opentelemetry === void 0) { opentelemetry = {
+                inheritFrom: 'event',
+                tracer: OpenTelemetry_1.ArvoEventHandlerTracer,
+            }; }
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
-                        span = (0, utils_3.createSpanFromEvent)("ArvoEventRouter.source<".concat((_a = this._source) !== null && _a !== void 0 ? _a : 'arvo.event.router', ">.execute<").concat(event.type, ">"), event, {
+                        spanName = "ArvoEventRouter.source<".concat((_b = this._source) !== null && _b !== void 0 ? _b : 'arvo.event.router', ">.execute<").concat(event.type, ">");
+                        spanKinds = {
                             kind: this.openTelemetrySpanKind,
                             openInference: this.openInferenceSpanKind,
                             arvoExecution: this.arvoExecutionSpanKind,
-                        });
+                        };
+                        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),
+                        };
+                        span = opentelemetry.inheritFrom === 'event'
+                            ? (0, utils_3.createSpanFromEvent)(spanName, event, spanKinds, opentelemetry.tracer)
+                            : ((_c = opentelemetry.tracer) !== null && _c !== void 0 ? _c : OpenTelemetry_1.ArvoEventHandlerTracer).startSpan(spanName, spanOptions);
                         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;
                                 var _this = this;
@@ -188,13 +205,14 @@ var ArvoEventRouter = /** @class */ (function (_super) {
                                         case 1:
                                             _a.trys.push([1, 3, 4, 5]);
                                             span.setStatus({ code: api_1.SpanStatusCode.OK });
-                                            if (!(0, utils_1.isNullOrUndefined)(this._source) && newEvent.to !== this._source) {
+                                            if (!(0, utils_1.isNullOrUndefined)(this._source) &&
+                                                newEvent.to !== this._source) {
                                                 throw new Error((0, arvo_core_1.cleanString)("\n            Invalid event. The 'event.to' is ".concat(newEvent.to, " while this handler \n            listens to only 'event.to' equal to ").concat(this._source, ". If this is a mistake,\n            please update the 'source' field of the handler\n          ")));
                                             }
                                             if (!this.handlersMap[newEvent.type]) {
                                                 throw new Error((0, arvo_core_1.cleanString)("\n            Invalid event (type=".concat(newEvent.type, "). No valid handler \n            <handler[*].contract.accepts.type> found in the router.\n          ")));
                                             }
-                                            return [4 /*yield*/, this.handlersMap[newEvent.type].execute(newEvent)];
+                                            return [4 /*yield*/, this.handlersMap[newEvent.type].execute(newEvent, { inheritFrom: 'execution', tracer: opentelemetry.tracer })];
                                         case 2:
                                             results = _a.sent();
                                             return [2 /*return*/, results.map(function (event) {
@@ -232,7 +250,7 @@ var ArvoEventRouter = /** @class */ (function (_super) {
                                     }
                                 });
                             }); })];
-                    case 1: return [2 /*return*/, _b.sent()];
+                    case 1: return [2 /*return*/, _d.sent()];
                 }
             });
         });

package/dist/MultiArvoEventHandler/index.d.ts

@@ -1,4 +1,4 @@
-import { SpanKind } from '@opentelemetry/api';
+import { SpanKind, Tracer } from '@opentelemetry/api';
 import { ArvoEvent, ArvoExecutionSpanKind, OpenInferenceSpanKind } from 'arvo-core';
 import { IMultiArvoEventHandler } from './types';
 import AbstractArvoEventHandler from '../AbstractArvoEventHandler';
@@ -90,7 +90,10 @@ export default class MultiArvoEventHandler extends AbstractArvoEventHandler {
      * - If they don't match, an error is thrown with a descriptive message.
      * - This ensures that the handler only processes events intended for it.
      */
-    execute(event: ArvoEvent): Promise<ArvoEvent[]>;
+    execute(event: ArvoEvent, opentelemetry?: {
+        inheritFrom: 'event' | 'execution';
+        tracer?: Tracer;
+    }): Promise<ArvoEvent[]>;
     /**
      * Provides the schema for system error events.
      *

package/dist/MultiArvoEventHandler/index.js

@@ -59,6 +59,7 @@ var arvo_core_1 = require("arvo-core");
 var utils_1 = require("../utils");
 var utils_2 = require("../OpenTelemetry/utils");
 var AbstractArvoEventHandler_1 = __importDefault(require("../AbstractArvoEventHandler"));
+var OpenTelemetry_1 = require("../OpenTelemetry");
 /**
  * Represents a Multi ArvoEvent handler that can process multiple event types.
  *
@@ -149,18 +150,35 @@ var MultiArvoEventHandler = /** @class */ (function (_super) {
      * - If they don't match, an error is thrown with a descriptive message.
      * - This ensures that the handler only processes events intended for it.
      */
-    MultiArvoEventHandler.prototype.execute = function (event) {
-        return __awaiter(this, void 0, void 0, function () {
-            var span;
+    MultiArvoEventHandler.prototype.execute = function (event_1) {
+        return __awaiter(this, arguments, void 0, function (event, opentelemetry) {
+            var spanName, spanKinds, spanOptions, span;
+            var _a;
             var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var _b;
+            if (opentelemetry === void 0) { opentelemetry = {
+                inheritFrom: 'event',
+                tracer: OpenTelemetry_1.ArvoEventHandlerTracer,
+            }; }
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
-                        span = (0, utils_2.createSpanFromEvent)("MutliArvoEventHandler.source<".concat(this.source, ">.execute<").concat(event.type, ">"), event, {
+                        spanName = "MutliArvoEventHandler.source<".concat(this.source, ">.execute<").concat(event.type, ">");
+                        spanKinds = {
                             kind: this.openTelemetrySpanKind,
                             openInference: this.openInferenceSpanKind,
                             arvoExecution: this.arvoExecutionSpanKind,
-                        });
+                        };
+                        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),
+                        };
+                        span = opentelemetry.inheritFrom === 'event'
+                            ? (0, utils_2.createSpanFromEvent)(spanName, event, spanKinds, opentelemetry.tracer)
+                            : ((_b = opentelemetry.tracer) !== null && _b !== void 0 ? _b : OpenTelemetry_1.ArvoEventHandlerTracer).startSpan(spanName, spanOptions);
                         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;
                                 return __generator(this, function (_a) {
@@ -216,7 +234,7 @@ var MultiArvoEventHandler = /** @class */ (function (_super) {
                                     }
                                 });
                             }); })];
-                    case 1: return [2 /*return*/, _a.sent()];
+                    case 1: return [2 /*return*/, _c.sent()];
                 }
             });
         });

package/dist/index.d.ts

@@ -11,4 +11,4 @@ import { ArvoEventRouter } from './ArvoEventRouter';
 import { createArvoEventRouter } from './ArvoEventRouter/helpers';
 import AbstractArvoEventHandler from './AbstractArvoEventHandler';
 import { createSpanFromEvent } from './OpenTelemetry/utils';
-export { ArvoEventHandler, createArvoEventHandler, IArvoEventHandler, ArvoEventHandlerFunctionOutput, ArvoEventHandlerFunctionInput, ArvoEventHandlerFunction, PartialExcept, MultiArvoEventHandler, MultiArvoEventHandlerFunctionInput, MultiArvoEventHandlerFunctionOutput, MultiArvoEventHandlerFunction, IMultiArvoEventHandler, createMultiArvoEventHandler, isNullOrUndefined, getValueOrDefault, coalesce, coalesceOrDefault, IArvoEventRouter, ArvoEventRouter, createArvoEventRouter, AbstractArvoEventHandler, createSpanFromEvent as createOtelSpanFromEvent };
+export { ArvoEventHandler, createArvoEventHandler, IArvoEventHandler, ArvoEventHandlerFunctionOutput, ArvoEventHandlerFunctionInput, ArvoEventHandlerFunction, PartialExcept, MultiArvoEventHandler, MultiArvoEventHandlerFunctionInput, MultiArvoEventHandlerFunctionOutput, MultiArvoEventHandlerFunction, IMultiArvoEventHandler, createMultiArvoEventHandler, isNullOrUndefined, getValueOrDefault, coalesce, coalesceOrDefault, IArvoEventRouter, ArvoEventRouter, createArvoEventRouter, AbstractArvoEventHandler, createSpanFromEvent as createOtelSpanFromEvent, };

package/dist/utils.d.ts

@@ -1,6 +1,6 @@
-import { ArvoEvent, CreateArvoEvent, OpenTelemetryHeaders } from "arvo-core";
-import { ArvoEventHandlerFunctionOutput } from "./ArvoEventHandler/types";
-import { MultiArvoEventHandlerFunctionOutput } from "./MultiArvoEventHandler/types";
+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.
  *

package/dist/utils.js

@@ -140,7 +140,7 @@ var createHandlerErrorOutputEvent = function (error, otelSpanHeaders, type, sour
             errorMessage: error.message,
             errorStack: (_d = error.stack) !== null && _d !== void 0 ? _d : null,
         },
-        accesscontrol: (_e = originalEvent.accesscontrol) !== null && _e !== void 0 ? _e : undefined
+        accesscontrol: (_e = originalEvent.accesscontrol) !== null && _e !== void 0 ? _e : undefined,
     });
     Object.entries(result.otelAttributes).forEach(function (_a) {
         var _b;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arvo-event-handler",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "description": "This package contains class and function for event handlers in an Arvo Event Driven system",
   "main": "dist/index.js",
   "scripts": {
@@ -49,7 +49,7 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "arvo-core": "^1.1.15",
+    "arvo-core": "^1.1.16",
     "uuid": "^10.0.0",
     "zod": "^3.23.8"
   }