Skip to content

Commit 6487802

Browse files
alvinkrebsManuelJNunezalejnpalexcamposruizlloadholt
authored
IRONSIDE-1156 -- merge release/connector/1.3.0 to develop (#202)
* COMMUNITY-78: update submodule * COMMUNITY-86 | Backport COMMUNITY-79 and COMMUNITY-80 to release/connector/1.3.0 (#191) * COMMUNITY-86: backport COMMUNITY-79 back to release/connector/1.3.0 * COMMUNITY-86: backport COMMUNITY-80 back to release/connector/1.3.0 * COMMUNITY-86: update submodule * CON-305: Update Platform Notes (#192) * Apply suggestions from code review * CON-305: Update documentation (#194) * Fix license pdf (#197) * Use the current lts instead of the latest one (#196) * Use current lts instead of the latest one fixes #195 * 20 is equal to lts-iron * Update submodule commit * Update submodule commit * CON-311: Add warning to documentation (#199) * CON-311: Add warning to documentation * CON-311: Apply feedback * CON-311: Add GH Issue link * Update docs/release_notes.rst Co-authored-by: lloadholt <117761400+lloadholt@users.noreply.github.com> --------- Co-authored-by: lloadholt <117761400+lloadholt@users.noreply.github.com> * DOC-489: Correct headings in Previous Releases section (#200) * DOC-489: Correct headings in Previous Releases section * DOC-489: More corrections * DOC-489: Increase index depth * DOC-489: Heading corrections * Update release_notes.rst (#201) * IRONSIDE-1156 -- PR comment, must include lts in config file ... * Correct release_notes.rst Moved 1.0.0 text to heading "Version 1.0.0" * Update release_notes.rst --------- Co-authored-by: ManuelJNunez <manueljesusnunezruiz@gmail.com> Co-authored-by: Alejandro <alejnp@rti.com> Co-authored-by: Alex Campos <alejandro@rti.com> Co-authored-by: lloadholt <117761400+lloadholt@users.noreply.github.com>
1 parent c6a83c6 commit 6487802

3 files changed

Lines changed: 52 additions & 35 deletions

File tree

LICENSE.pdf

-40.2 KB
Binary file not shown.

docs/release_notes.rst

Lines changed: 51 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
Release Notes
2-
=============
2+
*************
33

44
Supported Platforms
5-
-------------------
5+
===================
66

77
*Connector* has been validated to run with the following Node.js versions:
8-
* v17
98
* v18
9+
* v19
1010
* v20
1111

12+
.. warning::
13+
Due to an upstream change in Node.js, **some versions will fail when building
14+
Connector dependencies**. This issue affects, at the very least,
15+
Node.js versions 18.20, 20.12 and 21.6.
16+
For more information, see `Github Issue #198 <https://github.com/rticommunity/rticonnextdds-connector-js/issues/198>`_.
17+
1218
Other versions may also work, but have not been validated internally.
1319
If you run into an issue, make sure that the issue can be reproduced
1420
in any of the versions listed above.
@@ -34,14 +40,17 @@ repository <https://github.com/rticommunity/rticonnextdds-connector>`__.
3440

3541

3642
Version 1.3.0
37-
-----------------
43+
=============
44+
45+
What's New in 1.3.0
46+
-------------------
3847

3948
*RTI Connector* 1.3.0 is built on
4049
`RTI Connext DDS 7.3.0 <https://community.rti.com/documentation/rti-connext-dds-730>`__.
4150

4251

4352
Failed to create a Connector in certain Node versions (18.8 or greater)
44-
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
53+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4554
.. CON-299
4655
4756
Due to an incompatibility in some *Connector* dependencies, it was not
@@ -60,10 +69,13 @@ This issue is known to have affected Node.js versions 18.8 and 20; other
6069
versions may also have been affected.
6170

6271
Previous Releases
63-
-----------------
72+
=================
6473

6574
Version 1.2.2
66-
^^^^^^^^^^^^^
75+
-------------
76+
77+
What's New in 1.2.2
78+
^^^^^^^^^^^^^^^^^^^
6779

6880
*RTI Connector* 1.2.2 is built on
6981
`RTI Connext DDS 6.1.2 <https://community.rti.com/documentation/rti-connext-dds-612>`__.
@@ -78,29 +90,32 @@ libraries are now built using Visual Studio 2015. The redistributable that is
7890
shipped has been updated accordingly.
7991

8092
Version 1.2.1
81-
^^^^^^^^^^^^^
93+
-------------
94+
95+
What's New in 1.2.1
96+
^^^^^^^^^^^^^^^^^^^
8297

8398
*Connector* 1.2.1 updates some third party dependencies that were found to contain
8499
vulnerabilities. *Connector* was not affected by these vulnerabilities.
85100

86101
Version 1.2.0
87-
^^^^^^^^^^^^^
102+
-------------
88103

89104
What's New in 1.2.0
90-
"""""""""""""""""""
105+
^^^^^^^^^^^^^^^^^^^
91106

92107
*RTI Connector* 1.2.0 is built on
93108
`RTI Connext DDS 6.1.1 <https://community.rti.com/documentation/rti-connext-dds-611>`__.
94109

95110
New Platforms
96-
+++++++++++++
111+
"""""""""""""
97112

98113
*Connector* has been validated on macOS 11 (Big Sur) systems on x64 and Arm v8
99114
CPUs (via x64 libraries).
100115

101116

102117
New API makes it easier to query what version of Connector is being used
103-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
118+
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
104119
.. CON-92
105120
106121
A new API, :meth:`Connector.getVersion`, has been added that provides the
@@ -109,10 +124,10 @@ libraries being used.
109124

110125

111126
What's Fixed in 1.2.0
112-
"""""""""""""""""""""
127+
^^^^^^^^^^^^^^^^^^^^^
113128

114129
Error logged when accessing string longer than 128 bytes
115-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
130+
""""""""""""""""""""""""""""""""""""""""""""""""""""""""
116131

117132
Previously, on an input, when accessing a string longer than 128 bytes, the
118133
following error was printed:
@@ -128,7 +143,7 @@ the string. The message is no longer printed.
128143

129144

130145
Support added for handling large 64-bit integers
131-
++++++++++++++++++++++++++++++++++++++++++++++++
146+
""""""""""""""""""""""""""""""""""""""""""""""""
132147

133148
Support has been improved for both getting and setting large (greater than 2^53)
134149
64-bit values. See :ref:`section-access-64-bit-integers-js` for more information.
@@ -137,7 +152,7 @@ Support has been improved for both getting and setting large (greater than 2^53)
137152

138153

139154
Promise returned by Output.wait did not resolve/reject
140-
++++++++++++++++++++++++++++++++++++++++++++++++++++++
155+
""""""""""""""""""""""""""""""""""""""""""""""""""""""
141156

142157
The Promise being returned by the Output.wait method (used to wait for
143158
acknowledgements on an output) was not being resolved or rejected. This
@@ -148,9 +163,8 @@ supplied timeout has elapsed.
148163

149164
[RTI Issue ID CON-227]
150165

151-
152166
Version 1.1.1
153-
^^^^^^^^^^^^^
167+
-------------
154168

155169
*Connector* 1.1.1 is built on *RTI Connext DDS* 6.1.0.3, which fixes several
156170
bugs in the Core Libraries. If you want more details on the bugs fixed in 6.1.0.3,
@@ -159,23 +173,23 @@ contact support@rti.com. These bugs are also fixed in
159173
upon which *RTI Connector* 1.2.0 is built.
160174

161175
Version 1.1.0
162-
^^^^^^^^^^^^^
176+
-------------
163177

164178
What's New in 1.1.0
165-
""""""""""""""""""""
179+
^^^^^^^^^^^^^^^^^^^
166180

167181
*RTI Connector* 1.1.0 is built on `RTI Connext DDS 6.1.0 <https://community.rti.com/documentation/rti-connext-dds-610>`__.
168182

169183
Support added for ARMv8 architectures
170-
+++++++++++++++++++++++++++++++++++++
184+
"""""""""""""""""""""""""""""""""""""
171185
.. CON-174
172186
173187
Connector for JavaScript now runs on ARMv8 architectures. Native libraries
174188
built for ARMv8 Ubuntu 16.04 are now shipped alongside Connector. These libraries
175189
have been tested on ARMv8 Ubuntu 16.04 and ARMv8 Ubuntu 18.04.
176190

177191
Support added for Node.js version 12
178-
++++++++++++++++++++++++++++++++++++
192+
""""""""""""""""""""""""""""""""""""
179193
.. CON-173
180194
181195
Previously, Node.js version 12 was not supported in *Connector* for JavaScript.
@@ -187,7 +201,7 @@ Connector for JavaScript.
187201

188202

189203
Sample state, instance state and view state can now be obtained in Connector
190-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
204+
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
191205
.. CON-177
192206
193207
The :class:`SampleInfo` class in *Connector* has been extended to provide access to the
@@ -199,7 +213,7 @@ new feature.
199213

200214

201215
Support for accessing the key values of disposed instances
202-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
216+
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
203217
.. CON-188
204218
205219
Support for disposing instances was added in *Connector* 1.0.0.
@@ -214,15 +228,15 @@ See :ref:`Accessing key values of disposed samples` for more
214228
information on this new feature.
215229

216230
Connector for Javascript dependencies now locked to specific versions
217-
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
231+
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
218232
.. CON-220
219233
220234
``package-lock.json`` has been committed, fixing the versions of *Connector for
221235
Javascript's* dependencies.
222236

223237

224238
Support for Security, Monitoring and other Connext DDS add-on libraries
225-
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
239+
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
226240

227241
.. CON-221
228242
@@ -231,10 +245,10 @@ that Connext DDS features such as Monitoring and Security Plugins are now suppor
231245
Refer to :ref:`Loading Connext DDS Add-On Libraries` for more information.
232246

233247
What's Fixed in 1.1.0
234-
""""""""""""""""""""""
248+
^^^^^^^^^^^^^^^^^^^^^
235249

236250
Creating two instances of Connector resulted in a license error
237-
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
251+
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
238252

239253
Under some circumstances, it was not possible to create two *Connector* objects.
240254
The creation of the second *Connector* object failed due to a license error.
@@ -245,7 +259,7 @@ This issue has been fixed.
245259

246260

247261
Some larger integer values may have been corrupted by Connector's internal JSON parser
248-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
262+
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
249263

250264
The internal JSON parser used in *Connector* failed to identify integer numbers
251265
from double-precision floating-point numbers for certain values.
@@ -257,7 +271,7 @@ become corrupted. This problem has been resolved.
257271

258272

259273
Support for loading multiple configuration files
260-
++++++++++++++++++++++++++++++++++++++++++++++++
274+
""""""""""""""""""""""""""""""""""""""""""""""""
261275

262276
A *Connector* object now supports loading multiple files. This allows separating
263277
the definition of types, QoS profiles, and *DomainParticipants* into different
@@ -271,7 +285,7 @@ files:
271285

272286

273287
Creating a Connector instance with a participant_qos tag in the XML may have resulted in a license error
274-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
288+
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
275289

276290
In some cases, if the XML configuration file of *Connector* contained a
277291
`<participant_qos>` tag within the definition of the *DomainParticipant*,
@@ -282,7 +296,7 @@ This problem has been resolved.
282296

283297

284298
Websocket example may have failed to run
285-
++++++++++++++++++++++++++++++++++++++++
299+
""""""""""""""""""""""""""""""""""""""""
286300

287301
The websocket example (available only in *Connector for Javascript*) may have
288302
failed to run due to one of its dependencies, socket.io, removing a public API.
@@ -292,7 +306,7 @@ This problem has been resolved.
292306

293307

294308
Version 1.0.0
295-
^^^^^^^^^^^^^
309+
-------------
296310

297311
1.0.0 is the first official release of *RTI Connector for JavaScript* as well as
298312
`RTI Connector for Python <https://community.rti.com/static/documentation/connector/1.0.0/api/python/index.html>`__.
@@ -305,7 +319,10 @@ APIs have been preserved for backward compatibility as much as possible.
305319

306320

307321
Vulnerability Assessments
308-
-------------------------
322+
=========================
309323
Internally, *Connector* relies on Lua. RTI has assessed the current version of
310324
Lua used by *Connector*, version 5.2, and found that *Connector* is not currently
311325
affected by any of the publicly disclosed vulnerabilities in Lua 5.2.
326+
327+
328+

0 commit comments

Comments
 (0)