@webiny/api-websockets-standalone 0.0.0-unstable.0156a4c312
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/LICENSE +21 -0
- package/README.md +11 -0
- package/WebsocketsStandaloneFeature.d.ts +10 -0
- package/WebsocketsStandaloneFeature.js +11 -0
- package/WebsocketsStandaloneFeature.js.map +1 -0
- package/adapter/NodeWsAdapter.d.ts +27 -0
- package/adapter/NodeWsAdapter.js +111 -0
- package/adapter/NodeWsAdapter.js.map +1 -0
- package/adapter/abstractions.d.ts +18 -0
- package/adapter/abstractions.js +5 -0
- package/adapter/abstractions.js.map +1 -0
- package/adapter/types.d.ts +2 -0
- package/adapter/types.js +0 -0
- package/bus/InProcessMessageBus.d.ts +11 -0
- package/bus/InProcessMessageBus.js +24 -0
- package/bus/InProcessMessageBus.js.map +1 -0
- package/bus/abstractions.d.ts +30 -0
- package/bus/abstractions.js +5 -0
- package/bus/abstractions.js.map +1 -0
- package/bus/createBusMessageHandler.d.ts +10 -0
- package/bus/createBusMessageHandler.js +20 -0
- package/bus/createBusMessageHandler.js.map +1 -0
- package/connectionManager/ServerConnectionManager.d.ts +21 -0
- package/connectionManager/ServerConnectionManager.js +85 -0
- package/connectionManager/ServerConnectionManager.js.map +1 -0
- package/connectionManager/abstractions.d.ts +34 -0
- package/connectionManager/abstractions.js +5 -0
- package/connectionManager/abstractions.js.map +1 -0
- package/delivery/disconnectLocalSockets.d.ts +10 -0
- package/delivery/disconnectLocalSockets.js +24 -0
- package/delivery/disconnectLocalSockets.js.map +1 -0
- package/delivery/sendToLocalSockets.d.ts +12 -0
- package/delivery/sendToLocalSockets.js +24 -0
- package/delivery/sendToLocalSockets.js.map +1 -0
- package/heartbeat/HeartbeatManager.d.ts +13 -0
- package/heartbeat/HeartbeatManager.js +46 -0
- package/heartbeat/HeartbeatManager.js.map +1 -0
- package/index.d.ts +12 -0
- package/index.js +11 -0
- package/package.json +42 -0
- package/server/WebsocketsServer.d.ts +55 -0
- package/server/WebsocketsServer.js +211 -0
- package/server/WebsocketsServer.js.map +1 -0
- package/server/types.d.ts +44 -0
- package/server/types.js +0 -0
- package/transport/ServerWebsocketsTransport.d.ts +21 -0
- package/transport/ServerWebsocketsTransport.js +77 -0
- package/transport/ServerWebsocketsTransport.js.map +1 -0
- package/upgradeHandler/DefaultUpgradeHandler.d.ts +8 -0
- package/upgradeHandler/DefaultUpgradeHandler.js +15 -0
- package/upgradeHandler/DefaultUpgradeHandler.js.map +1 -0
- package/upgradeHandler/abstractions.d.ts +17 -0
- package/upgradeHandler/abstractions.js +5 -0
- package/upgradeHandler/abstractions.js.map +1 -0
- package/validator/ServerWebsocketsEventValidator.d.ts +4 -0
- package/validator/ServerWebsocketsEventValidator.js +53 -0
- package/validator/ServerWebsocketsEventValidator.js.map +1 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) Webiny
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# @webiny/api-websockets-standalone
|
|
2
|
+
|
|
3
|
+
> [!NOTE]
|
|
4
|
+
> This package is part of the [Webiny](https://www.webiny.com) monorepo.
|
|
5
|
+
> Itβs **included in every Webiny project by default** and is not meant to be used as a standalone package.
|
|
6
|
+
|
|
7
|
+
π **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
_This README file is automatically generated during the publish process._
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Per-request real-time transport for the standalone server: registers `ServerWebsocketsTransport`,
|
|
3
|
+
* overriding the domain's NullWebsocketsTransport. Resolves the shared connection manager + adapter
|
|
4
|
+
* from the root (registered there as singletons by the handler). Exposed as a Feature so the handler's
|
|
5
|
+
* `transports` wiring reads uniformly (`WebsocketsStandaloneFeature.register(c)`).
|
|
6
|
+
*/
|
|
7
|
+
export declare const WebsocketsStandaloneFeature: {
|
|
8
|
+
name: string;
|
|
9
|
+
register(container: import("@webiny/di").Container): void;
|
|
10
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { createFeature } from "@webiny/feature/api";
|
|
2
|
+
import { ServerWebsocketsTransport } from "./transport/ServerWebsocketsTransport.js";
|
|
3
|
+
const WebsocketsStandaloneFeature = createFeature({
|
|
4
|
+
name: "WebsocketsServer",
|
|
5
|
+
register (container) {
|
|
6
|
+
container.register(ServerWebsocketsTransport);
|
|
7
|
+
}
|
|
8
|
+
});
|
|
9
|
+
export { WebsocketsStandaloneFeature };
|
|
10
|
+
|
|
11
|
+
//# sourceMappingURL=WebsocketsStandaloneFeature.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WebsocketsStandaloneFeature.js","sources":["../src/WebsocketsStandaloneFeature.ts"],"sourcesContent":["import { createFeature } from \"@webiny/feature/api\";\nimport { ServerWebsocketsTransport } from \"~/transport/ServerWebsocketsTransport.js\";\n\n/**\n * Per-request real-time transport for the standalone server: registers `ServerWebsocketsTransport`,\n * overriding the domain's NullWebsocketsTransport. Resolves the shared connection manager + adapter\n * from the root (registered there as singletons by the handler). Exposed as a Feature so the handler's\n * `transports` wiring reads uniformly (`WebsocketsStandaloneFeature.register(c)`).\n */\nexport const WebsocketsStandaloneFeature = createFeature({\n name: \"WebsocketsServer\",\n register(container) {\n container.register(ServerWebsocketsTransport);\n }\n});\n"],"names":["WebsocketsStandaloneFeature","createFeature","container","ServerWebsocketsTransport"],"mappings":";;AASO,MAAMA,8BAA8BC,cAAc;IACrD,MAAM;IACN,UAASC,SAAS;QACdA,UAAU,QAAQ,CAACC;IACvB;AACJ"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { Server as HttpServer } from "node:http";
|
|
2
|
+
import type { IncomingMessage } from "node:http";
|
|
3
|
+
import type { Duplex } from "node:stream";
|
|
4
|
+
import { WebSocket } from "ws";
|
|
5
|
+
import { WebsocketsServerAdapter } from "./abstractions.js";
|
|
6
|
+
declare class NodeWsAdapterImpl implements WebsocketsServerAdapter.Interface<WebSocket> {
|
|
7
|
+
private wss;
|
|
8
|
+
private pingTimer;
|
|
9
|
+
private readonly answered;
|
|
10
|
+
private pingInterval;
|
|
11
|
+
static withPingInterval(pingInterval: number): NodeWsAdapterImpl;
|
|
12
|
+
private getWss;
|
|
13
|
+
start(_server: HttpServer): void;
|
|
14
|
+
handleUpgrade(request: IncomingMessage, socket: Duplex, head: Buffer): void;
|
|
15
|
+
stop(): Promise<void>;
|
|
16
|
+
private pingAll;
|
|
17
|
+
onConnection(cb: (socket: WebSocket, request: import("node:http").IncomingMessage) => void): void;
|
|
18
|
+
onMessage(socket: WebSocket, cb: (data: Buffer) => void): void;
|
|
19
|
+
onClose(socket: WebSocket, cb: (code: number, reason: Buffer) => void): void;
|
|
20
|
+
onError(socket: WebSocket, cb: (error: Error) => void): void;
|
|
21
|
+
send(socket: WebSocket, data: string): Promise<void>;
|
|
22
|
+
close(socket: WebSocket, code?: number, reason?: string): void;
|
|
23
|
+
}
|
|
24
|
+
export { NodeWsAdapterImpl };
|
|
25
|
+
export declare const NodeWsAdapter: typeof NodeWsAdapterImpl & {
|
|
26
|
+
__abstraction: import("@webiny/di").Abstraction<import("./abstractions.js").IWebsocketsServerAdapter<unknown>>;
|
|
27
|
+
};
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { WebSocket, WebSocketServer } from "ws";
|
|
2
|
+
import { WebsocketsServerAdapter } from "./abstractions.js";
|
|
3
|
+
const MAX_PAYLOAD_BYTES = 65536;
|
|
4
|
+
const SERVICE_RESTART = 1012;
|
|
5
|
+
const CLOSE_WAIT_MS = 1000;
|
|
6
|
+
const PING_INTERVAL_MS = 30000;
|
|
7
|
+
const closeForRestart = (client)=>new Promise((resolve)=>{
|
|
8
|
+
if (client.readyState === WebSocket.CLOSED) return void resolve();
|
|
9
|
+
const timer = setTimeout(()=>{
|
|
10
|
+
client.terminate();
|
|
11
|
+
}, CLOSE_WAIT_MS);
|
|
12
|
+
client.once("close", ()=>{
|
|
13
|
+
clearTimeout(timer);
|
|
14
|
+
resolve();
|
|
15
|
+
});
|
|
16
|
+
client.close(SERVICE_RESTART, "Server restarting");
|
|
17
|
+
});
|
|
18
|
+
class NodeWsAdapterImpl {
|
|
19
|
+
static withPingInterval(pingInterval) {
|
|
20
|
+
const adapter = new NodeWsAdapterImpl();
|
|
21
|
+
adapter.pingInterval = pingInterval;
|
|
22
|
+
return adapter;
|
|
23
|
+
}
|
|
24
|
+
getWss() {
|
|
25
|
+
if (!this.wss) throw new Error("WebSocketServer has not been started. Call start() first.");
|
|
26
|
+
return this.wss;
|
|
27
|
+
}
|
|
28
|
+
start(_server) {
|
|
29
|
+
if (this.wss) return;
|
|
30
|
+
const wss = new WebSocketServer({
|
|
31
|
+
noServer: true,
|
|
32
|
+
maxPayload: MAX_PAYLOAD_BYTES
|
|
33
|
+
});
|
|
34
|
+
wss.on("connection", (socket)=>{
|
|
35
|
+
this.answered.add(socket);
|
|
36
|
+
socket.on("pong", ()=>{
|
|
37
|
+
this.answered.add(socket);
|
|
38
|
+
});
|
|
39
|
+
});
|
|
40
|
+
this.wss = wss;
|
|
41
|
+
this.pingTimer = setInterval(()=>{
|
|
42
|
+
this.pingAll(wss);
|
|
43
|
+
}, this.pingInterval);
|
|
44
|
+
}
|
|
45
|
+
handleUpgrade(request, socket, head) {
|
|
46
|
+
this.getWss().handleUpgrade(request, socket, head, (ws)=>{
|
|
47
|
+
this.getWss().emit("connection", ws, request);
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
async stop() {
|
|
51
|
+
const wss = this.wss;
|
|
52
|
+
if (!wss) return;
|
|
53
|
+
this.wss = void 0;
|
|
54
|
+
clearInterval(this.pingTimer);
|
|
55
|
+
const clients = [
|
|
56
|
+
...wss.clients
|
|
57
|
+
];
|
|
58
|
+
const closing = clients.map(closeForRestart);
|
|
59
|
+
await Promise.all(closing);
|
|
60
|
+
await new Promise((resolve, reject)=>{
|
|
61
|
+
wss.close((err)=>{
|
|
62
|
+
if (err) return void reject(err);
|
|
63
|
+
resolve();
|
|
64
|
+
});
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
pingAll(wss) {
|
|
68
|
+
for (const socket of wss.clients){
|
|
69
|
+
if (!this.answered.has(socket)) {
|
|
70
|
+
socket.terminate();
|
|
71
|
+
continue;
|
|
72
|
+
}
|
|
73
|
+
this.answered.delete(socket);
|
|
74
|
+
if (socket.readyState === WebSocket.OPEN) socket.ping();
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
onConnection(cb) {
|
|
78
|
+
this.getWss().on("connection", cb);
|
|
79
|
+
}
|
|
80
|
+
onMessage(socket, cb) {
|
|
81
|
+
socket.on("message", cb);
|
|
82
|
+
}
|
|
83
|
+
onClose(socket, cb) {
|
|
84
|
+
socket.on("close", cb);
|
|
85
|
+
}
|
|
86
|
+
onError(socket, cb) {
|
|
87
|
+
socket.on("error", cb);
|
|
88
|
+
}
|
|
89
|
+
send(socket, data) {
|
|
90
|
+
return new Promise((resolve, reject)=>{
|
|
91
|
+
socket.send(data, (err)=>{
|
|
92
|
+
if (err) return void reject(err);
|
|
93
|
+
resolve();
|
|
94
|
+
});
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
close(socket, code, reason) {
|
|
98
|
+
socket.close(code, reason);
|
|
99
|
+
}
|
|
100
|
+
constructor(){
|
|
101
|
+
this.answered = new WeakSet();
|
|
102
|
+
this.pingInterval = PING_INTERVAL_MS;
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
const NodeWsAdapter = WebsocketsServerAdapter.createImplementation({
|
|
106
|
+
implementation: NodeWsAdapterImpl,
|
|
107
|
+
dependencies: []
|
|
108
|
+
});
|
|
109
|
+
export { NodeWsAdapter, NodeWsAdapterImpl };
|
|
110
|
+
|
|
111
|
+
//# sourceMappingURL=NodeWsAdapter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"adapter/NodeWsAdapter.js","sources":["../../src/adapter/NodeWsAdapter.ts"],"sourcesContent":["import type { Server as HttpServer } from \"node:http\";\nimport type { IncomingMessage } from \"node:http\";\nimport type { Duplex } from \"node:stream\";\nimport { WebSocketServer } from \"ws\";\nimport { WebSocket } from \"ws\";\nimport { WebsocketsServerAdapter } from \"./abstractions.js\";\n\n/*\n * Clients only send small JSON envelopes (a ping carrying a token). The `ws` default is 100 MiB,\n * which any client, authenticated or not, could make the server buffer per message.\n */\nconst MAX_PAYLOAD_BYTES = 64 * 1024;\n\n/*\n * Sent to every client when the server stops. 1012 means \"service restart\": the client reconnects,\n * and behind a load balancer it reaches a process that is still up.\n */\nconst SERVICE_RESTART = 1012;\n\n// How long a client gets to answer the close before its socket is cut.\nconst CLOSE_WAIT_MS = 1000;\n\n/*\n * How often every open socket gets a WebSocket ping frame. Proxies and load balancers close a\n * connection that carries nothing for a while (60 seconds by default on nginx and AWS ALB), and the\n * admin's own ping comes only every 5 minutes. Browsers answer ping frames by themselves; no client\n * code is involved, and nothing is written to the registry.\n */\nconst PING_INTERVAL_MS = 30_000;\n\n/*\n * Closes the socket with `SERVICE_RESTART` and resolves once it is closed. A client that has not\n * answered within `CLOSE_WAIT_MS` (a frozen tab, a dead network) is cut.\n */\nconst closeForRestart = (client: WebSocket): Promise<void> => {\n return new Promise(resolve => {\n if (client.readyState === WebSocket.CLOSED) {\n resolve();\n return;\n }\n const timer = setTimeout(() => {\n client.terminate();\n }, CLOSE_WAIT_MS);\n client.once(\"close\", () => {\n clearTimeout(timer);\n resolve();\n });\n client.close(SERVICE_RESTART, \"Server restarting\");\n });\n};\n\nclass NodeWsAdapterImpl implements WebsocketsServerAdapter.Interface<WebSocket> {\n private wss: WebSocketServer | undefined;\n private pingTimer: ReturnType<typeof setInterval> | undefined;\n // Sockets that answered the last ping, or connected since it was sent.\n private readonly answered = new WeakSet<WebSocket>();\n\n private pingInterval = PING_INTERVAL_MS;\n\n /*\n * An adapter that pings more often, for tests. The constructor takes nothing: DI builds this class\n * with no dependencies.\n */\n public static withPingInterval(pingInterval: number): NodeWsAdapterImpl {\n const adapter = new NodeWsAdapterImpl();\n adapter.pingInterval = pingInterval;\n return adapter;\n }\n\n private getWss(): WebSocketServer {\n if (!this.wss) {\n throw new Error(\"WebSocketServer has not been started. Call start() first.\");\n }\n return this.wss;\n }\n\n /* The server param is kept for interface compliance but not used β\n the HTTP upgrade event is handled externally via handleUpgrade(). */\n public start(_server: HttpServer): void {\n // Already started: a second server and timer would be left running, unreachable by stop().\n if (this.wss) {\n return;\n }\n const wss = new WebSocketServer({ noServer: true, maxPayload: MAX_PAYLOAD_BYTES });\n wss.on(\"connection\", socket => {\n this.answered.add(socket);\n socket.on(\"pong\", () => {\n this.answered.add(socket);\n });\n });\n this.wss = wss;\n this.pingTimer = setInterval(() => {\n this.pingAll(wss);\n }, this.pingInterval);\n }\n\n public handleUpgrade(request: IncomingMessage, socket: Duplex, head: Buffer): void {\n this.getWss().handleUpgrade(request, socket, head, ws => {\n this.getWss().emit(\"connection\", ws, request);\n });\n }\n\n // Safe to call again: a stopped adapter has nothing left to close.\n public async stop(): Promise<void> {\n const wss = this.wss;\n if (!wss) {\n return;\n }\n this.wss = undefined;\n clearInterval(this.pingTimer);\n\n const clients = [...wss.clients];\n const closing = clients.map(closeForRestart);\n await Promise.all(closing);\n\n await new Promise<void>((resolve, reject) => {\n wss.close(err => {\n if (err) {\n reject(err);\n return;\n }\n resolve();\n });\n });\n }\n\n /*\n * Pings every open socket. One that has not answered the previous ping within a whole interval is\n * gone without having closed (a laptop asleep, a dropped network), so it is cut; its close\n * handler then removes the connection.\n */\n private pingAll(wss: WebSocketServer): void {\n for (const socket of wss.clients) {\n if (!this.answered.has(socket)) {\n socket.terminate();\n continue;\n }\n this.answered.delete(socket);\n if (socket.readyState === WebSocket.OPEN) {\n socket.ping();\n }\n }\n }\n\n public onConnection(\n cb: (socket: WebSocket, request: import(\"node:http\").IncomingMessage) => void\n ): void {\n this.getWss().on(\"connection\", cb);\n }\n\n public onMessage(socket: WebSocket, cb: (data: Buffer) => void): void {\n socket.on(\"message\", cb);\n }\n\n public onClose(socket: WebSocket, cb: (code: number, reason: Buffer) => void): void {\n socket.on(\"close\", cb);\n }\n\n public onError(socket: WebSocket, cb: (error: Error) => void): void {\n socket.on(\"error\", cb);\n }\n\n public send(socket: WebSocket, data: string): Promise<void> {\n return new Promise((resolve, reject) => {\n socket.send(data, err => {\n if (err) {\n reject(err);\n return;\n }\n resolve();\n });\n });\n }\n\n public close(socket: WebSocket, code?: number, reason?: string): void {\n socket.close(code, reason);\n }\n}\n\nexport { NodeWsAdapterImpl };\n\nexport const NodeWsAdapter = WebsocketsServerAdapter.createImplementation({\n implementation: NodeWsAdapterImpl,\n dependencies: []\n});\n"],"names":["MAX_PAYLOAD_BYTES","SERVICE_RESTART","CLOSE_WAIT_MS","PING_INTERVAL_MS","closeForRestart","client","Promise","resolve","WebSocket","timer","setTimeout","clearTimeout","NodeWsAdapterImpl","pingInterval","adapter","Error","_server","wss","WebSocketServer","socket","setInterval","request","head","ws","undefined","clearInterval","clients","closing","reject","err","cb","data","code","reason","WeakSet","NodeWsAdapter","WebsocketsServerAdapter"],"mappings":";;AAWA,MAAMA,oBAAoB;AAM1B,MAAMC,kBAAkB;AAGxB,MAAMC,gBAAgB;AAQtB,MAAMC,mBAAmB;AAMzB,MAAMC,kBAAkB,CAACC,SACd,IAAIC,QAAQC,CAAAA;QACf,IAAIF,OAAO,UAAU,KAAKG,UAAU,MAAM,EAAE,YACxCD;QAGJ,MAAME,QAAQC,WAAW;YACrBL,OAAO,SAAS;QACpB,GAAGH;QACHG,OAAO,IAAI,CAAC,SAAS;YACjBM,aAAaF;YACbF;QACJ;QACAF,OAAO,KAAK,CAACJ,iBAAiB;IAClC;AAGJ,MAAMW;IAYF,OAAc,iBAAiBC,YAAoB,EAAqB;QACpE,MAAMC,UAAU,IAAIF;QACpBE,QAAQ,YAAY,GAAGD;QACvB,OAAOC;IACX;IAEQ,SAA0B;QAC9B,IAAI,CAAC,IAAI,CAAC,GAAG,EACT,MAAM,IAAIC,MAAM;QAEpB,OAAO,IAAI,CAAC,GAAG;IACnB;IAIO,MAAMC,OAAmB,EAAQ;QAEpC,IAAI,IAAI,CAAC,GAAG,EACR;QAEJ,MAAMC,MAAM,IAAIC,gBAAgB;YAAE,UAAU;YAAM,YAAYlB;QAAkB;QAChFiB,IAAI,EAAE,CAAC,cAAcE,CAAAA;YACjB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAACA;YAClBA,OAAO,EAAE,CAAC,QAAQ;gBACd,IAAI,CAAC,QAAQ,CAAC,GAAG,CAACA;YACtB;QACJ;QACA,IAAI,CAAC,GAAG,GAAGF;QACX,IAAI,CAAC,SAAS,GAAGG,YAAY;YACzB,IAAI,CAAC,OAAO,CAACH;QACjB,GAAG,IAAI,CAAC,YAAY;IACxB;IAEO,cAAcI,OAAwB,EAAEF,MAAc,EAAEG,IAAY,EAAQ;QAC/E,IAAI,CAAC,MAAM,GAAG,aAAa,CAACD,SAASF,QAAQG,MAAMC,CAAAA;YAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAcA,IAAIF;QACzC;IACJ;IAGA,MAAa,OAAsB;QAC/B,MAAMJ,MAAM,IAAI,CAAC,GAAG;QACpB,IAAI,CAACA,KACD;QAEJ,IAAI,CAAC,GAAG,GAAGO;QACXC,cAAc,IAAI,CAAC,SAAS;QAE5B,MAAMC,UAAU;eAAIT,IAAI,OAAO;SAAC;QAChC,MAAMU,UAAUD,QAAQ,GAAG,CAACtB;QAC5B,MAAME,QAAQ,GAAG,CAACqB;QAElB,MAAM,IAAIrB,QAAc,CAACC,SAASqB;YAC9BX,IAAI,KAAK,CAACY,CAAAA;gBACN,IAAIA,KAAK,YACLD,OAAOC;gBAGXtB;YACJ;QACJ;IACJ;IAOQ,QAAQU,GAAoB,EAAQ;QACxC,KAAK,MAAME,UAAUF,IAAI,OAAO,CAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAACE,SAAS;gBAC5BA,OAAO,SAAS;gBAChB;YACJ;YACA,IAAI,CAAC,QAAQ,CAAC,MAAM,CAACA;YACrB,IAAIA,OAAO,UAAU,KAAKX,UAAU,IAAI,EACpCW,OAAO,IAAI;QAEnB;IACJ;IAEO,aACHW,EAA6E,EACzE;QACJ,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,cAAcA;IACnC;IAEO,UAAUX,MAAiB,EAAEW,EAA0B,EAAQ;QAClEX,OAAO,EAAE,CAAC,WAAWW;IACzB;IAEO,QAAQX,MAAiB,EAAEW,EAA0C,EAAQ;QAChFX,OAAO,EAAE,CAAC,SAASW;IACvB;IAEO,QAAQX,MAAiB,EAAEW,EAA0B,EAAQ;QAChEX,OAAO,EAAE,CAAC,SAASW;IACvB;IAEO,KAAKX,MAAiB,EAAEY,IAAY,EAAiB;QACxD,OAAO,IAAIzB,QAAQ,CAACC,SAASqB;YACzBT,OAAO,IAAI,CAACY,MAAMF,CAAAA;gBACd,IAAIA,KAAK,YACLD,OAAOC;gBAGXtB;YACJ;QACJ;IACJ;IAEO,MAAMY,MAAiB,EAAEa,IAAa,EAAEC,MAAe,EAAQ;QAClEd,OAAO,KAAK,CAACa,MAAMC;IACvB;;aAzHiB,QAAQ,GAAG,IAAIC;aAExB,YAAY,GAAG/B;;AAwH3B;AAIO,MAAMgC,gBAAgBC,wBAAwB,oBAAoB,CAAC;IACtE,gBAAgBxB;IAChB,cAAc,EAAE;AACpB"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { Server as HttpServer } from "node:http";
|
|
2
|
+
import type { IncomingMessage } from "node:http";
|
|
3
|
+
import type { Duplex } from "node:stream";
|
|
4
|
+
export interface IWebsocketsServerAdapter<TSocket> {
|
|
5
|
+
start(server: HttpServer): void;
|
|
6
|
+
stop(): Promise<void>;
|
|
7
|
+
onConnection(cb: (socket: TSocket, request: IncomingMessage) => void): void;
|
|
8
|
+
onMessage(socket: TSocket, cb: (data: Buffer) => void): void;
|
|
9
|
+
onClose(socket: TSocket, cb: (code: number, reason: Buffer) => void): void;
|
|
10
|
+
onError(socket: TSocket, cb: (error: Error) => void): void;
|
|
11
|
+
send(socket: TSocket, data: string): Promise<void>;
|
|
12
|
+
close(socket: TSocket, code?: number, reason?: string): void;
|
|
13
|
+
handleUpgrade(request: IncomingMessage, socket: Duplex, head: Buffer): void;
|
|
14
|
+
}
|
|
15
|
+
export declare const WebsocketsServerAdapter: import("@webiny/di").Abstraction<IWebsocketsServerAdapter<unknown>>;
|
|
16
|
+
export declare namespace WebsocketsServerAdapter {
|
|
17
|
+
type Interface<TSocket> = IWebsocketsServerAdapter<TSocket>;
|
|
18
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"adapter/abstractions.js","sources":["../../src/adapter/abstractions.ts"],"sourcesContent":["import type { Server as HttpServer } from \"node:http\";\nimport type { IncomingMessage } from \"node:http\";\nimport type { Duplex } from \"node:stream\";\nimport { createAbstraction } from \"@webiny/feature/api\";\n\nexport interface IWebsocketsServerAdapter<TSocket> {\n start(server: HttpServer): void;\n stop(): Promise<void>;\n onConnection(cb: (socket: TSocket, request: IncomingMessage) => void): void;\n onMessage(socket: TSocket, cb: (data: Buffer) => void): void;\n onClose(socket: TSocket, cb: (code: number, reason: Buffer) => void): void;\n onError(socket: TSocket, cb: (error: Error) => void): void;\n send(socket: TSocket, data: string): Promise<void>;\n close(socket: TSocket, code?: number, reason?: string): void;\n handleUpgrade(request: IncomingMessage, socket: Duplex, head: Buffer): void;\n}\n\nexport const WebsocketsServerAdapter =\n createAbstraction<IWebsocketsServerAdapter<unknown>>(\"WebsocketsServerAdapter\");\n\nexport namespace WebsocketsServerAdapter {\n export type Interface<TSocket> = IWebsocketsServerAdapter<TSocket>;\n}\n"],"names":["WebsocketsServerAdapter","createAbstraction"],"mappings":";AAiBO,MAAMA,0BACTC,kBAAqD"}
|
package/adapter/types.js
ADDED
|
File without changes
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { WebsocketsMessageBus } from "./abstractions.js";
|
|
2
|
+
declare class InProcessMessageBusImpl implements WebsocketsMessageBus.Interface {
|
|
3
|
+
private readonly handlers;
|
|
4
|
+
publish(owner: string, message: WebsocketsMessageBus.Message): Promise<void>;
|
|
5
|
+
subscribe(owner: string, handler: WebsocketsMessageBus.Handler): Promise<void>;
|
|
6
|
+
close(): Promise<void>;
|
|
7
|
+
}
|
|
8
|
+
export { InProcessMessageBusImpl };
|
|
9
|
+
export declare const InProcessMessageBus: typeof InProcessMessageBusImpl & {
|
|
10
|
+
__abstraction: import("@webiny/di").Abstraction<import("./abstractions.js").IWebsocketsMessageBus>;
|
|
11
|
+
};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { WebsocketsMessageBus } from "./abstractions.js";
|
|
2
|
+
class InProcessMessageBusImpl {
|
|
3
|
+
async publish(owner, message) {
|
|
4
|
+
const handler = this.handlers.get(owner);
|
|
5
|
+
if (!handler) return;
|
|
6
|
+
await handler(message);
|
|
7
|
+
}
|
|
8
|
+
async subscribe(owner, handler) {
|
|
9
|
+
this.handlers.set(owner, handler);
|
|
10
|
+
}
|
|
11
|
+
async close() {
|
|
12
|
+
this.handlers.clear();
|
|
13
|
+
}
|
|
14
|
+
constructor(){
|
|
15
|
+
this.handlers = new Map();
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
const InProcessMessageBus = WebsocketsMessageBus.createImplementation({
|
|
19
|
+
implementation: InProcessMessageBusImpl,
|
|
20
|
+
dependencies: []
|
|
21
|
+
});
|
|
22
|
+
export { InProcessMessageBus, InProcessMessageBusImpl };
|
|
23
|
+
|
|
24
|
+
//# sourceMappingURL=InProcessMessageBus.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bus/InProcessMessageBus.js","sources":["../../src/bus/InProcessMessageBus.ts"],"sourcesContent":["import { WebsocketsMessageBus } from \"./abstractions.js\";\n\n/*\n * The bus for a single process, and the default. Every socket is in this process, so the only\n * listener it can reach is its own. Rows another process wrote, such as this process's predecessor\n * before a restart, name an owner nobody listens for here; those messages are dropped and the rows\n * are left to the heartbeat's stale cleanup.\n */\nclass InProcessMessageBusImpl implements WebsocketsMessageBus.Interface {\n private readonly handlers = new Map<string, WebsocketsMessageBus.Handler>();\n\n public async publish(owner: string, message: WebsocketsMessageBus.Message): Promise<void> {\n const handler = this.handlers.get(owner);\n if (!handler) {\n return;\n }\n await handler(message);\n }\n\n public async subscribe(owner: string, handler: WebsocketsMessageBus.Handler): Promise<void> {\n this.handlers.set(owner, handler);\n }\n\n public async close(): Promise<void> {\n this.handlers.clear();\n }\n}\n\nexport { InProcessMessageBusImpl };\n\nexport const InProcessMessageBus = WebsocketsMessageBus.createImplementation({\n implementation: InProcessMessageBusImpl,\n dependencies: []\n});\n"],"names":["InProcessMessageBusImpl","owner","message","handler","Map","InProcessMessageBus","WebsocketsMessageBus"],"mappings":";AAQA,MAAMA;IAGF,MAAa,QAAQC,KAAa,EAAEC,OAAqC,EAAiB;QACtF,MAAMC,UAAU,IAAI,CAAC,QAAQ,CAAC,GAAG,CAACF;QAClC,IAAI,CAACE,SACD;QAEJ,MAAMA,QAAQD;IAClB;IAEA,MAAa,UAAUD,KAAa,EAAEE,OAAqC,EAAiB;QACxF,IAAI,CAAC,QAAQ,CAAC,GAAG,CAACF,OAAOE;IAC7B;IAEA,MAAa,QAAuB;QAChC,IAAI,CAAC,QAAQ,CAAC,KAAK;IACvB;;aAhBiB,QAAQ,GAAG,IAAIC;;AAiBpC;AAIO,MAAMC,sBAAsBC,qBAAqB,oBAAoB,CAAC;IACzE,gBAAgBN;IAChB,cAAc,EAAE;AACpB"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { GenericRecord } from "@webiny/api/types.js";
|
|
2
|
+
export interface IWebsocketsBusSendMessage {
|
|
3
|
+
action: "send";
|
|
4
|
+
connectionIds: string[];
|
|
5
|
+
data: GenericRecord;
|
|
6
|
+
}
|
|
7
|
+
export interface IWebsocketsBusDisconnectMessage {
|
|
8
|
+
action: "disconnect";
|
|
9
|
+
connectionIds: string[];
|
|
10
|
+
}
|
|
11
|
+
export type IWebsocketsBusMessage = IWebsocketsBusSendMessage | IWebsocketsBusDisconnectMessage;
|
|
12
|
+
export type IWebsocketsBusHandler = (message: IWebsocketsBusMessage) => Promise<void>;
|
|
13
|
+
/**
|
|
14
|
+
* Carries a send or a disconnect to the process that holds the sockets. Each process listens on its
|
|
15
|
+
* own channel, named after its `ProcessOwner` id, and other processes publish to it.
|
|
16
|
+
*
|
|
17
|
+
* Delivery is at most once and nothing is queued: a message for a process that is not listening is
|
|
18
|
+
* dropped, as a push to a reconnecting client is on AWS.
|
|
19
|
+
*/
|
|
20
|
+
export interface IWebsocketsMessageBus {
|
|
21
|
+
publish(owner: string, message: IWebsocketsBusMessage): Promise<void>;
|
|
22
|
+
subscribe(owner: string, handler: IWebsocketsBusHandler): Promise<void>;
|
|
23
|
+
close(): Promise<void>;
|
|
24
|
+
}
|
|
25
|
+
export declare const WebsocketsMessageBus: import("@webiny/di").Abstraction<IWebsocketsMessageBus>;
|
|
26
|
+
export declare namespace WebsocketsMessageBus {
|
|
27
|
+
type Interface = IWebsocketsMessageBus;
|
|
28
|
+
type Message = IWebsocketsBusMessage;
|
|
29
|
+
type Handler = IWebsocketsBusHandler;
|
|
30
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bus/abstractions.js","sources":["../../src/bus/abstractions.ts"],"sourcesContent":["import type { GenericRecord } from \"@webiny/api/types.js\";\nimport { createAbstraction } from \"@webiny/feature/api\";\n\nexport interface IWebsocketsBusSendMessage {\n action: \"send\";\n connectionIds: string[];\n data: GenericRecord;\n}\n\nexport interface IWebsocketsBusDisconnectMessage {\n action: \"disconnect\";\n connectionIds: string[];\n}\n\nexport type IWebsocketsBusMessage = IWebsocketsBusSendMessage | IWebsocketsBusDisconnectMessage;\n\nexport type IWebsocketsBusHandler = (message: IWebsocketsBusMessage) => Promise<void>;\n\n/**\n * Carries a send or a disconnect to the process that holds the sockets. Each process listens on its\n * own channel, named after its `ProcessOwner` id, and other processes publish to it.\n *\n * Delivery is at most once and nothing is queued: a message for a process that is not listening is\n * dropped, as a push to a reconnecting client is on AWS.\n */\nexport interface IWebsocketsMessageBus {\n publish(owner: string, message: IWebsocketsBusMessage): Promise<void>;\n subscribe(owner: string, handler: IWebsocketsBusHandler): Promise<void>;\n close(): Promise<void>;\n}\n\nexport const WebsocketsMessageBus =\n createAbstraction<IWebsocketsMessageBus>(\"Websockets/MessageBus\");\n\nexport namespace WebsocketsMessageBus {\n export type Interface = IWebsocketsMessageBus;\n export type Message = IWebsocketsBusMessage;\n export type Handler = IWebsocketsBusHandler;\n}\n"],"names":["WebsocketsMessageBus","createAbstraction"],"mappings":";AA+BO,MAAMA,uBACTC,kBAAyC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { Logger } from "@webiny/api-core/features/logger/abstractions.js";
|
|
2
|
+
import type { WebsocketsConnectionManager } from "../connectionManager/abstractions.js";
|
|
3
|
+
import type { WebsocketsServerAdapter } from "../adapter/abstractions.js";
|
|
4
|
+
import type { WebsocketsMessageBus } from "./abstractions.js";
|
|
5
|
+
export interface ICreateBusMessageHandlerParams {
|
|
6
|
+
connectionManager: WebsocketsConnectionManager.Interface<unknown>;
|
|
7
|
+
adapter: WebsocketsServerAdapter.Interface<unknown>;
|
|
8
|
+
logger: Logger.Interface;
|
|
9
|
+
}
|
|
10
|
+
export declare const createBusMessageHandler: (params: ICreateBusMessageHandlerParams) => WebsocketsMessageBus.Handler;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { sendToLocalSockets } from "../delivery/sendToLocalSockets.js";
|
|
2
|
+
import { disconnectLocalSockets } from "../delivery/disconnectLocalSockets.js";
|
|
3
|
+
const createBusMessageHandler = (params)=>{
|
|
4
|
+
const { connectionManager } = params;
|
|
5
|
+
return async (message)=>{
|
|
6
|
+
let missing;
|
|
7
|
+
missing = "send" === message.action ? await sendToLocalSockets({
|
|
8
|
+
...params,
|
|
9
|
+
connectionIds: message.connectionIds,
|
|
10
|
+
data: message.data
|
|
11
|
+
}) : await disconnectLocalSockets({
|
|
12
|
+
...params,
|
|
13
|
+
connectionIds: message.connectionIds
|
|
14
|
+
});
|
|
15
|
+
for (const connectionId of missing)await connectionManager.remove(connectionId);
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
export { createBusMessageHandler };
|
|
19
|
+
|
|
20
|
+
//# sourceMappingURL=createBusMessageHandler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bus/createBusMessageHandler.js","sources":["../../src/bus/createBusMessageHandler.ts"],"sourcesContent":["import type { Logger } from \"@webiny/api-core/features/logger/abstractions.js\";\nimport type { WebsocketsConnectionManager } from \"~/connectionManager/abstractions.js\";\nimport type { WebsocketsServerAdapter } from \"~/adapter/abstractions.js\";\nimport type { WebsocketsMessageBus } from \"./abstractions.js\";\nimport { sendToLocalSockets } from \"~/delivery/sendToLocalSockets.js\";\nimport { disconnectLocalSockets } from \"~/delivery/disconnectLocalSockets.js\";\n\nexport interface ICreateBusMessageHandlerParams {\n connectionManager: WebsocketsConnectionManager.Interface<unknown>;\n adapter: WebsocketsServerAdapter.Interface<unknown>;\n logger: Logger.Interface;\n}\n\n/*\n * Handles what other processes publish to this one: sends and disconnects for sockets this process\n * holds. Messages arrive here only for connections this process owns, so one with no socket left is\n * gone, and its connection is removed.\n */\nexport const createBusMessageHandler = (\n params: ICreateBusMessageHandlerParams\n): WebsocketsMessageBus.Handler => {\n const { connectionManager } = params;\n return async message => {\n let missing: string[];\n if (message.action === \"send\") {\n missing = await sendToLocalSockets({\n ...params,\n connectionIds: message.connectionIds,\n data: message.data\n });\n } else {\n missing = await disconnectLocalSockets({\n ...params,\n connectionIds: message.connectionIds\n });\n }\n for (const connectionId of missing) {\n await connectionManager.remove(connectionId);\n }\n };\n};\n"],"names":["createBusMessageHandler","params","connectionManager","message","missing","sendToLocalSockets","disconnectLocalSockets","connectionId"],"mappings":";;AAkBO,MAAMA,0BAA0B,CACnCC;IAEA,MAAM,EAAEC,iBAAiB,EAAE,GAAGD;IAC9B,OAAO,OAAME;QACT,IAAIC;QAEAA,UADAD,AAAmB,WAAnBA,QAAQ,MAAM,GACJ,MAAME,mBAAmB;YAC/B,GAAGJ,MAAM;YACT,eAAeE,QAAQ,aAAa;YACpC,MAAMA,QAAQ,IAAI;QACtB,KAEU,MAAMG,uBAAuB;YACnC,GAAGL,MAAM;YACT,eAAeE,QAAQ,aAAa;QACxC;QAEJ,KAAK,MAAMI,gBAAgBH,QACvB,MAAMF,kBAAkB,MAAM,CAACK;IAEvC;AACJ"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { ConnectionRegistry } from "@webiny/api-websockets/exports/api.js";
|
|
2
|
+
import { ProcessOwner } from "@webiny/event-handler-standalone";
|
|
3
|
+
import { WebsocketsConnectionManager } from "./abstractions.js";
|
|
4
|
+
export declare class ServerConnectionManagerImpl implements WebsocketsConnectionManager.Interface<unknown> {
|
|
5
|
+
private readonly registry;
|
|
6
|
+
private readonly owner;
|
|
7
|
+
private readonly sockets;
|
|
8
|
+
private readonly metadata;
|
|
9
|
+
constructor(registry: ConnectionRegistry.Interface, owner: ProcessOwner.Interface);
|
|
10
|
+
add(params: WebsocketsConnectionManager.AddParams<unknown>): Promise<void>;
|
|
11
|
+
remove(connectionId: string): Promise<void>;
|
|
12
|
+
groupByOwner(connectionIds: string[]): Promise<Map<string, string[]>>;
|
|
13
|
+
getSocket(connectionId: string): unknown | undefined;
|
|
14
|
+
getMetadata(connectionId: string): WebsocketsConnectionManager.ConnectionMetadata | undefined;
|
|
15
|
+
updateLastSeen(connectionId: string): Promise<void>;
|
|
16
|
+
cleanup(maxAge: number): Promise<string[]>;
|
|
17
|
+
getActiveConnectionIds(): string[];
|
|
18
|
+
}
|
|
19
|
+
export declare const ServerConnectionManager: typeof ServerConnectionManagerImpl & {
|
|
20
|
+
__abstraction: import("@webiny/di").Abstraction<import("./abstractions.js").IWebsocketsConnectionManager<unknown>>;
|
|
21
|
+
};
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { ConnectionRegistry } from "@webiny/api-websockets/exports/api.js";
|
|
2
|
+
import { ProcessOwner } from "@webiny/event-handler-standalone";
|
|
3
|
+
import { WebsocketsConnectionManager } from "./abstractions.js";
|
|
4
|
+
class ServerConnectionManagerImpl {
|
|
5
|
+
constructor(registry, owner){
|
|
6
|
+
this.registry = registry;
|
|
7
|
+
this.owner = owner;
|
|
8
|
+
this.sockets = new Map();
|
|
9
|
+
this.metadata = new Map();
|
|
10
|
+
}
|
|
11
|
+
async add(params) {
|
|
12
|
+
this.sockets.set(params.connectionId, params.socket);
|
|
13
|
+
this.metadata.set(params.connectionId, {
|
|
14
|
+
connectionId: params.connectionId,
|
|
15
|
+
endpoint: params.endpoint,
|
|
16
|
+
connectedAt: params.connectedAt,
|
|
17
|
+
host: params.host,
|
|
18
|
+
headers: params.headers
|
|
19
|
+
});
|
|
20
|
+
await this.registry.register({
|
|
21
|
+
connectionId: params.connectionId,
|
|
22
|
+
identity: params.identity,
|
|
23
|
+
tenant: params.tenant,
|
|
24
|
+
endpoint: params.endpoint,
|
|
25
|
+
connectedOn: new Date(params.connectedAt).toISOString(),
|
|
26
|
+
owner: this.owner.id
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
async remove(connectionId) {
|
|
30
|
+
this.sockets.delete(connectionId);
|
|
31
|
+
this.metadata.delete(connectionId);
|
|
32
|
+
try {
|
|
33
|
+
await this.registry.unregister({
|
|
34
|
+
connectionId
|
|
35
|
+
});
|
|
36
|
+
} catch (err) {
|
|
37
|
+
if ("CONNECTION_NOT_FOUND" === err.code) return;
|
|
38
|
+
throw err;
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
async groupByOwner(connectionIds) {
|
|
42
|
+
const byOwner = new Map();
|
|
43
|
+
if (0 === connectionIds.length) return byOwner;
|
|
44
|
+
const connections = await this.registry.listViaConnections(connectionIds);
|
|
45
|
+
for (const connection of connections){
|
|
46
|
+
if (!connection.owner) continue;
|
|
47
|
+
const group = byOwner.get(connection.owner) ?? [];
|
|
48
|
+
group.push(connection.connectionId);
|
|
49
|
+
byOwner.set(connection.owner, group);
|
|
50
|
+
}
|
|
51
|
+
return byOwner;
|
|
52
|
+
}
|
|
53
|
+
getSocket(connectionId) {
|
|
54
|
+
return this.sockets.get(connectionId);
|
|
55
|
+
}
|
|
56
|
+
getMetadata(connectionId) {
|
|
57
|
+
return this.metadata.get(connectionId);
|
|
58
|
+
}
|
|
59
|
+
async updateLastSeen(connectionId) {
|
|
60
|
+
await this.registry.updateLastSeen(connectionId);
|
|
61
|
+
}
|
|
62
|
+
async cleanup(maxAge) {
|
|
63
|
+
const olderThan = new Date(Date.now() - maxAge);
|
|
64
|
+
const stale = await this.registry.listStale(olderThan);
|
|
65
|
+
const removed = [];
|
|
66
|
+
for (const entry of stale){
|
|
67
|
+
await this.remove(entry.connectionId);
|
|
68
|
+
removed.push(entry.connectionId);
|
|
69
|
+
}
|
|
70
|
+
return removed;
|
|
71
|
+
}
|
|
72
|
+
getActiveConnectionIds() {
|
|
73
|
+
return Array.from(this.sockets.keys());
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
const ServerConnectionManager = WebsocketsConnectionManager.createImplementation({
|
|
77
|
+
implementation: ServerConnectionManagerImpl,
|
|
78
|
+
dependencies: [
|
|
79
|
+
ConnectionRegistry,
|
|
80
|
+
ProcessOwner
|
|
81
|
+
]
|
|
82
|
+
});
|
|
83
|
+
export { ServerConnectionManager, ServerConnectionManagerImpl };
|
|
84
|
+
|
|
85
|
+
//# sourceMappingURL=ServerConnectionManager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"connectionManager/ServerConnectionManager.js","sources":["../../src/connectionManager/ServerConnectionManager.ts"],"sourcesContent":["import { ConnectionRegistry } from \"@webiny/api-websockets/exports/api.js\";\nimport { ProcessOwner } from \"@webiny/event-handler-standalone\";\nimport { WebsocketsConnectionManager } from \"./abstractions.js\";\n\nexport class ServerConnectionManagerImpl implements WebsocketsConnectionManager.Interface<unknown> {\n private readonly sockets = new Map<string, unknown>();\n private readonly metadata = new Map<string, WebsocketsConnectionManager.ConnectionMetadata>();\n\n public constructor(\n private readonly registry: ConnectionRegistry.Interface,\n private readonly owner: ProcessOwner.Interface\n ) {}\n\n public async add(params: WebsocketsConnectionManager.AddParams<unknown>): Promise<void> {\n this.sockets.set(params.connectionId, params.socket);\n this.metadata.set(params.connectionId, {\n connectionId: params.connectionId,\n endpoint: params.endpoint,\n connectedAt: params.connectedAt,\n host: params.host,\n headers: params.headers\n });\n\n // Save the connection to the shared registry. This is what lets the server later push a\n // message to a specific user β e.g. when a background task finishes and calls\n // SendToIdentity. That flow looks connections up in the registry by identity id to get their\n // connection ids, then comes back here to fetch each live socket by connection id and send.\n // The in-memory map above only answers \"socket for this connection id?\" β it can't be\n // searched by identity, so without this registry row a targeted send finds nobody. The\n // registry stores `connectedOn` as an ISO string (it compares connections against a recency\n // cutoff), so we convert the epoch-ms `connectedAt`.\n await this.registry.register({\n connectionId: params.connectionId,\n identity: params.identity,\n tenant: params.tenant,\n endpoint: params.endpoint,\n connectedOn: new Date(params.connectedAt).toISOString(),\n owner: this.owner.id\n });\n }\n\n public async remove(connectionId: string): Promise<void> {\n this.sockets.delete(connectionId);\n this.metadata.delete(connectionId);\n try {\n await this.registry.unregister({ connectionId });\n } catch (err) {\n if ((err as any).code === \"CONNECTION_NOT_FOUND\") {\n return;\n }\n throw err;\n }\n }\n\n /*\n * The process holding each of these connections, for connections this process has no socket for.\n * Rows without an owner are left out: nobody can say who holds them, so they wait for the\n * heartbeat's stale cleanup.\n */\n public async groupByOwner(connectionIds: string[]): Promise<Map<string, string[]>> {\n const byOwner = new Map<string, string[]>();\n if (connectionIds.length === 0) {\n return byOwner;\n }\n const connections = await this.registry.listViaConnections(connectionIds);\n for (const connection of connections) {\n if (!connection.owner) {\n continue;\n }\n const group = byOwner.get(connection.owner) ?? [];\n group.push(connection.connectionId);\n byOwner.set(connection.owner, group);\n }\n return byOwner;\n }\n\n public getSocket(connectionId: string): unknown | undefined {\n return this.sockets.get(connectionId);\n }\n\n public getMetadata(\n connectionId: string\n ): WebsocketsConnectionManager.ConnectionMetadata | undefined {\n return this.metadata.get(connectionId);\n }\n\n public async updateLastSeen(connectionId: string): Promise<void> {\n await this.registry.updateLastSeen(connectionId);\n }\n\n public async cleanup(maxAge: number): Promise<string[]> {\n const olderThan = new Date(Date.now() - maxAge);\n const stale = await this.registry.listStale(olderThan);\n const removed: string[] = [];\n for (const entry of stale) {\n await this.remove(entry.connectionId);\n removed.push(entry.connectionId);\n }\n return removed;\n }\n\n public getActiveConnectionIds(): string[] {\n return Array.from(this.sockets.keys());\n }\n}\n\nexport const ServerConnectionManager = WebsocketsConnectionManager.createImplementation({\n implementation: ServerConnectionManagerImpl,\n dependencies: [ConnectionRegistry, ProcessOwner]\n});\n"],"names":["ServerConnectionManagerImpl","registry","owner","Map","params","Date","connectionId","err","connectionIds","byOwner","connections","connection","group","maxAge","olderThan","stale","removed","entry","Array","ServerConnectionManager","WebsocketsConnectionManager","ConnectionRegistry","ProcessOwner"],"mappings":";;;AAIO,MAAMA;IAIT,YACqBC,QAAsC,EACtCC,KAA6B,CAChD;aAFmBD,QAAQ,GAARA;aACAC,KAAK,GAALA;aALJ,OAAO,GAAG,IAAIC;aACd,QAAQ,GAAG,IAAIA;IAK7B;IAEH,MAAa,IAAIC,MAAsD,EAAiB;QACpF,IAAI,CAAC,OAAO,CAAC,GAAG,CAACA,OAAO,YAAY,EAAEA,OAAO,MAAM;QACnD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAACA,OAAO,YAAY,EAAE;YACnC,cAAcA,OAAO,YAAY;YACjC,UAAUA,OAAO,QAAQ;YACzB,aAAaA,OAAO,WAAW;YAC/B,MAAMA,OAAO,IAAI;YACjB,SAASA,OAAO,OAAO;QAC3B;QAUA,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACzB,cAAcA,OAAO,YAAY;YACjC,UAAUA,OAAO,QAAQ;YACzB,QAAQA,OAAO,MAAM;YACrB,UAAUA,OAAO,QAAQ;YACzB,aAAa,IAAIC,KAAKD,OAAO,WAAW,EAAE,WAAW;YACrD,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE;QACxB;IACJ;IAEA,MAAa,OAAOE,YAAoB,EAAiB;QACrD,IAAI,CAAC,OAAO,CAAC,MAAM,CAACA;QACpB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAACA;QACrB,IAAI;YACA,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;gBAAEA;YAAa;QAClD,EAAE,OAAOC,KAAK;YACV,IAAKA,AAAqB,2BAArBA,IAAY,IAAI,EACjB;YAEJ,MAAMA;QACV;IACJ;IAOA,MAAa,aAAaC,aAAuB,EAAkC;QAC/E,MAAMC,UAAU,IAAIN;QACpB,IAAIK,AAAyB,MAAzBA,cAAc,MAAM,EACpB,OAAOC;QAEX,MAAMC,cAAc,MAAM,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAACF;QAC3D,KAAK,MAAMG,cAAcD,YAAa;YAClC,IAAI,CAACC,WAAW,KAAK,EACjB;YAEJ,MAAMC,QAAQH,QAAQ,GAAG,CAACE,WAAW,KAAK,KAAK,EAAE;YACjDC,MAAM,IAAI,CAACD,WAAW,YAAY;YAClCF,QAAQ,GAAG,CAACE,WAAW,KAAK,EAAEC;QAClC;QACA,OAAOH;IACX;IAEO,UAAUH,YAAoB,EAAuB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAACA;IAC5B;IAEO,YACHA,YAAoB,EACsC;QAC1D,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAACA;IAC7B;IAEA,MAAa,eAAeA,YAAoB,EAAiB;QAC7D,MAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAACA;IACvC;IAEA,MAAa,QAAQO,MAAc,EAAqB;QACpD,MAAMC,YAAY,IAAIT,KAAKA,KAAK,GAAG,KAAKQ;QACxC,MAAME,QAAQ,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAACD;QAC5C,MAAME,UAAoB,EAAE;QAC5B,KAAK,MAAMC,SAASF,MAAO;YACvB,MAAM,IAAI,CAAC,MAAM,CAACE,MAAM,YAAY;YACpCD,QAAQ,IAAI,CAACC,MAAM,YAAY;QACnC;QACA,OAAOD;IACX;IAEO,yBAAmC;QACtC,OAAOE,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI;IACvC;AACJ;AAEO,MAAMC,0BAA0BC,4BAA4B,oBAAoB,CAAC;IACpF,gBAAgBpB;IAChB,cAAc;QAACqB;QAAoBC;KAAa;AACpD"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { ConnectionRegistry } from "@webiny/api-websockets/exports/api.js";
|
|
2
|
+
export interface IWebsocketsConnectionManagerAddParams<TSocket> {
|
|
3
|
+
connectionId: string;
|
|
4
|
+
socket: TSocket;
|
|
5
|
+
endpoint: string;
|
|
6
|
+
identity: ConnectionRegistry.Identity;
|
|
7
|
+
tenant: string;
|
|
8
|
+
connectedAt: number;
|
|
9
|
+
host: string;
|
|
10
|
+
headers: Record<string, string>;
|
|
11
|
+
}
|
|
12
|
+
export interface IWebsocketsConnectionManagerMetadata {
|
|
13
|
+
connectionId: string;
|
|
14
|
+
endpoint: string;
|
|
15
|
+
connectedAt: number;
|
|
16
|
+
host: string;
|
|
17
|
+
headers: Record<string, string>;
|
|
18
|
+
}
|
|
19
|
+
export interface IWebsocketsConnectionManager<TSocket> {
|
|
20
|
+
add(params: IWebsocketsConnectionManagerAddParams<TSocket>): Promise<void>;
|
|
21
|
+
remove(connectionId: string): Promise<void>;
|
|
22
|
+
groupByOwner(connectionIds: string[]): Promise<Map<string, string[]>>;
|
|
23
|
+
getSocket(connectionId: string): TSocket | undefined;
|
|
24
|
+
getMetadata(connectionId: string): IWebsocketsConnectionManagerMetadata | undefined;
|
|
25
|
+
updateLastSeen(connectionId: string): Promise<void>;
|
|
26
|
+
cleanup(maxAge: number): Promise<string[]>;
|
|
27
|
+
getActiveConnectionIds(): string[];
|
|
28
|
+
}
|
|
29
|
+
export declare const WebsocketsConnectionManager: import("@webiny/di").Abstraction<IWebsocketsConnectionManager<unknown>>;
|
|
30
|
+
export declare namespace WebsocketsConnectionManager {
|
|
31
|
+
type Interface<TSocket> = IWebsocketsConnectionManager<TSocket>;
|
|
32
|
+
type AddParams<TSocket> = IWebsocketsConnectionManagerAddParams<TSocket>;
|
|
33
|
+
type ConnectionMetadata = IWebsocketsConnectionManagerMetadata;
|
|
34
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"connectionManager/abstractions.js","sources":["../../src/connectionManager/abstractions.ts"],"sourcesContent":["import { ConnectionRegistry } from \"@webiny/api-websockets/exports/api.js\";\nimport { createAbstraction } from \"@webiny/feature/api\";\n\nexport interface IWebsocketsConnectionManagerAddParams<TSocket> {\n connectionId: string;\n socket: TSocket;\n endpoint: string;\n identity: ConnectionRegistry.Identity;\n tenant: string;\n connectedAt: number;\n host: string;\n headers: Record<string, string>;\n}\n\nexport interface IWebsocketsConnectionManagerMetadata {\n connectionId: string;\n endpoint: string;\n connectedAt: number;\n host: string;\n headers: Record<string, string>;\n}\n\nexport interface IWebsocketsConnectionManager<TSocket> {\n add(params: IWebsocketsConnectionManagerAddParams<TSocket>): Promise<void>;\n remove(connectionId: string): Promise<void>;\n groupByOwner(connectionIds: string[]): Promise<Map<string, string[]>>;\n getSocket(connectionId: string): TSocket | undefined;\n getMetadata(connectionId: string): IWebsocketsConnectionManagerMetadata | undefined;\n updateLastSeen(connectionId: string): Promise<void>;\n cleanup(maxAge: number): Promise<string[]>;\n getActiveConnectionIds(): string[];\n}\n\nexport const WebsocketsConnectionManager = createAbstraction<IWebsocketsConnectionManager<unknown>>(\n \"WebsocketsConnectionManager\"\n);\n\nexport namespace WebsocketsConnectionManager {\n export type Interface<TSocket> = IWebsocketsConnectionManager<TSocket>;\n export type AddParams<TSocket> = IWebsocketsConnectionManagerAddParams<TSocket>;\n export type ConnectionMetadata = IWebsocketsConnectionManagerMetadata;\n}\n"],"names":["WebsocketsConnectionManager","createAbstraction"],"mappings":";AAiCO,MAAMA,8BAA8BC,kBACvC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { Logger } from "@webiny/api-core/features/logger/abstractions.js";
|
|
2
|
+
import type { WebsocketsConnectionManager } from "../connectionManager/abstractions.js";
|
|
3
|
+
import type { WebsocketsServerAdapter } from "../adapter/abstractions.js";
|
|
4
|
+
export interface IDisconnectLocalSocketsParams {
|
|
5
|
+
connectionManager: WebsocketsConnectionManager.Interface<unknown>;
|
|
6
|
+
adapter: WebsocketsServerAdapter.Interface<unknown>;
|
|
7
|
+
logger: Logger.Interface;
|
|
8
|
+
connectionIds: string[];
|
|
9
|
+
}
|
|
10
|
+
export declare const disconnectLocalSockets: (params: IDisconnectLocalSocketsParams) => Promise<string[]>;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
const disconnectLocalSockets = async (params)=>{
|
|
2
|
+
const { connectionManager, adapter, logger, connectionIds } = params;
|
|
3
|
+
const missing = [];
|
|
4
|
+
for (const connectionId of connectionIds){
|
|
5
|
+
const socket = connectionManager.getSocket(connectionId);
|
|
6
|
+
if (void 0 === socket) {
|
|
7
|
+
missing.push(connectionId);
|
|
8
|
+
continue;
|
|
9
|
+
}
|
|
10
|
+
try {
|
|
11
|
+
adapter.close(socket);
|
|
12
|
+
await connectionManager.remove(connectionId);
|
|
13
|
+
} catch (error) {
|
|
14
|
+
logger.error({
|
|
15
|
+
error,
|
|
16
|
+
connectionId
|
|
17
|
+
}, "[websockets] could not disconnect a connection");
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
return missing;
|
|
21
|
+
};
|
|
22
|
+
export { disconnectLocalSockets };
|
|
23
|
+
|
|
24
|
+
//# sourceMappingURL=disconnectLocalSockets.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"delivery/disconnectLocalSockets.js","sources":["../../src/delivery/disconnectLocalSockets.ts"],"sourcesContent":["import type { Logger } from \"@webiny/api-core/features/logger/abstractions.js\";\nimport type { WebsocketsConnectionManager } from \"~/connectionManager/abstractions.js\";\nimport type { WebsocketsServerAdapter } from \"~/adapter/abstractions.js\";\n\nexport interface IDisconnectLocalSocketsParams {\n connectionManager: WebsocketsConnectionManager.Interface<unknown>;\n adapter: WebsocketsServerAdapter.Interface<unknown>;\n logger: Logger.Interface;\n connectionIds: string[];\n}\n\n/*\n * Closes each socket this process holds, removes its connection, and returns the ids it holds no\n * socket for. A failed close is logged and the others go on.\n */\nexport const disconnectLocalSockets = async (\n params: IDisconnectLocalSocketsParams\n): Promise<string[]> => {\n const { connectionManager, adapter, logger, connectionIds } = params;\n const missing: string[] = [];\n for (const connectionId of connectionIds) {\n const socket = connectionManager.getSocket(connectionId);\n if (socket === undefined) {\n missing.push(connectionId);\n continue;\n }\n try {\n adapter.close(socket);\n await connectionManager.remove(connectionId);\n } catch (error) {\n logger.error({ error, connectionId }, \"[websockets] could not disconnect a connection\");\n }\n }\n return missing;\n};\n"],"names":["disconnectLocalSockets","params","connectionManager","adapter","logger","connectionIds","missing","connectionId","socket","undefined","error"],"mappings":"AAeO,MAAMA,yBAAyB,OAClCC;IAEA,MAAM,EAAEC,iBAAiB,EAAEC,OAAO,EAAEC,MAAM,EAAEC,aAAa,EAAE,GAAGJ;IAC9D,MAAMK,UAAoB,EAAE;IAC5B,KAAK,MAAMC,gBAAgBF,cAAe;QACtC,MAAMG,SAASN,kBAAkB,SAAS,CAACK;QAC3C,IAAIC,AAAWC,WAAXD,QAAsB;YACtBF,QAAQ,IAAI,CAACC;YACb;QACJ;QACA,IAAI;YACAJ,QAAQ,KAAK,CAACK;YACd,MAAMN,kBAAkB,MAAM,CAACK;QACnC,EAAE,OAAOG,OAAO;YACZN,OAAO,KAAK,CAAC;gBAAEM;gBAAOH;YAAa,GAAG;QAC1C;IACJ;IACA,OAAOD;AACX"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { GenericRecord } from "@webiny/api/types.js";
|
|
2
|
+
import type { Logger } from "@webiny/api-core/features/logger/abstractions.js";
|
|
3
|
+
import type { WebsocketsConnectionManager } from "../connectionManager/abstractions.js";
|
|
4
|
+
import type { WebsocketsServerAdapter } from "../adapter/abstractions.js";
|
|
5
|
+
export interface ISendToLocalSocketsParams {
|
|
6
|
+
connectionManager: WebsocketsConnectionManager.Interface<unknown>;
|
|
7
|
+
adapter: WebsocketsServerAdapter.Interface<unknown>;
|
|
8
|
+
logger: Logger.Interface;
|
|
9
|
+
connectionIds: string[];
|
|
10
|
+
data: GenericRecord;
|
|
11
|
+
}
|
|
12
|
+
export declare const sendToLocalSockets: (params: ISendToLocalSocketsParams) => Promise<string[]>;
|