@weave-js/core 0.14.0 → 0.14.1

package/lib/broker/context.js

@@ -27,8 +27,8 @@ exports.createContext = (runtime) => {
   const context = {
     id: null,
     nodeId: runtime.nodeId || null,
+    parentId: null,
     callerNodeId: null,
-    parentContext: null,
     endpoint: null,
     data: {},
     meta: {},
@@ -44,6 +44,7 @@ exports.createContext = (runtime) => {
     },
     duration: 0,
     stopTime: 0,
+    isCachedResult: false,
     setData (newParams) {
       this.data = newParams || {};
     },
@@ -137,21 +138,21 @@ exports.createContext = (runtime) => {
       contextCopy.options = this.options;
       contextCopy.data = this.data;
       contextCopy.meta = this.meta;
-      contextCopy.parentContext = this.parentContext;
+      contextCopy.parentId = this.parentId;
       contextCopy.callerNodeId = this.callerNodeId;
       contextCopy.requestId = this.requestId;
       contextCopy.tracing = this.tracing;
+      contextCopy.span = this.span;
       contextCopy.level = this.level;
       contextCopy.eventName = this.eventName;
       contextCopy.eventType = this.eventType;
       contextCopy.eventGroups = this.eventGroups;
+      contextCopy.isCachedResult = this.isCachedResult;
 
       return contextCopy;
     }
   };
 
-
-
   // Generate context Id
   if (!context.id) {
     // Use UUID factory from broker options

package/lib/broker/defaultOptions.js

@@ -80,6 +80,7 @@ exports.getDefaultOptions = () => {
       enabled: false,
       samplingRate: 1.0,
       collectors: [],
+      defaultTags: null,
       actions: {
         data: false,
         response: false,

package/lib/broker/index.js

@@ -5,7 +5,6 @@
  * @typedef {import('../types.js').Transport} Transport
 */
 
-// node packages
 const { isFunction } = require('@weave-js/utils');
 const path = require('path');
 const glob = require('glob');
@@ -31,26 +30,21 @@ exports.createBrokerInstance = (runtime) => {
     transport
   } = runtime;
 
-  // Log Messages
   log.info(`Initializing #weave node version ${version}`);
   log.info(`Node Id: ${options.nodeId}`);
 
-  // Output namespace
   if (options.namespace) {
     log.info(`Namespace: ${options.namespace}`);
   }
 
-  // Init metrics
   if (runtime.metrics) {
     runtime.metrics.init();
   }
 
-  // Init cache
   if (runtime.cache) {
     runtime.cache.init();
   }
 
-  // broker object
   /** @type {Broker} */
   const broker = Object.create(null);
 
@@ -131,7 +125,6 @@ exports.createBrokerInstance = (runtime) => {
     const startTime = Date.now();
     await middlewareHandler.callHandlersAsync('starting', [runtime], true);
 
-    // If transport is used, we connect the transport adapter.
     if (transport) {
       await transport.connect();
     }
@@ -146,10 +139,8 @@ exports.createBrokerInstance = (runtime) => {
 
     runtime.state.isStarted = true;
     eventBus.broadcastLocal('$broker.started');
-    // refresh local node information
     registry.generateLocalNodeInfo(true);
 
-    // If transport is used, we set the transport ready to inform the other nodes
     if (transport) {
       await transport.setReady();
     }
@@ -174,7 +165,6 @@ exports.createBrokerInstance = (runtime) => {
 
     await middlewareHandler.callHandlersAsync('stopping', [runtime], true);
 
-    // Stop services
     try {
       await Promise.all(services.serviceList.map(service => service.stop()));
     } catch (error) {
@@ -182,33 +172,27 @@ exports.createBrokerInstance = (runtime) => {
       throw error;
     }
 
-    // Disconnect transports
     if (transport) {
       await transport.disconnect();
     }
 
-    // Stop cache
     if (runtime.cache) {
       log.debug('Stopping caching adapters.');
       await runtime.cache.stop();
     }
 
-    // Stop metrics
     if (runtime.metrics) {
       log.debug('Stopping metrics.');
       await runtime.metrics.stop();
     }
 
-    // Stop tracers
     if (runtime.tracer) {
       log.debug('Stopping tracing adapters.');
       await runtime.tracer.stop();
     }
 
-    // Call "stopped" middleware method.
     await middlewareHandler.callHandlersAsync('stopped', [runtime], true);
 
-    // Call "stopped" lifecycle hook
     if (!runtime.state.isStarted && isFunction(options.stopped)) {
       options.stopped.call(runtime);
     }
@@ -229,7 +213,7 @@ exports.createBrokerInstance = (runtime) => {
    * Ping other nodes
    * @param {string=} nodeId Node ID
    * @param {number} timeout Timeout
-   * @returns {Object<string, number>} Result
+   * @returns {Promise<Object<string, number>>} Result
   */
   broker.ping = function (nodeId, timeout = 3000) {
     if (transport && transport.isConnected) {
@@ -250,7 +234,6 @@ exports.createBrokerInstance = (runtime) => {
           transport.sendPing(nodeId);
         });
       } else {
-        // handle arrays
         const pongs = {};
 
         const nodes = registry.nodeCollection.list({})
@@ -289,7 +272,6 @@ exports.createBrokerInstance = (runtime) => {
     return Promise.resolve(nodeId ? null : {});
   };
 
-  // Register internal broker events
   broker.bus.on('$node.disconnected', ({ nodeId }) => {
     runtime.transport.removePendingRequestsByNodeId(nodeId);
     services.serviceChanged(false);
@@ -301,101 +283,81 @@ exports.createBrokerInstance = (runtime) => {
    * @returns {void}
    */
   const registerMiddlewares = (customMiddlewares) => {
-    // Register custom middlewares
     if (Array.isArray(customMiddlewares) && customMiddlewares.length > 0) {
       customMiddlewares.forEach(middleware => middlewareHandler.add(middleware));
     }
 
-    // Add the built-in middlewares. (The order is important)
     if (options.loadInternalMiddlewares) {
       middlewareHandler.add(Middlewares.ActionHooks);
 
-      // Validator middleware
       if (options.validateActionParams && validator) {
         middlewareHandler.add(Middlewares.Validator);
       }
 
-      // Bulkhead
       if (options.bulkhead.enabled) {
         middlewareHandler.add(Middlewares.Bulkhead);
       }
 
-      // Cache
       if (runtime.cache) {
         middlewareHandler.add(Middlewares.Cache);
       }
 
-      // Context tracking
       if (options.contextTracking.enabled) {
         middlewareHandler.add(Middlewares.ContextTracker);
       }
 
-      // Circuit breaker
       if (options.circuitBreaker.enabled) {
         middlewareHandler.add(Middlewares.CircuitBreaker);
       }
 
-      // timeout middleware
       middlewareHandler.add(Middlewares.Timeout);
 
-      // Retry policy
       if (options.retryPolicy.enabled) {
         middlewareHandler.add(Middlewares.Retry);
       }
 
-      // Error handler
       middlewareHandler.add(Middlewares.ErrorHandler);
 
-      // Tracing
       if (options.tracing.enabled) {
         middlewareHandler.add(Middlewares.Tracing);
       }
 
-      // Metrics
       if (options.metrics.enabled) {
         middlewareHandler.add(Middlewares.Metrics);
       }
     }
 
-    // Wrap runtime and broker methods for middlewares
     runtime.actionInvoker.call = middlewareHandler.wrapMethod('call', runtime.actionInvoker.call);
     runtime.actionInvoker.multiCall = middlewareHandler.wrapMethod('multiCall', broker.multiCall);
     runtime.eventBus.emit = middlewareHandler.wrapMethod('emit', runtime.eventBus.emit);
     runtime.eventBus.broadcast = middlewareHandler.wrapMethod('broadcast', runtime.eventBus.broadcast);
     runtime.eventBus.broadcastLocal = middlewareHandler.wrapMethod('broadcastLocal', runtime.eventBus.broadcastLocal);
 
-    // Wrap broker methods
     broker.createService = middlewareHandler.wrapMethod('createService', broker.createService);
     broker.loadService = middlewareHandler.wrapMethod('loadService', broker.loadService);
     broker.loadServices = middlewareHandler.wrapMethod('loadServices', broker.loadServices);
     broker.ping = middlewareHandler.wrapMethod('ping', broker.ping);
   };
 
-  // Run "beforeRegisterMiddlewares" hook
   if (isFunction(options.beforeRegisterMiddlewares)) {
     options.beforeRegisterMiddlewares.call(broker, { broker, runtime });
   }
 
-  // Register middlewares
   registerMiddlewares(options.middlewares);
 
-  // Stop the broker greaceful
   /* istanbul ignore next */
   const onClose = () => broker.stop()
     .catch(error => broker.log.error(error))
     .then(() => process.exit(0));
 
-  // SIGTERM listener
   process.setMaxListeners(0);
   process.on('beforeExit', onClose);
   process.on('exit', onClose);
   process.on('SIGINT', onClose);
   process.on('SIGTERM', onClose);
 
-  // Add broker reference to runtime
   Object.assign(runtime, { broker });
 
-  // Call middleware hook for broker created.
   middlewareHandler.callHandlersSync('created', [runtime]);
 
   return broker;

package/lib/buildRuntime.js

@@ -37,7 +37,6 @@ exports.initRuntime = (options) => {
     maxListeners: 1000
   });
 
-  // Create base runtime object
   const runtime = {
     nodeId: options.nodeId,
     version,
@@ -51,7 +50,6 @@ exports.initRuntime = (options) => {
     fatalError: (message, error, killProcess) => fatalErrorHandler(runtime, message, error, killProcess)
   };
 
-  // Init modules
   initLogger(runtime);
   initUUIDFactory(runtime);
   initMiddlewareHandler(runtime);

package/lib/cache/adapters/base.js

@@ -39,7 +39,6 @@ const createCacheBase = (name, runtime, adapterOptions, options) => {
       ttl: null
     }, options),
     init () {
-      // register metrics
       if (runtime.metrics) {
         this.metrics = runtime.metrics;
         registerCacheMetrics(runtime.metrics);
@@ -79,7 +78,6 @@ const createCacheBase = (name, runtime, adapterOptions, options) => {
         const prefix = actionName + '.';
 
         if (keys) {
-          // fast path for single keys
           if (keys.length === 1) {
             const cacheKeyData = getPropertyFromDataOrMetadata(data, metadata, keys[0]);
             const key = getCacheKeyByObject(cacheKeyData);
@@ -87,7 +85,6 @@ const createCacheBase = (name, runtime, adapterOptions, options) => {
             return prefix + generateHash(value);
           }
 
-          // Handle data cache keys
           if (keys.length > 0) {
             const valueString = keys.reduce((pre, property, index) => {
               let value = getPropertyFromDataOrMetadata(data, metadata, property);

package/lib/cache/adapters/inMemory.js

@@ -36,7 +36,6 @@ const createInMemoryCache = (adapterOptions = {}) => (runtime, options = {}) =>
 
   ttlTimerHandle.unref();
 
-  // if a new broker gets connected, we need to clear the cache
   runtime.bus.on('$transport.connected', () => {
     base.log.debug('Transport adapter connected. Cache will be cleared.');
     cache.clear();
@@ -95,7 +94,6 @@ const createInMemoryCache = (adapterOptions = {}) => (runtime, options = {}) =>
           base.metrics.increment(Constants.CACHE_SET_TOTAL);
         }
 
-        // if ttl is not set in action cache settings, use options ttl
         if (ttl == null) {
           ttl = options.ttl;
         }

package/lib/cache/adapters/inMemoryLru.js

@@ -22,7 +22,6 @@ const createInMemoryLruCache = (adapterOptions) => (runtime, options = {}) => {
 
   timer.unref();
 
-  // if a new broker gets connected, we need to clear the cache
   runtime.bus.on('$transport.connected', () => {
     base.log.debug('Transport adapter connected. Cache will be cleared.');
     cache.clear();

package/lib/cache/getCacheKeyByObject.js

@@ -9,7 +9,6 @@ const getCacheKeyByObject = (value) => {
   if (Array.isArray(value)) {
     return '[' + value.map(object => getCacheKeyByObject(object)).join(',') + ']';
   } else if (isObject(value)) {
-    // Handle date objects
     if (value instanceof Date) {
       return value.toISOString();
     }

package/lib/cache/getPropertyFromDataOrMetadata.js

@@ -8,9 +8,7 @@ const { dotGet } = require('@weave-js/utils');
  * @returns {any} Result
  */
 const getPropertyFromDataOrMetadata = (data, metadata, key) => {
-  // if a key starts with ":", the property is picked from metadata
   if (key.startsWith(':')) {
-    // remove ':' from key.
     key = key.replace(':', '');
     return dotGet(metadata, key);
   }

package/lib/errors.js

@@ -7,8 +7,21 @@
 const { defaultsDeep } = require('@weave-js/utils');
 const { ExtendableError } = require('./ExtendableError');
 
+/**
+ * @typedef {object} ErrorOptions
+ * @property {string} code Error code
+ * @property {boolean} retryable Retryable error
+ * @property {*} data Error data
+ * @property {string} name Error name
+*/
+
 class WeaveError extends ExtendableError {
-  constructor (message, options) {
+  /**
+   * Create a new WeaveRetryableError
+   * @param {string} message Error message
+   * @param {ErrorOptions} options? Error options
+  */
+  constructor (message, options = {}) {
     options = defaultsDeep(
       options,
       {
@@ -26,6 +39,11 @@ class WeaveError extends ExtendableError {
 }
 
 class WeaveRetryableError extends WeaveError {
+  /**
+   * Create a new WeaveRetryableError
+   * @param {string} message Error message
+   * @param {ErrorOptions} options Error options
+  */
   constructor (message, options = { code: 'WEAVE_RETRYABLE_ERROR', retryable: true }) {
     super(message, options);
     this.retryable = true;

package/lib/index.js

@@ -20,16 +20,12 @@ exports.defaultOptions = getDefaultOptions();
  * @return {Broker} Broker instance
 */
 exports.createBroker = (options) => {
-  // get default options
   const defaultOptions = getDefaultOptions();
 
-  // merge options with default options
   options = defaultsDeep(options, defaultOptions);
 
-  // Init runtime
   const runtime = initRuntime(options);
 
-  // Create broker instance
   return createBrokerInstance(runtime);
 };
 
@@ -40,12 +36,10 @@ exports.createBroker = (options) => {
 */
 exports.Weave = exports.createBroker;
 
-// Errors
 exports.Errors = require('./errors');
 
 exports.Constants = require('./constants');
 
-// Caching
 exports.Cache = require('./cache/adapters');
 
 /**
@@ -56,7 +50,6 @@ exports.TransportAdapters = require('./transport/adapters');
 exports.TracingAdapters = require('./tracing/collectors');
 exports.CacheAdapters = require('./cache/adapters');
 
-// Helper
 exports.defineBrokerOptions = require('./helper/defineBrokerOptions');
 exports.defineService = require('./helper/defineService');
 exports.defineAction = require('./helper/defineAction');

package/lib/middlewares/tracing/index.js

@@ -65,7 +65,7 @@ const wrapTracingLocalActionMiddleware = function (handler, action) {
         sampled: context.tracing
       });
 
-      context.span = span;
+      context.tracing = span.sampled;
 
       return handler(context, serviceInjections)
         .then(result => {
@@ -110,7 +110,7 @@ const wrapTracingLocalEventMiddleware = function (handler, event) {
         sampled: context.tracing
       });
 
-      context.span = span;
+      context.tracing = span.sampled;
 
       return handler(context)
         .then(result => {

package/lib/runtime/initActionInvoker.js

@@ -20,24 +20,23 @@ exports.initActionInvoker = (runtime) => {
 
     const action = endpoint.action;
     const nodeId = endpoint.node.id;
-    let context;
+    let contextToUse;
 
-    // If a context is passed, we use this
     if (opts.context !== undefined) {
-      context = opts.context;
-      context.nodeId = nodeId;
+      contextToUse = opts.context;
+      contextToUse.nodeId = nodeId;
     } else {
-      context = contextFactory.create(endpoint, data, opts);
+      contextToUse = contextFactory.create(endpoint, data, opts);
     }
 
     if (endpoint.isLocal) {
-      log.debug({ action: context.action.name, requestId: context.requestId }, 'Call action local.');
+      log.debug({ action: contextToUse.action.name, requestId: contextToUse.requestId }, 'Call action local.');
     } else {
-      log.debug({ action: context.action.name, nodeId, requestId: context.requestId }, 'Call action on remote node.');
+      log.debug({ action: contextToUse.action.name, nodeId, requestId: contextToUse.requestId }, 'Call action on remote node.');
     }
 
-    const p = action.handler(context, { service: context.action.service, runtime, errors });
-    p.context = context;
+    const p = action.handler(contextToUse, { service: contextToUse.action.service, runtime, errors });
+    p.context = contextToUse;
 
     return p;
   };

package/lib/runtime/initCache.js

@@ -7,7 +7,6 @@ exports.initCache = (runtime) => {
       throw new WeaveError('Invalid cache adapter.');
     }
 
-    // Init cache adapter
     const cache = runtime.options.cache.adapter(runtime, runtime.options.cache);
 
     runtime.log.info(`Cache: ${cache.name}`);

package/lib/runtime/initContextFactory.js

@@ -32,27 +32,28 @@ exports.initContextFactory = (runtime) => {
       create (endpoint, data, opts) {
         const context = createContext(runtime);
 
+        if (endpoint) {
+          context.setEndpoint(endpoint);
+        }
+
         opts = opts || {};
         context.setData(data);
         // context.timeout = opts.timeout || 0
         context.retryCount = opts.retryCount;
         context.options = opts;
 
-        // get external request id from options
         if (opts.requestId) {
           context.requestId = opts.requestId;
         } else if (opts.parentContext && opts.parentContext.requestId) {
           context.requestId = opts.parentContext.requestId;
         }
 
-        // meta data
         if (opts.parentContext && opts.parentContext.meta !== null) {
           context.meta = Object.assign({}, opts.parentContext.meta, opts.meta);
         } else if (opts.meta) {
           context.meta = opts.meta;
         }
 
-        // Parent context
         if (opts.parentContext != null) {
           context.parentId = opts.parentContext.id;
           context.level = opts.parentContext.level + 1;
@@ -60,22 +61,19 @@ exports.initContextFactory = (runtime) => {
           context.span = opts.parentContext.span;
         }
 
-        // handle local streams
         if (opts.stream) {
           context.setStream(opts.stream);
         }
 
-        // set request ID for metrics
         if (context.metrics || context.nodeId !== runtime.nodeId) {
           if (!context.requestId) {
             context.requestId = context.id;
           }
         }
 
-        if (endpoint) {
-          context.setEndpoint(endpoint);
+        if (opts.parentSpan) {
+          context.tracing = opts.parentSpan.sampled;
         }
-
         return context;
       }
     }

package/lib/runtime/initEventbus.js

@@ -15,7 +15,6 @@ exports.initEventbus = (runtime) => {
       options = {};
     }
 
-    // Emit local events
     if (/^\$/.test(eventName)) {
       bus.emit(eventName, payload);
     }
@@ -34,7 +33,6 @@ exports.initEventbus = (runtime) => {
     endpoints.map(([endpoint, groupName]) => {
       if (endpoint) {
         if (endpoint.node.id === brokerOptions.nodeId) {
-          // Local event. Call handler
           context.setEndpoint(endpoint);
           promises.push(endpoint.action.handler(context));
         } else {
@@ -51,7 +49,6 @@ exports.initEventbus = (runtime) => {
       }
     });
 
-    // Send remote events
     if (runtime.transport) {
       Object.values(groupedEndpoints)
         .forEach(groupedEndpoint => {
@@ -73,7 +70,6 @@ exports.initEventbus = (runtime) => {
   * @returns {Promise<any>} Promise
   */
   const broadcastLocal = (eventName, payload, options) => {
-    // If the given group is no array - wrap it.
     if (Array.isArray(options)) {
       options = { groups: options };
     } else if (options == null) {
@@ -84,7 +80,6 @@ exports.initEventbus = (runtime) => {
     context.eventType = 'broadcastLocal';
     context.eventName = eventName;
 
-    // Emit the event on the internal event bus
     if (/^\$/.test(eventName)) {
       bus.emit(eventName, payload);
     }
@@ -109,14 +104,12 @@ exports.initEventbus = (runtime) => {
     const promises = [];
 
     if (runtime.transport) {
-      // create context
       // todo: create an event context object
       const context = contextFactory.create(null, payload, options);
       context.eventType = 'broadcast';
       context.eventName = eventName;
       context.eventGroups = options.groups;
 
-      // Avoid to broadcast internal events.
       if (!/^\$/.test(eventName)) {
         const endpoints = registry.eventCollection.getAllEndpointsUniqueNodes(eventName, options.groups);
 

package/lib/runtime/initLogger.js

@@ -20,12 +20,10 @@ exports.initLogger = (runtime) => {
       ...additional
     };
 
-    // custom logger generator function.
     if (typeof runtime.options.logger === 'function') {
       return runtime.options.logger(bindings, runtime.options.logger.level);
     }
 
-    // merge log options
     const loggerOptions = defaultsDeep({
       base: {
         ...bindings
@@ -37,7 +35,6 @@ exports.initLogger = (runtime) => {
 
   const createLogger = (moduleName, service) => loggerFactory(runtime, moduleName, service);
 
-  // create weave default logger
   const log = createLogger('WEAVE');
 
   Object.assign(runtime, {

package/lib/runtime/initMetrics.js

@@ -30,7 +30,6 @@ exports.initMetrics = (runtime) => {
         storage,
         log,
         init () {
-          // Load adapters
           if (metricOptions.adapters) {
             if (!Array.isArray(metricOptions.adapters)) {
               runtime.handleError(new WeaveError('Metic adapter needs to be an Array.'));
@@ -128,11 +127,6 @@ exports.initMetrics = (runtime) => {
             }
             return duration;
           };
-          // const item = this.storage.get(name)
-          // if (item) {
-
-          // }
-          // item.observe(labels, value, timestamp)
         },
         getMetric (name) {
           const item = this.storage.get(name);

package/lib/runtime/initServiceManager.js

@@ -8,45 +8,13 @@ exports.initServiceManager = (runtime) => {
   const serviceList = [];
 
   const serviceChanged = (isLocalService = false) => {
-    // Send local notification.
     eventBus.broadcastLocal('$services.changed', { isLocalService });
 
-    // If the service is a local service - send current node information to other nodes
     if (state.isStarted && isLocalService && transport) {
       transport.sendNodeInfo();
     }
   };
 
-  // const destroyService = (service) => Promise.resolve()
-  //   .then(() => service.stop())
-  //   .then(() => log.info(`Service "${service.name}" was stopped.`))
-  //   .then(() => {
-  //     registry.deregisterService(service.name, service.version)
-  //     log.info(`Service "${service.name}" was deregistered.`)
-  //     // Remove service from service store.
-  //     serviceList.splice(serviceList.indexOf(service), 1)
-  //     // Fire services changed event
-  //     serviceChanged(true)
-  //     return Promise.resolve()
-  //   })
-  //   .catch(error => log.error(error, `Unable to stop service "${service.name}"`))
-
-  // `onServiceFileChanged` only triggered by the file watcher
-  // const onServiceFileChanged = async (service) => {
-  //   const filename = service.filename;
-
-  //   // Clear the require cache
-  //   Object.keys(require.cache).forEach(key => {
-  //     if (key === filename) {
-  //       delete require.cache[key];
-  //     }
-  //   });
-
-  //   // Service has changed - 1. destroy the service, then reload it
-  //   await destroyService(service);
-  //   await runtime.broker.loadService(filename);
-  // };
-
   Object.defineProperty(runtime, 'services', {
     value: {
       serviceList,
@@ -55,7 +23,6 @@ exports.initServiceManager = (runtime) => {
         try {
           const newService = createServiceFromSchema(runtime, schema);
 
-          // if the broker is already started, we need to start the service.
           if (runtime.state.isStarted) {
             newService.start().catch(error => log.error(`Unable to start service ${newService.name}: ${error}`));
           }
@@ -114,11 +81,8 @@ exports.initServiceManager = (runtime) => {
        */
       async destroyService (service) {
         try {
-          // Stop the service
           await service.stop();
-          log.info(`Service "${service.name}" was stopped.`);
 
-          // Deregister the service and remove it from the service list
           registry.deregisterService(service.name, service.version);
           serviceList.splice(serviceList.indexOf(service), 1);
           log.info(`Service "${service.name}" was deregistered.`);
@@ -127,24 +91,6 @@ exports.initServiceManager = (runtime) => {
           log.error(error, `Unable to stop service "${service.name}"`);
         }
       }
-      /**
-       * Watch a Service object for changes.
-       * @param {Service} service Service object
-       * @return {void}
-      */
-      // watchService: (service) => {
-      //   if (service.filename && onServiceFileChanged) {
-      //     // Create debounced service changed reference
-      //     const debouncedOnServiceChange = debounce(onServiceFileChanged, 500);
-
-      //     // Watch file changes
-      //     const watcher = fs.watch(service.filename, (eventType, filename) => {
-      //       log.info(`The Service ${service.name} has been changed. (${eventType}, ${filename})`);
-      //       watcher.close();
-      //       debouncedOnServiceChange(service);
-      //     });
-      //   }
-      // }
     }
   });
 };

package/lib/runtime/initTracing.js

@@ -4,6 +4,7 @@ const { createSpan } = require('../tracing/span');
 exports.initTracer = (runtime) => {
   const options = runtime.options.tracing;
   const log = runtime.createLogger('TRACER');
+
   let collectors = [];
   let samplingCounter = 0;
 
@@ -18,7 +19,6 @@ exports.initTracer = (runtime) => {
         }
       },
       shouldSample (span) {
-        // check span priority
         if (options.samplingRate === 0) {
           return false;
         }
@@ -38,6 +38,12 @@ exports.initTracer = (runtime) => {
         collectors.map(collector => collector[method].apply(collector, args));
       },
       startSpan (name, options) {
+        const parentOptions = {};
+        if (options.parentSpan) {
+          parentOptions.traceId = options.parentSpan.traceId;
+          parentOptions.parentId = options.parentSpan.id;
+          parentOptions.sampled = options.parentSpan.sampled;
+        }
         const span = createSpan(this, name, Object.assign({
           type: 'custom'
         }, options));
@@ -49,7 +55,6 @@ exports.initTracer = (runtime) => {
     }
   });
 
-  // Init collectors
   if (options.enabled) {
     log.info('Tracer initialized.');
 

package/lib/tracing/collectors/index.js

@@ -1,7 +1,6 @@
 const { isFunction } = require('@weave-js/utils');
 
 const collectors = {
-  // Console: require('./console'),
   Event: require('./event'),
   BaseCollector: require('./base')
 };

package/lib/tracing/span.js

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

package/lib/transport/adapters/adapteBase.js

@@ -81,7 +81,6 @@ const createTransportBase = () => {
     },
     serialize (packet) {
       try {
-        // Add the sender to each outgoing message
         packet.payload.sender = this.broker.nodeId;
         return Buffer.from(JSON.stringify(packet));
       } catch (error) {

package/lib/transport/createMessage.js

@@ -1,5 +1,13 @@
 const MessageTypes = require('./messageTypes');
 
+/**
+ * Create a message object
+ *
+ * @param {string} type - The message type
+ * @param {string} targetNodeId - The target node id
+ * @param {object} payload - The message payload
+ * @returns {object} - The message object
+*/
 const createMessage = (type, targetNodeId, payload) => {
   return {
     type: type || MessageTypes.MESSAGE_UNKNOWN,

package/lib/transport/createTransport.js

@@ -70,7 +70,6 @@ exports.createTransport = (runtime, adapter) => {
 
       const doConnect = (isTryReconnect) => {
         const errorHandler = (error) => {
-          // Skip reconnect, if the adapter is disconnecting or an reconnect is in progress.
           if (transport.isDisconnecting || transport.reconnectInProgress) {
             return;
           }
@@ -132,7 +131,6 @@ exports.createTransport = (runtime, adapter) => {
       return Promise.resolve();
     }
 
-    // Collect own node info and send it to remote nodes
     const info = runtime.registry.getLocalNodeInfo();
     const message = createMessage(MessageTypes.MESSAGE_INFO, sender, {
       ...info,
@@ -194,6 +192,8 @@ exports.createTransport = (runtime, adapter) => {
       metrics: context.metrics,
       requestId: context.requestId,
       parentId: context.parentId,
+      callerNodeId: context.callerNodeId,
+      tracing: context.tracing,
       isBroadcast
     };
 
@@ -237,8 +237,10 @@ exports.createTransport = (runtime, adapter) => {
   };
 
   transport.sendRequest = (context) => {
-    // If the queue size is set, check the queue size and reject the job when the limit is reached.
-    if (runtime.options.transport.maxQueueSize && runtime.options.transport.maxQueueSize < pending.requests.size) {
+    const maxQueueSizeExceeded = runtime.options.transport.maxQueueSize &&
+      runtime.options.transport.maxQueueSize < pending.requests.size;
+
+    if (maxQueueSizeExceeded) {
       return Promise.reject(new WeaveQueueSizeExceededError({
         action: context.action.name,
         limit: runtime.options.transport.maxQueueSize,
@@ -273,6 +275,8 @@ exports.createTransport = (runtime, adapter) => {
         metrics: context.metrics,
         requestId: context.requestId,
         parentId: context.parentId,
+        callerNodeId: context.callerNodeId,
+        tracing: context.tracing,
         isStream
       };
 
@@ -383,10 +387,8 @@ exports.createTransport = (runtime, adapter) => {
    * @returns {Promise<void>} - Promise
   */
   transport.sendResponse = (target, contextId, data, meta, error) => {
-    // Check if data is a stream
     const isStream = utils.isStream(data);
 
-    // Build response payload
     const payload = {
       id: contextId,
       meta,
@@ -394,7 +396,6 @@ exports.createTransport = (runtime, adapter) => {
       success: error == null
     };
 
-    // If an error is occurs, we attach the an error object to the payload.
     if (error) {
       payload.error = getErrorPayload(error);
     }
@@ -422,7 +423,6 @@ exports.createTransport = (runtime, adapter) => {
         stream.pause();
         const chunks = [];
 
-        // chunk is larger than maxBufferSize
         if (data instanceof Buffer && runtime.options.transport.maxChunkSize > 0 && data.length > runtime.options.transport.maxChunkSize) {
           const length = data.length;
           let i = 0;
@@ -433,7 +433,6 @@ exports.createTransport = (runtime, adapter) => {
           chunks.push(data);
         }
 
-        // Send chunks from chunk buffer
         for (const chunk of chunks) {
           const payloadCopy = Object.assign({}, payload);
           payloadCopy.sequence = ++payload.sequence;
@@ -445,7 +444,6 @@ exports.createTransport = (runtime, adapter) => {
           transport.send(message);
         }
 
-        // resume stream
         stream.resume();
         return;
       });
@@ -541,7 +539,6 @@ exports.createTransport = (runtime, adapter) => {
 
   let messageHandler = createMessageHandler(runtime, transport);
 
-  // Wrap message handler for middlewares
   messageHandler = middlewareHandler.wrapMethod('transportMessageHandler', messageHandler, transport);
 
   adapter.init(runtime, transport)
@@ -635,10 +632,11 @@ exports.createTransport = (runtime, adapter) => {
     });
   }
 
-  // Removes the node after a given time from the registry.
   function checkOfflineNodes () {
     const now = Date.now();
-    runtime.registry.nodeCollection.list({}).forEach(node => {
+    const nodeList = runtime.registry.nodeCollection.list({});
+
+    nodeList.forEach(node => {
       if (node.isLocal || node.isAvailable) {
         return;
       }

package/lib/transport/messageHandlers.js

@@ -32,25 +32,20 @@ module.exports = (runtime, transport) => {
   const localRequestProxy = (context) => {
     const actionName = context.action.name;
 
-    // Get available endpoints
-    const endpointList = registry.getActionEndpoints(actionName);
+    const availableEndpointList = registry.getActionEndpoints(actionName);
 
-    // Reject the request if no local endpoint can be found.
-    if (endpointList == null || !endpointList.hasLocal()) {
+    if (availableEndpointList == null || !availableEndpointList.hasLocal()) {
       transport.log.warn(`Service ${actionName} not found localy.`);
       return Promise.reject('Service not found');
     }
 
-    // From all available local endpoints - get one.
-    const endpoint = endpointList.getNextLocalEndpoint();
+    const endpoint = availableEndpointList.getNextLocalEndpoint();
 
-    // if there is no endpoint, reject
     if (!endpoint) {
       transport.log.warn(`Service ${actionName} is not available localy.`);
       return Promise.reject('Service not found');
     }
 
-    // Call the local action handler with context
     const promise = endpoint.action.handler(context);
     promise.context = context;
 
@@ -58,7 +53,6 @@ module.exports = (runtime, transport) => {
   };
 
   const handleIncomingRequestStream = (payload) => {
-    // check for open stream.
     let stream = transport.pending.requestStreams.get(payload.id);
     let isNew = false;
 
@@ -75,7 +69,6 @@ module.exports = (runtime, transport) => {
         }
       );
 
-      // handle backpressure
       if (runtime.options.transport.streams.handleBackpressure) {
         stream.on('backpressure', async ({ sender, requestId }) => {
           const message = createMessage(MessageTypes.MESSAGE_REQUEST_STREAM_BACKPRESSURE, sender, { id: requestId });
@@ -107,7 +100,6 @@ module.exports = (runtime, transport) => {
 
         // Todo: Handle errors
 
-        // end of stream
         stream.end();
         transport.pending.requestStreams.delete(payload.id);
         return null;
@@ -147,7 +139,6 @@ module.exports = (runtime, transport) => {
         }
       );
 
-      // handle backpressure
       if (runtime.options.transport.streams.handleBackpressure) {
         stream.on('backpressure', async ({ sender, requestId }) => {
           const message = createMessage(MessageTypes.MESSAGE_RESPONSE_STREAM_BACKPRESSURE, sender, { id: requestId });
@@ -182,7 +173,6 @@ module.exports = (runtime, transport) => {
 
         // Todo: Handle errors
 
-        // end of stream
         stream.end();
         transport.pending.responseStreams.delete(payload.id);
         return null;
@@ -229,9 +219,7 @@ module.exports = (runtime, transport) => {
     try {
       let stream;
 
-      // Handle incomming stream
       if (payload.isStream !== undefined) {
-        // check for open stream.
         stream = handleIncomingRequestStream(payload);
         if (!stream) {
           return Promise.resolve();
@@ -250,9 +238,9 @@ module.exports = (runtime, transport) => {
       context.metrics = payload.metrics;
       context.level = payload.level;
       context.callerNodeId = payload.sender;
+      context.tracing = payload.tracing;
       context.options.timeout = getRequestTimeout(payload);
 
-      // If payload is a stream, attach stream to context
       if (payload.isStream) {
         context.stream = stream;
       }
@@ -278,10 +266,8 @@ module.exports = (runtime, transport) => {
       return Promise.resolve();
     }
 
-    // Merge meta data from response
     Object.assign(request.context.meta, payload.meta);
 
-    // Handle streams
     if (payload.isStream != null) {
       if (handleIncomingResponseStream(payload, request)) {
         return;
@@ -290,7 +276,6 @@ module.exports = (runtime, transport) => {
 
     transport.pending.requests.delete(payload.id);
 
-    // Response is an error
     if (!payload.success) {
       const error = restoreError(payload.error);
 
@@ -357,12 +342,12 @@ module.exports = (runtime, transport) => {
     context.metrics = payload.metrics;
     context.level = payload.level;
     context.callerNodeId = payload.sender;
+    context.tracing = !!payload.tracing;
 
     if (payload.timeout) {
       context.options.timeout = payload.timeout;
     }
 
-    // add event infos
     context.eventName = payload.eventName;
     context.eventType = payload.isBroadcast ? 'broadcast' : 'emit';
 
@@ -387,17 +372,14 @@ module.exports = (runtime, transport) => {
     transport.log.verbose(`Heartbeat from ${payload.sender}`);
     const node = registry.nodeCollection.get(payload.sender);
 
-    // if node is unknown then request a node info message.
     if (node) {
       if (!node.isAvailable) {
         transport.log.debug('Known node. Propably reconnected.');
-        // unknown node. request info message.
         transport.discoverNode(payload.sender);
       } else {
         node.heartbeat(payload);
       }
     } else {
-      // unknown node. request info message.
       transport.discoverNode(payload.sender);
     }
   };
@@ -500,10 +482,7 @@ module.exports = (runtime, transport) => {
       return true;
     } catch (error) {
       transport.log.error(error, type, data);
-
-      runtime.eventBus.broadcastLocal('$transport.error', {
-        error
-      });
+      runtime.eventBus.broadcastLocal('$transport.error', { error });
     }
     return false;
   };

package/lib/types.js

@@ -6,8 +6,6 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @typedef {import('stream').Writable} WritableStream
 */
 
-// Broker
-
 /**
  * @typedef {object} ActionOptions - Action options
  * @property {Context} [context] - Assign a existing context instead of creating a new one.
@@ -86,7 +84,7 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @property {ServiceManager} [services] - Service manager
  * @property {ContextFactory} [contextFactory] - contextFactory
  * @property {Logger} log - Logger instance
- * @property {function(string, any):Logger} [createLogger] - Create a new logger instace.
+ * @property {function(string, any):Logger} [createLogger] - Create a new logger instance.
  * @property {Cache} [cache] - Cache
  * @property {string} [getUUID] - Create a new from the UUID factory.
  * @property {Registry} registry - Service registry reference
@@ -169,6 +167,7 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @property {Boolean} enabled - Enable tracing middleware. (default = false)
  * @property {Number} samplingRate - Rate of traced actions. (default = 1.0)
  * @property {Array<String|Object>} collectors - Array of tracing collectors.
+ * @property {Array<String>} defaultTags - Default tags for spans.
  * @property {TracingErrorOptions} [errors] - Settings for tracing errors.
 */
 
@@ -323,6 +322,7 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @property {number} [retryCount] retryCount
  * @property {Object} tracing tracing
  * @property {Object} span span
+ * @property {boolean} [isCachedResult] eventType
  * @property {Service} service service
  * @property {ServiceAction} [action] action
  * @property {number} [startHighResolutionTime] - High resolution start timestamp.
@@ -361,8 +361,6 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @property {function():Promise<any>} stop stop
 */
 
-// Transport
-
 /**
  * Transport interface
  * @export
@@ -449,8 +447,6 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @property {void} close close
 */
 
-// Registry
-
 /**
  * Registry init function
  * @typedef {function} RegistryInitFunctionDef
@@ -498,7 +494,6 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
 
 /**
  * Endpoint collection
- *
  * @typedef EndpointCollection
  * @property {string} name name
  * @property {string} groupName groupName
@@ -705,7 +700,6 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @property {function():Promise<any>} stop stop
 */
 
-// Health handler
 /**
  * Health handler
  * @typedef HealthHandler
@@ -719,8 +713,6 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @property {any} getNodeHealthInfo getNodeHealthInfo
  */
 
-// Metrics
-
 /**
  * Metric registry
  * @typedef MetricRegistry
@@ -737,8 +729,6 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @property {function():Promise<any>} stop list
 */
 
-// Midlewares
-
 /**
  * Middleware handler
  * @export
@@ -779,15 +769,11 @@ const { EventEmitter2: EventEmitter } = require('eventemitter2');
  * @property {function(Broker):void} [transportMessageHandler] stopped
 */
 
-// Validator
-
 /**
  * Validator
  * @typedef {Object} Validator
 */
 
-// Tracer
-
 /**
  * Tracer instance
  * @typedef Tracer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weave-js/core",
-  "version": "0.14.0",
+  "version": "0.14.1",
   "description": "The core package of weave",
   "keywords": [
     "Weave",
@@ -49,5 +49,5 @@
     "lib": "lib",
     "test": "test"
   },
-  "gitHead": "c2f63481b2a72ae03a35682c9a6d12800f22dbf2"
+  "gitHead": "84fd5e4af3af96e8c004bcfba40bb3cb35f23fa7"
 }