arvo-core 1.0.19 → 1.0.21

package/CHANGELOG.md

@@ -40,3 +40,7 @@
 
 - Fix a type bug in ArvoEvent creation
 
+## [1.0.21] - 2024-09-07
+
+- Updated OpenTelemetry propagation and fixed propagation in the event factory
+

package/dist/ArvoEvent/helpers.js

@@ -47,7 +47,7 @@ var uuid_1 = require("uuid");
  * );
  */
 var createArvoEvent = function (event, extensions, telemetry) {
-    return (0, OpenTelemetry_1.createOtelSpan)(telemetry || 'ArvoEvent Creation Tracer', 'createArvoEvent', {}, function (telemetryContext) {
+    return (0, OpenTelemetry_1.createOtelSpan)(telemetry || 'ArvoEvent Creation Tracer', "createArvoEvent<".concat(event.type, ">"), {}, function (telemetryContext) {
         if (event.datacontenttype &&
             event.datacontenttype !== schema_1.ArvoDataContentType) {
             var warning = (0, utils_1.cleanString)("\n        Warning! The provided datacontenttype(=".concat(event.datacontenttype, ")\n        is not ArvoEvent compatible (=").concat(schema_1.ArvoDataContentType, "). There may \n        be some limited functionality.\n      "));

package/dist/ArvoEventFactory/index.js

@@ -54,12 +54,12 @@ var ArvoEventFactory = /** @class */ (function () {
      */
     ArvoEventFactory.prototype.accepts = function (event, extensions, telemetry) {
         var _this = this;
-        return (0, OpenTelemetry_1.createOtelSpan)(telemetry || 'ArvoEvent Creation Tracer', 'ContractualArvoEventFactory.accepts', {}, function () {
+        return (0, OpenTelemetry_1.createOtelSpan)(telemetry || 'ArvoEvent Creation Tracer', "ContractualArvoEventFactory<".concat(this.contract.uri, ">.accepts<").concat(this.contract.accepts.type, ">.create"), {}, function (telemetryContext) {
             var validationResult = _this.contract.validateInput(_this.contract.accepts.type, event.data);
             if (!validationResult.success) {
                 throw new Error("Accept Event data validation failed: ".concat(validationResult.error.message));
             }
-            return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { type: _this.contract.accepts.type, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions, telemetry);
+            return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { type: _this.contract.accepts.type, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions, telemetryContext);
         });
     };
     /**
@@ -75,12 +75,12 @@ var ArvoEventFactory = /** @class */ (function () {
      */
     ArvoEventFactory.prototype.emits = function (event, extensions, telemetry) {
         var _this = this;
-        return (0, OpenTelemetry_1.createOtelSpan)(telemetry || 'ArvoEvent Creation Tracer', 'ContractualArvoEventFactory.emits', {}, function () {
+        return (0, OpenTelemetry_1.createOtelSpan)(telemetry || 'ArvoEvent Creation Tracer', "ContractualArvoEventFactory<".concat(this.contract.uri, ">.emits<").concat(event.type, ">.create"), {}, function (telemetryContext) {
             var validationResult = _this.contract.validateOutput(event.type, event.data);
             if (!validationResult.success) {
                 throw new Error("Emit Event data validation failed: ".concat(validationResult.error.message));
             }
-            return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions, telemetry);
+            return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions, telemetryContext);
         });
     };
     /**
@@ -94,13 +94,13 @@ var ArvoEventFactory = /** @class */ (function () {
      */
     ArvoEventFactory.prototype.systemError = function (event, extensions, telemetry) {
         var _this = this;
-        return (0, OpenTelemetry_1.createOtelSpan)(telemetry || 'ArvoEvent Creation Tracer', 'ContractualArvoEventFactory.systemError', {}, function () {
+        return (0, OpenTelemetry_1.createOtelSpan)(telemetry || 'ArvoEvent Creation Tracer', "ContractualArvoEventFactory<".concat(this.contract.uri, ">.systemError<sys.").concat(this.contract.accepts.type, ".error>.create"), {}, function (telemetryContext) {
             var error = event.error, _events = __rest(event, ["error"]);
             return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { type: "sys.".concat(_this.contract.accepts.type, ".error"), data: {
                     errorName: error.name,
                     errorMessage: error.message,
                     errorStack: error.stack || null,
-                }, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri }), extensions, telemetry);
+                }, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri }), extensions, telemetryContext);
         });
     };
     return ArvoEventFactory;

package/dist/OpenTelemetry/index.d.ts

@@ -5,7 +5,7 @@ import { TelemetryCarrier, TelemetryLogLevel, TelemetryContext } from './types';
  * @param traceparent - The trace header string.
  * @returns The active context.
  */
-export declare const getTelemetryContext: (traceparent?: string | null) => Context;
+export declare const getTelemetryContext: (carrier?: TelemetryCarrier) => Context;
 /**
  * Parses the context from a span and active context.
  * @param span - The span to parse the context from.
@@ -42,23 +42,27 @@ export declare const exceptionToSpan: (span: Span, level: TelemetryLogLevel, err
  * @template TReturn - The return type of the wrapped function.
  *
  * @param {TelemetryContext | string} telemetryContext - The OpenTelemetry context object or a tracer name.
+ *   If a string is provided, it will be used as the tracer name to retrieve the tracer.
+ *   If a `TelemetryContext` object is provided, it should contain the span, tracer, and carrier information.
  * @param {string} spanName - The name of the span to be created.
- * @param {SpanOptions} [spanOptions] - Optional configuration for the span.
- * @param {(currentSpan: Span, ...args: TArgs) => TReturn} wrappedFunction - The function to be executed within the new span.
- *   This function will receive the current span as its first argument.
+ * @param {SpanOptions} [spanOptions] - Optional configuration for the span, such as attributes, links, and sampling.
+ * @param {(telemetryContext: TelemetryContext, ...args: TArgs) => TReturn} wrappedFunction - The function to be executed within the new span.
+ *   This function will receive the `TelemetryContext` object as its first argument, containing the current span, tracer, and carrier.
+ *   The rest of the arguments will be passed as additional parameters to the wrapped function.
  * @param {ThisParameterType<TFunction>} [thisArg] - The 'this' context to be used when calling the wrapped function.
  * @param {...TArgs} args - The arguments to be passed to the wrapped function.
  *
  * @returns {TReturn} The result of the wrapped function execution.
  *
  * @throws {Error} Rethrows any error that occurs during the execution of the wrapped function.
+ *   The error will be logged to the span with an 'ERROR' level, and the span status will be set to `SpanStatusCode.ERROR`.
  *
  * @example
  * // Using with TelemetryContext
  * const telemetryContext: TelemetryContext = {
  *   span: currentSpan,
  *   tracer: currentTracer,
- *   context: { traceparent: 'traceparent-value', tracestate: 'tracestate-value' }
+ *   carrier: { traceparent: 'traceparent-value', tracestate: 'tracestate-value' }
  * };
  * const result = createOtelSpan(
  *   telemetryContext,
@@ -85,8 +89,7 @@ export declare const exceptionToSpan: (span: Span, level: TelemetryLogLevel, err
  *   null,
  *   '12345'
  * );
- */
-export declare const createOtelSpan: <TArgs extends unknown[], TReturn>(telemetryContext: TelemetryContext | string, spanName: string, spanOptions: SpanOptions | undefined, wrappedFunction: (telemetryContext: TelemetryContext, ...args: TArgs) => TReturn, thisArg?: ThisParameterType<typeof wrappedFunction>, ...args: TArgs) => TReturn;
+ */ export declare const createOtelSpan: <TArgs extends unknown[], TReturn>(telemetryContext: TelemetryContext | string, spanName: string, spanOptions: SpanOptions | undefined, wrappedFunction: (telemetryContext: TelemetryContext, ...args: TArgs) => TReturn, thisArg?: ThisParameterType<typeof wrappedFunction>, ...args: TArgs) => TReturn;
 /**
  * A constant representing a null or not applicable value in OpenTelemetry context.
  */

package/dist/OpenTelemetry/index.js

@@ -27,9 +27,9 @@ var api_1 = require("@opentelemetry/api");
  * @param traceparent - The trace header string.
  * @returns The active context.
  */
-var getTelemetryContext = function (traceparent) {
-    if (traceparent) {
-        return api_1.propagation.extract(api_1.context.active(), { traceparent: traceparent });
+var getTelemetryContext = function (carrier) {
+    if (carrier && (carrier.traceparent || carrier.tracestate)) {
+        return api_1.propagation.extract(api_1.ROOT_CONTEXT, carrier);
     }
     return api_1.context.active();
 };
@@ -93,23 +93,27 @@ exports.exceptionToSpan = exceptionToSpan;
  * @template TReturn - The return type of the wrapped function.
  *
  * @param {TelemetryContext | string} telemetryContext - The OpenTelemetry context object or a tracer name.
+ *   If a string is provided, it will be used as the tracer name to retrieve the tracer.
+ *   If a `TelemetryContext` object is provided, it should contain the span, tracer, and carrier information.
  * @param {string} spanName - The name of the span to be created.
- * @param {SpanOptions} [spanOptions] - Optional configuration for the span.
- * @param {(currentSpan: Span, ...args: TArgs) => TReturn} wrappedFunction - The function to be executed within the new span.
- *   This function will receive the current span as its first argument.
+ * @param {SpanOptions} [spanOptions] - Optional configuration for the span, such as attributes, links, and sampling.
+ * @param {(telemetryContext: TelemetryContext, ...args: TArgs) => TReturn} wrappedFunction - The function to be executed within the new span.
+ *   This function will receive the `TelemetryContext` object as its first argument, containing the current span, tracer, and carrier.
+ *   The rest of the arguments will be passed as additional parameters to the wrapped function.
  * @param {ThisParameterType<TFunction>} [thisArg] - The 'this' context to be used when calling the wrapped function.
  * @param {...TArgs} args - The arguments to be passed to the wrapped function.
  *
  * @returns {TReturn} The result of the wrapped function execution.
  *
  * @throws {Error} Rethrows any error that occurs during the execution of the wrapped function.
+ *   The error will be logged to the span with an 'ERROR' level, and the span status will be set to `SpanStatusCode.ERROR`.
  *
  * @example
  * // Using with TelemetryContext
  * const telemetryContext: TelemetryContext = {
  *   span: currentSpan,
  *   tracer: currentTracer,
- *   context: { traceparent: 'traceparent-value', tracestate: 'tracestate-value' }
+ *   carrier: { traceparent: 'traceparent-value', tracestate: 'tracestate-value' }
  * };
  * const result = createOtelSpan(
  *   telemetryContext,
@@ -136,19 +140,18 @@ exports.exceptionToSpan = exceptionToSpan;
  *   null,
  *   '12345'
  * );
- */
-var createOtelSpan = function (telemetryContext, spanName, spanOptions, wrappedFunction, thisArg) {
+ */ var createOtelSpan = function (telemetryContext, spanName, spanOptions, wrappedFunction, thisArg) {
     var args = [];
     for (var _i = 5; _i < arguments.length; _i++) {
         args[_i - 5] = arguments[_i];
     }
-    var activeContext = api_1.context.active();
+    var activeContext = api_1.ROOT_CONTEXT;
     var activeTracer;
     if (typeof telemetryContext === 'string') {
         activeTracer = api_1.trace.getTracer(telemetryContext);
     }
     else {
-        activeContext = (0, exports.getTelemetryContext)(telemetryContext.carrier.traceparent);
+        activeContext = (0, exports.getTelemetryContext)(telemetryContext.carrier);
         activeTracer = telemetryContext.tracer;
     }
     var newSpan = activeTracer.startSpan(spanName, spanOptions, activeContext);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arvo-core",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "description": "This core package contains all the core classes and components of the Arvo Event Driven System",
   "main": "dist/index.js",
   "scripts": {