@weave-js/core 0.9.4 → 0.11.1

package/lib/cache/lock.js

@@ -1,14 +1,31 @@
-exports.ttlcreateLock = () => {
+const createLock = () => {
   const locked = new Map()
+
   return {
     acquire (key, ttl) {
-      const lock = locked.get(key)
-      if (!lock) {
-        lock.set(key, [])
+      const lockedItems = locked.get(key)
+      if (!lockedItems) {
+        locked.set(key, [])
+        return Promise.resolve()
+      } else {
+        return new Promise((resolve) => lockedItems.push(resolve))
       }
     },
     isLocked (key) {
       return !!locked.has(key)
+    },
+    release (key) {
+      const lockedItems = locked.get(key)
+      if (lockedItems) {
+        if (lockedItems.length > 0) {
+          lockedItems.shift()()
+        } else {
+          locked.delete(key)
+        }
+      }
+      return Promise.resolve()
     }
   }
 }
+
+module.exports = { createLock }

package/lib/constants.js

@@ -1,7 +1,7 @@
 /*
  * Author: Kevin Ries (kevin@fachw3rk.de)
  * -----
- * Copyright 2020 Fachwerk
+ * Copyright 2021 Fachwerk
  */
 
 exports.PROTOCOL_VERSION = 1
@@ -11,6 +11,13 @@ exports.loadBalancingStrategy = {
   RANDOM: 'random'
 }
 
+exports.circuitBreakerStates = {
+  CIRCUIT_CLOSED: 'closed',
+  CIRCUIT_HALF_OPENED: 'half_opened',
+  CIRCUIT_HALF_OPEN_WAITING: 'half_open_waiting',
+  CIRCUIT_OPENED: 'opened'
+}
+
 exports.level = {
   trace: 'trace',
   debug: 'debug',
@@ -19,7 +26,3 @@ exports.level = {
   error: 'error',
   fatal: 'fatal'
 }
-
-exports.SYNC_MIDDLEWARE_HOOKS = {
-  STARTING: 'starting'
-}

package/lib/errorHandler.js

@@ -0,0 +1,19 @@
+exports.errorHandler = ({ options }, error) => {
+  if (options.errorHandler) {
+    return options.errorHandler.call(null, error)
+  }
+  throw error
+}
+
+exports.fatalErrorHandler = (runtime, message, error, killProcess = true) => {
+  const { options, log } = runtime
+  if (options.logger.enabled) {
+    log.fatal(error, message)
+  } else {
+    console.error(message, error)
+  }
+
+  if (killProcess) {
+    process.exit(1)
+  }
+}

package/lib/errors.js

@@ -1,10 +1,12 @@
 /*
  * Author: Kevin Ries (kevin@fachw3rk.de)
  * -----
- * Copyright 2020 Fachwerk
+ * Copyright 2021 Fachwerk
  */
 
-class WeaveError extends Error {
+const { ExtendableError } = require('./ExtendableError')
+
+class WeaveError extends ExtendableError {
   constructor (message, code, type, data) {
     super(message)
     this.name = this.constructor.name
@@ -15,7 +17,7 @@ class WeaveError extends Error {
   }
 }
 
-class WeaveRetrieableError extends WeaveError {
+class WeaveRetryableError extends WeaveError {
   constructor (message, code, type, data) {
     super(message)
     this.code = code || 500
@@ -25,7 +27,7 @@ class WeaveRetrieableError extends WeaveError {
   }
 }
 
-class WeaveServiceNotFoundError extends WeaveRetrieableError {
+class WeaveServiceNotFoundError extends WeaveRetryableError {
   constructor (data = {}) {
     let message
 
@@ -33,31 +35,36 @@ class WeaveServiceNotFoundError extends WeaveRetrieableError {
       message = `Service "${data.actionName}" not found on node "${data.nodeId}".`
     } else if (data.actionName) {
       message = `Service "${data.actionName}" not found.`
+    } else {
+      message = 'Service not found.'
     }
 
     super(message, 404, 'WEAVE_SERVICE_NOT_FOUND_ERROR', data)
   }
 }
 
-class WeaveServiceNotAvailableError extends WeaveRetrieableError {
+class WeaveServiceNotAvailableError extends WeaveRetryableError {
   constructor (data = {}) {
     let message
     if (data.nodeId) {
       message = `Service "${data.actionName}" not available on node "${data.nodeId}".`
-    } else {
+    } else if (data.actionName) {
       message = `Service "${data.actionName}" not available.`
+    } else {
+      message = 'Service not available.'
     }
 
-    super(message, 405, 'WEAVE_SERVICE_NOT_AVAILABLE_ERROR', data)
+    super(message, 503, 'WEAVE_SERVICE_NOT_AVAILABLE_ERROR', data)
   }
 }
 
-class WeaveRequestTimeoutError extends WeaveRetrieableError {
+class WeaveRequestTimeoutError extends WeaveRetryableError {
   constructor (actionName, nodeId, timeout) {
     const message = `Action ${actionName} timed out node ${nodeId || '<local>'}.`
     super(message, 504, 'WEAVE_REQUEST_TIMEOUT_ERROR', {
       actionName,
-      nodeId
+      nodeId,
+      timeout
     })
     this.retryable = true
   }
@@ -116,7 +123,7 @@ module.exports = {
   WeaveParameterValidationError,
   WeaveQueueSizeExceededError,
   WeaveRequestTimeoutError,
-  WeaveRetrieableError,
+  WeaveRetryableError,
   WeaveServiceNotAvailableError,
   WeaveServiceNotFoundError,
   WeaveGracefulStopTimeoutError,

package/lib/helper/{define-action.js → defineAction.js}

@@ -1,3 +1,5 @@
+/* istanbul ignore next */
+
 /**
  * @typedef {import('../types.js').ServiceActionDefinition} ServiceActionDefinition
 */
@@ -6,7 +8,7 @@
  * Create and register a new service action.
  * @param {ServiceActionDefinition} actionDefinition - Schema of the the action
  * @returns {ServiceActionDefinition} Action definition
- */
+*/
 module.exports = function (actionDefinition) {
   return actionDefinition
 }

package/lib/helper/{define-broker-options.js → defineBrokerOptions.js}

@@ -1,3 +1,5 @@
+/* istanbul ignore next */
+
 /**
  * @typedef {import('../types.js').BrokerOptions} BrokerOptions
  */

package/lib/helper/{define-service.js → defineService.js}

@@ -1,3 +1,6 @@
+
+/* istanbul ignore next */
+
 /**
  * @typedef {import('../types.js').ServiceSchema} ServiceSchema
 */
@@ -6,7 +9,7 @@
  * Create and register a new service
  * @param {ServiceSchema} serviceSchema - Schema of the Service
  * @returns {ServiceSchema} Service schema
- */
+*/
 module.exports = function (serviceSchema) {
   return serviceSchema
 }

package/lib/index.js

@@ -4,93 +4,15 @@
  * @typedef {import('./types.js').Broker} Broker
 */
 
-const EventEmitter = require('eventemitter2')
-const { getDefaultOptions } = require('./broker/default-options')
-const { defaultsDeep, uuid, isFunction } = require('@weave-js/utils')
-const { initLogger } = require('./runtime/init-logger')
-const { initMiddlewareHandler } = require('./runtime/init-middleware-manager')
-const { initRegistry } = require('./runtime/init-registry')
-const { initContextFactory } = require('./runtime/init-context-factory')
-const { initEventbus } = require('./runtime/init-eventbus')
-const { initValidator } = require('./runtime/init-validator')
-const { initTransport } = require('./runtime/init-transport')
-const { initCache } = require('./runtime/init-cache')
-const { initActionInvoker } = require('./runtime/init-action-invoker')
-const { initServiceManager } = require('./runtime/init-service-manager')
-const { initMetrics } = require('./runtime/init-metrics')
-const { initTracer } = require('./runtime/init-tracing')
-const { initUUIDFactory } = require('./runtime/init-uuid-factory')
+const { getDefaultOptions } = require('./broker/defaultOptions')
+const { defaultsDeep } = require('@weave-js/utils')
+const { initRuntime } = require('./buildRuntime')
 const { createBrokerInstance } = require('./broker')
-const { version } = require('../package.json')
-
-exports.defaultOptions = require('./broker/default-options')
-
-const errorHandler = ({ options }, error) => {
-  if (options.errorHandler) {
-    return options.errorHandler.call(null, error)
-  }
-  throw error
-}
-
-const fatalErrorHandler = (runtime, message, error, killProcess = true) => {
-  const { options, log } = runtime
-  if (options.logger.enabled) {
-    log.fatal(error, message)
-  } else {
-    console.error(message, error)
-  }
-
-  if (killProcess) {
-    process.exit(1)
-  }
-}
 
 /**
- * Build runtime object
- * @param {BrokerOptions} options Broker options
- * @return {Runtime} Runtime
+ * @type {BrokerOptions} options Broker options
 */
-const buildRuntime = (options) => {
-  /**
-   * Event bus
-   * @returns {EventEmitter} Service object.
-  */
-  const bus = new EventEmitter({
-    wildcard: true,
-    maxListeners: 1000
-  })
-
-  // Create base runtime object
-  const runtime = {
-    nodeId: options.nodeId,
-    version,
-    options,
-    bus,
-    state: {
-      instanceId: uuid(),
-      isStarted: false
-    },
-    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)
-
-  return runtime
-}
+exports.defaultOptions = getDefaultOptions()
 
 /**
  * Build runtime object
@@ -105,13 +27,12 @@ exports.createBroker = (options) => {
   options = defaultsDeep(options, defaultOptions)
 
   // Init runtime
-  const runtime = buildRuntime(options)
+  const runtime = initRuntime(options)
 
   // Create broker instance
   return createBrokerInstance(runtime)
 }
 
-// eslint-disable-next-line valid-jsdoc
 /**
  * @deprecated since version 0.9.0
  * @param {import('./types.js').BrokerOptions} options Broker options.
@@ -123,15 +44,19 @@ exports.Weave = exports.createBroker
 exports.Errors = require('./errors')
 
 exports.Constants = require('./constants')
-// Transport
-exports.TransportAdapters = require('./transport/adapters')
 
 // Caching
-exports.Cache = require('./cache')
-exports.createBaseTracingCollector = require('./tracing/collectors/base')
+exports.Cache = require('./cache/adapters')
+
+/**
+ * @deprecated since version 0.10.0
+*/
+exports.createBaseTracingCollector = require('./tracing/collectors/base').createBaseTracingCollector
+exports.TransportAdapters = require('./transport/adapters')
 exports.TracingAdapters = require('./tracing/collectors')
+exports.CacheAdapters = require('./cache/adapters')
 
 // Helper
-exports.defineBrokerOptions = require('./helper/define-broker-options')
-exports.defineService = require('./helper/define-service')
-exports.defineAction = require('./helper/define-action')
+exports.defineBrokerOptions = require('./helper/defineBrokerOptions')
+exports.defineService = require('./helper/defineService')
+exports.defineAction = require('./helper/defineAction')

package/lib/logger/format/asHumanReadable.js

@@ -1,4 +1,4 @@
-const { green, magenta, red, yellow, white, gray, cyan } = require('../utils/colorize')
+const { green, magenta, red, yellow, gray, cyan } = require('../utils/colorize')
 const os = require('os')
 
 exports.asHumanReadable = ({ levels, options }, originObj, message, number, time) => {
@@ -15,8 +15,9 @@ exports.asHumanReadable = ({ levels, options }, originObj, message, number, time
 
   const currentLabel = levels.labels[number]
 
+  const color = logLevelColors[currentLabel] || yellow
   // Log level label
-  logResult += logLevelColors[currentLabel](currentLabel.toUpperCase())
+  logResult += color(currentLabel.toUpperCase())
 
   // date time
   logResult += ' [' + new Date(time).toISOString() + '] '
@@ -26,7 +27,7 @@ exports.asHumanReadable = ({ levels, options }, originObj, message, number, time
   }
 
   if (message) {
-    logResult += ' ' + logLevelColors[currentLabel](message)
+    logResult += ' ' + color(message)
   }
 
   if (Object.keys(originObj).length > 0) {

package/lib/logger/index.js

@@ -18,10 +18,16 @@ const defaultOptions = {
   level: 'info',
   messageKey: 'message',
   customLevels: null,
-  base: { pid, hostname },
+  base: {
+    pid,
+    hostname
+  },
   hooks: {
     logMethod: undefined
   },
+  formatter: {
+    messageFormat: false
+  },
   destination: process.stdout
 }
 

package/lib/logger/levels.js

@@ -1,12 +1,12 @@
 const { generateLogMethod } = require('./tools')
 
 const levels = {
-  verbose: 6,
-  debug: 5,
-  info: 4,
-  warn: 3,
-  error: 2,
-  fatal: 1
+  verbose: 60,
+  debug: 50,
+  info: 40,
+  warn: 30,
+  error: 20,
+  fatal: 10
 }
 
 // wrap log methods
@@ -51,8 +51,9 @@ exports.mappings = (customLevels = null, useOnlyCustomLevels = false) => {
     customNums
   )
 
+  // Merge log levels with "silent" log level.
   const values = Object.assign(
-    Object.create(Object.prototype, { silent: { value: Infinity }}),
+    Object.create(Object.prototype, { silent: { value: 0 }}),
     useOnlyCustomLevels ? null : levels,
     customLevels
   )

package/lib/logger/tools.js

@@ -7,6 +7,10 @@ exports.generateLogMethod = (runtime, level, hook) => {
     return log
   }
 
+  return function hookWrappedLog (...args) {
+    hook.call(runtime, args, log, level)
+  }
+
   function log (origin, ...n) {
     if (typeof origin === 'object') {
       let message = origin

package/lib/logger/utils/format.js

@@ -52,29 +52,43 @@ exports.format = (f, args, opts) => {
       case 79: // 'O'
       case 111: // 'o'
       case 106: // 'j'
-        if (a >= argumentLength) { break }
-        if (lastPos < i) { str += f.slice(lastPos, i) }
-        if (args[a] === undefined) break
+        if (a >= argumentLength) {
+          break
+        }
+
+        if (lastPos < i) {
+          str += f.slice(lastPos, i)
+        }
+
+        if (args[a] === undefined) {
+          break
+        }
+
         const type = typeof args[a]
+
         if (type === 'string') {
           str += '\'' + args[a] + '\''
           lastPos = i + 2
           i++
           break
         }
+
         if (type === 'function') {
           str += args[a].name || '<anonymous>'
           lastPos = i + 2
           i++
           break
         }
+
         str += ss(args[a])
         lastPos = i + 2
         i++
         break
       case 115: // 's'
         if (a >= argumentLength) { break }
-        if (lastPos < i) { str += f.slice(lastPos, i) }
+        if (lastPos < i) {
+          str += f.slice(lastPos, i)
+        }
         str += String(args[a])
         lastPos = i + 2
         i++

package/lib/metrics/constants.js

@@ -29,7 +29,7 @@ exports.TRANSPORTER_PACKETS_RECEIVED = 'weave.transport.packets.received'
 exports.TRANSPORT_IN_FLIGHT_STREAMS = 'weave.transport.streams.in-flight'
 
 // Bulkhead
-exports.REQUESTS_BULKHEAD_IN_FLIGHT = 'weave.requests.bulkhead.in-flight'
+exports.BULKHEAD_REQUESTS_IN_FLIGHT = 'weave.bulkhead.requests.in-flight'
 
 // OS Metrics
 exports.OS_HOSTNAME = 'os.hostname'
@@ -50,8 +50,10 @@ exports.OS_CPU_LOAD_1 = 'os.cpu-load.1'
 exports.OS_CPU_LOAD_5 = 'os.cpu-load.5'
 exports.OS_CPU_LOAD_15 = 'os.cpu-load.15'
 
-// Metric types
-exports.TYPE_INFO = 'info'
-exports.TYPE_GAUGE = 'gauge'
-exports.TYPE_COUNTER = 'counter'
-exports.TYPE_HISTOGRAM = 'counter'
+// Cache
+exports.CACHE_GET_TOTAL = 'weave.cache.items.get'
+exports.CACHE_SET_TOTAL = 'weave.cache.items.set'
+exports.CACHE_DELETED_TOTAL = 'weave.cache.items.deleted'
+exports.CACHE_FOUND_TOTAL = 'weave.cache.items.found'
+exports.CACHE_CLEANED_TOTAL = 'weave.cache.items.cleaned'
+exports.CACHE_EXPIRED_TOTAL = 'weave.cache.items.expired'

package/lib/metrics/types/gauge.js

@@ -6,7 +6,7 @@ exports.createGauge = (registry, obj) => {
   base.value = 0
 
   base.increment = (labels, value, timestamp) => {
-    const item = base.values.get(labels)
+    const item = base.get(labels)
     base.set((item ? item.value : 0) + value, labels, timestamp)
   }
 

package/lib/middlewares/action-hooks/index.js

@@ -1,14 +1,26 @@
 /*
  * Author: Kevin Ries (kevin@fachw3rk.de)
  * -----
- * Copyright 2020 Fachwerk
+ * Copyright 2021 Fachwerk
  */
 
 function callHook (hook, service, context, result) {
   if (typeof hook === 'function') {
     return hook.call(service, context, result)
   } else if (Array.isArray(hook)) {
-    return hook.reduce((promise, fn) => promise.then(res => fn.call(service, context, res)), Promise.resolve(result))
+    return hook.reduce(
+      (promise, fn) => promise.then(res => fn.call(service, context, res)),
+      Promise.resolve(result))
+  }
+}
+
+function callErrorHook (hook, service, context, error) {
+  if (typeof hook === 'function') {
+    return hook.call(service, context, error)
+  } else if (Array.isArray(hook)) {
+    return hook.reduce(
+      (promise, fn) => promise.catch(err => fn.call(service, context, err)),
+      Promise.reject(error))
   }
 }
 
@@ -19,6 +31,7 @@ function sanitizeHooks (hooks, service) {
 
   if (Array.isArray(hooks)) {
     return hooks.map((hook) => {
+      // resolve the method name
       if (typeof hook === 'string') {
         return (service && typeof service[hook] === 'function') ? service[hook] : null
       }
@@ -32,16 +45,34 @@ const makeActionHookMiddleware = function (handler, action) {
   const name = action.shortName
   const hooks = (action.service && action.service.schema) ? action.service.schema.hooks : null
 
-  if (hooks) {
-    const beforeWildcardHook = hooks.before ? sanitizeHooks(hooks.before['*'], action.service) : null
-    const afterWildcardHook = hooks.after ? sanitizeHooks(hooks.after['*'], action.service) : null
-    const errorWildcardHook = hooks.error ? sanitizeHooks(hooks.error['*'], action.service) : null
-    const beforeHook = hooks.before ? sanitizeHooks(hooks.before[name], action.service) : null
-    const afterHook = hooks.after ? sanitizeHooks(hooks.after[name], action.service) : null
-    const errorHook = hooks.error ? sanitizeHooks(hooks.error[name], action.service) : null
+  if (hooks || action.hooks) {
+    // Wildcard hooks
+    const beforeWildcardHook = hooks && hooks.before ? sanitizeHooks(hooks.before['*'], action.service) : null
+    const afterWildcardHook = hooks && hooks.after ? sanitizeHooks(hooks.after['*'], action.service) : null
+    const errorWildcardHook = hooks && hooks.error ? sanitizeHooks(hooks.error['*'], action.service) : null
+
+    // Action name-related hooks
+    const beforeHook = hooks && hooks.before ? sanitizeHooks(hooks.before[name], action.service) : null
+    const afterHook = hooks && hooks.after ? sanitizeHooks(hooks.after[name], action.service) : null
+    const errorHook = hooks && hooks.error ? sanitizeHooks(hooks.error[name], action.service) : null
 
-    if (beforeWildcardHook || afterWildcardHook || errorWildcardHook || beforeHook || afterHook || errorHook) {
-      return function actionHookMiddleware (context) {
+    // Hooks in action definition
+    const actionBeforeHook = action.hooks && action.hooks.before ? sanitizeHooks(action.hooks.before, action.service) : null
+    const actionAfterHook = action.hooks && action.hooks.after ? sanitizeHooks(action.hooks.after, action.service) : null
+    const actionErrorHook = action.hooks && action.hooks.error ? sanitizeHooks(action.hooks.error, action.service) : null
+
+    if (
+      beforeWildcardHook ||
+      afterWildcardHook ||
+      errorWildcardHook ||
+      beforeHook ||
+      afterHook ||
+      errorHook ||
+      actionBeforeHook ||
+      actionAfterHook ||
+      actionErrorHook
+    ) {
+      return function actionHookMiddleware (context, serviceInjections) {
         let promise = Promise.resolve()
 
         // before all hook
@@ -54,8 +85,18 @@ const makeActionHookMiddleware = function (handler, action) {
           promise = promise.then(() => callHook(beforeHook, action.service, context))
         }
 
+        // Before hook
+        if (actionBeforeHook) {
+          promise = promise.then(() => callHook(actionBeforeHook, action.service, context))
+        }
+
         // Call action handler
-        promise = promise.then(() => handler(context))
+        promise = promise.then(() => handler(context, serviceInjections))
+
+        // After hook in action definition
+        if (actionAfterHook) {
+          promise = promise.then(result => callHook(actionAfterHook, action.service, context, result))
+        }
 
         // After hook
         if (afterHook) {
@@ -67,13 +108,20 @@ const makeActionHookMiddleware = function (handler, action) {
           promise = promise.then(result => callHook(afterWildcardHook, action.service, context, result))
         }
 
+        // Error hooks
+        // Error hook in action definition
+        if (actionErrorHook) {
+          promise = promise.catch(error => callErrorHook(actionErrorHook, action.service, context, error))
+        }
+
         // Error hook
         if (errorHook) {
-          promise = promise.catch(error => callHook(errorHook, action.service, context, error))
+          promise = promise.catch(error => callErrorHook(errorHook, action.service, context, error))
         }
+
         // Error wildcard hook
         if (errorWildcardHook) {
-          promise = promise.catch(error => callHook(errorWildcardHook, action.service, context, error))
+          promise = promise.catch(error => callErrorHook(errorWildcardHook, action.service, context, error))
         }
 
         return promise

package/lib/middlewares/bulkhead/index.js

@@ -1,9 +1,9 @@
 /*
  * Author: Kevin Ries (kevin@fachw3rk.de)
  * -----
- * Copyright 2020 Fachwerk
+ * Copyright 2021 Fachwerk
  */
-
+const { Constants } = require('../../metrics')
 const { WeaveQueueSizeExceededError } = require('../../errors')
 
 /**
@@ -44,11 +44,11 @@ module.exports = (runtime) => {
           })
       }
 
-      return function bulkheadMiddlware (context) {
+      return function bulkheadMiddlware (context, serviceInjections) {
         // Execute action immediately
         if (currentlyInFlight < bulkheadOptions.concurrentCalls) {
           currentlyInFlight++
-          return handler(context)
+          return handler(context, serviceInjections)
             .then(result => {
               currentlyInFlight--
               callNext()
@@ -81,6 +81,7 @@ module.exports = (runtime) => {
     created () {
       if (runtime.options.metrics.enabled) {
         // todo: add bulkhead metrics
+        runtime.metrics.register({ type: 'gauge', name: Constants.BULKHEAD_REQUESTS_IN_FLIGHT, description: 'Number of in flight requests.' })
       }
     },
     localAction: wrapBulkheadMiddleware