- [BREAKING] removed url connection option. Instead provide `server…

…s` - this option can be a string or an array of strings. (#21)
nats-io · Aug 6, 2020 · c9b1426 · c9b1426
1 parent 7b74c22
commit c9b1426
Show file tree

Hide file tree

Showing 35 changed files with 137 additions and 137 deletions.
diff --git a/README.md b/README.md
@@ -54,8 +54,8 @@ import { connect, NatsConnection } from "src/mod.ts";
 // common options that you could pass look like:
 const localhostAtStandardPort = {};
 const localPort = { port: 4222 };
-const hostAtStdPort = { url: "demo.nats.io" };
-const hostPort = { url: "demo.nats.io:4222" };
+const hostAtStdPort = { servers: "demo.nats.io" };
+const hostPort = { servers: "demo.nats.io:4222" };
 
 // let's try to connect to all the above, some may fail
 const dials: Promise<NatsConnection>[] = [];
@@ -115,7 +115,7 @@ of your data as necessary.
 import { connect, StringCodec } from "../../src/mod.ts";
 
 // to create a connection to a nats-server:
-const nc = await connect({ url: "demo.nats.io:4222" });
+const nc = await connect({ servers: "demo.nats.io:4222" });
 
 // create a codec
 const sc = StringCodec();
@@ -150,7 +150,7 @@ getting the messages you unsubscribe.
 import { connect, JSONCodec } from "../../src/mod.ts";
 
 // to create a connection to a nats-server:
-const nc = await connect({ url: "demo.nats.io" });
+const nc = await connect({ servers: "demo.nats.io" });
 
 // create a codec
 const jc = JSONCodec();
@@ -183,7 +183,7 @@ will get a chance at processing the message.
 
 ```javascript
 import { connect, StringCodec, Subscription } from "../../src/mod.ts";
-const nc = await connect({ url: "demo.nats.io:4222" });
+const nc = await connect({ servers: "demo.nats.io:4222" });
 const sc = StringCodec();
 
 // subscriptions can have wildcard subjects
@@ -230,7 +230,7 @@ not only to provide a service, but also to control the service.
 import { connect, StringCodec, Subscription } from "../../src/mod.ts";
 
 // create a connection
-const nc = await connect({ url: "demo.nats.io" });
+const nc = await connect({ servers: "demo.nats.io" });
 
 // create a codec
 const sc = StringCodec();
@@ -305,7 +305,7 @@ async function adminHandler(sub: Subscription) {
 import { connect, StringCodec } from "../../src/mod.ts";
 
 // create a connection
-const nc = await connect({ url: "demo.nats.io:4222" });
+const nc = await connect({ servers: "demo.nats.io:4222" });
 
 // create an encoder
 const sc = StringCodec();
@@ -348,7 +348,7 @@ async function createService(
   for (let i = 1; i <= count; i++) {
     const n = queue ? `${name}-${i}` : name;
     const nc = await connect(
-      { url: "demo.nats.io:4222", name: `${n}` },
+      { servers: "demo.nats.io:4222", name: `${n}` },
     );
     nc.closed()
       .then((err) => {
@@ -409,15 +409,15 @@ await Promise.all(a);
 // `token` options in the NatsConnectionOptions
 import { connect } from "src/mod.ts";
 
-const nc1 = await connect({url: "nats://127.0.0.1:4222", user: "jenny", pass: "867-5309"});
+const nc1 = await connect({servers: "127.0.0.1:4222", user: "jenny", pass: "867-5309"});
 const nc2 = await connect({port: 4222, token: "t0pS3cret!"});
 ```
 
 ### Flush
 ```javascript
-// flush sends a PING request to the server and returns a promise
-// when the server responds with a PONG. The flush guarantees that
-// things you published have been delivered to the server. Typically
+// flush sends a PING request to the servers and returns a promise
+// when the servers responds with a PONG. The flush guarantees that
+// things you published have been delivered to the servers. Typically
 // it is not necessary to use flush, but on tests it can be invaluable.
 nc.publish('foo');
 nc.publish('bar');

diff --git a/doc/snippets/autounsub.ts b/doc/snippets/autounsub.ts
@@ -17,7 +17,7 @@
 import { connect, StringCodec, Subscription } from "../../src/mod.ts";
 
 // create a connection
-const nc = await connect({ url: "demo.nats.io:4222" });
+const nc = await connect({ servers: "demo.nats.io:4222" });
 
 // create a simple subscriber that listens for only one message
 // and then auto unsubscribes, ending the async iterator

diff --git a/doc/snippets/basics.ts b/doc/snippets/basics.ts
@@ -17,7 +17,7 @@
 import { connect, StringCodec } from "../../src/mod.ts";
 
 // to create a connection to a nats-server:
-const nc = await connect({ url: "demo.nats.io:4222" });
+const nc = await connect({ servers: "demo.nats.io:4222" });
 
 // create a codec
 const sc = StringCodec();

diff --git a/doc/snippets/queuegroups.ts b/doc/snippets/queuegroups.ts
@@ -28,7 +28,7 @@ async function createService(
   for (let i = 1; i <= count; i++) {
     const n = queue ? `${name}-${i}` : name;
     const nc = await connect(
-      { url: "demo.nats.io:4222", name: `${n}` },
+      { servers: "demo.nats.io:4222", name: `${n}` },
     );
     nc.closed()
       .then((err) => {

diff --git a/doc/snippets/service.ts b/doc/snippets/service.ts
@@ -17,7 +17,7 @@
 import { connect, StringCodec, Subscription } from "../../src/mod.ts";
 
 // create a connection
-const nc = await connect({ url: "demo.nats.io" });
+const nc = await connect({ servers: "demo.nats.io" });
 
 // create a codec
 const sc = StringCodec();

diff --git a/doc/snippets/service_client.ts b/doc/snippets/service_client.ts
@@ -17,7 +17,7 @@
 import { connect, StringCodec } from "../../src/mod.ts";
 
 // create a connection
-const nc = await connect({ url: "demo.nats.io:4222" });
+const nc = await connect({ servers: "demo.nats.io:4222" });
 
 // create an encoder
 const sc = StringCodec();

diff --git a/doc/snippets/stream.ts b/doc/snippets/stream.ts
@@ -17,7 +17,7 @@
 import { connect, JSONCodec } from "../../src/mod.ts";
 
 // to create a connection to a nats-server:
-const nc = await connect({ url: "demo.nats.io" });
+const nc = await connect({ servers: "demo.nats.io" });
 
 // create a codec
 const jc = JSONCodec();

diff --git a/doc/snippets/sub_timeout.ts b/doc/snippets/sub_timeout.ts
@@ -17,7 +17,7 @@
 import { connect, ErrorCode } from "../../src/mod.ts";
 
 // to create a connection to a nats-server:
-const nc = await connect({ url: "demo.nats.io:4222" });
+const nc = await connect({ servers: "demo.nats.io:4222" });
 
 // create subscription with a timeout, if no message arrives
 // within the timeout, the subscription throws a timeout error

diff --git a/doc/snippets/wildcard_subscriptions.ts b/doc/snippets/wildcard_subscriptions.ts
@@ -14,7 +14,7 @@
  */
 
 import { connect, StringCodec, Subscription } from "../../src/mod.ts";
-const nc = await connect({ url: "demo.nats.io:4222" });
+const nc = await connect({ servers: "demo.nats.io:4222" });
 const sc = StringCodec();
 
 // subscriptions can have wildcard subjects

diff --git a/examples/bench.ts b/examples/bench.ts
@@ -3,7 +3,7 @@
 import { parse } from "https://deno.land/[email protected]/flags/mod.ts";
 import { connect, Nuid } from "../src/mod.ts";
 const defaults = {
-  s: "nats://127.0.0.1:4222",
+  s: "127.0.0.1:4222",
   c: 1000000,
 };
 
@@ -30,7 +30,7 @@ const server = String(argv.server);
 const count = parseInt(String(argv.count));
 const subj = String(argv.subj) || new Nuid().next();
 
-const nc = await connect({ url: server, debug: argv.debug });
+const nc = await connect({ servers: server, debug: argv.debug });
 const start = Date.now();
 
 if (argv.req) {

diff --git a/examples/nats-events.ts b/examples/nats-events.ts
@@ -10,12 +10,12 @@ const argv = parse(
       "s": ["server"],
     },
     default: {
-      s: "nats://127.0.0.1:4222",
+      s: "127.0.0.1:4222",
     },
   },
 );
 
-const opts = { url: argv.s } as ConnectionOptions;
+const opts = { servers: argv.s } as ConnectionOptions;
 
 const nc = await connect(opts);
 (async () => {

diff --git a/examples/nats-pub.ts b/examples/nats-pub.ts
@@ -14,7 +14,7 @@ const argv = parse(
       "i": ["interval"],
     },
     default: {
-      s: "nats://127.0.0.1:4222",
+      s: "127.0.0.1:4222",
       c: 1,
       i: 0,
     },
@@ -23,7 +23,7 @@ const argv = parse(
   },
 );
 
-const copts = { url: argv.s } as ConnectionOptions;
+const copts = { servers: argv.s } as ConnectionOptions;
 const subject = String(argv._[0]);
 const payload = argv._[1] || "";
 const count = (argv.c == -1 ? Number.MAX_SAFE_INTEGER : argv.c) || 1;

diff --git a/examples/nats-rep.ts b/examples/nats-rep.ts
@@ -13,15 +13,15 @@ const argv = parse(
       "e": ["echo"],
     },
     default: {
-      s: "nats://127.0.0.1:4222",
+      s: "127.0.0.1:4222",
       q: "",
     },
     boolean: ["echo", "headers", "debug"],
     string: ["server", "queue"],
   },
 );
 
-const opts = { url: argv.s } as ConnectionOptions;
+const opts = { servers: argv.s } as ConnectionOptions;
 const subject = argv._[0] ? String(argv._[0]) : "";
 const payload = argv._[1] || "";
 

diff --git a/examples/nats-req.ts b/examples/nats-req.ts
@@ -14,7 +14,7 @@ const argv = parse(
       "t": ["timeout"],
     },
     default: {
-      s: "nats://127.0.0.1:4222",
+      s: "127.0.0.1:4222",
       c: 1,
       i: 0,
       t: 1000,
@@ -24,7 +24,7 @@ const argv = parse(
   },
 );
 
-const opts = { url: argv.s } as ConnectionOptions;
+const opts = { servers: argv.s } as ConnectionOptions;
 const subject = String(argv._[0]);
 const payload = argv._[1] || "";
 const count = (argv.c == -1 ? Number.MAX_SAFE_INTEGER : argv.c) || 1;

diff --git a/examples/nats-sub.ts b/examples/nats-sub.ts
@@ -11,15 +11,15 @@ const argv = parse(
       "q": ["queue"],
     },
     default: {
-      s: "nats://127.0.0.1:4222",
+      s: "127.0.0.1:4222",
       q: "",
     },
     boolean: ["headers", "debug"],
     string: ["server", "queue"],
   },
 );
 
-const opts = { url: argv.s } as ConnectionOptions;
+const opts = { servers: argv.s } as ConnectionOptions;
 const subject = argv._[0] ? String(argv._[0]) : ">";
 
 if (argv.debug) {

diff --git a/nats-base-client/options.ts b/nats-base-client/options.ts
@@ -22,9 +22,9 @@ import {
   DEFAULT_MAX_PING_OUT,
   DEFAULT_MAX_RECONNECT_ATTEMPTS,
   DEFAULT_PING_INTERVAL,
-  DEFAULT_PRE,
+  DEFAULT_HOST,
   DEFAULT_RECONNECT_TIME_WAIT,
-  DEFAULT_URI,
+  DEFAULT_HOSTPORT,
 } from "./types.ts";
 import { buildAuthenticator } from "./authenticator.ts";
 
@@ -46,9 +46,15 @@ export function defaultOptions(): ConnectionOptions {
 }
 
 export function parseOptions(opts?: ConnectionOptions): ConnectionOptions {
-  opts = opts || { url: DEFAULT_URI };
+  opts = opts || { servers: [DEFAULT_HOSTPORT] };
   if (opts.port) {
-    opts.url = DEFAULT_PRE + opts.port;
+    opts.servers = [`${DEFAULT_HOST}:${opts.port}`];
+  }
+  if (typeof opts.servers === "string") {
+    opts.servers = [opts.servers];
+  }
+  if (opts.servers && opts.servers.length === 0) {
+    opts.servers = [DEFAULT_HOSTPORT];
   }
   const options = extend(defaultOptions(), opts);
 

diff --git a/nats-base-client/protocol.ts b/nats-base-client/protocol.ts
@@ -133,8 +133,8 @@ export class ProtocolHandler {
     this.pongs = [];
     this.servers = new Servers(
       !options.noRandomize,
-      this.options.servers,
-      this.options.url,
+      //@ts-ignore
+      options.servers,
     );
     this.closed = deferred<Error | void>();
 

diff --git a/nats-base-client/servers.ts b/nats-base-client/servers.ts
@@ -15,7 +15,7 @@
  */
 import {
   DEFAULT_PORT,
-  DEFAULT_URI,
+  DEFAULT_HOSTPORT,
   ServerInfo,
   ServersChanged,
 } from "./types.ts";
@@ -34,19 +34,14 @@ export class Server {
   gossiped: boolean;
 
   constructor(u: string, gossiped = false) {
-    // remove any of the standard protocols we are used to seeing
-    u = u.replace("tls://", "");
-    u = u.replace("ws://", "");
-    u = u.replace("wss://", "");
-    u = u.replace("nats://", "");
-
+    // remove any protocol that may have been provided
+    if (u.match(/^(.*:\/\/)(.*)/m)) {
+      u = u.replace(/^(.*:\/\/)(.*)/gm, "$2");
+    }
     // in web environments, URL may not be a living standard
     // that means that protocols other than HTTP/S are not
     // parsable correctly.
-    if (!/^.*:\/\/.*/.test(u)) {
-      u = `http://${u}`;
-    }
-    let url = new URL(u);
+    let url = new URL(`http://${u}`);
     if (!url.port) {
       url.port = `${DEFAULT_PORT}`;
     }
@@ -103,7 +98,7 @@ export class Servers {
       }
     } else {
       if (this.servers.length === 0) {
-        this.addServer(DEFAULT_URI, false);
+        this.addServer(DEFAULT_HOSTPORT, false);
       }
     }
     this.currentServer = this.servers[0];

diff --git a/nats-base-client/types.ts b/nats-base-client/types.ts
@@ -39,8 +39,8 @@ export const DebugEvents = Object.freeze({
 });
 
 export const DEFAULT_PORT = 4222;
-export const DEFAULT_PRE = "nats://127.0.0.1:";
-export const DEFAULT_URI = DEFAULT_PRE + DEFAULT_PORT;
+export const DEFAULT_HOST = "127.0.0.1";
+export const DEFAULT_HOSTPORT = `${DEFAULT_HOST}:${DEFAULT_PORT}`;
 
 // DISCONNECT Parameters, 2 sec wait, 10 tries
 export const DEFAULT_RECONNECT_TIME_WAIT = 2 * 1000;
@@ -93,11 +93,10 @@ export interface ConnectionOptions {
   reconnectJitter?: number;
   reconnectJitterTLS?: number;
   reconnectTimeWait?: number;
-  servers?: Array<string>;
+  servers?: Array<string> | string;
   timeout?: number;
   tls?: boolean | TlsOptions;
   token?: string;
-  url?: string;
   user?: string;
   verbose?: boolean;
   waitOnFirstConnect?: boolean;

diff --git a/tests/auth_test.ts b/tests/auth_test.ts
@@ -135,7 +135,7 @@ Deno.test("auth - pub perm", async () => {
 });
 
 Deno.test("auth - user and token is rejected", async () => {
-  connect({ url: "nats://127.0.0.1:4222", user: "derek", token: "foobar" })
+  connect({ servers: "127.0.0.1:4222", user: "derek", token: "foobar" })
     .then(async (nc) => {
       await nc.close();
       fail("should not have connected");