@seriousme/opifex 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -4,6 +4,19 @@
 
 ### Changed
 
+## [v1.6.0] 18-01-2025
+
+### Changed
+
+- added: export TcpClient and TcpServer for both NodeJS and Deno
+- added: export mqttPacket and utils
+
+## [v1.5.1] 16-01-2025
+
+### Changed
+
+- fixed issue with QoS=1
+
 ## [v1.5.0] 02-01-2025
 
 ### Changed

package/bin/conformanceServer.ts

@@ -5,7 +5,7 @@ import { AuthenticationResult } from "../server/mod.ts";
 import type { Context, TAuthenticationResult, Topic } from "../server/mod.ts";
 import { logger, LogLevel } from "../utils/mod.ts";
 import { getArgs, parseArgs } from "../utils/mod.ts";
-import { TcpServer } from "../node/server.ts";
+import { TcpServer } from "../node/tcpServer.ts";
 
 const utf8Decoder = new TextDecoder();
 const userTable = new Map();

package/bin/demoServer.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env -S node --experimental-strip-types
-import { TcpServer } from "../node/server.ts";
+import { TcpServer } from "../node/tcpServer.ts";
 import type { Context, TAuthenticationResult, Topic } from "../server/mod.ts";
 import { AuthenticationResult } from "../server/mod.ts";
 import { getArgs, logger, LogLevel, parseArgs } from "../utils/mod.ts";

package/bin/mqtt.ts

@@ -2,7 +2,7 @@
 import { DEFAULT_URL } from "../client/mod.ts";
 import { logger, LogLevel } from "../utils/mod.ts";
 import { getArgs, parseArgs } from "../utils/mod.ts";
-import { getFileData, TcpClient } from "../node/client.ts";
+import { getFileData, TcpClient } from "../node/tcpClient.ts";
 import type { Args } from "../utils/args.ts";
 
 const client = new TcpClient();

package/client/client.ts

@@ -173,19 +173,23 @@ export class Client {
       type: PacketType.publish,
       ...params,
     };
-    await this.ctx.send(packet);
+    await this.ctx.publish(packet);
   }
 
   async subscribe(params: SubscribeParameters): Promise<void> {
     const packet: SubscribePacket = {
       type: PacketType.subscribe,
-      id: this.ctx.store.nextId(),
+      id: 0, //placeholder
       ...params,
     };
-    await this.ctx.send(packet);
+    await this.ctx.subscribe(packet);
   }
 
   async *messages(): AsyncGenerator<PublishPacket, void, unknown> {
     yield* this.ctx.incoming;
   }
+
+  closeMessages(reason?: string) {
+    this.ctx.incoming.close(reason);
+  }
 }

package/client/handlers/handlePacket.ts

@@ -25,7 +25,7 @@ export async function handlePacket(
   ctx: Context,
   packet: AnyPacket,
 ): Promise<void> {
-  logger.debug({ received: JSON.stringify(packet, null, 2) });
+  logger.debug({ received: PacketNameByType[packet.type], packet });
   if (ctx.connectionState !== ConnectionState.connected) {
     if (packet.type === PacketType.connack) {
       handleConnack(packet as ConnackPacket, ctx);

package/deno/{server.test.ts → tcpServer.test.ts}

@@ -1,6 +1,6 @@
 import assert from "node:assert/strict";
 import { test } from "node:test";
-import { TcpServer } from "./server.ts";
+import { TcpServer } from "./tcpServer.ts";
 
 test("Deno testServer", () => {
   const server = new TcpServer({ port: 0 }, {});

package/deno/{server.ts → tcpServer.ts}

@@ -29,4 +29,11 @@ export class TcpServer {
     }
     return undefined;
   }
+
+  get address() {
+    if (this.listener.addr.transport === "tcp") {
+      return this.listener.addr.hostname;
+    }
+    return undefined;
+  }
 }

package/deno.json

@@ -1,9 +1,13 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "exports": {
     "./server": "./server/mod.ts",
-    "./client": "./client/mod.ts"
+    "./client": "./client/mod.ts",
+    "./mqttPacket": "./mqttPacket/mod.ts",
+    "./utils": "./utils/mod.ts,",
+    "./tcpClient": "./deno/tcpClient.ts",
+    "./tcpServer": "./deno/tcpServer.ts"
   },
   "exclude": [
     "dist"

package/dist/bin/conformanceServer.js

@@ -3,7 +3,7 @@
 import { AuthenticationResult } from "../server/mod.js";
 import { logger, LogLevel } from "../utils/mod.js";
 import { getArgs, parseArgs } from "../utils/mod.js";
-import { TcpServer } from "../node/server.js";
+import { TcpServer } from "../node/tcpServer.js";
 const utf8Decoder = new TextDecoder();
 const userTable = new Map();
 userTable.set("IoTester_1", "strong_password");

package/dist/bin/demoServer.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env -S node --experimental-strip-types
-import { TcpServer } from "../node/server.js";
+import { TcpServer } from "../node/tcpServer.js";
 import { AuthenticationResult } from "../server/mod.js";
 import { getArgs, logger, LogLevel, parseArgs } from "../utils/mod.js";
 const utf8Decoder = new TextDecoder();

package/dist/bin/mqtt.js

@@ -2,7 +2,7 @@
 import { DEFAULT_URL } from "../client/mod.js";
 import { logger, LogLevel } from "../utils/mod.js";
 import { getArgs, parseArgs } from "../utils/mod.js";
-import { getFileData, TcpClient } from "../node/client.js";
+import { getFileData, TcpClient } from "../node/tcpClient.js";
 const client = new TcpClient();
 const encoder = new TextEncoder();
 const decoder = new TextDecoder();

package/dist/client/client.js

@@ -113,17 +113,20 @@ export class Client {
             type: PacketType.publish,
             ...params,
         };
-        await this.ctx.send(packet);
+        await this.ctx.publish(packet);
     }
     async subscribe(params) {
         const packet = {
             type: PacketType.subscribe,
-            id: this.ctx.store.nextId(),
+            id: 0, //placeholder
             ...params,
         };
-        await this.ctx.send(packet);
+        await this.ctx.subscribe(packet);
     }
     async *messages() {
         yield* this.ctx.incoming;
     }
+    closeMessages(reason) {
+        this.ctx.incoming.close(reason);
+    }
 }

package/dist/client/handlers/handlePacket.js

@@ -9,7 +9,7 @@ import { handleSuback } from "./handleSuback.js";
 import { handleUnsuback } from "./handleUnsuback.js";
 import { logger, PacketNameByType, PacketType } from "../deps.js";
 export async function handlePacket(ctx, packet) {
-    logger.debug({ received: JSON.stringify(packet, null, 2) });
+    logger.debug({ received: PacketNameByType[packet.type], packet });
     if (ctx.connectionState !== ConnectionState.connected) {
         if (packet.type === PacketType.connack) {
             handleConnack(packet, ctx);

package/dist/node/{server.js → tcpServer.js}

@@ -17,6 +17,24 @@ export class TcpServer {
         this.server?.close();
     }
     get port() {
-        return this.serverOptions.port;
+        const address = this.server?.address();
+        if (typeof address === "object") {
+            return address?.port;
+        }
+        return this.serverOptions?.port;
+    }
+    get address() {
+        const addressResult = this.server?.address();
+        if (typeof addressResult === "object") {
+            const address = addressResult?.address;
+            if (address === "::") {
+                return "localhost";
+            }
+            if (address?.includes(":")) {
+                return `[${address}]`;
+            }
+            return address;
+        }
+        return addressResult;
     }
 }

package/dist/server/handlers/handlePublish.js

@@ -21,10 +21,11 @@ export async function handlePublish(ctx, packet) {
     if (packet.id !== undefined) {
         // qos 1
         if (qos === 1) {
+            const id = packet.id; // retain the id
             ctx.persistence.publish(packet.topic, packet);
             await ctx.send({
                 type: PacketType.puback,
-                id: packet.id,
+                id,
             });
             return;
         }

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../bin/conformanceServer.ts","../bin/demoServer.ts","../bin/mqtt.ts"],"version":"5.7.2"}
+{"root":["../bin/conformanceServer.ts","../bin/demoServer.ts","../bin/mqtt.ts"],"version":"5.7.3"}

package/node/tcpServer.test.ts

@@ -0,0 +1,94 @@
+import { test } from "node:test";
+import assert from "node:assert/strict";
+import { TcpClient } from "./tcpClient.ts";
+import { TcpServer } from "./tcpServer.ts";
+import { logger, LogLevel } from "../utils/mod.ts";
+import type { PublishPacket, QoS } from "../mqttPacket/mod.ts";
+
+logger.level(LogLevel.info);
+export function sleep(ms: number): Promise<unknown> {
+  return new Promise((r) => setTimeout(r, ms));
+}
+export async function serverTest() {
+  const server = new TcpServer({ port: 0 }, {});
+  server.start();
+  await sleep(1000);
+
+  assert.deepStrictEqual(
+    server.port !== undefined,
+    true,
+    "server runs a a random port",
+  );
+  logger.verbose({ port: server.port, address: server.address });
+
+  const params = {
+    url: new URL(`mqtt://${server.address}:${server.port}`),
+    numberOfRetries: 0,
+  };
+
+  const client = new TcpClient();
+
+  await client.connect(params);
+  assert(true, "Client connected to server");
+
+  const publishSet: { topic: string; qos: QoS }[] = [
+    { topic: "t0@q0", qos: 0 },
+    { topic: "t1@q0", qos: 0 },
+    { topic: "t2@q0", qos: 0 },
+    { topic: "t0@q1", qos: 1 },
+    { topic: "t1@q1", qos: 1 },
+    { topic: "t2@q1", qos: 1 },
+    { topic: "t0@q2", qos: 2 },
+    { topic: "t1@q2", qos: 2 },
+    { topic: "t2@q2", qos: 2 },
+  ];
+
+  const subscriptions = publishSet.map((item) => ({
+    topicFilter: item.topic,
+    qos: item.qos,
+  }));
+  await client.subscribe({
+    subscriptions,
+  });
+
+  // the IIFE ensures message reception runs in parallel
+  logger.verbose(`Start receiving`);
+  const received: PublishPacket[] = [];
+  (async function () {
+    for await (const item of client.messages()) {
+      logger.verbose(`Receiving: ${item.topic} -- ${item.qos}`);
+      received.push(item);
+    }
+  })();
+  // end of IIFE
+  for (const item of publishSet) {
+    logger.verbose(`Publishing: ${item.topic} -- ${item.qos}`);
+    await client.publish({
+      topic: item.topic,
+      qos: item.qos,
+      payload: new Uint8Array([0x01]),
+    });
+  }
+
+  await sleep(100);
+  logger.verbose(`Disconnect client`);
+  //client.closeMessages();
+  await client.disconnect();
+
+  logger.verbose(`Check completeness`);
+  for (const item of publishSet) {
+    const found = received.find((f) =>
+      f.topic == item.topic && f.qos === item.qos
+    );
+    logger.verbose(`Found: ${item.topic} -- ${item.qos}`);
+    assert(found, `${item.topic} -- ${item.qos}`);
+  }
+
+  logger.verbose(`Stop server`);
+  server.stop();
+}
+
+test("Test pubSub using client and server", async function () {
+  await serverTest();
+  logger.verbose("End of test");
+});

package/node/{server.ts → tcpServer.ts}

@@ -31,6 +31,25 @@ export class TcpServer {
   }
 
   get port() {
-    return this.serverOptions.port;
+    const address = this.server?.address();
+    if (typeof address === "object") {
+      return address?.port;
+    }
+    return this.serverOptions?.port;
+  }
+
+  get address() {
+    const addressResult = this.server?.address();
+    if (typeof addressResult === "object") {
+      const address = addressResult?.address;
+      if (address === "::") {
+        return "localhost";
+      }
+      if (address?.includes(":")) {
+        return `[${address}]`;
+      }
+      return address;
+    }
+    return addressResult;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "MQTT client & server for Deno & NodeJS",
   "type": "module",
   "scripts": {
@@ -23,12 +23,20 @@
   },
   "exports": {
     "./server": "./dist/server/mod.js",
-    "./client": "./dist/client/mod.js"
+    "./client": "./dist/client/mod.js",
+    "./mqttPacket": "./dist/mqttPacket/mod.js",
+    "./utils": "./dist/utils/mod.js,",
+    "./tcpClient": "./dist/node/tcpClient.js",
+    "./tcpServer": "./dist/node/tcpServer.js"
   },
   "deno": {
     "exports": {
       "./server": "./server/mod.ts",
-      "./client": "./client/mod.ts"
+      "./client": "./client/mod.ts",
+      "./mqttPacket": "./mqttPacket/mod.ts",
+      "./utils": "./utils/mod.ts,",
+      "./tcpClient": "./deno/tcpClient.ts",
+      "./tcpServer": "./deno/tcpServer.ts"
     },
     "exclude": [
       "dist"

package/server/handlers/handlePublish.ts

@@ -28,10 +28,11 @@ export async function handlePublish(
   if (packet.id !== undefined) {
     // qos 1
     if (qos === 1) {
+      const id = packet.id; // retain the id
       ctx.persistence.publish(packet.topic, packet);
       await ctx.send({
         type: PacketType.puback,
-        id: packet.id,
+        id,
       });
       return;
     }

package/node/server.test.ts

@@ -1,14 +0,0 @@
-import assert from "node:assert/strict";
-import { test } from "node:test";
-import { TcpServer } from "./server.ts";
-
-test("testServer", () => {
-  const server = new TcpServer({ port: 0 }, {});
-  server.start();
-  assert.deepStrictEqual(
-    server.port !== undefined,
-    true,
-    "server runs a a random port",
-  );
-  server.stop();
-});