@weave-js/core 0.11.1 → 0.12.0

package/lib/broker/index.js

@@ -6,10 +6,10 @@
 */
 
 // node packages
-const { isFunction } = require('@weave-js/utils')
-const path = require('path')
-const glob = require('glob')
-const Middlewares = require('../middlewares')
+const { isFunction } = require('@weave-js/utils');
+const path = require('path');
+const glob = require('glob');
+const Middlewares = require('../middlewares');
 
 /**
  * Creates a new Weave Broker instance
@@ -28,206 +28,202 @@ exports.createBrokerInstance = (runtime) => {
     validator,
     log,
     services,
-    transport,
-    metrics,
-    cache
-  } = runtime
+    transport
+  } = runtime;
 
   // Log Messages
-  log.info(`Initializing #weave node version ${version}`)
-  log.info(`Node Id: ${options.nodeId}`)
+  log.info(`Initializing #weave node version ${version}`);
+  log.info(`Node Id: ${options.nodeId}`);
 
   // Output namespace
   if (options.namespace) {
-    log.info(`Namespace: ${options.namespace}`)
+    log.info(`Namespace: ${options.namespace}`);
   }
 
   // Init metrics
-  if (metrics) {
-    metrics.init()
+  if (runtime.metrics) {
+    runtime.metrics.init();
   }
 
   // Init cache
-  if (cache) {
-    cache.init()
+  if (runtime.cache) {
+    runtime.cache.init();
   }
 
   // broker object
   /** @type {Broker} */
-  const broker = Object.create(null)
-
-  broker.runtime = runtime
-  broker.registry = registry
-  broker.bus = bus
-  broker.nodeId = options.nodeId
-  broker.version = version
-  broker.options = options
-  broker.validator = validator
-  broker.contextFactory = contextFactory
-  broker.log = log
-  broker.createLogger = runtime.createLogger
+  const broker = Object.create(null);
+
+  broker.runtime = runtime;
+  broker.registry = registry;
+  broker.bus = bus;
+  broker.nodeId = options.nodeId;
+  broker.version = version;
+  broker.options = options;
+  broker.validator = validator;
+  broker.contextFactory = contextFactory;
+  broker.log = log;
+  broker.createLogger = runtime.createLogger;
 
   broker.getUUID = function () {
-    return runtime.generateUUID()
-  }
+    return runtime.generateUUID();
+  };
 
   broker.getNextActionEndpoint = function (actionName, options = {}) {
-    return registry.getNextAvailableActionEndpoint(actionName, options)
-  }
+    return registry.getNextAvailableActionEndpoint(actionName, options);
+  };
 
-  broker.emit = eventBus.emit.bind(broker)
+  broker.emit = eventBus.emit.bind(broker);
 
-  broker.broadcast = eventBus.broadcast.bind(broker)
+  broker.broadcast = eventBus.broadcast.bind(broker);
 
-  broker.broadcastLocal = eventBus.broadcastLocal.bind(broker)
+  broker.broadcastLocal = eventBus.broadcastLocal.bind(broker);
 
-  broker.call = runtime.actionInvoker.call.bind(broker)
+  broker.call = runtime.actionInvoker.call.bind(broker);
 
-  broker.multiCall = runtime.actionInvoker.multiCall.bind(broker)
+  broker.multiCall = runtime.actionInvoker.multiCall.bind(broker);
 
-  broker.waitForServices = services.waitForServices.bind(broker)
+  broker.waitForServices = services.waitForServices.bind(broker);
 
-  broker.createService = services.createService.bind(broker)
+  broker.createService = services.createService.bind(broker);
 
   /**
    * Global error handler of the broker.
    * @param {*} error Error
    * @returns {void}
   */
-  broker.handleError = runtime.handleError
+  broker.handleError = runtime.handleError;
 
-  broker.fatalError = runtime.fatalError
+  broker.fatalError = runtime.fatalError;
 
   /**
   * Load and register a service from file.
-  * @param {string} fileName Path to the service file.
+  * @param {string} filename Path to the service file.
   * @returns {Service} Service
   */
-  broker.loadService = function (fileName) {
-    const filePath = path.resolve(fileName)
-    const schema = require(filePath)
-    const service = broker.createService(schema)
-
-    // If the "watchSevrices" option is set - add service to service watcher.
-    if (options.watchServices) {
-      service.filename = fileName
-      services.watchService.call(broker, service)
+  broker.loadService = function (filename) {
+    const filePath = path.resolve(filename);
+    const schema = require(filePath);
+    const service = broker.createService(schema);
+
+    if (service) {
+      service.filename = filename;
     }
 
-    return service
-  }
+    return service;
+  };
 
   broker.loadServices = function (folder = './services', fileMask = '*.service.js') {
-    const serviceFiles = glob.sync(path.join(folder, fileMask))
+    const serviceFiles = glob.sync(path.join(folder, fileMask));
 
-    log.info(`Searching services in folder '${folder}' with name pattern '${fileMask}'.`)
-    log.info(`${serviceFiles.length} services found.`)
+    log.info(`Searching services in folder '${folder}' with name pattern '${fileMask}'.`);
+    log.info(`${serviceFiles.length} services found.`);
 
-    serviceFiles.forEach(fileName => broker.loadService(fileName))
-    return serviceFiles.length
-  }
+    serviceFiles.forEach(fileName => broker.loadService(fileName));
+    return serviceFiles.length;
+  };
 
   /**
   * Starts the broker.
   * @returns {Promise} Promise
   */
   broker.start = async function () {
-    const startTime = Date.now()
-    await middlewareHandler.callHandlersAsync('starting', [runtime], true)
+    const startTime = Date.now();
+    await middlewareHandler.callHandlersAsync('starting', [runtime], true);
 
     // If transport is used, we connect the transport adapter.
     if (transport) {
-      await transport.connect()
+      await transport.connect();
     }
 
     try {
-      await Promise.all(services.serviceList.map(service => service.start()))
+      await Promise.all(services.serviceList.map(service => service.start()));
     } catch (error) {
-      log.error(error, 'Unable to start all services')
-      clearInterval(options.waitForServiceInterval)
-      throw error
+      log.error(error, 'Unable to start all services');
+      clearInterval(options.waitForServiceInterval);
+      throw error;
     }
 
-    runtime.state.isStarted = true
-    eventBus.broadcastLocal('$broker.started')
+    runtime.state.isStarted = true;
+    eventBus.broadcastLocal('$broker.started');
     // refresh local node information
-    registry.generateLocalNodeInfo(true)
+    registry.generateLocalNodeInfo(true);
 
     // If transport is used, we set the transport ready to inform the other nodes
     if (transport) {
-      await transport.setReady()
+      await transport.setReady();
     }
 
-    await middlewareHandler.callHandlersAsync('started', [runtime], true)
+    await middlewareHandler.callHandlersAsync('started', [runtime], true);
 
     if (runtime.state.isStarted && isFunction(options.started)) {
-      options.started.call(broker)
+      options.started.call(broker);
     }
 
-    const duration = Date.now() - startTime
-    log.info(`Node "${options.nodeId}" with ${services.serviceList.length} services successfully started in ${duration}ms.`)
-  }
+    const duration = Date.now() - startTime;
+    log.info(`Node "${options.nodeId}" with ${services.serviceList.length} services successfully started in ${duration}ms.`);
+  };
 
   /**
     * Stops the broker.
     * @returns {Promise} Promise
   */
   broker.stop = async function () {
-    runtime.state.isStarted = false
-    log.info('Shutting down the node...')
+    runtime.state.isStarted = false;
+    log.info('Shutting down the node...');
 
-    await middlewareHandler.callHandlersAsync('stopping', [runtime], true)
+    await middlewareHandler.callHandlersAsync('stopping', [runtime], true);
 
     // Stop services
     try {
-      await Promise.all(services.serviceList.map(service => service.stop()))
+      await Promise.all(services.serviceList.map(service => service.stop()));
     } catch (error) {
-      log.error(error, 'Unable to stop all services.')
-      throw error
+      log.error(error, 'Unable to stop all services.');
+      throw error;
     }
 
     // Disconnect transports
     if (transport) {
-      await transport.disconnect()
+      await transport.disconnect();
     }
 
     // Stop cache
     if (runtime.cache) {
-      log.debug('Stopping caching adapters.')
-      await runtime.cache.stop()
+      log.debug('Stopping caching adapters.');
+      await runtime.cache.stop();
     }
 
     // Stop metrics
     if (runtime.metrics) {
-      log.debug('Stopping metrics.')
-      await runtime.metrics.stop()
+      log.debug('Stopping metrics.');
+      await runtime.metrics.stop();
     }
 
     // Stop tracers
     if (runtime.tracer) {
-      log.debug('Stopping tracing adapters.')
-      await runtime.tracer.stop()
+      log.debug('Stopping tracing adapters.');
+      await runtime.tracer.stop();
     }
 
     // Call "stopped" middleware method.
-    await middlewareHandler.callHandlersAsync('stopped', [runtime], true)
+    await middlewareHandler.callHandlersAsync('stopped', [runtime], true);
 
     // Call "stopped" lifecycle hook
     if (!runtime.state.isStarted && isFunction(options.stopped)) {
-      options.stopped.call(runtime)
+      options.stopped.call(runtime);
     }
 
-    log.info('The node was successfully shut down. Bye bye! 👋')
+    log.info('The node was successfully shut down. Bye bye! 👋');
 
-    eventBus.broadcastLocal('$broker.stopped')
+    eventBus.broadcastLocal('$broker.stopped');
 
-    process.removeListener('beforeExit', onClose)
-    process.removeListener('exit', onClose)
-    process.removeListener('SIGINT', onClose)
-    process.removeListener('SIGTERM', onClose)
+    process.removeListener('beforeExit', onClose);
+    process.removeListener('exit', onClose);
+    process.removeListener('SIGINT', onClose);
+    process.removeListener('SIGTERM', onClose);
 
     // todo: handle errors
-  }
+  };
 
   /**
    * Ping other nodes
@@ -240,167 +236,167 @@ exports.createBrokerInstance = (runtime) => {
       if (nodeId) {
         return new Promise((resolve) => {
           const timeoutTimer = setTimeout(() => {
-            bus.off('$node.pong', pongHandler)
-            return resolve(null)
-          }, timeout)
+            bus.off('$node.pong', pongHandler);
+            return resolve(null);
+          }, timeout);
 
           const pongHandler = pong => {
-            clearTimeout(timeoutTimer)
-            bus.off('$node.pong', pongHandler)
-            resolve(pong)
-          }
-
-          bus.on('$node.pong', pongHandler)
-          transport.sendPing(nodeId)
-        })
+            clearTimeout(timeoutTimer);
+            bus.off('$node.pong', pongHandler);
+            resolve(pong);
+          };
+
+          bus.on('$node.pong', pongHandler);
+          transport.sendPing(nodeId);
+        });
       } else {
         // handle arrays
-        const pongs = {}
+        const pongs = {};
 
         const nodes = registry.nodeCollection.list({})
           .filter(node => !node.isLocal)
-          .map(node => node.id)
+          .map(node => node.id);
 
-        const onFlight = new Set(nodes)
+        const onFlight = new Set(nodes);
 
         nodes.forEach(nodeId => {
-          pongs[nodeId] = null
-        })
+          pongs[nodeId] = null;
+        });
 
         return new Promise((resolve) => {
           // todo: handle timeout
           const timeoutTimer = setTimeout(() => {
-            bus.off('$node.pong', pongHandler)
-            resolve(pongs)
-          }, timeout)
+            bus.off('$node.pong', pongHandler);
+            resolve(pongs);
+          }, timeout);
 
           const pongHandler = pong => {
-            pongs[pong.nodeId] = pong
-            onFlight.delete(pong.nodeId)
+            pongs[pong.nodeId] = pong;
+            onFlight.delete(pong.nodeId);
             if (onFlight.size === 0) {
-              clearTimeout(timeoutTimer)
-              bus.off('$node.pong', pongHandler)
-              resolve(pongs)
+              clearTimeout(timeoutTimer);
+              bus.off('$node.pong', pongHandler);
+              resolve(pongs);
             }
-          }
+          };
 
-          bus.on('$node.pong', pongHandler)
-          nodes.map(nodeId => transport.sendPing(nodeId))
-        })
+          bus.on('$node.pong', pongHandler);
+          nodes.map(nodeId => transport.sendPing(nodeId));
+        });
       }
     }
 
-    return Promise.resolve(nodeId ? null : {})
-  }
+    return Promise.resolve(nodeId ? null : {});
+  };
 
   // Register internal broker events
   broker.bus.on('$node.disconnected', ({ nodeId }) => {
-    runtime.transport.removePendingRequestsByNodeId(nodeId)
-    services.serviceChanged(false)
-  })
+    runtime.transport.removePendingRequestsByNodeId(nodeId);
+    services.serviceChanged(false);
+  });
 
   /**
    * Register middlewares
    * @param {Array<Object>} customMiddlewares Array of user defined middlewares
    * @returns {void}
    */
-  const registerMiddlewares = customMiddlewares => {
+  const registerMiddlewares = (customMiddlewares) => {
     // Register custom middlewares
     if (Array.isArray(customMiddlewares) && customMiddlewares.length > 0) {
-      customMiddlewares.forEach(middleware => middlewareHandler.add(middleware))
+      customMiddlewares.forEach(middleware => middlewareHandler.add(middleware));
     }
 
     // Add the built-in middlewares. (The order is important)
     if (options.loadInternalMiddlewares) {
-      middlewareHandler.add(Middlewares.ActionHooks)
+      middlewareHandler.add(Middlewares.ActionHooks);
 
       // Validator middleware
       if (options.validateActionParams && validator) {
-        middlewareHandler.add(Middlewares.Validator)
+        middlewareHandler.add(Middlewares.Validator);
       }
 
       // Bulkhead
       if (options.bulkhead.enabled) {
-        middlewareHandler.add(Middlewares.Bulkhead)
+        middlewareHandler.add(Middlewares.Bulkhead);
       }
 
       // Cache
       if (runtime.cache) {
-        middlewareHandler.add(Middlewares.Cache)
+        middlewareHandler.add(Middlewares.Cache);
       }
 
       // Context tracking
       if (options.contextTracking.enabled) {
-        middlewareHandler.add(Middlewares.ContextTracker)
+        middlewareHandler.add(Middlewares.ContextTracker);
       }
 
       // Circuit breaker
       if (options.circuitBreaker.enabled) {
-        middlewareHandler.add(Middlewares.CircuitBreaker)
+        middlewareHandler.add(Middlewares.CircuitBreaker);
       }
 
       // timeout middleware
-      middlewareHandler.add(Middlewares.Timeout)
+      middlewareHandler.add(Middlewares.Timeout);
 
       // Retry policy
       if (options.retryPolicy.enabled) {
-        middlewareHandler.add(Middlewares.Retry)
+        middlewareHandler.add(Middlewares.Retry);
       }
 
       // Error handler
-      middlewareHandler.add(Middlewares.ErrorHandler)
+      middlewareHandler.add(Middlewares.ErrorHandler);
 
       // Tracing
       if (options.tracing.enabled) {
-        middlewareHandler.add(Middlewares.Tracing)
+        middlewareHandler.add(Middlewares.Tracing);
       }
 
       // Metrics
       if (options.metrics.enabled) {
-        middlewareHandler.add(Middlewares.Metrics)
+        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)
+    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)
-  }
+    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 })
+    options.beforeRegisterMiddlewares.call(broker, { broker, runtime });
   }
 
   // Register middlewares
-  registerMiddlewares(options.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))
+    .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)
+  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 })
+  Object.assign(runtime, { broker });
 
   // Call middleware hook for broker created.
-  middlewareHandler.callHandlersSync('created', [runtime])
+  middlewareHandler.callHandlersSync('created', [runtime]);
 
-  return broker
-}
+  return broker;
+};

package/lib/buildRuntime.js

@@ -4,23 +4,23 @@
  * @typedef {import('./types.js').Broker} Broker
 */
 
-const { initLogger } = require('./runtime/initLogger')
-const { initMiddlewareHandler } = require('./runtime/initMiddlewareManager')
-const { initRegistry } = require('./runtime/initRegistry')
-const { initContextFactory } = require('./runtime/initContextFactory')
-const { initEventbus } = require('./runtime/initEventbus')
-const { initValidator } = require('./runtime/initValidator')
-const { initTransport } = require('./runtime/initTransport')
-const { initCache } = require('./runtime/initCache')
-const { initActionInvoker } = require('./runtime/initActionInvoker')
-const { initServiceManager } = require('./runtime/initServiceManager')
-const { initMetrics } = require('./runtime/initMetrics')
-const { initTracer } = require('./runtime/initTracing')
-const { initUUIDFactory } = require('./runtime/initUuidFactory')
-const { errorHandler, fatalErrorHandler } = require('./errorHandler')
-const { uuid } = require('@weave-js/utils')
-const { version } = require('../package.json')
-const EventEmitter = require('eventemitter2')
+const { initLogger } = require('./runtime/initLogger');
+const { initMiddlewareHandler } = require('./runtime/initMiddlewareManager');
+const { initRegistry } = require('./runtime/initRegistry');
+const { initContextFactory } = require('./runtime/initContextFactory');
+const { initEventbus } = require('./runtime/initEventbus');
+const { initValidator } = require('./runtime/initValidator');
+const { initTransport } = require('./runtime/initTransport');
+const { initCache } = require('./runtime/initCache');
+const { initActionInvoker } = require('./runtime/initActionInvoker');
+const { initServiceManager } = require('./runtime/initServiceManager');
+const { initMetrics } = require('./runtime/initMetrics');
+const { initTracer } = require('./runtime/initTracing');
+const { initUUIDFactory } = require('./runtime/initUuidFactory');
+const { errorHandler, fatalErrorHandler } = require('./errorHandler');
+const { uuid } = require('@weave-js/utils');
+const { version } = require('../package.json');
+const EventEmitter = require('eventemitter2');
 
 /**
  * Build runtime object
@@ -35,7 +35,7 @@ exports.initRuntime = (options) => {
   const bus = new EventEmitter({
     wildcard: true,
     maxListeners: 1000
-  })
+  });
 
   // Create base runtime object
   const runtime = {
@@ -49,22 +49,22 @@ exports.initRuntime = (options) => {
     },
     handleError: (error) => errorHandler(runtime, error),
     fatalError: (message, error, killProcess) => fatalErrorHandler(runtime, message, error, killProcess)
-  }
+  };
 
   // Init modules
-  initLogger(runtime)
-  initUUIDFactory(runtime)
-  initMiddlewareHandler(runtime)
-  initRegistry(runtime)
-  initContextFactory(runtime)
-  initEventbus(runtime)
-  initValidator(runtime)
-  initTransport(runtime)
-  initCache(runtime)
-  initActionInvoker(runtime)
-  initServiceManager(runtime)
-  initMetrics(runtime)
-  initTracer(runtime)
+  initLogger(runtime);
+  initUUIDFactory(runtime);
+  initMiddlewareHandler(runtime);
+  initRegistry(runtime);
+  initContextFactory(runtime);
+  initEventbus(runtime);
+  initValidator(runtime);
+  initTransport(runtime);
+  initCache(runtime);
+  initActionInvoker(runtime);
+  initServiceManager(runtime);
+  initMetrics(runtime);
+  initTracer(runtime);
 
-  return runtime
-}
+  return runtime;
+};