@nmtjs/ws-client 0.15.0-beta.9 → 0.15.0
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/README.md +31 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +29 -6
- package/dist/index.js.map +1 -1
- package/package.json +14 -12
- package/src/index.ts +33 -7
package/README.md
CHANGED
|
@@ -6,4 +6,34 @@
|
|
|
6
6
|
- binary data streaming and event subscriptions
|
|
7
7
|
- contract-based API
|
|
8
8
|
- end-to-end type safety
|
|
9
|
-
- CPU-intensive task execution on separate workers
|
|
9
|
+
- CPU-intensive task execution on separate workers
|
|
10
|
+
|
|
11
|
+
## Jobs E2E (Local Docker)
|
|
12
|
+
|
|
13
|
+
Prerequisites:
|
|
14
|
+
- Docker Desktop (or Docker Engine) with `docker compose` available
|
|
15
|
+
|
|
16
|
+
No host ports are exposed in this setup. Tests run fully inside Docker containers.
|
|
17
|
+
The test image is optimized for Docker layer caching with `pnpm fetch` + offline install.
|
|
18
|
+
|
|
19
|
+
Run both backends with one command:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
pnpm run test:e2e:jobs:docker
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
This command rebuilds the test image on each run and executes Redis + Valkey suites in one pass.
|
|
26
|
+
|
|
27
|
+
Run Jobs E2E directly in Docker:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
docker compose -f docker-compose.jobs-e2e.yml run --rm --build test-jobs
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Manual Docker control:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
docker compose -f docker-compose.jobs-e2e.yml up -d --wait redis valkey
|
|
37
|
+
docker compose -f docker-compose.jobs-e2e.yml run --rm --build test-jobs
|
|
38
|
+
docker compose -f docker-compose.jobs-e2e.yml down -v --remove-orphans
|
|
39
|
+
```
|
package/dist/index.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export declare class WsTransportClient {
|
|
|
22
22
|
type: ConnectionType.Bidirectional;
|
|
23
23
|
protected webSocket: WebSocket | null;
|
|
24
24
|
protected connecting: Promise<void> | null;
|
|
25
|
+
protected closingByClient: boolean;
|
|
25
26
|
constructor(format: BaseClientFormat, protocol: ProtocolVersion, options: WsClientTransportOptions);
|
|
26
27
|
connect(params: ClientTransportStartParams): Promise<void>;
|
|
27
28
|
disconnect(): Promise<void>;
|
package/dist/index.js
CHANGED
|
@@ -7,6 +7,7 @@ export class WsTransportClient {
|
|
|
7
7
|
type = ConnectionType.Bidirectional;
|
|
8
8
|
webSocket = null;
|
|
9
9
|
connecting = null;
|
|
10
|
+
closingByClient = false;
|
|
10
11
|
constructor(format, protocol, options) {
|
|
11
12
|
this.format = format;
|
|
12
13
|
this.protocol = protocol;
|
|
@@ -14,6 +15,7 @@ export class WsTransportClient {
|
|
|
14
15
|
this.options = { debug: false, ...options };
|
|
15
16
|
}
|
|
16
17
|
async connect(params) {
|
|
18
|
+
this.closingByClient = false;
|
|
17
19
|
const url = new URL(params.application ? `/${params.application}` : '/', this.options.url);
|
|
18
20
|
const secure = url.protocol === 'wss:' || url.protocol === 'https:';
|
|
19
21
|
url.protocol = secure ? 'wss:' : 'ws:';
|
|
@@ -27,20 +29,40 @@ export class WsTransportClient {
|
|
|
27
29
|
: new WebSocket(url.toString());
|
|
28
30
|
ws.binaryType = 'arraybuffer';
|
|
29
31
|
this.connecting = new Promise((resolve, reject) => {
|
|
32
|
+
let settled = false;
|
|
33
|
+
const settle = (fn) => {
|
|
34
|
+
if (settled)
|
|
35
|
+
return;
|
|
36
|
+
settled = true;
|
|
37
|
+
fn();
|
|
38
|
+
};
|
|
30
39
|
ws.addEventListener('open', () => {
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
40
|
+
settle(() => {
|
|
41
|
+
this.connecting = null;
|
|
42
|
+
params.onConnect();
|
|
43
|
+
resolve();
|
|
44
|
+
});
|
|
34
45
|
});
|
|
35
46
|
ws.addEventListener('message', (event) => {
|
|
36
47
|
params.onMessage(new Uint8Array(event.data));
|
|
37
48
|
});
|
|
38
49
|
ws.addEventListener('error', (event) => {
|
|
39
|
-
|
|
50
|
+
settle(() => {
|
|
51
|
+
this.connecting = null;
|
|
52
|
+
reject(new Error('WebSocket error', {
|
|
53
|
+
cause: event.error,
|
|
54
|
+
}));
|
|
55
|
+
});
|
|
40
56
|
});
|
|
41
57
|
ws.addEventListener('close', (event) => {
|
|
42
|
-
|
|
43
|
-
|
|
58
|
+
const reason = this.closingByClient || event.reason === 'client'
|
|
59
|
+
? 'client'
|
|
60
|
+
: 'server';
|
|
61
|
+
settle(() => {
|
|
62
|
+
this.webSocket = null;
|
|
63
|
+
this.connecting = null;
|
|
64
|
+
params.onDisconnect(reason);
|
|
65
|
+
});
|
|
44
66
|
});
|
|
45
67
|
});
|
|
46
68
|
this.webSocket = ws;
|
|
@@ -49,6 +71,7 @@ export class WsTransportClient {
|
|
|
49
71
|
async disconnect() {
|
|
50
72
|
if (this.webSocket === null)
|
|
51
73
|
return;
|
|
74
|
+
this.closingByClient = true;
|
|
52
75
|
const closing = once(this.webSocket, 'close');
|
|
53
76
|
this.webSocket.close(1000, 'client');
|
|
54
77
|
return closing;
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAiBhD,MAAM,OAAO,iBAAiB;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAiBhD,MAAM,OAAO,iBAAiB;IAQP,MAAM;IACN,QAAQ;IACjB,OAAO;IATnB,IAAI,GAAiC,cAAc,CAAC,aAAa,CAAA;IAEvD,SAAS,GAAqB,IAAI,CAAA;IAClC,UAAU,GAAyB,IAAI,CAAA;IACvC,eAAe,GAAG,KAAK,CAAA;IAEjC,YACqB,MAAwB,EACxB,QAAyB,EAClC,OAAiC,EAC3C;sBAHmB,MAAM;wBACN,QAAQ;uBACjB,OAAO;QAEjB,IAAI,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAA;IAAA,CAC5C;IAED,KAAK,CAAC,OAAO,CAAC,MAAkC,EAAE;QAChD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;QAC5B,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,GAAG,EACnD,IAAI,CAAC,OAAO,CAAC,GAAG,CACjB,CAAA;QAED,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAA;QAEnE,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAA;QACtC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QAC7D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QAEvD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;QAC3C,CAAC;QAED,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS;YAC/B,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC;YACjC,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEjC,EAAE,CAAC,UAAU,GAAG,aAAa,CAAA;QAE7B,IAAI,CAAC,UAAU,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;YACjD,IAAI,OAAO,GAAG,KAAK,CAAA;YACnB,MAAM,MAAM,GAAG,CAAC,EAAc,EAAE,EAAE,CAAC;gBACjC,IAAI,OAAO;oBAAE,OAAM;gBACnB,OAAO,GAAG,IAAI,CAAA;gBACd,EAAE,EAAE,CAAA;YAAA,CACL,CAAA;YAED,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;gBAChC,MAAM,CAAC,GAAG,EAAE,CAAC;oBACX,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;oBACtB,MAAM,CAAC,SAAS,EAAE,CAAA;oBAClB,OAAO,EAAE,CAAA;gBAAA,CACV,CAAC,CAAA;YAAA,CACH,CAAC,CAAA;YACF,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;gBACxC,MAAM,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAmB,CAAC,CAAC,CAAA;YAAA,CAC5D,CAAC,CAAA;YACF,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;gBACtC,MAAM,CAAC,GAAG,EAAE,CAAC;oBACX,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;oBACtB,MAAM,CACJ,IAAI,KAAK,CAAC,iBAAiB,EAAE;wBAC3B,KAAK,EAAG,KAAoB,CAAC,KAAK;qBACnC,CAAC,CACH,CAAA;gBAAA,CACF,CAAC,CAAA;YAAA,CACH,CAAC,CAAA;YACF,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;gBACtC,MAAM,MAAM,GACV,IAAI,CAAC,eAAe,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ;oBAC/C,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,QAAQ,CAAA;gBACd,MAAM,CAAC,GAAG,EAAE,CAAC;oBACX,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;oBACrB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;oBACtB,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;gBAAA,CAC5B,CAAC,CAAA;YAAA,CACH,CAAC,CAAA;QAAA,CACH,CAAC,CAAA;QAEF,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QAEnB,OAAO,IAAI,CAAC,UAAU,CAAA;IAAA,CACvB;IAED,KAAK,CAAC,UAAU,GAAG;QACjB,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,OAAM;QACnC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAA;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;QAC7C,IAAI,CAAC,SAAU,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QACrC,OAAO,OAAO,CAAA;IAAA,CACf;IAED,KAAK,CAAC,IAAI,CAAC,OAAwB,EAAE,OAA0B,EAAE;QAC/D,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAC1E,MAAM,IAAI,CAAC,UAAU,CAAA;QACrB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO;YAAE,IAAI,CAAC,SAAU,CAAC,IAAI,CAAC,OAAc,CAAC,CAAA;IAAA,CACnE;CACF;AAQD,MAAM,CAAC,MAAM,kBAAkB,GAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CACxE,IAAI,iBAAiB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,20 +1,25 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nmtjs/ws-client",
|
|
3
|
+
"description": "WebSocket client transport for Neemata.",
|
|
3
4
|
"type": "module",
|
|
4
5
|
"exports": {
|
|
5
|
-
".":
|
|
6
|
+
".": {
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"import": "./dist/index.js",
|
|
9
|
+
"module-sync": "./dist/index.js"
|
|
10
|
+
}
|
|
6
11
|
},
|
|
7
12
|
"dependencies": {
|
|
8
|
-
"@nmtjs/
|
|
9
|
-
"@nmtjs/
|
|
13
|
+
"@nmtjs/client": "0.15.0",
|
|
14
|
+
"@nmtjs/common": "0.15.0"
|
|
10
15
|
},
|
|
11
16
|
"devDependencies": {
|
|
12
|
-
"@nmtjs/protocol": "0.15.0
|
|
17
|
+
"@nmtjs/protocol": "0.15.0"
|
|
13
18
|
},
|
|
14
19
|
"peerDependencies": {
|
|
15
|
-
"@nmtjs/
|
|
16
|
-
"@nmtjs/common": "0.15.0
|
|
17
|
-
"@nmtjs/
|
|
20
|
+
"@nmtjs/protocol": "0.15.0",
|
|
21
|
+
"@nmtjs/common": "0.15.0",
|
|
22
|
+
"@nmtjs/client": "0.15.0"
|
|
18
23
|
},
|
|
19
24
|
"files": [
|
|
20
25
|
"dist",
|
|
@@ -22,11 +27,8 @@
|
|
|
22
27
|
"LICENSE.md",
|
|
23
28
|
"README.md"
|
|
24
29
|
],
|
|
25
|
-
"version": "0.15.0
|
|
30
|
+
"version": "0.15.0",
|
|
26
31
|
"scripts": {
|
|
27
|
-
"clean-build": "rm -rf ./dist"
|
|
28
|
-
"build": "tsc --declaration --sourcemap",
|
|
29
|
-
"dev": "tsc --watch",
|
|
30
|
-
"type-check": "tsc --noEmit"
|
|
32
|
+
"clean-build": "rm -rf ./dist"
|
|
31
33
|
}
|
|
32
34
|
}
|
package/src/index.ts
CHANGED
|
@@ -28,6 +28,7 @@ export class WsTransportClient {
|
|
|
28
28
|
|
|
29
29
|
protected webSocket: WebSocket | null = null
|
|
30
30
|
protected connecting: Promise<void> | null = null
|
|
31
|
+
protected closingByClient = false
|
|
31
32
|
|
|
32
33
|
constructor(
|
|
33
34
|
protected readonly format: BaseClientFormat,
|
|
@@ -38,6 +39,7 @@ export class WsTransportClient {
|
|
|
38
39
|
}
|
|
39
40
|
|
|
40
41
|
async connect(params: ClientTransportStartParams) {
|
|
42
|
+
this.closingByClient = false
|
|
41
43
|
const url = new URL(
|
|
42
44
|
params.application ? `/${params.application}` : '/',
|
|
43
45
|
this.options.url,
|
|
@@ -60,20 +62,43 @@ export class WsTransportClient {
|
|
|
60
62
|
ws.binaryType = 'arraybuffer'
|
|
61
63
|
|
|
62
64
|
this.connecting = new Promise((resolve, reject) => {
|
|
65
|
+
let settled = false
|
|
66
|
+
const settle = (fn: () => void) => {
|
|
67
|
+
if (settled) return
|
|
68
|
+
settled = true
|
|
69
|
+
fn()
|
|
70
|
+
}
|
|
71
|
+
|
|
63
72
|
ws.addEventListener('open', () => {
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
73
|
+
settle(() => {
|
|
74
|
+
this.connecting = null
|
|
75
|
+
params.onConnect()
|
|
76
|
+
resolve()
|
|
77
|
+
})
|
|
67
78
|
})
|
|
68
79
|
ws.addEventListener('message', (event) => {
|
|
69
80
|
params.onMessage(new Uint8Array(event.data as ArrayBuffer))
|
|
70
81
|
})
|
|
71
82
|
ws.addEventListener('error', (event) => {
|
|
72
|
-
|
|
83
|
+
settle(() => {
|
|
84
|
+
this.connecting = null
|
|
85
|
+
reject(
|
|
86
|
+
new Error('WebSocket error', {
|
|
87
|
+
cause: (event as ErrorEvent).error,
|
|
88
|
+
}),
|
|
89
|
+
)
|
|
90
|
+
})
|
|
73
91
|
})
|
|
74
92
|
ws.addEventListener('close', (event) => {
|
|
75
|
-
|
|
76
|
-
|
|
93
|
+
const reason: 'client' | 'server' =
|
|
94
|
+
this.closingByClient || event.reason === 'client'
|
|
95
|
+
? 'client'
|
|
96
|
+
: 'server'
|
|
97
|
+
settle(() => {
|
|
98
|
+
this.webSocket = null
|
|
99
|
+
this.connecting = null
|
|
100
|
+
params.onDisconnect(reason)
|
|
101
|
+
})
|
|
77
102
|
})
|
|
78
103
|
})
|
|
79
104
|
|
|
@@ -84,6 +109,7 @@ export class WsTransportClient {
|
|
|
84
109
|
|
|
85
110
|
async disconnect() {
|
|
86
111
|
if (this.webSocket === null) return
|
|
112
|
+
this.closingByClient = true
|
|
87
113
|
const closing = once(this.webSocket, 'close')
|
|
88
114
|
this.webSocket!.close(1000, 'client')
|
|
89
115
|
return closing
|
|
@@ -92,7 +118,7 @@ export class WsTransportClient {
|
|
|
92
118
|
async send(message: ArrayBufferView, options: ClientCallOptions) {
|
|
93
119
|
if (this.webSocket === null) throw new Error('WebSocket is not connected')
|
|
94
120
|
await this.connecting
|
|
95
|
-
if (!options.signal?.aborted) this.webSocket!.send(message)
|
|
121
|
+
if (!options.signal?.aborted) this.webSocket!.send(message as any)
|
|
96
122
|
}
|
|
97
123
|
}
|
|
98
124
|
|