vrpc 2.6.0 → 3.0.0

package/CHANGELOG.md

@@ -5,6 +5,89 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [3.0.0] - Jan 20 2022
+
+### Added
+
+- `vrpcOn` / `vrpcOff` feature to client
+- tests exclusively for VrpcAdapter
+- support for `path.join(__dirname, <path>)` expressions when registering class
+
+### Fixed
+
+- unhandled promise rejection on initial connect timeout
+- missing documentation for VrpcNative
+- bug on new `vrpcOn` feature
+- bug while unregister event listeners via "off" or "removeAllListeners"
+
+### Changed
+
+- error messages as triggered on remote agents (now include context info)
+- removed obsolete public API from VrpcAdapter
+- internal handling of EventEmitter subscriptions
+  - now publishing a single message per event to a fixed topic
+  - dispatching happens by the broker not by the agent anymore
+  - this saves a lot of traffic when many clients subscribe to same events
+- reduced size of response messages by skipping redundant information
+- order of items within RPC message
+- promise rejection message as triggered on remote agents (now include context
+  info)
+
+## [3.0.0-alpha.3] - 25 Nov 2021
+
+### Fixed
+
+- missing 'create' event in VrpcAdapter
+- respecting isolation state in callAll
+
+### Changed
+
+- cleaned API and tests from deprecation supports, those will now result in
+  errors
+- intercepting return value of EventEmitter functions and changing it from
+  potentially gigantic object (as it returns `this`) to `true`
+
+## [3.0.0-alpha.2] - 19 Nov 2021
+
+### Fixed
+
+- leaking event registrations on remote-controlled instance when event consumer
+  was not creator of the instance
+
+## Changed
+
+- reduced payload of callback message by omitting the original return value
+- changed prefix of mqtt client id to `vc3` and `va3`, respectively
+
+## [3.0.0-alpha.1] - 10 Nov 2021
+
+### Changed
+
+- layout and content of this repository, only javascript related code is left
+- naming of public API classes is made consistent
+  - VrpcAdapter
+  - VrpcAgent
+  - VrpcClient (formerly VrpcRemote)
+  - VrpcNative (formerly VrpcLocal)
+- RPC wire protocol got changed and simplified, a protocol version is attached
+  to every message (`v: 3`)
+- concept of isolated and shared proxy instances
+  ([#51](https://github.com/heisenware/vrpc/issues/51)) got implemented
+- all namings including 'binding' got renamed for the more appropriate 'adapter'
+- calling embedded C++ code got a completely new API (VrpcNative)
+
+### Added
+
+- injection of proxy-, instance-, and client id into proxy instance [Node.js] (#49)
+- public accessor for client id [Node.js] (#49)
+- signal `clientGone` on agent, indicating that a state-changing client went
+  [Node.js]
+
+### Fixed
+
+- Bug during clientId extraction for an exited client (causing leaks for
+  anonymous instances)
+
 ## [2.6.0] - 12 Jul 2021
 
 ### Added

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 - 2021 Dr. Burkhard C. Heisen
+Copyright (c) 2018 - 2022 Dr. Burkhard C. Heisen
 
 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/README.md

@@ -1,76 +1,50 @@
 # VRPC - Variadic Remote Procedure Calls
 
-[![Build Status](https://travis-ci.com/heisenware/vrpc.svg?branch=master)](https://travis-ci.com/heisenware/vrpc)
-[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/heisenware/vrpc/master/LICENSE)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/heisenware/vrpc-js/master/LICENSE)
 [![Semver](https://img.shields.io/badge/semver-2.0.0-blue)](https://semver.org/spec/v2.0.0.html)
-[![GitHub Releases](https://img.shields.io/github/tag/heisenware/vrpc.svg)](https://github.com/heisenware/vrpc/tag)
-[![GitHub Issues](https://img.shields.io/github/issues/heisenware/vrpc.svg)](http://github.com/heisenware/vrpc/issues)
+[![GitHub Releases](https://img.shields.io/github/tag/heisenware/vrpc-js.svg)](https://github.com/heisenware/vrpc-js/tag)
+[![GitHub Issues](https://img.shields.io/github/issues/heisenware/vrpc-js.svg)](http://github.com/heisenware/vrpc-js/issues)
+![ci](https://github.com/heisenware/vrpc-js/actions/workflows/ci.yml/badge.svg)
 
----
-## Visit our website: https://vrpc.io
----
+## Visit our website: [vrpc.io](https://vrpc.io)
 
 ## What is VRPC?
 
-VRPC - Variadic Remote Procedure Calls - is a modern and asynchronous
-implementation of the old RPC (remote procedure calls) idea. Basically, it
-allows to directly call functions written in any programming language by
-functions written in any other (or the same) programming language.
+VRPC - Variadic Remote Procedure Calls - is an enhancement of the old RPC
+(remote procedure calls) idea. Like RPC, it allows to directly call functions
+written in any programming language by functions written in any other (or the
+same) programming language. Unlike RPC, VRPC furthermore supports:
 
-VRPC is modern as existing code can be made remotely callable:
+- non-intrusive adaption of existing code, making it callable remotely
+- remote function calls on many distributed receivers at the same time (one
+  client - multiple agents)
+- service discovery
+- outbound-connection-only network architecture (using MQTT technology)
+- isolated (multi-tenant) and shared access modes to remote resources
+- asynchronous language constructs (callbacks, promises, event-loops)
+- OOP (classes, objects, member functions) and functional (lambda) patterns
+- exception forwarding
 
-- without having to change it
-- without the need to program any binding code or complex
-  schemas
-- without the need to run a server
+VRPC is available for an entire spectrum of programming technologies including
+embedded, data-science, and web technologies.
 
-VRPC is unique as it supports the full power of the programming language in use,
-such as:
+As a robust and highly performing communication system, it can build the
+foundation of complex digitization projects in the area of (I)IoT or
+Cloud-Computing.
 
-- automated memory handling
-- language native and custom data type support
-- callback mechanisms
-- asynchronicity (i.e. event-loop integration)
-- exception handling
-- object orientation
-- lambda and closures support
+## This is VRPC for Javascript (Node.js and Browser)
 
-Depending on the targeted technologies, VRPC ships as a library (static or
-dynamic linkage), executable or source package.
+Understand how to use it by looking at the examples:
 
-## Examples
+- [Agent Example](examples/01-agent/README.md)
+- [Client Example](examples/02-client/README.md)
+- [Simple C++ Embedding Example](examples/03-native-simple/README.md)
+- [Advanced C++ Embedding Example](examples/04-native-advanced/README.md)
 
-### Embedding C++ into Node.js
+Get all the details by reading the documentation:
 
-- [Simple C++ to Node.js Binding Example](docs/examples/CppNodeExample1.md)
-- [Advanced C++ to Node.js Binding Example](docs/examples/CppNodeExample2.md)
+- [API Reference](docs/api.md)
+- [RPC Protocol Details](docs/protocol.md)
 
-### Embedding C++ into Python3
-
-- [Simple C++ to Python Binding Example](docs/examples/CppPythonExample1.md)
-- [Advanced C++ to Python Binding Example](docs/examples/CppPythonExample2.md)
-
-### Making existing C++ code remotely callable (agent)
-
-- [Simple C++ Agent Example](docs/examples/CppAgentLinuxExample1.md)
-- [Advanced C++ Agent Example](docs/examples/CppAgentLinuxExample2.md)
-
-### Making existing Node.js code remotely callable (agent)
-
-- [Node.js Agent Example](docs/examples/NodeAgentExample.md)
-
-### Calling code remotely from Node.js (client)
-
-- [Node.js Remote Client Example](docs/examples/NodeClientExample.md)
-
-### Frontend-Backend communication
-
-- [Simple React Todos App](https://github.com/heisenware/react-vrpc/tree/master/examples/vrpc-react-todos-1)
-- [Advanced React Todos App](https://github.com/heisenware/react-vrpc/tree/master/examples/vrpc-react-todos-2)
-
-## Reference Documentation
-
-- [RPC Protocol Details](docs/reference/remoteProtocol.md)
-- [C++ Binding Syntax](docs/reference/cppBinding.md)
-- [C++ Agent](docs/reference/cppAgent.md)
-- [Node.js API](docs/reference/nodeJs.md)
+> This open-source project is professionally managed and supported by
+> [Heisenware GmbH](https://heisenware.com).

package/binding.gyp.no-auto

@@ -6,8 +6,6 @@
         ['"<!(echo $VRPC_DEBUG)"=="1"', {'defines': ['VRPC_DEBUG']}],
       ],
       'defines': ['VRPC_WITH_DL'],
-      'sources': ['vrpc/addon.cpp'],
-      'include_dirs': ['cpp'],
       'cflags_cc!': ['-std=gnu++0x', '-fno-rtti', '-fno-exceptions'],
       'cflags_cc': ['-std=c++14', '-fPIC'],
       'conditions': [
@@ -17,7 +15,9 @@
             'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
           }
         }]
-      ]
+      ],
+      'sources': ['vrpc/addon.cpp'],
+      'include_dirs': ['.']
     },
     {
       'target_name': 'vrpc_test',
@@ -36,29 +36,7 @@
         }]
       ],
       'sources': ['vrpc/addon.cpp'],
-      'include_dirs': ['vrpc', 'test/fixtures']
+      'include_dirs': ['.', 'tests/native/fixtures']
     },
-    {
-      'target_name': 'vrpc-test',
-      'target_conditions': [
-        ['"<!(echo $VRPC_DEBUG)"=="1"', {'defines': ['VRPC_DEBUG']}],
-      ],
-      'type': 'executable',
-      'sources': [
-        'test/cpp/main.cpp',
-        'test/cpp/vrpcTest.cpp'
-      ],
-      'include_dirs': ['third_party/include', 'vrpc'],
-      'cflags_cc!': ['-std=gnu++0x', '-fno-rtti', '-fno-exceptions'],
-      'cflags_cc': ['-std=c++14'],
-      'conditions': [
-        ['OS=="mac"', {
-          'xcode_settings': {
-            'GCC_ENABLE_CPP_RTTI': 'YES',
-            'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
-          }
-        }]
-      ]
-    }
   ]
 }