vrpc 3.0.2 → 3.1.0

package/CHANGELOG.md

@@ -5,7 +5,57 @@ 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.2] - Feb 8 2022
+## [3.1.0] - Jun 15 2022
+
+### Added
+
+- possibility to set a user-defined MQTT client ID for both, agent and client [#56]
+- possibility to set a user-defined VRPC client identity
+
+### Fixed
+
+- potential access to null object resulting in remote exception
+- more defensive programming when client used an non-emitter instance for
+  registering events
+- potential application crash when VrpcNative was provided with a bad callback
+  which got called from within C++
+
+### Changed
+
+- switched domain and agent separator from `:` to `/` when generating username
+
+## [3.0.4] - Apr 04 2022
+
+### Added
+
+- automatic token generation when no token and not password were provided
+
+### Changed
+
+- changed agent to always run connect with clean session
+- changed generated username on agent to include domain information
+- generating username when neither token nor password are provided
+- changed client's username generation to as well include domain information
+  disconnects on inactive browser pages
+- added agent name info to token generator (allows to run in same folder)
+
+### Fixed
+
+- agent simplification should fix subscription issues when broker gets restarted
+- removed `os.userInfo()` from generated client username as browsers do not
+  support this function
+- failing mqtt reconnection when using websocket on a browser that goes inactive
+- removed changing `os.cpus()` call making the clientId stable on same executable
+- serious bug while cleaning up event-registrations resulting from "callAll"
+
+## [3.0.3] - Feb 09 2022
+
+### Fixed
+
+- again generating implicit username (when none is given) as MQTT does not
+  support handing over password only
+
+## [3.0.2] - Feb 08 2022
 
 ### Changed
 
@@ -96,8 +146,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- injection of proxy-, instance-, and client id into proxy instance [Node.js] (#49)
-- public accessor for client id [Node.js] (#49)
+- 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]
 
@@ -178,9 +228,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Fixed
 
-- domain inconsistency in the VrpcRemote API [Node.js] (#33)
+- domain inconsistency in the VrpcRemote API [Node.js](#33)
 - webpack-5 crash, using custom browser library now (#36)
-- missing callback when same native addon was loaded to different VrpcLocal instances [Node.js] (#31)
+- missing callback when same native addon was loaded to different VrpcLocal instances [Node.js](#31)
 
 ### Changed
 
@@ -188,7 +238,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- possibility to unregister an offline agent [Node.js] (#32)
+- possibility to unregister an offline agent [Node.js](#32)
 
 ## [2.3.1] - 02 Feb 2021
 
@@ -196,7 +246,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Wrong `break` statements when inspecting the client cache for instances to be
   attached to [Node.js]
-- Compilation error on non-copyable classes [C++-Addon] (#22)
+- Compilation error on non-copyable classes [C++-Addon](#22)
 
 ## [2.3.0] - 13 Jan 2021
 
@@ -323,7 +373,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Issues with `VrpcRemote::getInstance` ignoring defaults or throwing wrong
   exceptions [Node.js]
 
-
 ### Added
 
 - Initial example code for a minimal Todos Application using react-vrpc
@@ -477,7 +526,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - proper waiting until all INFO messages arrived
 - automatic un-subscription of dead-client events
 
-
 ## [2.1.0-alpha.0] - 11 Nov 2019
 
 ### Added
@@ -564,7 +612,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Currently the validity of the server certificate will be trusted
 - Removed the need of automatically building native add-on during vrpc installation
 
-
 ## [2.0.0-alpha.7] - 01 Apr 2019
 
 ### Fixed
@@ -613,7 +660,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Adapter and Proxy can now use username and password for MQTT authentication
 - ClientIDs are not longer random generated but explicitly set
-- Added __static__ keyword to wire protocol as placeholder for the instance
+- Added **static** keyword to wire protocol as placeholder for the instance
   position in case of static function
 - Updated README to reflect latest documentation
 
@@ -658,34 +705,34 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Fixed
 
-  - Re-registration problem for emitter based callbacks resulting in multiplied callbacks
+- Re-registration problem for emitter based callbacks resulting in multiplied callbacks
 
 ## [1.1.6] - 31 Mar 2018
 
-  - Nothing changed, this tag is identical to 1.1.5 for a technical issue during
-    publishing
+- Nothing changed, this tag is identical to 1.1.5 for a technical issue during
+  publishing
 
 ## [1.1.5] - 14 Jun 2018
 
 ### Changed
 
-  - Increased maximum number of inflight ("open") callbacks
-  - Updated dependent packages
+- Increased maximum number of inflight ("open") callbacks
+- Updated dependent packages
 
 ## [1.1.4] - 04 Jun 2018
 
 ### Added
 
-  - Low-level addon tests
+- Low-level addon tests
 
 ### Changed
 
-  - vrpc's callCpp function to throw runtime exception in case of issues
-  - DRYed addon.cpp, improved string conversions and exception text
+- vrpc's callCpp function to throw runtime exception in case of issues
+- DRYed addon.cpp, improved string conversions and exception text
 
 ### Fixed
 
-  - Dev-Ops issue if installing twice (`cpp` soft-link is now forced)
+- Dev-Ops issue if installing twice (`cpp` soft-link is now forced)
 
 ## [1.1.3] - 01 Jun 2018
 
@@ -719,7 +766,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - This CHANGELOG.md file
 - pandoc generated REAMDE.rst file
 
-
 ### Changed
 
 - Renamed source folder `cpp` into `vrpc`, needed to please python's setup tools
@@ -737,7 +783,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Python proxy constructor to be callable with variadic arguments
 - Syntactic problems in `REAMDE.md` leading to mistakes in auto rst translation
 
-
 ## [1.0.2] - 16 Mar 2018
 
 ### Changed
@@ -748,8 +793,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Unnecessary npm-dependency `shortid`
 
-
-
 ## [1.0.1] - 14 Mar 2018
 
 ### Added
@@ -760,8 +803,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Typo and missing brace in `README.md`
 
-
-
 ## [1.0.0] - 14 Mar 2018
 
 First public release