encapsulate reply interface with symbols

Author: StarpTech

packages/hemera/lib/add.js

@@ -9,7 +9,8 @@
  *
  */
 
-const runExt = require('./extensionRunner').extRunner
+const { extRunner } = require('./extensionRunner')
+const { sAddReceivedMsg } = require('./symbols')
 
 class Add {
   constructor(addDef) {
@@ -20,7 +21,7 @@ class Add {
     this.transport = addDef.transport
     this.action = null
     // only used for maxMessages$ flag
-    this._receivedMsg = 0
+    this[sAddReceivedMsg] = 0
   }
 
   _use(handler) {
@@ -42,7 +43,7 @@ class Add {
   }
 
   run(request, response, cb) {
-    runExt(
+    extRunner(
       this.middleware,
       (fn, state, next) => fn(request, response, next),
       null,

packages/hemera/lib/extensions.js

@@ -11,6 +11,7 @@
 
 const Util = require('./util')
 const Errors = require('./errors')
+const { sAddReceivedMsg } = require('./symbols')
 
 /**
  * - Restore context
@@ -213,9 +214,9 @@ function onRequest(context, req, reply, next) {
   // This is required because NATS unsubscribe events is fired too early.
   // Only relevant for server actions with custom transport options.
   if (context.matchedAction !== null) {
-    context.matchedAction._receivedMsg++
+    context.matchedAction[sAddReceivedMsg]++
     if (
-      context.matchedAction._receivedMsg ===
+      context.matchedAction[sAddReceivedMsg] ===
       context.matchedAction.transport.maxMessages
     ) {
       // we only need to remove the pattern because the subscription is unsubscribed by nats driver automatically

packages/hemera/lib/index.js

@@ -25,10 +25,7 @@ const Avvio = require('avvio')
 const Stream = require('stream').Stream
 
 const runExt = require('./extensionRunner').extRunner
-const serverExtIterator = require('./extensionRunner').serverExtIterator
-const clientExtIterator = require('./extensionRunner').clientExtIterator
 const Errors = require('./errors')
-const Symbols = require('./symbols')
 const Util = require('./util')
 const NatsTransport = require('./transport')
 const DefaultExtensions = require('./extensions')
@@ -42,6 +39,8 @@ const ConfigScheme = require('./configScheme')
 const Reply = require('./reply')
 const Add = require('./add')
 const ExtensionManager = require('./extensionManager')
+const { sChildren, sRegisteredPlugins } = require('./symbols')
+const { serverExtIterator, clientExtIterator } = require('./extensionRunner')
 
 const natsConnCodes = [
   NATS.CONN_ERR,
@@ -146,15 +145,15 @@ class Hemera {
       timeout: this._config.pluginTimeout
     })
 
-    this[Symbols.childrenKey] = []
-    this[Symbols.registeredPlugins] = []
+    this[sChildren] = []
+    this[sRegisteredPlugins] = []
 
     this._avvio.override = (hemera, plugin, opts) => {
       const pluginMeta = this.getPluginMeta(plugin)
 
       if (pluginMeta) {
         if (pluginMeta.name) {
-          hemera[Symbols.registeredPlugins].push(pluginMeta.name)
+          hemera[sRegisteredPlugins].push(pluginMeta.name)
         }
         hemera.checkPluginDependencies(plugin)
         hemera.checkPluginDecorators(plugin)
@@ -166,16 +165,14 @@ class Hemera {
 
       const instance = Object.create(hemera)
 
-      hemera[Symbols.childrenKey].push(instance)
-      instance[Symbols.childrenKey] = []
+      hemera[sChildren].push(instance)
+      instance[sChildren] = []
 
       if (pluginMeta && pluginMeta.name && hemera._config.childLogger) {
         instance.log = hemera.log.child({ plugin: pluginMeta.name })
       }
 
-      instance[Symbols.registeredPlugins] = Object.create(
-        hemera[Symbols.registeredPlugins]
-      )
+      instance[sRegisteredPlugins] = Object.create(hemera[sRegisteredPlugins])
 
       // inherit all extensions
       instance._extensionManager = ExtensionManager.build(
@@ -597,7 +594,7 @@ class Hemera {
       )
     }
     dependencies.forEach(dependency => {
-      if (this[Symbols.registeredPlugins].indexOf(dependency) === -1) {
+      if (this[sRegisteredPlugins].indexOf(dependency) === -1) {
         throw new Errors.HemeraError(
           `The dependency '${dependency}' is not registered`
         )

packages/hemera/lib/reply.js

@@ -13,47 +13,53 @@ const Errors = require('./errors')
 const Errio = require('errio')
 const runExt = require('./extensionRunner').extRunner
 const { responseExtIterator, serverExtIterator } = require('./extensionRunner')
+const {
+  sReplySent,
+  sReplyRequest,
+  sReplyResponse,
+  sReplyHemera
+} = require('./symbols')
 
 class Reply {
   constructor(request, response, hemera, logger) {
-    this._request = request
-    this._response = response
-    this.hemera = hemera
+    this[sReplyRequest] = request
+    this[sReplyResponse] = response
+    this[sReplyHemera] = hemera
     this.log = logger
-    this.sent = false
+    this[sReplySent] = false
     this.isError = false
   }
 
   set payload(value) {
-    this._response.payload = value
+    this[sReplyResponse].payload = value
   }
 
   get payload() {
-    return this._response.payload
+    return this[sReplyResponse].payload
   }
 
   set error(value) {
-    this._response.error = this.hemera._attachHops(
-      this.hemera.getRootError(value)
+    this[sReplyResponse].error = this[sReplyHemera]._attachHops(
+      this[sReplyHemera].getRootError(value)
     )
   }
 
   get error() {
-    return this._response.error
+    return this[sReplyResponse].error
   }
 
   next(msg) {
-    this.sent = false
+    this[sReplySent] = false
     this.send(msg)
   }
 
   send(msg) {
-    if (this.sent === true) {
+    if (this[sReplySent] === true) {
       this.log.warn(new Errors.HemeraError('Reply already sent'))
       return
     }
 
-    this.sent = true
+    this[sReplySent] = true
 
     const isNativeError = msg instanceof Error
 
@@ -85,8 +91,8 @@ class Reply {
       return
     }
 
-    if (this.hemera._errorHandler) {
-      const result = this.hemera._errorHandler(this.hemera, err, this.reply)
+    if (this[sReplyHemera]._errorHandler) {
+      const result = this[sReplyHemera]._errorHandler(this[sReplyHemera], err, this.reply)
       if (result && typeof result.then === 'function') {
         result
           .then(() => {
@@ -97,7 +103,7 @@ class Reply {
           .catch(err => {
             const internalError = new Errors.HemeraError(
               'error handler',
-              this.hemera.errorDetails
+              this[sReplyHemera].errorDetails
             ).causedBy(err)
             this.log.error(internalError)
           })
@@ -112,9 +118,9 @@ class Reply {
 
   _sendHook() {
     runExt(
-      this.hemera._extensionManager.onSend,
+      this[sReplyHemera]._extensionManager.onSend,
       serverExtIterator,
-      this.hemera,
+      this[sReplyHemera],
       err => this._sendHookCallback(err)
     )
   }
@@ -123,13 +129,13 @@ class Reply {
     if (extensionError) {
       const internalError = new Errors.HemeraError(
         'onSend extension',
-        this.hemera.errorDetails
+        this[sReplyHemera].errorDetails
       ).causedBy(extensionError)
       this.log.error(internalError)
 
       // first set error has precedence
       if (this.error === null) {
-        this.sent = false
+        this[sReplySent] = false
         this.send(extensionError)
         return
       }
@@ -140,9 +146,9 @@ class Reply {
 
   _send() {
     let msg = this.build(
-      this.hemera.meta$,
-      this.hemera.trace$,
-      this.hemera.request$
+      this[sReplyHemera].meta$,
+      this[sReplyHemera].trace$,
+      this[sReplyHemera].request$
     )
 
     // don't try to send encoding issues back because
@@ -156,18 +162,18 @@ class Reply {
       return
     }
 
-    if (this._response.replyTo) {
-      this.hemera._transport.send(this._response.replyTo, msg.value)
+    if (this[sReplyResponse].replyTo) {
+      this[sReplyHemera]._transport.send(this[sReplyResponse].replyTo, msg.value)
     }
 
     this._onResponse()
   }
 
   _onResponse() {
     runExt(
-      this.hemera._extensionManager.onResponse,
+      this[sReplyHemera]._extensionManager.onResponse,
       responseExtIterator,
-      this.hemera,
+      this[sReplyHemera],
       err => {
         if (err) {
           let internalError = new Errors.ParseError(
@@ -189,7 +195,7 @@ class Reply {
       error: this.error ? Errio.toObject(this.error) : null
     }
 
-    return this.hemera._serverEncoder(message)
+    return this[sReplyHemera]._serverEncoder(message)
   }
 }
 

packages/hemera/lib/symbols.js

@@ -10,6 +10,12 @@
  */
 
 module.exports = {
-  childrenKey: Symbol('hemera.children'),
-  registeredPlugins: Symbol('hemera.registered-plugin')
+  sChildren: Symbol('hemera.children'),
+  sRegisteredPlugins: Symbol('hemera.registered-plugin'),
+  sReplySent: Symbol('hemera.reply-sent'),
+  sReplyRequest: Symbol('hemera.reply-request'),
+  sReplyResponse: Symbol('hemera.reply-response'),
+  sReplyHemera: Symbol('hemera.reply-hemera'),
+  sReplyLog: Symbol('hemera.reply-log'),
+  sAddReceivedMsg: Symbol('hemera.add-receivedMsg')
 }