SocketAdapter TypeScript refactor by drewhoener · Pull Request #926 · RobotWebTools/roslibjs

drewhoener · 2025-08-19T05:45:53Z

Public API Changes
None

Overview

This PR is a refactor of the SocketAdapter module to TypeScript.
While doing it, I ran into a few curiosities - a good portion of the JSDoc doesn't seem to match up with how the events emitted are actually used in examples.
When reviewing, see SocketAdapter.ts, there's a few FIXME items in particular I'd like to get answers for before merging.

/**
 * FIXME: Need Answers:
 * 1. onopen emits 'connection' event with an object, the typedoc says it's a function, but no examples use it. What is this type?
 * 2. onclose emits 'close' event with an object, the typedoc says it's a function, but no examples use it. What is this type?
 * 3. onerror emits 'error' event with an object, the typedoc says it's a function, but every example uses it like a string. What is this type?
 */

This PR also replaces the old cbor-js dependancy with cbor2 which is much more active; cbor-js hasn't been published in 10 years 0.o.
I don't think it constitutes a breaking change since everything works the same in terms of public API but it's worth calling out as a significant refactor under the hood.
I'm half expecting for you to ask me to move it to a new PR lol, lmk if that's what you want.

Migrating to cbor2 is a good step for a native typescript project. cbor-js didn't have any typedefs beyond encode and decode functions that returned any and didn't document the extra decoding function that was used.
Speaking of which, cbor2 natively supports all the types that were being bootstrapped by the cborTypedArray module, so it's no longer needed.

I did have a bit of an issue when implementing it though, the tests expect BigInt64 and BigUInt64 decode methods to return a plain array of numbers, even when cbor2 correctly decodes it as a BigInt64Array. I added in a shim utility method to support the truncation that was being done before but it struck me as a bit weird...

Other things of note

Added in some extensive typing of the RosBridge protocol to support the refactor to the Ros client module later on.
Moved GoalStatus to its own typing module for the same reason, it'll help with organization when more Ros2 types need to be added in to support things like the RosAPI messages
Added a module for type assertion utils and things of that sort
Allow explicit any in eslint, it's helpful for typing the tricker elements when unknown just won't do the trick

As always, please feel free to leave feedback :)

Supports #904

cbor-js was last published 10+ years ago, stable support is provided by `cbor`, and now the `cbor2` package. The `cbor2` library is written natively in typescript and supports all the tags we were shimming with cborTypedArrayTags.js. It also supports adding new encoders/decoders later as part of its feature set. Should be fixed up in the future to address loss of precision expected by old cbor typing functions Signed-off-by: Drew Hoener <drewhoener@gmail.com>

Signed-off-by: Drew Hoener <drewhoener@gmail.com>

…not included or bundled in any way Signed-off-by: Drew Hoener <drewhoener@gmail.com>

…evant ROS2 messages. Signed-off-by: Drew Hoener <drewhoener@gmail.com>

Signed-off-by: Drew Hoener <drewhoener@gmail.com>

…e in the future. Signed-off-by: Drew Hoener <drewhoener@gmail.com>

…module Signed-off-by: Drew Hoener <drewhoener@gmail.com>

EzraBrooks · 2025-08-19T14:56:55Z

src/core/SocketAdapter.ts

+export default function SocketAdapter(client: Ros): ISocketAdapter {
+  let decoder: Nullable<((raw: unknown, outputFunc: (message: object) => void) => void)> = null;
+  // FIXME: Ros Client types not ready yet
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access


Is this chicken-or-the-egg or could we do this first?

More of a chicken-egg thing. If I did the ROS client first, I'd have the same comments in there defering the lint check until the socket types are ready.
FWIW I have the Ros client mostly done, but I figured this would make sense as 2 PRs

EzraBrooks · 2025-08-19T14:58:13Z

eslint.config.js

      },
+    },
+    rules: {
+      '@typescript-eslint/no-explicit-any': 0,


Personally I'd prefer we hold unknown data in unknown not any, but I won't be super picky about that if you feel strongly since I could see it being a barrier to contribution for people who aren't TypeScript experts.

I can defer this one, I had it at one point because I had a really uncooperative type but I ended up smoothing it out. It can probably be dropped for now

EzraBrooks · 2025-08-19T14:58:30Z

src/core/Action.js

      action: this.name,
      values: result,
-      status: GoalStatus.STATUS_CANCELED,
+      status: GoalStatus.Canceled,


Isn't changing these member names technically an API-breaking change?

I didn't think so. GoalStatus was just used in Action and wasn't exported from an index.js file, so it wasn't exposed in the actual "public api". People might have been using it, but it would've been from the dist folder which IMO doesn't count as public API. Happy to discuss it though

EzraBrooks · 2025-08-19T14:58:53Z

src/core/SocketAdapter.js

looks like git mv isn't cooperating here..

If you want the file history I can do the same dance with the linter/checker we did before?

EzraBrooks · 2025-11-06T18:55:08Z

Superseded by #1004

drewhoener changed the title ~~Feature/typescript cbor socket~~ SocketAdapter TypeScript refactor Aug 19, 2025

drewhoener added 8 commits August 19, 2025 01:55

refactor(SocketAdapter): Rename from JS to TS.

f68a68b

Signed-off-by: Drew Hoener <drewhoener@gmail.com>

refactor(BSON): Add type extension for global bson object since it's …

b6bd560

…not included or bundled in any way Signed-off-by: Drew Hoener <drewhoener@gmail.com>

refactor(types): Add types to describe the RosBridge protocol and rel…

1d3b5ca

…evant ROS2 messages. Signed-off-by: Drew Hoener <drewhoener@gmail.com>

feat(type-utils): Add type utils module

763400b

Signed-off-by: Drew Hoener <drewhoener@gmail.com>

refactor(SocketAdapter): Convert SocketAdapter module to typescript

988cb0b

Signed-off-by: Drew Hoener <drewhoener@gmail.com>

refactor(eslint): Allow explicit any for types we might have to coerc…

7068a0d

…e in the future. Signed-off-by: Drew Hoener <drewhoener@gmail.com>

refactor(GoalStatus): Remove old GoalStatus enum, point to new types …

8004243

…module Signed-off-by: Drew Hoener <drewhoener@gmail.com>

drewhoener force-pushed the feature/typescript-cbor-socket branch from 2e6dbf0 to 8004243 Compare August 19, 2025 05:55

drewhoener mentioned this pull request Aug 18, 2025

Convert library to Typescript Roadmap #904

Closed

13 tasks

EzraBrooks reviewed Aug 19, 2025

View reviewed changes

EzraBrooks closed this Nov 6, 2025

drewhoener mentioned this pull request Nov 18, 2025

Switch from cbor-js to cbor2 #1096

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SocketAdapter TypeScript refactor#926

SocketAdapter TypeScript refactor#926
drewhoener wants to merge 8 commits intoRobotWebTools:developfrom
drewhoener:feature/typescript-cbor-socket

drewhoener commented Aug 19, 2025

Uh oh!

EzraBrooks Aug 19, 2025

Uh oh!

drewhoener Aug 19, 2025

Uh oh!

EzraBrooks Aug 19, 2025

Uh oh!

drewhoener Aug 19, 2025

Uh oh!

EzraBrooks Aug 19, 2025

Uh oh!

drewhoener Aug 19, 2025

Uh oh!

EzraBrooks Aug 19, 2025

Uh oh!

drewhoener Aug 19, 2025

Uh oh!

EzraBrooks commented Nov 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

drewhoener commented Aug 19, 2025

Overview

Other things of note

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EzraBrooks commented Nov 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants