@weave-js/core 0.13.0 → 0.14.0

package/lib/broker/context.js

@@ -21,6 +21,8 @@ const { WeaveMaxCallLevelError, WeaveError } = require('../errors');
  * @returns {Context} Context
 */
 exports.createContext = (runtime) => {
+  const spanStack = [];
+
   /** @type {Context} */
   const context = {
     id: null,
@@ -95,17 +97,33 @@ exports.createContext = (runtime) => {
         sampled: this.tracing
       }, options);
 
+      let span;
+
       if (this.span) {
-        this.span = this.span.startChildSpan(name, options);
+        span = this.span.startChildSpan(name, options);
       } else {
-        this.span = runtime.tracer.startSpan(name, options);
+        span = runtime.tracer.startSpan(name, options);
       }
+      spanStack.push(span);
+      this.span = span;
+
       return this.span;
     },
-    finishSpan () {
-      if (this.span) {
-        this.span.finish();
-        return this.span;
+    finishSpan (span, time) {
+      if (span && !span.isActive()) {
+        return;
+      }
+
+      span.finish(time);
+
+      const idx = spanStack.findIndex((s) => s === span);
+
+      if (idx !== -1) {
+        spanStack.splice(idx, 1);
+        this.span = spanStack[spanStack.length - 1];
+      } else {
+        /* istanbul ignore next */
+        this.service.log.warn('This span is not assigned to this context', span);
       }
     },
     /**
@@ -132,6 +150,8 @@ exports.createContext = (runtime) => {
     }
   };
 
+
+
   // Generate context Id
   if (!context.id) {
     // Use UUID factory from broker options

package/lib/broker/defaultOptions.js

@@ -82,6 +82,7 @@ exports.getDefaultOptions = () => {
       collectors: [],
       actions: {
         data: false,
+        response: false,
         tags: {}
       },
       events: {

package/lib/errors.js

@@ -8,7 +8,7 @@ const { defaultsDeep } = require('@weave-js/utils');
 const { ExtendableError } = require('./ExtendableError');
 
 class WeaveError extends ExtendableError {
-  constructor (message, options) { // code, type, data
+  constructor (message, options) {
     options = defaultsDeep(
       options,
       {
@@ -22,10 +22,6 @@ class WeaveError extends ExtendableError {
     this.code = options.code || 'WEAVE_ERROR';
     this.data = options.data;
     this.retryable = false;
-
-    if (options.statusCode) {
-      this.statusCode = options.statusCode;
-    }
   }
 }
 

package/lib/middlewares/tracing/index.js

@@ -4,22 +4,56 @@
  * Copyright 2021 Fachwerk
  */
 
-const { isPlainObject } = require('@weave-js/utils');
+const { isPlainObject, isFunction, isObject, dotGet } = require('@weave-js/utils');
 const { buildActionTags, buildEventTags } = require('./tags');
 
-const wrapTracingLocalActionMiddleware = function (handler) {
+const wrapTracingLocalActionMiddleware = function (handler, action) {
   const broker = this;
   const tracingOptions = broker.options.tracing || {};
+  const actionTracingOptions = action.tracing || {};
 
   if (tracingOptions.enabled) {
     return function metricsLocalMiddleware (context, serviceInjections) {
       const tags = buildActionTags(context, tracingOptions);
 
-      if (tracingOptions) {
+      if (tracingOptions.actions.data) {
         tags.data = context.data !== null && isPlainObject(context.data) ? Object.assign({}, context.data) : context.data;
       }
 
-      const spanName = `action "${context.action.name}"`;
+      const globalActionTags = tracingOptions.actions.tags;
+      let actionTags;
+      // local action tags take precedence
+      if (isFunction(actionTracingOptions.tags)) {
+        actionTags = actionTracingOptions.tags;
+      } else if (!actionTracingOptions.tags && isFunction(globalActionTags)) {
+        actionTags = globalActionTags;
+      } else {
+        // By default all params are captured. This can be overridden globally and locally
+        actionTags = { ...{ data: true }, ...globalActionTags, ...actionTracingOptions.tags };
+      }
+
+      if (isObject(actionTracingOptions.tags)) {
+        if (Array.isArray(actionTags.data)) {
+          tags.data = actionTags.data.reduce((acc, current) => {
+            acc[current] = dotGet(context.data, current);
+            return acc;
+          }, {});
+        }
+      }
+
+      // Span name
+      let spanName = `action "${context.action.name}"`;
+
+      if (actionTracingOptions.spanName) {
+        switch (typeof actionTracingOptions.spanName) {
+        case 'string':
+          spanName = actionTracingOptions.spanName;
+          break;
+        case 'function':
+          spanName = actionTracingOptions.spanName.call(context.service, context);
+          break;
+        }
+      }
 
       const span = context.startSpan(spanName, {
         id: context.id,
@@ -39,18 +73,17 @@ const wrapTracingLocalActionMiddleware = function (handler) {
             isCachedResult: context.isCachedResult
           };
 
-          if (tracingOptions) {
+          if (tracingOptions.actions.response) {
             tags.response = result !== null && isPlainObject(result) ? Object.assign({}, result) : result;
           }
 
           span.addTags(tags);
-          span.finish();
+          context.finishSpan(span);
           return result;
         })
         .catch(error => {
-          span
-            .setError(error)
-            .finish();
+          span.setError(error);
+          context.finishSpan(span);
           return Promise.reject(error);
         });
     };
@@ -81,13 +114,12 @@ const wrapTracingLocalEventMiddleware = function (handler, event) {
 
       return handler(context)
         .then(result => {
-          span.finish();
+          context.finishSpan(span);
           return result;
         })
         .catch(error => {
-          span
-            .setError(error)
-            .finish();
+          span.setError(error);
+          context.finishSpan(span);
           return Promise.reject(error);
         });
     };

package/lib/tracing/span.js

@@ -42,7 +42,7 @@ exports.createSpan = (tracer, name, options) => {
   span.finish = (time) => {
     span.finishTime = time || hrTime();
     span.duration = span.finishTime - span.startTime;
-    tracer.log.debug('Span finished');
+    tracer.log.debug(`Span "${span.id}" finished`);
     tracer.invokeCollectorMethod('finishedSpan', [span]);
 
     return span;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weave-js/core",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "The core package of weave",
   "keywords": [
     "Weave",
@@ -40,14 +40,14 @@
   "license": "MIT",
   "dependencies": {
     "@weave-js/errors": "^0.9.1",
-    "@weave-js/utils": "^0.12.0",
-    "@weave-js/validator": "^0.13.0",
-    "eventemitter2": "^6.4.5",
-    "glob": "^7.2.0"
+    "@weave-js/utils": "^0.13.0",
+    "@weave-js/validator": "^0.14.0",
+    "eventemitter2": "^6.4.9",
+    "glob": "^10.2.2"
   },
   "directories": {
     "lib": "lib",
     "test": "test"
   },
-  "gitHead": "6772c8bfb00be1da32c17cff621a8abcd98a08fc"
+  "gitHead": "c2f63481b2a72ae03a35682c9a6d12800f22dbf2"
 }