feat(core,node,deno): added a check on the connect function that th…

…e client wasn't given a `ws/s://` url as these are difficult issues to diagnose.

Signed-off-by: Alberto Ricart <[email protected]>

core/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@nats-io/nats-core",
-  "version": "3.0.0-36",
+  "version": "3.0.0-38",
   "exports": {
     ".": "./src/mod.ts",
     "./internal": "./src/internal_mod.ts"

core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nats-io/nats-core",
-  "version": "3.0.0-36",
+  "version": "3.0.0-38",
   "files": [
     "lib/",
     "LICENSE",

core/src/internal_mod.ts

@@ -54,6 +54,7 @@ export {
   checkUnsupportedOption,
   DEFAULT_MAX_RECONNECT_ATTEMPTS,
   defaultOptions,
+  hasWsProtocol,
   parseOptions,
 } from "./options.ts";
 export { RequestOne } from "./request.ts";

core/src/mod.ts

@@ -31,6 +31,7 @@ export {
   Empty,
   errors,
   Events,
+  hasWsProtocol,
   headers,
   InvalidArgumentError,
   InvalidOperationError,

core/src/options.ts

@@ -53,6 +53,24 @@ export function defaultOptions(): ConnectionOptions {
   } as ConnectionOptions;
 }
 
+export function hasWsProtocol(opts?: ConnectionOptions): boolean {
+  if (opts) {
+    let { servers } = opts;
+    if (typeof servers === "string") {
+      servers = [servers];
+    }
+    if (servers) {
+      for (let i = 0; i < servers.length; i++) {
+        const s = servers[i].toLowerCase();
+        if (s.startsWith("ws://") || s.startsWith("wss://")) {
+          return true;
+        }
+      }
+    }
+  }
+  return false;
+}
+
 export function buildAuthenticator(
   opts: ConnectionOptions,
 ): Authenticator {

core/src/version.ts

@@ -1,2 +1,2 @@
 // This file is generated - do not edit
-export const version = "3.0.0-36";
+export const version = "3.0.0-38";

core/tests/properties_test.ts

@@ -17,6 +17,7 @@ import {
   assert,
   assertEquals,
   assertExists,
+  assertFalse,
   assertMatch,
 } from "jsr:@std/assert";
 
@@ -35,6 +36,7 @@ import {
 } from "../src/internal_mod.ts";
 
 import { NatsServer } from "../../test_helpers/launcher.ts";
+import { hasWsProtocol } from "../src/options.ts";
 
 Deno.test("properties - VERSION is semver", async () => {
   const ns = await NatsServer.start();
@@ -192,3 +194,16 @@ Deno.test("properties - multi", () => {
   assert(cc.sig.length > 0);
   assertExists(cc.nkey);
 });
+
+Deno.test("properties - hasWsProtocol", () => {
+  assertFalse(hasWsProtocol({ servers: "127.0.0.1:4222" }));
+  assert(hasWsProtocol({ servers: "WS://127.0.0.1:4222" }));
+  assert(hasWsProtocol({ servers: "ws://127.0.0.1:4222" }));
+  assert(hasWsProtocol({ servers: "WSS://127.0.0.1:4222" }));
+  assert(hasWsProtocol({ servers: "ws://127.0.0.1:4222" }));
+  assert(
+    hasWsProtocol({
+      servers: ["nats://127.0.0.1:4222", "ws://127.0.0.1:4222"],
+    }),
+  );
+});

jetstream/deno.json

@@ -33,6 +33,6 @@
     "test": "deno test -A --parallel --reload --trace-leaks --quiet tests/ --import-map=import_map.json"
   },
   "imports": {
-    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-36"
+    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-38"
   }
 }

jetstream/import_map.json

@@ -2,8 +2,8 @@
   "imports": {
     "@nats-io/nkeys": "jsr:@nats-io/[email protected]",
     "@nats-io/nuid": "jsr:@nats-io/[email protected]",
-    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-36",
-    "@nats-io/nats-core/internal": "jsr:@nats-io/nats-core@~3.0.0-36/internal",
+    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-38",
+    "@nats-io/nats-core/internal": "jsr:@nats-io/nats-core@~3.0.0-38/internal",
     "test_helpers": "../test_helpers/mod.ts",
     "@std/io": "jsr:@std/[email protected]"
   }

jetstream/package.json

@@ -34,7 +34,7 @@
   },
   "description": "jetstream library - this library implements all the base functionality for NATS JetStream for javascript clients",
   "dependencies": {
-    "@nats-io/nats-core": "3.0.0-36"
+    "@nats-io/nats-core": "3.0.0-38"
   },
   "devDependencies": {
     "@types/node": "^22.7.6",

kv/deno.json

@@ -33,7 +33,7 @@
     "test": "deno test -A --parallel --reload --quiet tests/ --import-map=import_map.json"
   },
   "imports": {
-    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-36",
+    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-38",
     "@nats-io/jetstream": "jsr:@nats-io/jetstream@~3.0.0-25"
   }
 }

kv/import_map.json

@@ -1,7 +1,7 @@
 {
   "imports": {
-    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-36",
-    "@nats-io/nats-core/internal": "jsr:@nats-io/nats-core@~3.0.0-36/internal",
+    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-38",
+    "@nats-io/nats-core/internal": "jsr:@nats-io/nats-core@~3.0.0-38/internal",
     "@nats-io/jetstream": "jsr:@nats-io/jetstream@~3.0.0-25",
     "@nats-io/jetstream/internal": "jsr:@nats-io/jetstream@~3.0.0-25/internal",
     "test_helpers": "../test_helpers/mod.ts",

kv/package.json

@@ -35,7 +35,7 @@
   "description": "kv library - this library implements all the base functionality for NATS KV javascript clients",
   "dependencies": {
     "@nats-io/jetstream": "3.0.0-25",
-    "@nats-io/nats-core": "3.0.0-36"
+    "@nats-io/nats-core": "3.0.0-38"
   },
   "devDependencies": {
     "@types/node": "^22.7.6",

obj/deno.json

@@ -33,7 +33,7 @@
     "test": "deno test -A --parallel --reload --quiet tests/ --import-map=import_map.json"
   },
   "imports": {
-    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-36",
+    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-38",
     "@nats-io/jetstream": "jsr:@nats-io/jetstream@~3.0.0-25"
   }
 }

obj/import_map.json

@@ -1,7 +1,7 @@
 {
   "imports": {
-    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-36",
-    "@nats-io/nats-core/internal": "jsr:@nats-io/nats-core@~3.0.0-36/internal",
+    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-38",
+    "@nats-io/nats-core/internal": "jsr:@nats-io/nats-core@~3.0.0-38/internal",
     "@nats-io/jetstream": "jsr:@nats-io/jetstream@~3.0.0-25",
     "@nats-io/jetstream/internal": "jsr:@nats-io/jetstream@~3.0.0-25/internal",
     "test_helpers": "../test_helpers/mod.ts",

obj/package.json

@@ -35,7 +35,7 @@
   "description": "obj library - this library implements all the base functionality for NATS objectstore for javascript clients",
   "dependencies": {
     "@nats-io/jetstream": "3.0.0-25",
-    "@nats-io/nats-core": "3.0.0-36"
+    "@nats-io/nats-core": "3.0.0-38"
   },
   "devDependencies": {
     "@types/node": "^22.7.6",

services/deno.json

@@ -33,6 +33,6 @@
     "test": "deno test -A --parallel --reload --quiet tests/ --import-map=import_map.json"
   },
   "imports": {
-    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-36"
+    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-38"
   }
 }

services/import_map.json

@@ -1,7 +1,7 @@
 {
   "imports": {
-    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-36",
-    "@nats-io/nats-core/internal": "jsr:@nats-io/nats-core@~3.0.0-36/internal",
+    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-38",
+    "@nats-io/nats-core/internal": "jsr:@nats-io/nats-core@~3.0.0-38/internal",
     "test_helpers": "../test_helpers/mod.ts",
     "@nats-io/nkeys": "jsr:@nats-io/[email protected]",
     "@nats-io/nuid": "jsr:@nats-io/[email protected]",

services/package.json

@@ -34,7 +34,7 @@
   },
   "description": "services library - this library implements all the base functionality for NATS services for javascript clients",
   "dependencies": {
-    "@nats-io/nats-core": "3.0.0-36"
+    "@nats-io/nats-core": "3.0.0-38"
   },
   "devDependencies": {
     "@types/node": "^22.7.6",

transport-deno/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@nats-io/transport-deno",
-  "version": "3.0.0-11",
+  "version": "3.0.0-13",
   "exports": {
     ".": "./src/mod.ts"
   },
@@ -20,7 +20,7 @@
   },
   "imports": {
     "@std/io": "jsr:@std/[email protected]",
-    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-36",
+    "@nats-io/nats-core": "jsr:@nats-io/nats-core@~3.0.0-38",
     "@nats-io/nkeys": "jsr:@nats-io/[email protected]",
     "@nats-io/nuid": "jsr:@nats-io/[email protected]"
   }

transport-deno/src/connect.ts

@@ -21,11 +21,21 @@ import type {
 } from "@nats-io/nats-core/internal";
 
 import {
+  errors,
+  hasWsProtocol,
   NatsConnectionImpl,
   setTransportFactory,
 } from "@nats-io/nats-core/internal";
 
 export function connect(opts: ConnectionOptions = {}): Promise<NatsConnection> {
+  if (hasWsProtocol(opts)) {
+    return Promise.reject(
+      errors.InvalidArgumentError.format(
+        `servers`,
+        `deno client doesn't support websockets, use the 'wsconnect' function instead`,
+      ),
+    );
+  }
   setTransportFactory({
     factory: (): Transport => {
       return new DenoTransport();

transport-deno/src/version.ts

@@ -1,2 +1,2 @@
 // This file is generated - do not edit
-export const version = "3.0.0-11";
+export const version = "3.0.0-13";

transport-deno/tests/basics_test.ts

@@ -1,8 +1,42 @@
 import { connect, createInbox, wsconnect } from "../src/mod.ts";
-import { assertEquals } from "jsr:@std/assert";
+import { assertEquals, assertRejects } from "jsr:@std/assert";
 
 Deno.test("basics", () => {
   assertEquals(typeof connect, "function");
   assertEquals(typeof wsconnect, "function");
   assertEquals(typeof createInbox, "function");
 });
+
+Deno.test("basics - ws urls fail", async () => {
+  await assertRejects(
+    () => {
+      return connect({ servers: ["ws://localhost:4222"] });
+    },
+    Error,
+    "'servers' deno client doesn't support websockets, use the 'wsconnect' function instead",
+  );
+
+  await assertRejects(
+    () => {
+      return connect({ servers: "ws://localhost:4222" });
+    },
+    Error,
+    "'servers' deno client doesn't support websockets, use the 'wsconnect' function instead",
+  );
+
+  await assertRejects(
+    () => {
+      return connect({ servers: ["wss://localhost:4222"] });
+    },
+    Error,
+    "'servers' deno client doesn't support websockets, use the 'wsconnect' function instead",
+  );
+
+  await assertRejects(
+    () => {
+      return connect({ servers: "wss://localhost:4222" });
+    },
+    Error,
+    "'servers' deno client doesn't support websockets, use the 'wsconnect' function instead",
+  );
+});

transport-node/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nats-io/transport-node",
-  "version": "3.0.0-22",
+  "version": "3.0.0-24",
   "description": "Node.js client for NATS, a lightweight, high-performance cloud native messaging system",
   "keywords": [
     "nats",
@@ -54,7 +54,7 @@
     "node": ">= 18.0.0"
   },
   "dependencies": {
-    "@nats-io/nats-core": "3.0.0-36",
+    "@nats-io/nats-core": "3.0.0-38",
     "@nats-io/nkeys": "1.2.0-7",
     "@nats-io/nuid": "2.0.1-2"
   },
@@ -64,8 +64,8 @@
     "nats-jwt": "^0.0.9",
     "shx": "^0.3.3",
     "typescript": "5.6.3",
-    "@nats-io/jetstream": "3.0.0-24",
-    "@nats-io/kv": "3.0.0-18",
-    "@nats-io/obj": "3.0.0-19"
+    "@nats-io/jetstream": "3.0.0-25",
+    "@nats-io/kv": "3.0.0-19",
+    "@nats-io/obj": "3.0.0-20"
   }
 }

transport-node/src/connect.ts

@@ -22,7 +22,17 @@ import {
   TransportFactory,
 } from "./nats-base-client";
 
+import { errors, hasWsProtocol } from "./nats-base-client";
+
 export function connect(opts: ConnectionOptions = {}): Promise<NatsConnection> {
+  if (hasWsProtocol(opts)) {
+    return Promise.reject(
+      errors.InvalidArgumentError.format(
+        `servers`,
+        `node client doesn't support websockets, use the 'wsconnect' function instead`,
+      ),
+    );
+  }
   setTransportFactory({
     factory: (): Transport => {
       return new NodeTransport();

transport-node/src/version.ts

@@ -1,2 +1,2 @@
 // This file is generated - do not edit
-export const version = "3.0.0-22";
+export const version = "3.0.0-24";

transport-node/tests/basics_test.js

@@ -174,4 +174,37 @@ describe(
       await ns.stop();
     });
   },
+  it("basics - ws urls fail", async () => {
+    await assert.rejects(
+      () => {
+        return connect({ servers: ["ws://localhost:4222"] });
+      },
+      Error,
+      "'servers' deno client doesn't support websockets, use the 'wsconnect' function instead",
+    );
+
+    await assert.rejects(
+      () => {
+        return connect({ servers: "ws://localhost:4222" });
+      },
+      Error,
+      "'servers' deno client doesn't support websockets, use the 'wsconnect' function instead",
+    );
+
+    await assert.rejects(
+      () => {
+        return connect({ servers: ["wss://localhost:4222"] });
+      },
+      Error,
+      "'servers' deno client doesn't support websockets, use the 'wsconnect' function instead",
+    );
+
+    await assert.rejects(
+      () => {
+        return connect({ servers: "wss://localhost:4222" });
+      },
+      Error,
+      "'servers' deno client doesn't support websockets, use the 'wsconnect' function instead",
+    );
+  }),
 );