vrpc 3.14.0 → 3.15.0

package/vrpc/VrpcNative.js

@@ -16,7 +16,7 @@ Author: Dr. Burkhard C. Heisen (https://github.com/heisenware/vrpc)
 
 
 Licensed under the MIT License <http://opensource.org/licenses/MIT>.
-Copyright (c) 2018 - 2022 Dr. Burkhard C. Heisen <burkhard.heisen@heisenware.com>.
+Copyright (c) 2018 Dr. Burkhard C. Heisen <burkhard.heisen@heisenware.com>.
 
 Permission is hereby  granted, free of charge, to any  person obtaining a copy
 of this software and associated  documentation files (the "Software"), to deal
@@ -57,10 +57,15 @@ class VrpcNative {
 
     // register callback handler
     this._adapter.onCallback(data => {
-      // when a javascript VrpcAdapter was used we will receive an object, in
-      // all other cases data will be a string (crossing language boundaries)
-      const json = typeof data === 'string' ? JSON.parse(data) : data
-      this._eventEmitter.emit(json.i, json.a)
+      // the native adapter hands over a string (crossing language
+      // boundaries): a callback or an event `{ a, i }`, or the second answer
+      // of a promise `{ r | e, i }`, which goes on as a whole
+      const json = JSON.parse(data)
+      const { i } = json
+      this._eventEmitter.emit(
+        i,
+        typeof i === 'string' && i.startsWith('__p__') ? json : json.a
+      )
     })
   }
 

package/vrpc/VrpcPersistor.js

@@ -14,7 +14,7 @@ procedure calls (RPC).
 Author: Dr. Burkhard C. Heisen (https://github.com/heisenware/vrpc)
 
 Licensed under the MIT License <http://opensource.org/licenses/MIT>.
-Copyright (c) 2018 - 2022 Dr. Burkhard C. Heisen <burkhard.heisen@heisenware.com>.
+Copyright (c) 2018 Dr. Burkhard C. Heisen <burkhard.heisen@heisenware.com>.
 
 Permission is hereby  granted, free of charge, to any  person obtaining a copy
 of this software and associated  documentation files (the "Software"), to deal

package/vrpc/adapter.hpp

@@ -16,7 +16,7 @@ Author: Dr. Burkhard C. Heisen (https://github.com/heisenware/vrpc-hpp)
 
 
 Licensed under the MIT License <http://opensource.org/licenses/MIT>.
-Copyright (c) 2018 - 2022 Dr. Burkhard C. Heisen
+Copyright (c) 2018 Dr. Burkhard C. Heisen
 <burkhard.heisen@heisenware.com>.
 
 Permission is hereby  granted, free of charge, to any  person obtaining a copy

package/vrpc/addon.cpp

@@ -15,7 +15,7 @@ Author: Dr. Burkhard C. Heisen (https://github.com/heisenware/vrpc)
 
 
 Licensed under the MIT License <http://opensource.org/licenses/MIT>.
-Copyright (c) 2018 - 2022 Dr. Burkhard C. Heisen
+Copyright (c) 2018 Dr. Burkhard C. Heisen
 <burkhard.heisen@heisenware.com>.
 
 Permission is hereby  granted, free of charge, to any  person obtaining a copy

package/vrpc/comment-parser/parser.js

@@ -189,11 +189,19 @@ function parse_block (source, opts) {
 /**
  * Produces `extract` function with internal state initialized
  */
+// A class declaration: `class Name`, also exported or assigned to module.exports
+const CLASS_DECLARATION = /^(\s*)(?:export\s+(?:default\s+)?)?(?:module\.exports\s*=\s*)?class\s+([\w$]+)/
+
 function mkextract (opts) {
   let chunk = null
   let indent = 0
   let number = 0
   let findMethod = false
+  // the class whose body the lines are in: its name and the indentation of
+  // its declaration; a function indented deeper belongs to it
+  let scope = null
+  // whether the lines are inside a /** ... */ block
+  let commentOpen = false
 
   opts = Object.assign({}, {
     trim: true,
@@ -217,6 +225,14 @@ function mkextract (opts) {
     const startPos = line.indexOf(MARKER_START)
     const endPos = line.indexOf(MARKER_END)
 
+    // in the code: where a class begins, and where its body ends
+    if (!commentOpen && startPos === -1) {
+      const declared = line.match(CLASS_DECLARATION)
+      const closing = scope && line.match(/^(\s*)\}/)
+      if (declared) scope = { name: declared[2], indent: declared[1].length }
+      else if (closing && closing[1].length === scope.indent) scope = null
+    }
+
     // if open marker detected and it's not, skip one
     if (startPos !== -1 && line.indexOf(MARKER_START_SKIP) !== startPos) {
       // A block still waiting for its function is followed by another
@@ -247,6 +263,9 @@ function mkextract (opts) {
       if (ret) {
         result = parse_block(chunk, opts)
         result.functionName = ret[1]
+        result.isStatic = /^\s*static\s/.test(line)
+        const depth = line.match(/^\s*/)[0].length
+        result.className = scope && depth > scope.indent ? scope.name : null
         findMethod = false
       }
     }
@@ -292,6 +311,9 @@ function mkextract (opts) {
       }
     }
 
+    if (startPos !== -1) commentOpen = true
+    if (endPos !== -1) commentOpen = false
+
     number += 1
     return result
   }
@@ -316,3 +338,4 @@ module.exports = function parse (source, opts) {
 
 module.exports.PARSERS = PARSERS
 module.exports.mkextract = mkextract
+module.exports.CLASS_DECLARATION = CLASS_DECLARATION

package/vrpc/namePattern.js

@@ -0,0 +1,86 @@
+'use strict'
+
+/**
+ * Name patterns and selections (docs/spec/protocol.md, section 11).
+ *
+ * In a pattern, `*` matches any run of characters, none included; every
+ * other character matches itself, case counts, and nothing else is special.
+ * A selection is a pattern or a non-empty list of them; it selects a name
+ * one of them matches.
+ *
+ * Matching takes time in proportion to the lengths of pattern and name,
+ * whatever they hold: no backtracking a name could make explode.
+ *
+ * @private
+ */
+
+/**
+ * Whether a pattern matches a name
+ *
+ * @param {String} pattern
+ * @param {String} name
+ * @returns {Boolean}
+ */
+function matches (pattern, name) {
+  let p = 0
+  let n = 0
+  // the last `*` seen, and the position in the name it stands at
+  let star = -1
+  let mark = 0
+  while (n < name.length) {
+    if (p < pattern.length && pattern[p] === '*') {
+      star = p++
+      mark = n
+    } else if (p < pattern.length && pattern[p] === name[n]) {
+      p++
+      n++
+    } else if (star !== -1) {
+      // the last `*` takes one more character
+      p = star + 1
+      n = ++mark
+    } else {
+      return false
+    }
+  }
+  while (p < pattern.length && pattern[p] === '*') p++
+  return p === pattern.length
+}
+
+/**
+ * Whether a value is a selection: a non-empty string, or a non-empty list
+ * of them
+ *
+ * @param {Any} selection
+ * @returns {Boolean}
+ */
+function isSelection (selection) {
+  const isPattern = x => typeof x === 'string' && x.length > 0
+  return Array.isArray(selection)
+    ? selection.length > 0 && selection.every(isPattern)
+    : isPattern(selection)
+}
+
+/**
+ * Whether a selection selects a name
+ *
+ * @param {String|Array.<String>} selection
+ * @param {String} name
+ * @returns {Boolean}
+ */
+function selects (selection, name) {
+  return Array.isArray(selection)
+    ? selection.some(pattern => matches(pattern, name))
+    : matches(selection, name)
+}
+
+/**
+ * Whether a selection is everything: `*`, alone or in its list
+ *
+ * @param {String|Array.<String>} selection
+ * @returns {Boolean}
+ */
+function selectsAll (selection) {
+  return Array.isArray(selection) ? selection.includes('*') : selection === '*'
+}
+
+module.exports = { matches, isSelection, selects, selectsAll }

package/vrpc/vrpc-agent-js

@@ -3,17 +3,9 @@
 'use strict'
 
 const { ArgumentParser } = require('argparse')
-const crypto = require('crypto')
-const os = require('os')
 const VrpcAgent = require('./VrpcAgent')
 const path = require('path')
 
-function generateAgentName () {
-  const { username } = os.userInfo()
-  const pathId = crypto.createHash('md5').update(path.resolve()).digest('hex').substr(0, 4)
-  return `${username}-${pathId}@${os.hostname()}-${os.platform()}-js`
-}
-
 const parser = new ArgumentParser({
   add_help: true,
   description: 'Starts a vrpc agent for node.js'
@@ -29,9 +21,9 @@ parser.add_argument(
 parser.add_argument(
   ['-a', '--agent'],
   {
-    help: 'Name of the agent for remote addressing',
+    help: 'Name of the agent for remote addressing (default: stable for this installation)',
     type: 'string',
-    default: generateAgentName()
+    default: VrpcAgent._generateAgentName()
   }
 )
 parser.add_argument(
@@ -71,7 +63,7 @@ parser.add_argument(
   {
     help: 'Returns the VRPC version this client was built with.',
     action: 'version',
-    version: 'v2.3.2'
+    version: `v${require('../package.json').version}`
   }
 )