fix(core): implement two-level Map for O(1) protocol+subprotocol lookup

Signed-off-by: Thembo Jonathan <thembojonathan@gmail.com>

Author: jona42-ui

packages/binding-coap/src/coap-client-factory.ts

@@ -32,6 +32,10 @@ export default class CoapClientFactory implements ProtocolClientFactory {
         this.server = server;
     }
 
+    public getSupportedProtocols(): Array<[string, string?]> {
+        return [["coap"]];
+    }
+
     public getClient(): ProtocolClient {
         debug(`CoapClientFactory creating client for '${this.scheme}'`);
         return new CoapClient(this.server);

packages/binding-coap/src/coaps-client-factory.ts

@@ -25,6 +25,10 @@ const { debug } = createLoggers("binding-coap", "coaps-client-factory");
 export default class CoapsClientFactory implements ProtocolClientFactory {
     public readonly scheme: string = "coaps";
 
+    public getSupportedProtocols(): Array<[string, string?]> {
+        return [["coaps"]];
+    }
+
     public getClient(): ProtocolClient {
         debug(`CoapsClientFactory creating client for '${this.scheme}'`);
         return new CoapsClient();

packages/binding-file/src/file-client-factory.ts

@@ -24,6 +24,10 @@ const { debug } = createLoggers("binding-file", "file-client-factory");
 export default class FileClientFactory implements ProtocolClientFactory {
     public readonly scheme: string = "file";
 
+    public getSupportedProtocols(): Array<[string, string?]> {
+        return [["file"]];
+    }
+
     public getClient(): ProtocolClient {
         debug(`FileClientFactory creating client for '${this.scheme}'`);
         return new FileClient();

packages/binding-http/src/http-client-factory.ts

@@ -33,6 +33,10 @@ export default class HttpClientFactory implements ProtocolClientFactory {
         this.config = config;
     }
 
+    public getSupportedProtocols(): Array<[string, string?]> {
+        return [["http"]];
+    }
+
     public getClient(): ProtocolClient {
         // HTTP over HTTPS proxy requires HttpsClient
         if (this.config && this.config.proxy && this.config.proxy.href && this.config.proxy.href.startsWith("https:")) {

packages/binding-http/src/https-client-factory.ts

@@ -31,6 +31,10 @@ export default class HttpsClientFactory implements ProtocolClientFactory {
         this.config = config;
     }
 
+    public getSupportedProtocols(): Array<[string, string?]> {
+        return [["https"]];
+    }
+
     public getClient(): ProtocolClient {
         // HTTPS over HTTP proxy requires HttpClient
         if (this.config && this.config.proxy && this.config.proxy.href && this.config.proxy.href.startsWith("http:")) {

packages/binding-mbus/src/mbus-client-factory.ts

@@ -21,6 +21,10 @@ const info = createInfoLogger("binding-mbus", "mbus-client-factory");
 export default class MBusClientFactory implements ProtocolClientFactory {
     public readonly scheme: string = "mbus+tcp";
 
+    public getSupportedProtocols(): Array<[string, string?]> {
+        return [["mbus+tcp"]];
+    }
+
     public getClient(): ProtocolClient {
         info(`MBusClientFactory creating client for '${this.scheme}'`);
         return new MBusClient();

packages/binding-modbus/src/modbus-client-factory.ts

@@ -22,6 +22,10 @@ export default class ModbusClientFactory implements ProtocolClientFactory {
     public readonly scheme: string = "modbus+tcp";
     private singleton?: ModbusClient;
 
+    public getSupportedProtocols(): Array<[string, string?]> {
+        return [["modbus+tcp"]];
+    }
+
     public getClient(): ProtocolClient {
         debug(`Get client for '${this.scheme}'`);
         this.init();

packages/binding-mqtt/src/mqtt-client-factory.ts

@@ -18,6 +18,7 @@
  */
 
 import { ProtocolClientFactory, ProtocolClient, createDebugLogger } from "@node-wot/core";
+import { MqttClientConfig } from "./mqtt";
 import MqttClient from "./mqtt-client";
 
 const debug = createDebugLogger("binding-mqtt", "mqtt-client-factory");
@@ -26,8 +27,19 @@ export default class MqttClientFactory implements ProtocolClientFactory {
     public readonly scheme: string = "mqtt";
     private readonly clients: Array<ProtocolClient> = [];
 
+    constructor(private readonly config: MqttClientConfig = {}) {}
+
+    getSupportedProtocols(): Array<[string, string?]> {
+        return [
+            ["mqtt"],        // mqtt://
+            ["mqtts"],       // mqtts://
+            ["ws", "mqtt"],  // ws:// + subprotocol:mqtt
+            ["wss", "mqtt"], // wss:// + subprotocol:mqtt
+        ];
+    }
+
     getClient(): ProtocolClient {
-        const client = new MqttClient();
+        const client = new MqttClient(this.config);
         this.clients.push(client);
         return client;
     }

packages/binding-mqtt/src/mqtt-client.ts

@@ -54,6 +54,22 @@ export default class MqttClient implements ProtocolClient {
 
     private client?: mqtt.MqttClient;
 
+    private getBrokerUri(href: string): string {
+        const requestUri = new URL(href);
+
+        if (href.startsWith("ws://") || href.startsWith("wss://")) {
+            return `${requestUri.protocol}//${requestUri.host}`;
+        }
+
+        const compositeMatch = href.match(/^([a-z]+)\+([a-z]+):\/\//i);
+        if (compositeMatch) {
+            const transportScheme = compositeMatch[2];
+            return `${transportScheme}://${requestUri.host}`;
+        }
+
+        return `${this.scheme}://${requestUri.host}`;
+    }
+
     public async subscribeResource(
         form: MqttForm,
         next: (value: Content) => void,
@@ -62,7 +78,7 @@ export default class MqttClient implements ProtocolClient {
     ): Promise<Subscription> {
         const contentType = form.contentType ?? ContentSerdes.DEFAULT;
         const requestUri = new url.URL(form.href);
-        const brokerUri: string = `${this.scheme}://` + requestUri.host;
+        const brokerUri: string = this.getBrokerUri(form.href);
         // Keeping the path as the topic for compatibility reasons.
         // Current specification allows only form["mqv:filter"]
         const filter = requestUri.pathname.slice(1) ?? form["mqv:filter"];
@@ -92,7 +108,7 @@ export default class MqttClient implements ProtocolClient {
     public async readResource(form: MqttForm): Promise<Content> {
         const contentType = form.contentType ?? ContentSerdes.DEFAULT;
         const requestUri = new url.URL(form.href);
-        const brokerUri: string = `${this.scheme}://` + requestUri.host;
+        const brokerUri: string = this.getBrokerUri(form.href);
         // Keeping the path as the topic for compatibility reasons.
         // Current specification allows only form["mqv:filter"]
         const filter = requestUri.pathname.slice(1) ?? form["mqv:filter"];
@@ -124,7 +140,7 @@ export default class MqttClient implements ProtocolClient {
 
     public async writeResource(form: MqttForm, content: Content): Promise<void> {
         const requestUri = new url.URL(form.href);
-        const brokerUri = `${this.scheme}://${requestUri.host}`;
+        const brokerUri = this.getBrokerUri(form.href);
         const topic = requestUri.pathname.slice(1) ?? form["mqv:topic"];
 
         let pool = this.pools.get(brokerUri);
@@ -147,7 +163,7 @@ export default class MqttClient implements ProtocolClient {
     public async invokeResource(form: MqttForm, content: Content): Promise<Content> {
         const requestUri = new url.URL(form.href);
         const topic = requestUri.pathname.slice(1);
-        const brokerUri = `${this.scheme}://${requestUri.host}`;
+        const brokerUri = this.getBrokerUri(form.href);
 
         let pool = this.pools.get(brokerUri);
 
@@ -170,7 +186,7 @@ export default class MqttClient implements ProtocolClient {
 
     public async unlinkResource(form: Form): Promise<void> {
         const requestUri = new url.URL(form.href);
-        const brokerUri: string = `${this.scheme}://` + requestUri.host;
+        const brokerUri: string = this.getBrokerUri(form.href);
         const topic = requestUri.pathname.slice(1);
 
         const pool = this.pools.get(brokerUri);

packages/binding-mqtt/src/mqtts-client-factory.ts

@@ -17,30 +17,15 @@
  * Protocol test suite to test protocol implementations
  */
 
-import { ProtocolClientFactory, ProtocolClient, createDebugLogger } from "@node-wot/core";
 import { MqttClientConfig } from "./mqtt";
-import MqttClient from "./mqtt-client";
+import MqttClientFactory from "./mqtt-client-factory";
 
-const debug = createDebugLogger("binding-mqtt", "mqtts-client-factory");
-
-export default class MqttsClientFactory implements ProtocolClientFactory {
-    public readonly scheme: string = "mqtts";
-    private readonly clients: Array<ProtocolClient> = [];
-
-    constructor(private readonly config: MqttClientConfig) {}
-    getClient(): ProtocolClient {
-        const client = new MqttClient(this.config, true);
-        this.clients.push(client);
-        return client;
-    }
-
-    init(): boolean {
-        return true;
-    }
-
-    destroy(): boolean {
-        debug(`MqttClientFactory stopping all clients for '${this.scheme}'`);
-        this.clients.forEach((client) => client.stop());
-        return true;
+/**
+ * @deprecated Use MqttClientFactory instead. MqttClientFactory now handles both secure and non-secure MQTT protocols.
+ * This class is kept for backward compatibility and simply wraps MqttClientFactory.
+ */
+export default class MqttsClientFactory extends MqttClientFactory {
+    constructor(config: MqttClientConfig) {
+        super(config);
     }
 }