@design.estate/dees-comms 1.1.0 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.smartconfig.json +1 -6
- package/dist_bundle/bundle.js +7 -7
- package/dist_bundle/bundle.js.map +1 -1
- package/dist_bundle/bundle.js.third-party-notices.json +408 -0
- package/dist_bundle/bundle.js.third-party-notices.txt +968 -0
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/dees-comms.classes.deescomms.d.ts +7 -0
- package/dist_ts/dees-comms.classes.deescomms.js +35 -1
- package/dist_ts/dees-comms.plugins.d.ts +1 -2
- package/dist_ts/dees-comms.plugins.js +3 -4
- package/package.json +6 -7
- package/readme.md +3 -1
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/dees-comms.classes.deescomms.ts +50 -0
- package/ts/dees-comms.plugins.ts +2 -3
- /package/{license → license.md} +0 -0
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@design.estate/dees-comms',
|
|
6
|
-
version: '1.1.
|
|
6
|
+
version: '1.1.2',
|
|
7
7
|
description: 'A communications module for enabling DOM-based messaging and synchronization across browser tabs and workers.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSwyQkFBMkI7SUFDakMsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLCtHQUErRztDQUM3SCxDQUFBIn0=
|
|
@@ -32,6 +32,7 @@ export declare class DeesComms {
|
|
|
32
32
|
readonly channelName: string;
|
|
33
33
|
private readonly channel;
|
|
34
34
|
private readonly eventHandlers;
|
|
35
|
+
private hasTypedHandlers;
|
|
35
36
|
private closed;
|
|
36
37
|
private closing;
|
|
37
38
|
typedrouter: plugins.typedrequest.TypedRouter<plugins.typedrequestInterfaces.ITypedRequest>;
|
|
@@ -69,6 +70,12 @@ export declare class DeesComms {
|
|
|
69
70
|
* and ends with its own timeout. Closing again does nothing.
|
|
70
71
|
*/
|
|
71
72
|
close(): Promise<void>;
|
|
73
|
+
/**
|
|
74
|
+
* In Node.js an instance keeps its process alive while something listens on
|
|
75
|
+
* it, as a MessagePort with a message listener does: a subscription, or a
|
|
76
|
+
* typed handler it created. One nobody listens on lets the process end.
|
|
77
|
+
*/
|
|
78
|
+
private holdProcessWhileListened;
|
|
72
79
|
private assertOpen;
|
|
73
80
|
private receive;
|
|
74
81
|
private dispatch;
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
import * as plugins from './dees-comms.plugins.js';
|
|
2
|
+
const isProcessHolding = (channelArg) => 'ref' in channelArg &&
|
|
3
|
+
typeof channelArg.ref === 'function' &&
|
|
4
|
+
'unref' in channelArg &&
|
|
5
|
+
typeof channelArg.unref === 'function';
|
|
2
6
|
/**
|
|
3
7
|
* Opens a channel that hands every message it receives to `receiveArg` as the
|
|
4
8
|
* message itself: the platform's BroadcastChannel delivers a MessageEvent, the
|
|
@@ -10,6 +14,9 @@ const openChannel = (nameArg, receiveArg) => {
|
|
|
10
14
|
channel.onmessage = (eventArg) => {
|
|
11
15
|
receiveArg(eventArg.data);
|
|
12
16
|
};
|
|
17
|
+
const processHolding = isProcessHolding(channel) ? channel : null;
|
|
18
|
+
// an open channel alone does not keep a Node.js process running
|
|
19
|
+
processHolding?.unref();
|
|
13
20
|
return {
|
|
14
21
|
post: async (messageArg) => {
|
|
15
22
|
channel.postMessage(messageArg);
|
|
@@ -17,6 +24,14 @@ const openChannel = (nameArg, receiveArg) => {
|
|
|
17
24
|
close: async () => {
|
|
18
25
|
channel.close();
|
|
19
26
|
},
|
|
27
|
+
holdProcess: (holdArg) => {
|
|
28
|
+
if (holdArg) {
|
|
29
|
+
processHolding?.ref();
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
processHolding?.unref();
|
|
33
|
+
}
|
|
34
|
+
},
|
|
20
35
|
};
|
|
21
36
|
}
|
|
22
37
|
const channel = new plugins.BroadCastChannelPolyfill(nameArg);
|
|
@@ -26,6 +41,9 @@ const openChannel = (nameArg, receiveArg) => {
|
|
|
26
41
|
return {
|
|
27
42
|
post: (messageArg) => channel.postMessage(messageArg),
|
|
28
43
|
close: () => channel.close(),
|
|
44
|
+
// the polyfill stands in only where the platform has no channel, which
|
|
45
|
+
// Node.js always has
|
|
46
|
+
holdProcess: () => undefined,
|
|
29
47
|
};
|
|
30
48
|
};
|
|
31
49
|
const isObject = (valueArg) => typeof valueArg === 'object' && valueArg !== null;
|
|
@@ -65,6 +83,7 @@ export class DeesComms {
|
|
|
65
83
|
// receiving messages
|
|
66
84
|
constructor(optionsArg = {}) {
|
|
67
85
|
this.eventHandlers = new Map();
|
|
86
|
+
this.hasTypedHandlers = false;
|
|
68
87
|
this.closed = false;
|
|
69
88
|
this.closing = null;
|
|
70
89
|
// sending messages
|
|
@@ -99,6 +118,8 @@ export class DeesComms {
|
|
|
99
118
|
*/
|
|
100
119
|
async createTypedHandler(methodArg, handlerFunction) {
|
|
101
120
|
this.typedrouter.addTypedHandler(new plugins.typedrequest.TypedHandler(methodArg, handlerFunction));
|
|
121
|
+
this.hasTypedHandlers = true;
|
|
122
|
+
this.holdProcessWhileListened();
|
|
102
123
|
}
|
|
103
124
|
/**
|
|
104
125
|
* Sends a typed event to every other instance on this channel and expects
|
|
@@ -132,6 +153,7 @@ export class DeesComms {
|
|
|
132
153
|
this.eventHandlers.set(nameArg, handlers);
|
|
133
154
|
}
|
|
134
155
|
handlers.add(handler);
|
|
156
|
+
this.holdProcessWhileListened();
|
|
135
157
|
return {
|
|
136
158
|
unsubscribe: () => {
|
|
137
159
|
const current = this.eventHandlers.get(nameArg);
|
|
@@ -141,6 +163,7 @@ export class DeesComms {
|
|
|
141
163
|
current.delete(handler);
|
|
142
164
|
if (current.size === 0) {
|
|
143
165
|
this.eventHandlers.delete(nameArg);
|
|
166
|
+
this.holdProcessWhileListened();
|
|
144
167
|
}
|
|
145
168
|
},
|
|
146
169
|
};
|
|
@@ -159,6 +182,17 @@ export class DeesComms {
|
|
|
159
182
|
}
|
|
160
183
|
await this.closing;
|
|
161
184
|
}
|
|
185
|
+
/**
|
|
186
|
+
* In Node.js an instance keeps its process alive while something listens on
|
|
187
|
+
* it, as a MessagePort with a message listener does: a subscription, or a
|
|
188
|
+
* typed handler it created. One nobody listens on lets the process end.
|
|
189
|
+
*/
|
|
190
|
+
holdProcessWhileListened() {
|
|
191
|
+
if (this.closed) {
|
|
192
|
+
return;
|
|
193
|
+
}
|
|
194
|
+
this.channel.holdProcess(this.hasTypedHandlers || this.eventHandlers.size > 0);
|
|
195
|
+
}
|
|
162
196
|
assertOpen() {
|
|
163
197
|
if (this.closed) {
|
|
164
198
|
throw new Error(`DeesComms channel "${this.channelName}" is closed`);
|
|
@@ -206,4 +240,4 @@ export class DeesComms {
|
|
|
206
240
|
}
|
|
207
241
|
}
|
|
208
242
|
}
|
|
209
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
243
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"dees-comms.classes.deescomms.js","sourceRoot":"","sources":["../ts/dees-comms.classes.deescomms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAgEnD,MAAM,gBAAgB,GAAG,CAAC,UAAkB,EAAwC,EAAE,CACpF,KAAK,IAAI,UAAU;IACnB,OAAO,UAAU,CAAC,GAAG,KAAK,UAAU;IACpC,OAAO,IAAI,UAAU;IACrB,OAAO,UAAU,CAAC,KAAK,KAAK,UAAU,CAAC;AAEzC;;;;GAIG;AACH,MAAM,WAAW,GAAG,CAClB,OAAe,EACf,UAAyC,EACtB,EAAE;IACrB,IAAI,OAAO,UAAU,CAAC,gBAAgB,KAAK,UAAU,EAAE,CAAC;QACtD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACzD,OAAO,CAAC,SAAS,GAAG,CAAC,QAA+B,EAAE,EAAE;YACtD,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC;QACF,MAAM,cAAc,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;QAClE,gEAAgE;QAChE,cAAc,EAAE,KAAK,EAAE,CAAC;QACxB,OAAO;YACL,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBACzB,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAClC,CAAC;YACD,KAAK,EAAE,KAAK,IAAI,EAAE;gBAChB,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,CAAC;YACD,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE;gBACvB,IAAI,OAAO,EAAE,CAAC;oBACZ,cAAc,EAAE,GAAG,EAAE,CAAC;gBACxB,CAAC;qBAAM,CAAC;oBACN,cAAc,EAAE,KAAK,EAAE,CAAC;gBAC1B,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,wBAAwB,CAAU,OAAO,CAAC,CAAC;IACvE,OAAO,CAAC,SAAS,GAAG,CAAC,UAAmB,EAAE,EAAE;QAC1C,UAAU,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC,CAAC;IACF,OAAO;QACL,IAAI,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC;QACrD,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE;QAC5B,uEAAuE;QACvE,qBAAqB;QACrB,WAAW,EAAE,GAAG,EAAE,CAAC,SAAS;KAC7B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,QAAiB,EAAuC,EAAE,CAC1E,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,CAAC;AAEpD,2EAA2E;AAC3E,MAAM,MAAM,GAAG,CAAC,SAAkC,EAAE,MAAc,EAAW,EAAE,CAC7E,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,OAAO,GAAG,CACd,UAAmB,EACuD,EAAE;IAC5E,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,gBAAgB,CAAC,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,cAAc,CAAC;IACxC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChB,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;QACvC,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,EACzB,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;AAC1F,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,GAAW,EAAE;IACjC,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IACpE,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxF,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,SAAS;IACpB;;;;OAIG;aACoB,uBAAkB,GAAG,YAAY,AAAf,CAAgB;IAkBzD,qBAAqB;IACrB,YAAY,aAAgC,EAAE;QAf7B,kBAAa,GAAG,IAAI,GAAG,EAAoC,CAAC;QACrE,qBAAgB,GAAG,KAAK,CAAC;QACzB,WAAM,GAAG,KAAK,CAAC;QACf,YAAO,GAAyB,IAAI,CAAC;QAE7C,mBAAmB;QACZ,gBAAW,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;QACrD,gBAAW,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC;YACxD,yBAAyB,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC9C,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YACrC,CAAC;YACD,cAAc,EAAE,IAAI,CAAC,WAAW;SACjC,CAAC,CAAC;QAID,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,IAAI,SAAS,CAAC,kBAAkB,CAAC;QAC1E,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,EAAE;YAC1D,KAAK,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,kBAAkB,CACvB,UAAuB;QAEvB,MAAM,YAAY,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACzF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,WAAW,CACtB,UAAa;QAEb,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,kBAAkB,CAC7B,SAAsB,EACtB,eAAyD;QAEzD,IAAI,CAAC,WAAW,CAAC,eAAe,CAC9B,IAAI,OAAO,CAAC,YAAY,CAAC,YAAY,CAAI,SAAS,EAAE,eAAe,CAAC,CACrE,CAAC;QACF,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,OAAkB,EAClB,UAAwB;QAExB,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE;gBACd,IAAI,EAAE,OAAO;gBACb,aAAa,EAAE,aAAa,EAAE;gBAC9B,OAAO,EAAE,UAAU;aACpB;SACF,CAAC;QACF,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACI,SAAS,CACd,OAAkB,EAClB,UAAqC;QAErC,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,wEAAwE;QACxE,qDAAqD;QACrD,MAAM,OAAO,GAAwB,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,CAC5D,UAAU,CAAC,UAA0B,EAAE,QAAa,CAAC,CAAC;QACxD,IAAI,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;YACrB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAChC,OAAO;YACL,WAAW,EAAE,GAAG,EAAE;gBAChB,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAChD,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,OAAO;gBACT,CAAC;gBACD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACxB,IAAI,OAAO,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;oBACvB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBACnC,IAAI,CAAC,wBAAwB,EAAE,CAAC;gBAClC,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACtC,CAAC;QACD,MAAM,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACK,wBAAwB;QAC9B,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IACjF,CAAC;IAEO,UAAU;QAChB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,WAAW,aAAa,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,UAAmB;QACvC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;YACpD,OAAO;QACT,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QACD,uEAAuE;QACvE,uEAAuE;QACvE,iCAAiC;QACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,CACzD,UAA0D,EAC1D,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB,CAAC;QACF,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAChD,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAEO,QAAQ,CAAC,QAA6D;QAC5E,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO;QACT,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;YACpC,kEAAkE;YAClE,sDAAsD;YACtD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,OAAO;YACT,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC3B,SAAS;YACX,CAAC;YACD,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAiB,EAAE,EAAE;gBACnF,sDAAsD;gBACtD,OAAO,CAAC,KAAK,CAAC,sCAAsC,QAAQ,CAAC,IAAI,UAAU,EAAE,QAAQ,CAAC,CAAC;YACzF,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import * as smartdelay from '@push.rocks/smartdelay';
|
|
2
1
|
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
|
|
3
2
|
import * as typedrequest from '@api.global/typedrequest';
|
|
4
|
-
export {
|
|
3
|
+
export { typedrequestInterfaces, typedrequest };
|
|
5
4
|
import { BroadcastChannel as BroadCastChannelPolyfill } from 'broadcast-channel';
|
|
6
5
|
export { BroadCastChannelPolyfill };
|
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
//
|
|
2
|
-
import * as smartdelay from '@push.rocks/smartdelay';
|
|
1
|
+
// apiglobal scope
|
|
3
2
|
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
|
|
4
3
|
import * as typedrequest from '@api.global/typedrequest';
|
|
5
|
-
export {
|
|
4
|
+
export { typedrequestInterfaces, typedrequest };
|
|
6
5
|
// third party scope
|
|
7
6
|
import { BroadcastChannel as BroadCastChannelPolyfill } from 'broadcast-channel';
|
|
8
7
|
export { BroadCastChannelPolyfill };
|
|
9
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
8
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVlcy1jb21tcy5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvZGVlcy1jb21tcy5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGtCQUFrQjtBQUNsQixPQUFPLEtBQUssc0JBQXNCLE1BQU0scUNBQXFDLENBQUM7QUFDOUUsT0FBTyxLQUFLLFlBQVksTUFBTSwwQkFBMEIsQ0FBQztBQUV6RCxPQUFPLEVBQUUsc0JBQXNCLEVBQUUsWUFBWSxFQUFFLENBQUM7QUFFaEQsb0JBQW9CO0FBQ3BCLE9BQU8sRUFBRSxnQkFBZ0IsSUFBSSx3QkFBd0IsRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBRWpGLE9BQU8sRUFDTCx3QkFBd0IsRUFDekIsQ0FBQSJ9
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@design.estate/dees-comms",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "A communications module for enabling DOM-based messaging and synchronization across browser tabs and workers.",
|
|
6
6
|
"main": "dist_ts/index.js",
|
|
@@ -9,16 +9,15 @@
|
|
|
9
9
|
"author": "Lossless GmbH",
|
|
10
10
|
"license": "MIT",
|
|
11
11
|
"devDependencies": {
|
|
12
|
-
"@git.zone/tsbuild": "^
|
|
13
|
-
"@git.zone/tsbundle": "^
|
|
14
|
-
"@git.zone/tsrun": "^3.0.
|
|
15
|
-
"@git.zone/tstest": "^6.2
|
|
16
|
-
"@types/node": "^26.6.
|
|
12
|
+
"@git.zone/tsbuild": "^5.0.0",
|
|
13
|
+
"@git.zone/tsbundle": "^3.0.0",
|
|
14
|
+
"@git.zone/tsrun": "^3.0.2",
|
|
15
|
+
"@git.zone/tstest": "^6.3.2",
|
|
16
|
+
"@types/node": "^26.6.2"
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"@api.global/typedrequest": "^8.0.3",
|
|
20
20
|
"@api.global/typedrequest-interfaces": "^7.1.0",
|
|
21
|
-
"@push.rocks/smartdelay": "^3.0.5",
|
|
22
21
|
"broadcast-channel": "^7.2.0"
|
|
23
22
|
},
|
|
24
23
|
"files": [
|
package/readme.md
CHANGED
|
@@ -109,7 +109,9 @@ subscription.unsubscribe();
|
|
|
109
109
|
await comms.close();
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
A closed instance receives nothing: its subscriptions end and its typed handlers are no longer asked. `postMessage()`, `broadcast()` and the typed requests it fires reject, and `subscribe()` throws. A typed request that is still waiting for its response when the channel closes cannot receive it and ends with its own timeout. Closing again does nothing.
|
|
112
|
+
A closed instance receives nothing: its subscriptions end and its typed handlers are no longer asked. `postMessage()`, `broadcast()` and the typed requests it fires reject, and `subscribe()` throws. A typed request that is still waiting for its response when the channel closes cannot receive it and ends with its own timeout. Closing again does nothing.
|
|
113
|
+
|
|
114
|
+
In Node.js an instance keeps the process alive only while something listens on it, as a `MessagePort` with a message listener does: while it has a subscription, or once it has created a typed handler. An instance nobody listens on, such as the one `@design.estate/dees-domtools` opens on import, lets the process end. An unsubscribed or closed instance lets it end too, so close every instance with a typed handler that a test or a script opens. In browsers and workers nothing changes.
|
|
113
115
|
|
|
114
116
|
### What travels
|
|
115
117
|
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -46,8 +46,28 @@ type TStoredEventHandler = (
|
|
|
46
46
|
interface IDeesCommsChannel {
|
|
47
47
|
post(messageArg: unknown): Promise<void>;
|
|
48
48
|
close(): Promise<void>;
|
|
49
|
+
/**
|
|
50
|
+
* Whether the open channel keeps its process alive. Only Node.js's channel
|
|
51
|
+
* can hold a process; elsewhere this does nothing.
|
|
52
|
+
*/
|
|
53
|
+
holdProcess(holdArg: boolean): void;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* A channel that decides whether it keeps its process alive, as Node.js's
|
|
58
|
+
* BroadcastChannel does. A browser's channel has neither method.
|
|
59
|
+
*/
|
|
60
|
+
interface IProcessHoldingChannel {
|
|
61
|
+
ref(): void;
|
|
62
|
+
unref(): void;
|
|
49
63
|
}
|
|
50
64
|
|
|
65
|
+
const isProcessHolding = (channelArg: object): channelArg is IProcessHoldingChannel =>
|
|
66
|
+
'ref' in channelArg &&
|
|
67
|
+
typeof channelArg.ref === 'function' &&
|
|
68
|
+
'unref' in channelArg &&
|
|
69
|
+
typeof channelArg.unref === 'function';
|
|
70
|
+
|
|
51
71
|
/**
|
|
52
72
|
* Opens a channel that hands every message it receives to `receiveArg` as the
|
|
53
73
|
* message itself: the platform's BroadcastChannel delivers a MessageEvent, the
|
|
@@ -62,6 +82,9 @@ const openChannel = (
|
|
|
62
82
|
channel.onmessage = (eventArg: MessageEvent<unknown>) => {
|
|
63
83
|
receiveArg(eventArg.data);
|
|
64
84
|
};
|
|
85
|
+
const processHolding = isProcessHolding(channel) ? channel : null;
|
|
86
|
+
// an open channel alone does not keep a Node.js process running
|
|
87
|
+
processHolding?.unref();
|
|
65
88
|
return {
|
|
66
89
|
post: async (messageArg) => {
|
|
67
90
|
channel.postMessage(messageArg);
|
|
@@ -69,6 +92,13 @@ const openChannel = (
|
|
|
69
92
|
close: async () => {
|
|
70
93
|
channel.close();
|
|
71
94
|
},
|
|
95
|
+
holdProcess: (holdArg) => {
|
|
96
|
+
if (holdArg) {
|
|
97
|
+
processHolding?.ref();
|
|
98
|
+
} else {
|
|
99
|
+
processHolding?.unref();
|
|
100
|
+
}
|
|
101
|
+
},
|
|
72
102
|
};
|
|
73
103
|
}
|
|
74
104
|
const channel = new plugins.BroadCastChannelPolyfill<unknown>(nameArg);
|
|
@@ -78,6 +108,9 @@ const openChannel = (
|
|
|
78
108
|
return {
|
|
79
109
|
post: (messageArg) => channel.postMessage(messageArg),
|
|
80
110
|
close: () => channel.close(),
|
|
111
|
+
// the polyfill stands in only where the platform has no channel, which
|
|
112
|
+
// Node.js always has
|
|
113
|
+
holdProcess: () => undefined,
|
|
81
114
|
};
|
|
82
115
|
};
|
|
83
116
|
|
|
@@ -129,6 +162,7 @@ export class DeesComms {
|
|
|
129
162
|
public readonly channelName: string;
|
|
130
163
|
private readonly channel: IDeesCommsChannel;
|
|
131
164
|
private readonly eventHandlers = new Map<string, Set<TStoredEventHandler>>();
|
|
165
|
+
private hasTypedHandlers = false;
|
|
132
166
|
private closed = false;
|
|
133
167
|
private closing: Promise<void> | null = null;
|
|
134
168
|
|
|
@@ -179,6 +213,8 @@ export class DeesComms {
|
|
|
179
213
|
this.typedrouter.addTypedHandler(
|
|
180
214
|
new plugins.typedrequest.TypedHandler<T>(methodArg, handlerFunction)
|
|
181
215
|
);
|
|
216
|
+
this.hasTypedHandlers = true;
|
|
217
|
+
this.holdProcessWhileListened();
|
|
182
218
|
}
|
|
183
219
|
|
|
184
220
|
/**
|
|
@@ -221,6 +257,7 @@ export class DeesComms {
|
|
|
221
257
|
this.eventHandlers.set(nameArg, handlers);
|
|
222
258
|
}
|
|
223
259
|
handlers.add(handler);
|
|
260
|
+
this.holdProcessWhileListened();
|
|
224
261
|
return {
|
|
225
262
|
unsubscribe: () => {
|
|
226
263
|
const current = this.eventHandlers.get(nameArg);
|
|
@@ -230,6 +267,7 @@ export class DeesComms {
|
|
|
230
267
|
current.delete(handler);
|
|
231
268
|
if (current.size === 0) {
|
|
232
269
|
this.eventHandlers.delete(nameArg);
|
|
270
|
+
this.holdProcessWhileListened();
|
|
233
271
|
}
|
|
234
272
|
},
|
|
235
273
|
};
|
|
@@ -250,6 +288,18 @@ export class DeesComms {
|
|
|
250
288
|
await this.closing;
|
|
251
289
|
}
|
|
252
290
|
|
|
291
|
+
/**
|
|
292
|
+
* In Node.js an instance keeps its process alive while something listens on
|
|
293
|
+
* it, as a MessagePort with a message listener does: a subscription, or a
|
|
294
|
+
* typed handler it created. One nobody listens on lets the process end.
|
|
295
|
+
*/
|
|
296
|
+
private holdProcessWhileListened(): void {
|
|
297
|
+
if (this.closed) {
|
|
298
|
+
return;
|
|
299
|
+
}
|
|
300
|
+
this.channel.holdProcess(this.hasTypedHandlers || this.eventHandlers.size > 0);
|
|
301
|
+
}
|
|
302
|
+
|
|
253
303
|
private assertOpen(): void {
|
|
254
304
|
if (this.closed) {
|
|
255
305
|
throw new Error(`DeesComms channel "${this.channelName}" is closed`);
|
package/ts/dees-comms.plugins.ts
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
//
|
|
2
|
-
import * as smartdelay from '@push.rocks/smartdelay';
|
|
1
|
+
// apiglobal scope
|
|
3
2
|
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
|
|
4
3
|
import * as typedrequest from '@api.global/typedrequest';
|
|
5
4
|
|
|
6
|
-
export {
|
|
5
|
+
export { typedrequestInterfaces, typedrequest };
|
|
7
6
|
|
|
8
7
|
// third party scope
|
|
9
8
|
import { BroadcastChannel as BroadCastChannelPolyfill } from 'broadcast-channel';
|
/package/{license → license.md}
RENAMED
|
File without changes
|