@celljs/ta-relay 0.0.0-stage → 4.6.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.
Files changed (106) hide show
  1. package/README.md +34 -2
  2. package/esm/common/index.d.ts +6 -0
  3. package/esm/common/index.js +7 -0
  4. package/esm/common/index.js.map +1 -0
  5. package/esm/common/relay-bytes.d.ts +8 -0
  6. package/esm/common/relay-bytes.js +40 -0
  7. package/esm/common/relay-bytes.js.map +1 -0
  8. package/esm/common/relay-cipher.d.ts +22 -0
  9. package/esm/common/relay-cipher.js +55 -0
  10. package/esm/common/relay-cipher.js.map +1 -0
  11. package/esm/common/relay-pairing.d.ts +18 -0
  12. package/esm/common/relay-pairing.js +35 -0
  13. package/esm/common/relay-pairing.js.map +1 -0
  14. package/esm/common/relay-protocol.d.ts +56 -0
  15. package/esm/common/relay-protocol.js +29 -0
  16. package/esm/common/relay-protocol.js.map +1 -0
  17. package/esm/common/relay-room.d.ts +31 -0
  18. package/esm/common/relay-room.js +63 -0
  19. package/esm/common/relay-room.js.map +1 -0
  20. package/esm/common/relay-socket.d.ts +38 -0
  21. package/esm/common/relay-socket.js +98 -0
  22. package/esm/common/relay-socket.js.map +1 -0
  23. package/esm/node/index.d.ts +4 -0
  24. package/esm/node/index.js +5 -0
  25. package/esm/node/index.js.map +1 -0
  26. package/esm/node/relay-host.d.ts +61 -0
  27. package/esm/node/relay-host.js +208 -0
  28. package/esm/node/relay-host.js.map +1 -0
  29. package/esm/node/relay-server.d.ts +33 -0
  30. package/esm/node/relay-server.js +127 -0
  31. package/esm/node/relay-server.js.map +1 -0
  32. package/esm/node/relay-store.d.ts +35 -0
  33. package/esm/node/relay-store.js +59 -0
  34. package/esm/node/relay-store.js.map +1 -0
  35. package/esm/package.json +3 -0
  36. package/lib/common/index.d.ts +7 -0
  37. package/lib/common/index.d.ts.map +1 -0
  38. package/lib/common/index.js +23 -0
  39. package/lib/common/index.js.map +1 -0
  40. package/lib/common/relay-bytes.d.ts +9 -0
  41. package/lib/common/relay-bytes.d.ts.map +1 -0
  42. package/lib/common/relay-bytes.js +43 -0
  43. package/lib/common/relay-bytes.js.map +1 -0
  44. package/lib/common/relay-cipher.d.ts +23 -0
  45. package/lib/common/relay-cipher.d.ts.map +1 -0
  46. package/lib/common/relay-cipher.js +59 -0
  47. package/lib/common/relay-cipher.js.map +1 -0
  48. package/lib/common/relay-cipher.spec.d.ts +2 -0
  49. package/lib/common/relay-cipher.spec.d.ts.map +1 -0
  50. package/lib/common/relay-cipher.spec.js +43 -0
  51. package/lib/common/relay-cipher.spec.js.map +1 -0
  52. package/lib/common/relay-pairing.d.ts +19 -0
  53. package/lib/common/relay-pairing.d.ts.map +1 -0
  54. package/lib/common/relay-pairing.js +38 -0
  55. package/lib/common/relay-pairing.js.map +1 -0
  56. package/lib/common/relay-pairing.spec.d.ts +2 -0
  57. package/lib/common/relay-pairing.spec.d.ts.map +1 -0
  58. package/lib/common/relay-pairing.spec.js +25 -0
  59. package/lib/common/relay-pairing.spec.js.map +1 -0
  60. package/lib/common/relay-protocol.d.ts +57 -0
  61. package/lib/common/relay-protocol.d.ts.map +1 -0
  62. package/lib/common/relay-protocol.js +32 -0
  63. package/lib/common/relay-protocol.js.map +1 -0
  64. package/lib/common/relay-room.d.ts +32 -0
  65. package/lib/common/relay-room.d.ts.map +1 -0
  66. package/lib/common/relay-room.js +67 -0
  67. package/lib/common/relay-room.js.map +1 -0
  68. package/lib/common/relay-socket.d.ts +39 -0
  69. package/lib/common/relay-socket.d.ts.map +1 -0
  70. package/lib/common/relay-socket.js +102 -0
  71. package/lib/common/relay-socket.js.map +1 -0
  72. package/lib/node/index.d.ts +5 -0
  73. package/lib/node/index.d.ts.map +1 -0
  74. package/lib/node/index.js +21 -0
  75. package/lib/node/index.js.map +1 -0
  76. package/lib/node/relay-host.d.ts +62 -0
  77. package/lib/node/relay-host.d.ts.map +1 -0
  78. package/lib/node/relay-host.js +212 -0
  79. package/lib/node/relay-host.js.map +1 -0
  80. package/lib/node/relay-server.d.ts +34 -0
  81. package/lib/node/relay-server.d.ts.map +1 -0
  82. package/lib/node/relay-server.js +131 -0
  83. package/lib/node/relay-server.js.map +1 -0
  84. package/lib/node/relay-store.d.ts +36 -0
  85. package/lib/node/relay-store.d.ts.map +1 -0
  86. package/lib/node/relay-store.js +63 -0
  87. package/lib/node/relay-store.js.map +1 -0
  88. package/lib/node/relay.spec.d.ts +2 -0
  89. package/lib/node/relay.spec.d.ts.map +1 -0
  90. package/lib/node/relay.spec.js +141 -0
  91. package/lib/node/relay.spec.js.map +1 -0
  92. package/package.json +58 -4
  93. package/src/common/index.ts +6 -0
  94. package/src/common/relay-bytes.ts +37 -0
  95. package/src/common/relay-cipher.spec.ts +45 -0
  96. package/src/common/relay-cipher.ts +74 -0
  97. package/src/common/relay-pairing.spec.ts +26 -0
  98. package/src/common/relay-pairing.ts +46 -0
  99. package/src/common/relay-protocol.ts +50 -0
  100. package/src/common/relay-room.ts +79 -0
  101. package/src/common/relay-socket.ts +106 -0
  102. package/src/node/index.ts +4 -0
  103. package/src/node/relay-host.ts +230 -0
  104. package/src/node/relay-server.ts +143 -0
  105. package/src/node/relay-store.ts +84 -0
  106. package/src/node/relay.spec.ts +151 -0
@@ -0,0 +1,151 @@
1
+ import { afterAll, beforeAll, describe, expect, it } from 'bun:test';
2
+ import { type ChildProcess, spawn } from 'node:child_process';
3
+ import { mkdtempSync } from 'node:fs';
4
+ import { tmpdir } from 'node:os';
5
+ import { join } from 'node:path';
6
+ import { RelayPairingUtil } from '../common/relay-pairing';
7
+ import { RelayCloseCode } from '../common/relay-protocol';
8
+ import { RelaySocket } from '../common/relay-socket';
9
+ import { RelayHost } from './relay-host';
10
+ import { RelayStore } from './relay-store';
11
+
12
+ /** In Node.js: the HTTP server of Bun before 1.4 cannot answer WebSocket upgrades. Prints what reached the host side. */
13
+ function startRelay(port = 0): Promise<{ child: ChildProcess; url: string; seen: string[] }> {
14
+ const script = `const { RelayServer } = require(${JSON.stringify(join(__dirname, 'relay-server.js'))});
15
+ const { RelayRoom } = require(${JSON.stringify(join(__dirname, '../common/relay-room.js'))});
16
+ const fromClient = RelayRoom.prototype.fromClient;
17
+ RelayRoom.prototype.fromClient = function (channel, text) { console.error('SEEN ' + text); return fromClient.call(this, channel, text); };
18
+ new RelayServer({ port: ${port} }).listen().then(url => console.log(url));`;
19
+ const child = spawn('node', ['-e', script], { stdio: ['ignore', 'pipe', 'pipe'] });
20
+ const seen: string[] = [];
21
+ child.stderr?.on('data', data => seen.push(String(data)));
22
+ return new Promise(resolve => child.stdout?.once('data', data => resolve({ child, url: String(data).trim(), seen })));
23
+ }
24
+
25
+ /** Stands in for ta serve: answers every message with what it got, to connections with the token. */
26
+ function startLocal() {
27
+ return Bun.serve({
28
+ port: 0,
29
+ hostname: '127.0.0.1',
30
+ fetch: (request, server) =>
31
+ new URL(request.url).searchParams.get('token') === 'local-token' && server.upgrade(request) ? undefined : new Response('no', { status: 401 }),
32
+ websocket: {
33
+ message: (socket, message) => {
34
+ socket.send(`echo ${message}`);
35
+ },
36
+ },
37
+ });
38
+ }
39
+
40
+ function open(socket: RelaySocket): Promise<{ code: number } | undefined> {
41
+ return new Promise(resolve => {
42
+ socket.onopen = () => resolve(undefined);
43
+ socket.onclose = event => resolve({ code: event.code });
44
+ });
45
+ }
46
+
47
+ function next(socket: RelaySocket): Promise<string> {
48
+ return new Promise(resolve => {
49
+ socket.onmessage = message => resolve(message.data);
50
+ });
51
+ }
52
+
53
+ describe('the relay', () => {
54
+ let relay: Awaited<ReturnType<typeof startRelay>>;
55
+ const local = startLocal();
56
+ const store = new RelayStore(mkdtempSync(join(tmpdir(), 'ta-relay-')));
57
+ let host: RelayHost;
58
+
59
+ beforeAll(async () => {
60
+ relay = await startRelay();
61
+ host = new RelayHost({ store, localUrl: `ws://127.0.0.1:${local.port}/?token=local-token`, reconnectDelayMs: 20 });
62
+ });
63
+
64
+ afterAll(() => {
65
+ host.stop();
66
+ local.stop(true);
67
+ relay.child.kill();
68
+ });
69
+
70
+ const online = async () => {
71
+ host.refresh();
72
+ while (!host.online) {
73
+ await Bun.sleep(10);
74
+ }
75
+ };
76
+
77
+ it('does not connect ta serve before a device is paired', () => {
78
+ host.start();
79
+ expect(host.online).toBe(false);
80
+ });
81
+
82
+ it('takes a paired device to ta serve, and the relay sees only what is sealed', async () => {
83
+ const pairing = store.pair(relay.url, 'phone');
84
+ await online();
85
+ const socket = new RelaySocket(RelayPairingUtil.parse(RelayPairingUtil.link(pairing)));
86
+ expect(await open(socket)).toBeUndefined();
87
+ const answer = next(socket);
88
+ socket.send('a secret question');
89
+ expect(await answer).toBe('echo a secret question');
90
+ const seen = relay.seen.join('');
91
+ expect(seen).toContain('SEEN');
92
+ expect(seen).not.toContain('secret');
93
+ socket.close();
94
+ });
95
+
96
+ it('refuses a device that is not paired, or no longer', async () => {
97
+ const pairing = store.pair(relay.url, 'tablet');
98
+ const stranger = new RelaySocket({ ...pairing, device: 'x'.repeat(22) });
99
+ expect((await open(stranger))?.code).toBe(4403);
100
+ store.remove(pairing.device);
101
+ const removed = new RelaySocket(pairing);
102
+ expect((await open(removed))?.code).toBe(4403);
103
+ });
104
+
105
+ it('refuses a device whose key is wrong', async () => {
106
+ const pairing = store.pair(relay.url, 'laptop');
107
+ const forged = new RelaySocket({ ...pairing, key: store.pair(relay.url, 'other').key });
108
+ expect((await open(forged))?.code).toBe(4403);
109
+ });
110
+
111
+ it('tells a device when its host is offline', async () => {
112
+ const pairing = store.pair(relay.url, 'watch');
113
+ const socket = new RelaySocket({ ...pairing, host: 'n'.repeat(22) });
114
+ expect((await open(socket))?.code).toBe(RelayCloseCode.HOST_OFFLINE);
115
+ });
116
+
117
+ it('does not let another host take the id', async () => {
118
+ const { host: id } = store.read();
119
+ const thief = new WebSocket(`${RelayPairingUtil.websocketUrl(relay.url, '/v1/host/')}${id?.id}?secret=${'w'.repeat(43)}`);
120
+ const code = await new Promise<number>(resolve => {
121
+ thief.onclose = event => resolve(event.code);
122
+ });
123
+ expect(code).toBe(RelayCloseCode.REFUSED);
124
+ expect(host.online).toBe(true);
125
+ });
126
+
127
+ it('comes back when the relay does', async () => {
128
+ const port = Number(new URL(relay.url).port);
129
+ relay.child.kill();
130
+ await new Promise(resolve => relay.child.once('exit', resolve));
131
+ while (host.online) {
132
+ await Bun.sleep(10);
133
+ }
134
+ relay = await startRelay(port);
135
+ while (!host.online) {
136
+ await Bun.sleep(10);
137
+ }
138
+ const pairing = store.pair(relay.url, 'again');
139
+ const socket = new RelaySocket(pairing);
140
+ expect(await open(socket)).toBeUndefined();
141
+ socket.close();
142
+ });
143
+
144
+ it('leaves the relay when the last device is removed', async () => {
145
+ for (const device of store.read().devices) {
146
+ store.remove(device.id);
147
+ }
148
+ host.refresh();
149
+ expect(host.online).toBe(false);
150
+ });
151
+ });