From 95d6c4c682ffbc2930a82d4e4ae432bb88156976 Mon Sep 17 00:00:00 2001 From: Ezra Brooks Date: Mon, 17 Nov 2025 11:24:01 -0700 Subject: [PATCH] Revert rename of connection event --- package.json | 2 +- src/core/Ros.ts | 8 ++++---- test/ros.test.ts | 5 ++++- test/setup/ros-backend.ts | 2 +- 4 files changed, 10 insertions(+), 7 deletions(-) diff --git a/package.json b/package.json index 70e3093e6..056458c93 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "roslib", "homepage": "https://robotwebtools.github.io", "description": "The standard ROS Javascript Library", - "version": "2.0.0-alpha5", + "version": "2.0.0-alpha6", "license": "BSD-2-Clause", "files": [ "dist" diff --git a/src/core/Ros.ts b/src/core/Ros.ts index 37f72c138..d845cb3d4 100644 --- a/src/core/Ros.ts +++ b/src/core/Ros.ts @@ -42,7 +42,7 @@ export interface TypeDefDict { * Manages connection to the rosbridge server and all interactions with ROS. * * Emits the following events: - * * 'open' - Connected to the rosbridge server. + * * 'connection' - Connected to the rosbridge server. * * 'close' - Disconnected to the rosbridge server. * * 'error' - There was an error with ROS. * * <topicName> - A message came from rosbridge with the given topic name. @@ -50,7 +50,7 @@ export interface TypeDefDict { */ export default class Ros extends EventEmitter< { - open: [TransportEvent]; + connection: [TransportEvent]; close: [TransportEvent]; error: [TransportEvent]; // Any dynamically-named event should correspond to a rosbridge protocol message @@ -101,7 +101,7 @@ export default class Ros extends EventEmitter< transport.on("open", (event: TransportEvent) => { this.#isConnected = true; - this.emit("open", event); + this.emit("connection", event); }); transport.on("close", (event: TransportEvent) => { @@ -191,7 +191,7 @@ export default class Ros extends EventEmitter< if (this.isConnected()) { this.transport?.send(message); } else { - this.once("open", () => { + this.once("connection", () => { this.transport?.send(message); }); } diff --git a/test/ros.test.ts b/test/ros.test.ts index 363dac42d..ebbe63ac7 100644 --- a/test/ros.test.ts +++ b/test/ros.test.ts @@ -247,7 +247,10 @@ describe("Ros", function () { const rosOnceSpy = vi.spyOn(ros, "once"); ros.callOnConnection({ op: "set_level", level: "info" }); - expect(rosOnceSpy).toHaveBeenCalledWith("open", expect.any(Function)); + expect(rosOnceSpy).toHaveBeenCalledWith( + "connection", + expect.any(Function), + ); expect(mockTransport.send).not.toHaveBeenCalled(); // Once connected, the message is sent diff --git a/test/setup/ros-backend.ts b/test/setup/ros-backend.ts index 5cfb97df4..02e36d048 100644 --- a/test/setup/ros-backend.ts +++ b/test/setup/ros-backend.ts @@ -27,7 +27,7 @@ async function waitForRosConnection(ros: Ros, timeout = 5000) { reject(new Error("Timeout waiting for ROS connection")); }, timeout); - ros.on("open", () => { + ros.on("connection", () => { clearTimeout(timeoutId); resolve(); });