@seriousme/opifex 1.11.1 → 1.11.2

package/benchmarks/receiver.ts

@@ -0,0 +1,35 @@
+import { exit } from "node:process";
+import { importClientClass } from "./utils.ts";
+
+const { TcpClient } = await importClientClass();
+const client = new TcpClient();
+client.onError = (err) => {
+  console.log("client error", err);
+  exit(1);
+};
+
+await client.connect({
+  url: new URL("mqtt://localhost:1883"),
+});
+
+await client.subscribe({ subscriptions: [{ topicFilter: "test", qos: 0 }] });
+
+let counter = 0;
+const interval = 5000;
+
+function count() {
+  console.log("received/s", (counter / interval) * 1000);
+  counter = 0;
+}
+
+setInterval(count, interval);
+
+// // Consume using a callback
+// client.onPacket = async (packet) => {
+//   counter++;
+// };
+
+// Consume using an AsyncIterator
+for await (const _ of client.messages()) {
+  counter++;
+}

package/benchmarks/sender.ts

@@ -0,0 +1,32 @@
+import { exit } from "node:process";
+import { runAsap } from "../dev_utils/timers.ts";
+import { importClientClass } from "./utils.ts";
+
+const { TcpClient } = await importClientClass();
+const client = new TcpClient();
+client.onError = (err) => {
+  console.log("client error", err);
+  exit(1);
+};
+
+await client.connect({
+  url: new URL("mqtt://localhost:1883"),
+});
+
+const payload = new TextEncoder().encode("payload");
+let sent = 0;
+const interval = 5000;
+
+const loop = () => {
+  sent++;
+  client.publish({ topic: "test", payload })
+    .then(() => runAsap(loop));
+};
+
+function count() {
+  console.log("sent/s", (sent / interval) * 1000);
+  sent = 0;
+}
+
+setInterval(count, interval);
+loop();

package/benchmarks/utils.ts

@@ -1,32 +1,9 @@
-import type { Client } from "../client/client.ts";
-
-export type ClientClass = new () => Client;
-
-export type Main = (clientClass: ClientClass) => void | Promise<void>;
-
-// @ts-ignore: the Deno global variable is not defined in @types/node,
-//             therefore we need to ignore this error because this file
-//             is meant to be used in both environments.
-const isDeno = typeof Deno !== "undefined";
-
-// @ts-ignore: the Deno global variable is not defined in @types/node,
-//             therefore we need to ignore this error because this file
-//             is meant to be used in both environments.
-// deno-lint-ignore no-process-global
-const exit = isDeno ? Deno.exit : process.exit;
-
-const importClientClass = async (): Promise<ClientClass> => {
+export async function importClientClass() {
+  // @ts-ignore: the Deno global variable is not defined in @types/node,
+  //             therefore we need to ignore this error because this file
+  //             is meant to be used in both environments.
+  const isDeno = typeof Deno !== "undefined";
   return isDeno
-    ? (await import("../deno/tcpClient.ts")).TcpClient
-    : (await import("../node/tcpClient.ts")).TcpClient;
-};
-
-export const loader = async (main: Main) => {
-  const TcpClient = await importClientClass();
-  try {
-    await main(TcpClient);
-  } catch (err) {
-    console.error(err);
-    exit(1);
-  }
-};
+    ? (await import("../deno/tcpClient.ts"))
+    : (await import("../node/tcpClient.ts"));
+}

package/dist/server/handlers/handlePublish.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handlePublish.d.ts","sourceRoot":"","sources":["../../../server/handlers/handlePublish.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAS,MAAM,YAAY,CAAC;AAkBvD;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC,IAAI,CAAC,CAiCf"}
+{"version":3,"file":"handlePublish.d.ts","sourceRoot":"","sources":["../../../server/handlers/handlePublish.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAS,MAAM,YAAY,CAAC;AAkBvD;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC,IAAI,CAAC,CAiDf"}

package/dist/server/handlers/handlePublish.js

@@ -43,9 +43,24 @@ export async function handlePublish(ctx, packet) {
             });
             return;
         }
-        // qos 2
+        /*
+    In the QoS 2 delivery protocol, the Receiver
+    
+    - MUST respond with a PUBREC containing the Packet Identifier from the incoming PUBLISH Packet,
+    having accepted ownership of the Application Message.
+    - Until it has received the corresponding PUBREL packet, the Receiver MUST acknowledge any subsequent
+    PUBLISH packet with the same Packet Identifier by sending a PUBREC. It MUST NOT cause duplicate
+    messages to be delivered to any onward recipients in this case.
+    - MUST respond to a PUBREL packet by sending a PUBCOMP packet containing the same Packet Identifier as the PUBREL.
+    - After it has sent a PUBCOMP, the receiver MUST treat any subsequent PUBLISH packet that contains that Packet
+    Identifier as being a new publication.
+    [MQTT-4.3.3-2].
+        */
         if (ctx.store) {
-            ctx.store.pendingIncoming.set(packet.id, packet);
+            if (!ctx.store.pendingIncoming.has(packet.id)) {
+                ctx.store.pendingIncoming.set(packet.id, packet);
+                ctx.persistence.publish(packet.topic, packet);
+            }
             await ctx.send({
                 type: PacketType.pubrec,
                 protocolLevel: ctx.protocolLevel,

package/dist/server/handlers/handlePublish.js.map

@@ -1 +1 @@
-{"version":3,"file":"handlePublish.js","sourceRoot":"","sources":["../../../server/handlers/handlePublish.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAIxC;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,GAAY,EAAE,KAAY;IACrD,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC;QACvC,OAAO,GAAG,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAY,EACZ,MAAqB;IAErB,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO;IACT,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5B,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;QACd,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC9C,OAAO;IACT,CAAC;IAED,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;QAC5B,QAAQ;QACR,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YACd,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,gBAAgB;YACtC,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC9C,MAAM,GAAG,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,UAAU,CAAC,MAAM;gBACvB,aAAa,EAAE,GAAG,CAAC,aAAa;gBAChC,EAAE;aACH,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QACD,QAAQ;QACR,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YACd,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;YACjD,MAAM,GAAG,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,UAAU,CAAC,MAAM;gBACvB,aAAa,EAAE,GAAG,CAAC,aAAa;gBAChC,EAAE,EAAE,MAAM,CAAC,EAAE;aACd,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"handlePublish.js","sourceRoot":"","sources":["../../../server/handlers/handlePublish.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAIxC;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,GAAY,EAAE,KAAY;IACrD,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC;QACvC,OAAO,GAAG,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAY,EACZ,MAAqB;IAErB,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO;IACT,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5B,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;QACd,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC9C,OAAO;IACT,CAAC;IAED,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;QAC5B,QAAQ;QACR,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YACd,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,gBAAgB;YACtC,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC9C,MAAM,GAAG,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,UAAU,CAAC,MAAM;gBACvB,aAAa,EAAE,GAAG,CAAC,aAAa;gBAChC,EAAE;aACH,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED;;;;;;;;;;;;UAYE;QACF,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YACd,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC9C,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;gBACjD,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAChD,CAAC;YACD,MAAM,GAAG,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,UAAU,CAAC,MAAM;gBACvB,aAAa,EAAE,GAAG,CAAC,aAAa;gBAChC,EAAE,EAAE,MAAM,CAAC,EAAE;aACd,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/server/handlers/handlePubrel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handlePubrel.d.ts","sourceRoot":"","sources":["../../../server/handlers/handlePubrel.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C;;;;;;;;;;;GAWG;AACH,wBAAsB,YAAY,CAChC,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,YAAY,GACnB,OAAO,CAAC,IAAI,CAAC,CAcf"}
+{"version":3,"file":"handlePubrel.d.ts","sourceRoot":"","sources":["../../../server/handlers/handlePubrel.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C;;;;;;;;;;;GAWG;AACH,wBAAsB,YAAY,CAChC,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,YAAY,GACnB,OAAO,CAAC,IAAI,CAAC,CAUf"}

package/dist/server/handlers/handlePubrel.js

@@ -14,16 +14,12 @@ import { PacketType } from "../deps.js";
 export async function handlePubrel(ctx, packet) {
     const id = packet.id;
     if (ctx.store?.pendingIncoming.has(id)) {
-        const storedPacket = ctx.store.pendingIncoming.get(id);
-        if (storedPacket) {
-            ctx.persistence.publish(storedPacket.topic, storedPacket);
-            ctx.store.pendingIncoming.delete(id);
-            await ctx.send({
-                type: PacketType.pubcomp,
-                protocolLevel: ctx.protocolLevel,
-                id,
-            });
-        }
+        ctx.store.pendingIncoming.delete(id);
     }
+    await ctx.send({
+        type: PacketType.pubcomp,
+        protocolLevel: ctx.protocolLevel,
+        id,
+    });
 }
 //# sourceMappingURL=handlePubrel.js.map

package/dist/server/handlers/handlePubrel.js.map

@@ -1 +1 @@
-{"version":3,"file":"handlePubrel.js","sourceRoot":"","sources":["../../../server/handlers/handlePubrel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAIxC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,GAAY,EACZ,MAAoB;IAEpB,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;IACrB,IAAI,GAAG,CAAC,KAAK,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;QACvC,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACvD,IAAI,YAAY,EAAE,CAAC;YACjB,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YAC1D,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACrC,MAAM,GAAG,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,UAAU,CAAC,OAAO;gBACxB,aAAa,EAAE,GAAG,CAAC,aAAa;gBAChC,EAAE;aACH,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"handlePubrel.js","sourceRoot":"","sources":["../../../server/handlers/handlePubrel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAIxC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,GAAY,EACZ,MAAoB;IAEpB,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;IACrB,IAAI,GAAG,CAAC,KAAK,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;QACvC,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IACD,MAAM,GAAG,CAAC,IAAI,CAAC;QACb,IAAI,EAAE,UAAU,CAAC,OAAO;QACxB,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,EAAE;KACH,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.11.1",
+  "version": "1.11.2",
   "description": "MQTT client & server for Deno & NodeJS",
   "type": "module",
   "scripts": {

package/server/handlers/handlePublish.ts

@@ -52,9 +52,25 @@ export async function handlePublish(
       });
       return;
     }
-    // qos 2
+
+    /*
+In the QoS 2 delivery protocol, the Receiver
+
+- MUST respond with a PUBREC containing the Packet Identifier from the incoming PUBLISH Packet,
+having accepted ownership of the Application Message.
+- Until it has received the corresponding PUBREL packet, the Receiver MUST acknowledge any subsequent
+PUBLISH packet with the same Packet Identifier by sending a PUBREC. It MUST NOT cause duplicate
+messages to be delivered to any onward recipients in this case.
+- MUST respond to a PUBREL packet by sending a PUBCOMP packet containing the same Packet Identifier as the PUBREL.
+- After it has sent a PUBCOMP, the receiver MUST treat any subsequent PUBLISH packet that contains that Packet
+Identifier as being a new publication.
+[MQTT-4.3.3-2].
+    */
     if (ctx.store) {
-      ctx.store.pendingIncoming.set(packet.id, packet);
+      if (!ctx.store.pendingIncoming.has(packet.id)) {
+        ctx.store.pendingIncoming.set(packet.id, packet);
+        ctx.persistence.publish(packet.topic, packet);
+      }
       await ctx.send({
         type: PacketType.pubrec,
         protocolLevel: ctx.protocolLevel,

package/server/handlers/handlePubrel.ts

@@ -20,15 +20,11 @@ export async function handlePubrel(
 ): Promise<void> {
   const id = packet.id;
   if (ctx.store?.pendingIncoming.has(id)) {
-    const storedPacket = ctx.store.pendingIncoming.get(id);
-    if (storedPacket) {
-      ctx.persistence.publish(storedPacket.topic, storedPacket);
-      ctx.store.pendingIncoming.delete(id);
-      await ctx.send({
-        type: PacketType.pubcomp,
-        protocolLevel: ctx.protocolLevel,
-        id,
-      });
-    }
+    ctx.store.pendingIncoming.delete(id);
   }
+  await ctx.send({
+    type: PacketType.pubcomp,
+    protocolLevel: ctx.protocolLevel,
+    id,
+  });
 }

package/benchmarks/bombing.ts

@@ -1,35 +0,0 @@
-import { loader } from "./utils.ts";
-import { runAsap } from "../dev_utils/timers.ts";
-
-loader((ClientClass) => {
-  const client = new ClientClass();
-
-  client.connect({
-    url: new URL("mqtt://127.0.0.1:1884"),
-  });
-
-  client.onConnected = () => {
-    const payload = new TextEncoder().encode("payload");
-
-    let sent = 0;
-    const interval = 5000;
-
-    const loop = () => {
-      sent++;
-      client.publish({ topic: "test", payload })
-        .then(() => runAsap(loop));
-    };
-
-    function count() {
-      console.log("sent/s", (sent / interval) * 1000);
-      sent = 0;
-    }
-
-    setInterval(count, interval);
-    loop();
-  };
-
-  client.onError = (err) => {
-    console.log("client error", err);
-  };
-});

package/benchmarks/throughputCounter.ts

@@ -1,31 +0,0 @@
-import { loader } from "./utils.ts";
-
-loader(async (ClientClass) => {
-  const client = new ClientClass();
-
-  await client.connect({
-    url: new URL("mqtt://127.0.0.1:1884"),
-  });
-
-  await client.subscribe({ subscriptions: [{ topicFilter: "test", qos: 0 }] });
-
-  let counter = 0;
-  const interval = 5000;
-
-  function count() {
-    console.log("received/s", (counter / interval) * 1000);
-    counter = 0;
-  }
-
-  setInterval(count, interval);
-
-  // // Consume using a callback
-  // client.onPacket = async (packet) => {
-  //   counter++;
-  // };
-
-  // Consume using an AsyncIterator
-  for await (const _ of client.messages()) {
-    counter++;
-  }
-});