@webqit/port-plus 0.1.14 → 0.1.15

package/package.json

@@ -14,7 +14,7 @@
   ],
   "homepage": "https://port-plus.netlify.app/",
   "icon": "https://webqit.io/icon.svg",
-  "version": "0.1.14",
+  "version": "0.1.15",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -38,10 +38,10 @@
     "@webqit/util": "^0.8.16"
   },
   "peerDependencies": {
-    "@webqit/observer": "^3.8.17"
+    "@webqit/observer": "^3.8.19"
   },
   "devDependencies": {
-    "@webqit/observer": "^3.8.17",
+    "@webqit/observer": "^3.8.19",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "esbuild": "^0.20.2",

package/src/BroadcastChannelPlus.js

@@ -4,19 +4,29 @@ import {
 } from './MessagePortPlus.js';
 
 export class BroadcastChannelPlus extends MessagePortPlusMockPortsMixin(BroadcastChannel) {
-    constructor(name, { autoStart = true, postAwaitsOpen = false, clientServerMode = null, autoClose = true } = {}) {
+    constructor(name, { handshake = 0, postAwaitsOpen = false, clientServerMode = null, autoClose = false } = {}) {
         super(name);
 
         const portPlusMeta = _meta(this);
 
+        if (typeof handshake !== 'number') {
+            throw new Error('handshake must be a number');
+        }
+        if (handshake < 0 || handshake > 2) {
+            throw new Error('handshake must be between 0 and 2');
+        }
+
         if (clientServerMode
             && !['server', 'client'].includes(clientServerMode)) {
             throw new Error('clientServerMode must be "server" or "client"');
         }
-        portPlusMeta.set('options', { autoStart, postAwaitsOpen, clientServerMode, autoClose });
+
+        portPlusMeta.set('options', { handshake, postAwaitsOpen, clientServerMode, autoClose });
         // Must come before upgradeEvents()
 
         this.constructor/* IMPORTANT */.upgradeEvents(this);
+
+        if (handshake === 0) this.start();
     }
 
     __postMessage(payload, portOptions) {

package/src/MessageChannelPlus.js

@@ -2,10 +2,10 @@ import { MessagePortPlus } from './MessagePortPlus.js';
 
 export class MessageChannelPlus extends MessageChannel {
 
-    constructor({ autoStart = true, postAwaitsOpen = false } = {}) {
+    constructor({ handshake = 0, postAwaitsOpen = false } = {}) {
         super();
         [this.port1, this.port2].forEach((port, i) => {
-            MessagePortPlus.upgradeInPlace(port, { autoStart, postAwaitsOpen });
+            MessagePortPlus.upgradeInPlace(port, { handshake, postAwaitsOpen });
         });
     }
 }

package/src/MessageEventPlus.js

@@ -50,8 +50,7 @@ export class MessageEventPlus extends MessageEvent {
         this.#honourDoneMutationFlags = honourDoneMutationFlags;
 
         this.#ports = ports;
-        const options = this.#originalTarget && _options(this.#originalTarget) || {};
-        this.#ports.forEach((port) => MessagePortPlus.upgradeInPlace(port, { autoStart: options.autoStart, postAwaitsOpen: options.postAwaitsOpen }));
+        this.#ports.forEach((port) => MessagePortPlus.upgradeInPlace(port));
 
         if (_isTypeObject(this.#data) && this.#live) {
             if (typeof eventID !== 'string') {

package/src/MessagePortPlus.js

@@ -29,10 +29,18 @@ const portPlusProps = [
 
 export class MessagePortPlus extends MessagePortPlusMixin(EventTarget) {
 
-    constructor(options = {}) {
+    constructor({ handshake = 0, postAwaitsOpen = false, ...options } = {}) {
+        if (typeof handshake !== 'number') {
+            throw new Error('handshake must be a number');
+        }
+        if (handshake < 0 || handshake > 2) {
+            throw new Error('handshake must be between 0 and 2');
+        }
+
         super();
+
         const portPlusMeta = _wq(this, 'meta');
-        portPlusMeta.set('options', options);
+        portPlusMeta.set('options', { handshake, postAwaitsOpen, ...options });
     }
 
     static [Symbol.hasInstance](instance) {
@@ -47,11 +55,18 @@ export class MessagePortPlus extends MessagePortPlusMixin(EventTarget) {
 export function MessagePortPlusMixin(superClass) {
     return class extends superClass {
 
-        static upgradeInPlace(port, options = {}) {
+        static upgradeInPlace(port, { handshake = 0, postAwaitsOpen = false } = {}) {
             if (port instanceof MessagePortPlus) {
                 return port;
             }
 
+            if (typeof handshake !== 'number') {
+                throw new Error('handshake must be a number');
+            }
+            if (handshake < 0 || handshake > 2) {
+                throw new Error('handshake must be between 0 and 2');
+            }
+
             const proto = this.prototype;
 
             for (const prop of portPlusMethods.concat('_autoStart')) {
@@ -71,9 +86,12 @@ export function MessagePortPlusMixin(superClass) {
             }
 
             const portPlusMeta = _wq(port, 'meta');
-            portPlusMeta.set('options', options);
+            portPlusMeta.set('options', { handshake, postAwaitsOpen });
 
             this.upgradeEvents(port);
+
+            if (handshake === 0) port.start();
+
             return port;
         }
 
@@ -115,28 +133,34 @@ export function MessagePortPlusMixin(superClass) {
 
                 if (e.data.ping === 'connect'
                     && typeof e.data?.['.wq']?.eventID === 'string'
-                    && (!(port instanceof WebSocket) || !options.naturalOpen)) {
+                    && (!(port instanceof WebSocket) || options.handshake)) {
                     // This is a special ping from a MessagePort or BroadcastChannel instance
                     // that helps us simulate an "open" event
-                    // If !options.naturalOpen, WebSockets too
+                    // If options.handshake !== 0, WebSockets too
 
-                    let reply = true;
+                    const nowOpen = options.handshake === 0
+                        || portPlusMeta.get('start.called');
+
+                    const reply = { isOpen: nowOpen };
 
                     if (port instanceof BroadcastChannel) {
                         if (options.clientServerMode === 'server'
                             && typeof e.data.id === 'string') {
                             portPlusMeta.get('clients').add(e.data.id);
-                            reply = 'server';
+                            reply.id = 'server';
                         } else if (e.data.id === 'server'
                             && portPlusMeta.has('client_id')) {
-                            reply = portPlusMeta.get('client_id');
+                            reply.id = portPlusMeta.get('client_id');
                         }
                     }
 
                     e.ports?.forEach((p) => p.postMessage(reply));
 
-                    portPlusMeta.set('remote.start.called', true);
-                    portPlus.start();
+                    if (nowOpen) {
+                        portPlusMeta.set('remote.open.called', true);
+                        portPlus.start();
+                    }
+
                     return;
                 }
 
@@ -195,46 +219,19 @@ export function MessagePortPlusMixin(superClass) {
                 portPlus.dispatchEvent(eventPlus);
             };
 
-            // ------------- OPEN
-
-            const openHandler = (e) => {
-                // Native "open" event fired by WebSocket
-                if (port instanceof WebSocket
-                    && options.naturalOpen
-                    && !(e instanceof MessageEventPlus)) {
-                    portPlusMeta.set('remote.start.called', true);
-                    portPlus.start();
-                }
-            };
-
-            // ------------- CLOSE
-
-            const closeHandler = (e) => {
-                // Native "close" events fired by MessagePort and WebSocket
-                if ((port instanceof WebSocket || port instanceof MessagePort)
-                    && !(e instanceof MessageEventPlus)) {
-                    portPlusMeta.set('remote.close.called', true);
-                    portPlus.close();
-                }
-            };
-
             rawPortMeta.set('internal_call', true);
             port.addEventListener('message', messageHandler);
             port.addEventListener('error', messageHandler);
-            port.addEventListener('open', openHandler);
-            port.addEventListener('close', closeHandler);
             rawPortMeta.delete('internal_call');
 
-            rawPortMeta.set('events+', true);
-
             garbageCollection.add(() => {
                 port.removeEventListener('message', messageHandler);
                 port.removeEventListener('error', messageHandler);
-                port.removeEventListener('open', openHandler);
-                port.removeEventListener('close', closeHandler);
 
                 rawPortMeta.set('events+', false);
             });
+
+            rawPortMeta.set('events+', true);
         }
 
         get options() { return { ..._options(this) }; }
@@ -282,11 +279,9 @@ export function MessagePortPlusMixin(superClass) {
         }
 
         set onmessage(v) {
-            // Auto-start?
-            this._autoStart();
-
             if (typeof super.onmessage !== 'undefined') {
                 super.onmessage = v;
+                this._autoStart();
                 return;
             }
 
@@ -296,18 +291,17 @@ export function MessagePortPlusMixin(superClass) {
 
             if (Object.getOwnPropertyDescriptor(this, '_onmessage')?.set) {
                 this._onmessage = v;
+                this._autoStart();
                 return;
             }
 
             if (this._onmessage) this.removeEventListener('message', this._onmessage);
             this.addEventListener('message', v);
             this._onmessage = v;
+            this._autoStart();
         }
 
         addEventListener(...args) {
-            // Auto-start?
-            this._autoStart();
-
             // Add to registry 
             const garbageCollection = getGarbageCollection.call(this);
             garbageCollection.add(() => {
@@ -317,9 +311,11 @@ export function MessagePortPlusMixin(superClass) {
             });
 
             // Execute addEventListener()
-            return this._addEventListener
+            const returnValue = this._addEventListener
                 ? this._addEventListener(...args)
                 : super.addEventListener(...args);
+            this._autoStart();
+            return returnValue;
         }
 
         dispatchEvent(event) {
@@ -334,7 +330,6 @@ export function MessagePortPlusMixin(superClass) {
         }
 
         postMessage(message, transferOrOptions = {}) {
-            // Auto-start?
             this._autoStart();
 
             // Update readyState
@@ -455,21 +450,21 @@ export function MessagePortPlusMixin(superClass) {
             };
         }
 
-        channel(channelSpec, resolveMessage = null) {
+        channel(channelSpec, resolveMessage = null, { handshake = 0, postAwaitsOpen = false } = {}) {
             const channel = new MessageChannel;
 
-            MessagePortPlus.upgradeInPlace(channel.port1, { autoStart: this.options.autoStart, postAwaitsOpen: this.options.postAwaitsOpen });
-            MessagePortPlus.upgradeInPlace(channel.port2, { autoStart: this.options.autoStart, postAwaitsOpen: this.options.postAwaitsOpen });
+            MessagePortPlus.upgradeInPlace(channel.port1, { handshake, postAwaitsOpen });
+            MessagePortPlus.upgradeInPlace(channel.port2, { handshake, postAwaitsOpen });
 
             const garbageCollection = getGarbageCollection.call(this);
-            garbageCollection.add(this.relay({ channel: channelSpec, to: channel.port1, bidirectional: true, resolveMessage }));
+            garbageCollection.add(this.relay({ channel: channelSpec, to: channel.port2, bidirectional: true, resolveMessage }));
 
-            channel.port1.start();
+            channel.port2.start();
             this.readyStateChange('close').then(() => {
-                channel.port1.close();
+                channel.port2.close();
             });
 
-            return channel.port2;
+            return channel.port1;
         }
 
         projectMutations({ from, to, ...options }) {
@@ -509,7 +504,7 @@ export function MessagePortPlusMixin(superClass) {
             const portPlusMeta = _meta(this);
             const options = _options(this);
             if (!portPlusMeta.get('internal_call')
-                && options.autoStart) {
+                && options.handshake === 1) {
                 this.start();
             }
         }
@@ -518,30 +513,29 @@ export function MessagePortPlusMixin(superClass) {
             const readyStateInternals = getReadyStateInternals.call(this);
             if (readyStateInternals.open.state) return;
 
-            let messageChannel;
-
-            const readyStateOpen = () => {
-                if (readyStateInternals.open.state) return;
-                readyStateInternals.open.state = true;
-                readyStateInternals.open.resolve(this);
-
-                const openEvent = new MessageEventPlus(null, { type: 'open' });
-                this._dispatchEvent
-                    ? this._dispatchEvent(openEvent)
-                    : super.dispatchEvent(openEvent);
-
-                messageChannel?.port1.close();
-                messageChannel?.port2.close();
-            };
-
             const portPlusMeta = _meta(this);
             const options = _options(this);
 
-            if (portPlusMeta.get('remote.start.called')) {
-                readyStateOpen();
+            const readyStateOpen = (nowOpen) => {
+                if (nowOpen) {
+                    readyStateInternals.open.state = true;
+                    readyStateInternals.open.resolve(this);
+                }
+                const handshakeChannel = portPlusMeta.get('handshake_channel');
+                setTimeout(() => {
+                    handshakeChannel?.port1.close();
+                    handshakeChannel?.port2.close();
+                    portPlusMeta.delete('handshake_channel');
+                }, 100);
+            };
+
+            // A peer ping triggered us to open
+            if (portPlusMeta.get('remote.open.called')) {
+                readyStateOpen(true);
                 return;
             }
 
+            // Start was explicitly called
             if (portPlusMeta.get('start.called')) return;
             portPlusMeta.set('start.called', true);
 
@@ -549,16 +543,26 @@ export function MessagePortPlusMixin(superClass) {
                 ? this._start()
                 : super.start?.();
 
-            messageChannel = new MessageChannel;
+            // No handshake?
+            if (options.handshake === 0) {
+                readyStateOpen(true);
+                return;
+            }
+
+            const handshakeChannel = new MessageChannel;
+            portPlusMeta.set('handshake_channel', handshakeChannel);
 
-            messageChannel.port1.onmessage = (e) => {
+            handshakeChannel.port1.onmessage = (e) => {
                 if (this instanceof BroadcastChannel
                     && options.clientServerMode === 'server'
-                    && typeof e.data === 'string') {
+                    && typeof e.data?.id === 'string') {
                     // Register clients that replied
-                    portPlusMeta.get('clients').add(e.data);
+                    portPlusMeta.get('clients').add(e.data.id);
                 }
-                readyStateOpen();
+                if (typeof e.data?.isOpen) {
+                    // This peer is ready to start messaging
+                    readyStateOpen(true);
+                } else readyStateOpen(false);
             };
 
             const { wqOptions } = preProcessPostMessage.call(this);
@@ -567,8 +571,8 @@ export function MessagePortPlusMixin(superClass) {
             const pingData = { ['.wq']: wqOptions, ping: 'connect', id };
 
             this._postMessage
-                ? this._postMessage(pingData, { transfer: [messageChannel.port2] })
-                : super.postMessage(pingData, { transfer: [messageChannel.port2] });
+                ? this._postMessage(pingData, { transfer: [handshakeChannel.port2] })
+                : super.postMessage(pingData, { transfer: [handshakeChannel.port2] });
         }
 
         close(...args) {
@@ -580,7 +584,8 @@ export function MessagePortPlusMixin(superClass) {
             const portPlusMeta = _meta(this);
             const options = _options(this);
 
-            if (!portPlusMeta.get('remote.close.called')
+            if (options.handshake > 0
+                && !portPlusMeta.get('remote.close.called')
                 && (this instanceof BroadcastChannel || this instanceof MessagePort)) {
 
                 const { wqOptions } = preProcessPostMessage.call(this);
@@ -604,11 +609,6 @@ export function MessagePortPlusMixin(superClass) {
 
             readyStateInternals.close.resolve(this);
 
-            const openEvent = new MessageEventPlus(null, { type: 'close' });
-            this._dispatchEvent
-                ? this._dispatchEvent(openEvent)
-                : super.dispatchEvent(openEvent);
-
             garbageCollect.call(this);
         }
     };
@@ -832,6 +832,7 @@ export function publishMutations(message, eventID, { signal, withArrayMethodDesc
         if (mutationsDone) dispose.abort();
     };
 
+
     const dispose = Observer.observe(message, Observer.subtree(), mutationHandler, { signal, withArrayMethodDescriptors });
     const garbageCollection = getGarbageCollection.call(this);
     garbageCollection.add(dispose);

package/src/StarPort.js

@@ -8,13 +8,16 @@ import {
 export class StarPort extends MessagePortPlus {
 
     #ports = new Set;
+    #startCalled = false;
+    #closeCalled = false;
 
     get length() { return this.#ports.size; }
 
     [Symbol.iterator]() { return this.#ports[Symbol.iterator](); }
 
-    constructor({ autoStart = true, postAwaitsOpen = false, autoClose = true } = {}) {
-        super({ autoStart, postAwaitsOpen, autoClose });
+    constructor({ handshake = 0, postAwaitsOpen = false, autoClose = false } = {}) {
+        super({ handshake, postAwaitsOpen, autoClose });
+        if (handshake === 0) this.start();
     }
 
     addPort(portPlus, { enableBubbling = true } = {}) {
@@ -24,7 +27,7 @@ export class StarPort extends MessagePortPlus {
 
         const readyStateInternals = getReadyStateInternals.call(this);
 
-        if (readyStateInternals.close.state) {
+        if (this.#closeCalled || readyStateInternals.close.state) {
             const starPortName = this.constructor.name;
             throw new Error(`Cannot add port to ${starPortName}. ${starPortName} is closed.`);
         }
@@ -41,8 +44,17 @@ export class StarPort extends MessagePortPlus {
             portPlusMeta.set('parentNode', this); // @ORDER: 2
         }
 
-        portPlus.readyStateChange('open').then(() => this.start());
-        portPlus.readyStateChange('close').then(cleanup);
+        if (this.options.handshake) {
+            portPlus.readyStateChange('open').then(() => {
+                readyStateInternals.open.state = true;
+                readyStateInternals.open.resolve(this);
+            });
+            portPlus.readyStateChange('close').then(() => cleanup());
+        }
+
+        if (this.#startCalled || readyStateInternals.open.state) {
+            portPlus.start();
+        }
 
         const cleanup = () => {
             if (!this.#ports.has(portPlus)) return;
@@ -56,7 +68,8 @@ export class StarPort extends MessagePortPlus {
 
             if (this.#ports.size === 0
                 && _options(this).autoClose) {
-                this.close();
+                readyStateInternals.close.state = true;
+                readyStateInternals.close.resolve(this);
             }
         };
 
@@ -78,33 +91,33 @@ export class StarPort extends MessagePortPlus {
         }
     }
 
-    _autoStart() { } // Must be present to do nothing
-
     start() {
-        const readyStateInternals = getReadyStateInternals.call(this);
-
-        if (readyStateInternals.open.state) return;
-        readyStateInternals.open.state = true;
+        if (this.#startCalled) return;
+        this.#startCalled = true;
 
-        readyStateInternals.open.resolve(this);
+        for (const portPlus of this.#ports) {
+            portPlus.start();
+        }
 
-        const openEvent = new MessageEventPlus(null, { type: 'open' });
-        super.dispatchEvent(openEvent);
+        if (!this.options.handshake) {
+            const readyStateInternals = getReadyStateInternals.call(this);
+            readyStateInternals.open.state = true;
+            readyStateInternals.open.resolve(this);
+        }
     }
 
     close(...args) {
-        const readyStateInternals = getReadyStateInternals.call(this);
-
-        if (readyStateInternals.close.state) return;
-        readyStateInternals.close.state = true;
+        if (this.#closeCalled) return;
+        this.#closeCalled = true;
 
         for (const portPlus of this.#ports) {
-            portPlus.close?.(...args);
+            portPlus.close(...args);
         }
 
-        readyStateInternals.close.resolve(this);
-
-        const closeEvent = new MessageEventPlus(null, { type: 'close' });
-        super.dispatchEvent(closeEvent);
+        if (!this.options.handshake) {
+            const readyStateInternals = getReadyStateInternals.call(this);
+            readyStateInternals.close.state = true;
+            readyStateInternals.close.resolve(this);
+        }
     }
 }

package/src/WebSocketPort.js

@@ -9,30 +9,42 @@ export class WebSocketPort extends MessagePortPlusMockPortsMixin(EventTarget) {
     #ws;
     #wsReady;
 
-    constructor(ws, { autoStart = true, naturalOpen = true, postAwaitsOpen = false } = {}) {
+    constructor(ws, { handshake = 0, postAwaitsOpen = false } = {}) {
         super();
-        this.#ws = typeof ws === 'string' ? new WebSocket(ws) : ws;
-        
+
+        if (typeof handshake !== 'number') {
+            throw new Error('handshake must be a number');
+        }
+        if (handshake < 0 || handshake > 2) {
+            throw new Error('handshake must be between 0 and 2');
+        }
+
         const portPlusMeta = _meta(this);
-        portPlusMeta.set('options', { autoStart, naturalOpen, postAwaitsOpen });
+        portPlusMeta.set('options', { handshake, postAwaitsOpen });
         // Must come before upgradeEvents()
 
+        this.#ws = typeof ws === 'string' ? new WebSocket(ws) : ws;
+
         this.constructor/* IMPORTANT */.upgradeEvents(this.#ws, this);
 
-        if (naturalOpen
-            && autoStart
-            && this.#ws.readyState === WebSocket.OPEN) {
-            this.start();
-        }
         this.#wsReady = new Promise((resolve) => {
             if (this.#ws.readyState === WebSocket.OPEN) {
                 resolve();
             } else {
-                this.#ws.addEventListener('open', resolve);
+                this.#ws.addEventListener('open', () => resolve(), { once: true });
             }
         });
+
+        if (handshake === 0) {
+            this.#wsReady.then(() => this.start());
+        }
+
         if (this.#ws.readyState === WebSocket.CLOSED) {
-            try { this.close(); } catch(e) {}
+            try { this.close(); } catch (e) { }
+        } else {
+            this.#ws.addEventListener('close', () => {
+                try { this.close(); } catch (e) { }
+            }, { once: true });
         }
     }
 
@@ -45,7 +57,7 @@ export class WebSocketPort extends MessagePortPlusMockPortsMixin(EventTarget) {
                 Object.defineProperty(event, 'data', { value: data, configurable: true });
                 return super._hydrateMessage(portPlus, event);
             }
-        } catch (e) {}
+        } catch (e) { }
         return event;
     }