diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 6ba9374..19de9e8 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -1,8 +1,8 @@ Release Notes -============= +************* Supported Platforms -------------------- +=================== *Connector* has been validated to run with the following Node.js versions: * v18 @@ -39,15 +39,18 @@ macOS® platforms. It has been tested on the following systems: repository `__. -Version 1.3.0 ------------------ +Version 1.2.2 +============= + +What's New in 1.2.2 +------------------- *RTI Connector* 1.3.0 is built on `RTI Connext DDS 7.3.0 `__. Failed to create a Connector in certain Node versions (18.8 or greater) -""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. CON-299 Due to an incompatibility in some *Connector* dependencies, it was not @@ -66,10 +69,13 @@ This issue is known to have affected Node.js versions 18.8 and 20; other versions may also have been affected. Previous Releases ------------------ +================= Version 1.2.2 -^^^^^^^^^^^^^ +------------- + +What's New in 1.2.2 +^^^^^^^^^^^^^^^^^^^ *RTI Connector* 1.2.2 is built on `RTI Connext DDS 6.1.2 `__. @@ -84,29 +90,32 @@ libraries are now built using Visual Studio 2015. The redistributable that is shipped has been updated accordingly. Version 1.2.1 -^^^^^^^^^^^^^ +------------- + +What's New in 1.2.1 +^^^^^^^^^^^^^^^^^^^ *Connector* 1.2.1 updates some third party dependencies that were found to contain vulnerabilities. *Connector* was not affected by these vulnerabilities. Version 1.2.0 -^^^^^^^^^^^^^ +------------- What's New in 1.2.0 -""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^ *RTI Connector* 1.2.0 is built on `RTI Connext DDS 6.1.1 `__. New Platforms -+++++++++++++ +""""""""""""" *Connector* has been validated on macOS 11 (Big Sur) systems on x64 and Arm v8 CPUs (via x64 libraries). New API makes it easier to query what version of Connector is being used -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. CON-92 A new API, :meth:`Connector.getVersion`, has been added that provides the @@ -115,10 +124,10 @@ libraries being used. What's Fixed in 1.2.0 -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ Error logged when accessing string longer than 128 bytes -++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""""""""""""""""""" Previously, on an input, when accessing a string longer than 128 bytes, the following error was printed: @@ -134,7 +143,7 @@ the string. The message is no longer printed. Support added for handling large 64-bit integers -++++++++++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""""""""""" Support has been improved for both getting and setting large (greater than 2^53) 64-bit values. See :ref:`section-access-64-bit-integers-js` for more information. @@ -143,7 +152,7 @@ Support has been improved for both getting and setting large (greater than 2^53) Promise returned by Output.wait did not resolve/reject -++++++++++++++++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""""""""""""""""" The Promise being returned by the Output.wait method (used to wait for acknowledgements on an output) was not being resolved or rejected. This @@ -154,9 +163,8 @@ supplied timeout has elapsed. [RTI Issue ID CON-227] - Version 1.1.1 -^^^^^^^^^^^^^ +------------- *Connector* 1.1.1 is built on *RTI Connext DDS* 6.1.0.3, which fixes several bugs in the Core Libraries. If you want more details on the bugs fixed in 6.1.0.3, @@ -165,15 +173,15 @@ contact support@rti.com. These bugs are also fixed in upon which *RTI Connector* 1.2.0 is built. Version 1.1.0 -^^^^^^^^^^^^^ +------------- What's New in 1.1.0 -"""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^ *RTI Connector* 1.1.0 is built on `RTI Connext DDS 6.1.0 `__. Support added for ARMv8 architectures -+++++++++++++++++++++++++++++++++++++ +""""""""""""""""""""""""""""""""""""" .. CON-174 Connector for JavaScript now runs on ARMv8 architectures. Native libraries @@ -181,7 +189,7 @@ built for ARMv8 Ubuntu 16.04 are now shipped alongside Connector. These librarie have been tested on ARMv8 Ubuntu 16.04 and ARMv8 Ubuntu 18.04. Support added for Node.js version 12 -++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""" .. CON-173 Previously, Node.js version 12 was not supported in *Connector* for JavaScript. @@ -193,7 +201,7 @@ Connector for JavaScript. Sample state, instance state and view state can now be obtained in Connector -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. CON-177 The :class:`SampleInfo` class in *Connector* has been extended to provide access to the @@ -205,7 +213,7 @@ new feature. Support for accessing the key values of disposed instances -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. CON-188 Support for disposing instances was added in *Connector* 1.0.0. @@ -220,7 +228,7 @@ See :ref:`Accessing key values of disposed samples` for more information on this new feature. Connector for Javascript dependencies now locked to specific versions -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. CON-220 ``package-lock.json`` has been committed, fixing the versions of *Connector for @@ -228,7 +236,7 @@ Javascript's* dependencies. Support for Security, Monitoring and other Connext DDS add-on libraries -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. CON-221 @@ -237,10 +245,19 @@ that Connext DDS features such as Monitoring and Security Plugins are now suppor Refer to :ref:`Loading Connext DDS Add-On Libraries` for more information. What's Fixed in 1.1.0 -"""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ + +1.0.0 is the first official release of *RTI Connector for JavaScript* as well as +`RTI Connector for Python `__. + +If you had access to previous experimental releases, this release makes the product +more robust, modifies many APIs and adds new functionality. However the old +APIs have been preserved for backward compatibility as much as possible. + +*RTI Connector* 1.0.0 is built on `RTI Connext DDS 6.0.1 `__. Creating two instances of Connector resulted in a license error -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Under some circumstances, it was not possible to create two *Connector* objects. The creation of the second *Connector* object failed due to a license error. @@ -251,7 +268,7 @@ This issue has been fixed. Some larger integer values may have been corrupted by Connector's internal JSON parser -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" The internal JSON parser used in *Connector* failed to identify integer numbers from double-precision floating-point numbers for certain values. @@ -263,7 +280,7 @@ become corrupted. This problem has been resolved. Support for loading multiple configuration files -++++++++++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""""""""""" A *Connector* object now supports loading multiple files. This allows separating the definition of types, QoS profiles, and *DomainParticipants* into different @@ -277,7 +294,7 @@ files: Creating a Connector instance with a participant_qos tag in the XML may have resulted in a license error -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" In some cases, if the XML configuration file of *Connector* contained a `` tag within the definition of the *DomainParticipant*, @@ -288,7 +305,7 @@ This problem has been resolved. Websocket example may have failed to run -++++++++++++++++++++++++++++++++++++++++ +"""""""""""""""""""""""""""""""""""""""" The websocket example (available only in *Connector for Javascript*) may have failed to run due to one of its dependencies, socket.io, removing a public API. @@ -297,21 +314,8 @@ This problem has been resolved. [RTI Issue ID CON-217] -Version 1.0.0 -^^^^^^^^^^^^^ - -1.0.0 is the first official release of *RTI Connector for JavaScript* as well as -`RTI Connector for Python `__. - -If you had access to previous experimental releases, this release makes the product -more robust, modifies many APIs and adds new functionality. However the old -APIs have been preserved for backward compatibility as much as possible. - -*RTI Connector* 1.0.0 is built on `RTI Connext DDS 6.0.1 `__. - - Vulnerability Assessments -------------------------- +========================= Internally, *Connector* relies on Lua. RTI has assessed the current version of Lua used by *Connector*, version 5.2, and found that *Connector* is not currently affected by any of the publicly disclosed vulnerabilities in Lua 5.2.