@weave-js/core 0.13.0 → 0.14.1

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 finished');
-    tracer.invokeCollectorMethod('finishedSpan', [span]);
+
+    tracer.log.debug(`Span "${span.id}" finished`);
+
+    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;
   };