conats: some clarity on undefined v null

Author: williamstein

src/packages/nats/core/client.ts

@@ -512,9 +512,6 @@ export class Client {
     // **right now** or received these messages.
     count: number;
   }> => {
-    if (mesg === undefined) {
-      throw Error("mesg must not be undefined");
-    }
     const { bytes, getCount, promise } = this._publish(subject, mesg, {
       ...opts,
       confirm: true,
@@ -536,9 +533,6 @@ export class Client {
     if (!isValidSubjectWithoutWildcards(subject)) {
       throw Error(`invalid publish subject ${subject}`);
     }
-    if (mesg === undefined) {
-      throw Error("mesg must not be undefined");
-    }
     raw = raw ?? encode({ encoding, mesg });
     // default to 1MB is safe since it's at least that big.
     const chunkSize = Math.max(
@@ -902,19 +896,21 @@ export class Message extends MessageData {
     return `${subject}`;
   };
 
-  respondSync = (data, opts?: PublishOptions): { bytes: number } => {
+  respondSync = (mesg, opts?: PublishOptions): { bytes: number } => {
     const subject = this.respondSubject();
     if (!subject) return { bytes: 0 };
-    return this.client.publishSync(subject, data, opts);
+    return this.client.publishSync(subject, mesg, opts);
   };
 
   respond = async (
-    data,
+    mesg,
     opts: PublishOptions = {},
   ): Promise<{ bytes: number; count: number }> => {
     const subject = this.respondSubject();
-    if (!subject) return { bytes: 0, count: 0 };
-    return await this.client.publish(subject, data, opts);
+    if (!subject) {
+      return { bytes: 0, count: 0 };
+    }
+    return await this.client.publish(subject, mesg, opts);
   };
 }
 

src/packages/nats/service/service.ts

@@ -53,7 +53,8 @@ export async function callNatsService(opts: ServiceCall): Promise<any> {
   const subject = serviceSubject(opts);
   let resp;
   const timeout = opts.timeout ?? DEFAULT_TIMEOUT;
-  const data = opts.mesg;
+  // ensure not undefined, since undefined can't be published.
+  const data = opts.mesg ?? null;
 
   const doRequest = async () => {
     resp = await cn.request(subject, data, {

src/packages/nats/sync/core-stream.ts

@@ -524,7 +524,7 @@ export class CoreStream<T = any> extends EventEmitter {
     options?: { headers?: Headers; msgID?: string; key?: string },
   ) => {
     if (mesg === undefined) {
-      throw Error("mesg must not be undefined");
+      throw Error("stream publish - mesg must not be 'undefined'");
     }
     const data = mesg;
 

src/packages/project/nats/browser-websocket-api.ts

@@ -85,5 +85,5 @@ async function handleRequest({ data, mesg, primus }) {
     resp = { error: `${err}` };
   }
   //logger.debug("responded", resp);
-  mesg.respond(resp);
+  mesg.respond(resp ?? null);
 }

src/packages/server/nats/test/core/basic.test.ts

@@ -42,16 +42,6 @@ describe("basic test of publish and subscribe", () => {
     expect(done).toBe(false);
   });
 
-  it("publishing undefined is not allowed", async () => {
-    await expect(
-      async () => await cn.publish(subject, undefined),
-    ).rejects.toThrowError("must not be undefined");
-
-    expect(() => cn.publishSync(subject, undefined)).toThrow(
-      "must not be undefined",
-    );
-  });
-
   it("publishes using a second client", async () => {
     const data = null;
     cn2 = connect();

src/packages/server/nats/test/core/core-stream-ephemeral.test.ts

@@ -44,7 +44,7 @@ describe("create a client, create an ephemeral leader core-stream, and do basic
   it("publishing undefined is not allowed", async () => {
     await expect(
       async () => await stream.publish(undefined),
-    ).rejects.toThrowError("must not be undefined");
+    ).rejects.toThrowError("must not be 'undefined'");
   });
 
   it("a second client has the same messages", async () => {
@@ -299,6 +299,8 @@ describe("test using ephemeral dstream", () => {
     wait({ until: () => stream.length == 101 });
     expect(stream.get(stream.length - 1)).toBe("x");
   });
+  
+  
 });
 
 afterAll(after);