forked from kubernetes-client/javascript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathweb-socket-handler.ts
More file actions
290 lines (260 loc) · 9.2 KB
/
web-socket-handler.ts
File metadata and controls
290 lines (260 loc) · 9.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
import WebSocket from 'isomorphic-ws';
import stream from 'node:stream';
import { V1Status } from './api.js';
import { KubeConfig } from './config.js';
const protocols = [
'v5.channel.k8s.io',
'v4.channel.k8s.io',
'v3.channel.k8s.io',
'v2.channel.k8s.io',
'channel.k8s.io',
];
export interface WebSocketInterface {
connect(
path: string,
textHandler: ((text: string) => boolean) | null,
binaryHandler: ((stream: number, buff: Buffer) => boolean) | null,
): Promise<WebSocket.WebSocket>;
}
export interface StreamInterface {
stdin: stream.Readable;
stdout: stream.Writable;
stderr: stream.Writable;
}
export class WebSocketHandler implements WebSocketInterface {
public static readonly StdinStream: number = 0;
public static readonly StdoutStream: number = 1;
public static readonly StderrStream: number = 2;
public static readonly StatusStream: number = 3;
public static readonly ResizeStream: number = 4;
public static readonly CloseStream: number = 255;
public static supportsClose(protocol: string): boolean {
return protocol === 'v5.channel.k8s.io';
}
public static closeStream(streamNum: number, streams: StreamInterface): void {
switch (streamNum) {
case WebSocketHandler.StdinStream:
streams.stdin.pause();
break;
case WebSocketHandler.StdoutStream:
streams.stdout.end();
break;
case WebSocketHandler.StderrStream:
streams.stderr.end();
break;
}
}
public static handleStandardStreams(
streamNum: number,
buff: Buffer,
stdout: stream.Writable | null,
stderr: stream.Writable | null,
): V1Status | null {
if (buff.length < 1) {
return null;
}
if (stdout && streamNum === WebSocketHandler.StdoutStream) {
stdout.write(buff);
} else if (stderr && streamNum === WebSocketHandler.StderrStream) {
stderr.write(buff);
} else if (streamNum === WebSocketHandler.StatusStream) {
// stream closing.
// Hacky, change tests to use the stream interface
if (stdout && stdout !== process.stdout) {
stdout.end();
}
if (stderr && stderr !== process.stderr) {
stderr.end();
}
return JSON.parse(buff.toString('utf8')) as V1Status;
} else {
throw new Error('Unknown stream: ' + streamNum);
}
return null;
}
public static handleStandardInput(
ws: WebSocket.WebSocket,
stdin: stream.Readable,
streamNum: number = 0,
): boolean {
stdin.on('data', (data) => {
ws.send(copyChunkForWebSocket(streamNum, data, stdin.readableEncoding));
});
stdin.on('end', () => {
if (WebSocketHandler.supportsClose(ws.protocol)) {
const buff = Buffer.alloc(2);
buff.writeUint8(this.CloseStream, 0);
buff.writeUint8(this.StdinStream, 1);
ws.send(buff);
return;
}
ws.close();
});
// Keep the stream open
return true;
}
public static async processData(
data: string | Buffer,
ws: WebSocket.WebSocket | null,
createWS: () => Promise<WebSocket.WebSocket>,
streamNum: number = 0,
retryCount: number = 3,
encoding?: BufferEncoding | null,
): Promise<WebSocket.WebSocket | null> {
const buff = copyChunkForWebSocket(streamNum, data, encoding);
let i = 0;
for (; i < retryCount; ++i) {
if (ws !== null && ws.readyState === WebSocket.OPEN) {
ws.send(buff);
break;
} else {
ws = await createWS();
}
}
// This throw doesn't go anywhere.
// TODO: Figure out the right way to return an error.
if (i >= retryCount) {
throw new Error("can't send data to ws");
}
return ws;
}
public static restartableHandleStandardInput(
createWS: () => Promise<WebSocket.WebSocket>,
stdin: stream.Readable,
streamNum: number = 0,
retryCount: number = 3,
// kind of hacky, but otherwise we can't wait for the writes to flush before testing.
addFlushForTesting: boolean = false,
): () => WebSocket.WebSocket | null {
if (retryCount < 0) {
throw new Error("retryCount can't be lower than 0.");
}
let queue: Promise<void> = Promise.resolve();
let ws: WebSocket.WebSocket | null = null;
stdin.on('data', (data) => {
queue = queue.then(async () => {
ws = await WebSocketHandler.processData(
data,
ws,
createWS,
streamNum,
retryCount,
stdin.readableEncoding,
);
});
});
if (addFlushForTesting) {
stdin.on('flush', async () => {
await queue;
});
}
stdin.on('end', () => {
if (ws !== null) {
ws.close();
}
});
return () => ws;
}
readonly config: KubeConfig;
readonly socketFactory?: (
uri: string,
protocols: string[],
opts: WebSocket.ClientOptions,
) => WebSocket.WebSocket;
readonly streams: StreamInterface;
// factory is really just for test injection
public constructor(
kc: KubeConfig,
socketFactoryFn?: (
uri: string,
protocols: string[],
opts: WebSocket.ClientOptions,
) => WebSocket.WebSocket,
streamsInterface: StreamInterface = {
stdin: process.stdin,
stdout: process.stdout,
stderr: process.stderr,
},
) {
this.config = kc;
this.socketFactory = socketFactoryFn;
this.streams = streamsInterface;
}
/**
* Connect to a web socket endpoint.
* @param path The HTTP Path to connect to on the server.
* @param textHandler Callback for text over the web socket.
* Returns true if the connection should be kept alive, false to disconnect.
* @param binaryHandler Callback for binary data over the web socket.
* Returns true if the connection should be kept alive, false to disconnect.
*/
public async connect(
path: string,
textHandler: ((text: string) => boolean) | null,
binaryHandler: ((stream: number, buff: Buffer) => boolean) | null,
): Promise<WebSocket.WebSocket> {
const cluster = this.config.getCurrentCluster();
if (!cluster) {
throw new Error('No cluster is defined.');
}
const server = cluster.server;
const ssl = server.startsWith('https://');
const target = ssl ? server.substr(8) : server.substr(7);
const proto = ssl ? 'wss' : 'ws';
const uri = `${proto}://${target}${path}`;
const opts: WebSocket.ClientOptions = {};
await this.config.applyToHTTPSOptions(opts);
return await new Promise<WebSocket.WebSocket>((resolve, reject) => {
const client = this.socketFactory
? this.socketFactory(uri, protocols, opts)
: new WebSocket(uri, protocols, opts);
let resolved = false;
client.onopen = () => {
resolved = true;
resolve(client);
};
client.onerror = (err) => {
if (!resolved) {
reject(err);
}
};
client.onmessage = ({ data }: { data: WebSocket.Data }) => {
// TODO: support ArrayBuffer and Buffer[] data types?
if (typeof data === 'string') {
if (data.charCodeAt(0) === WebSocketHandler.CloseStream) {
WebSocketHandler.closeStream(data.charCodeAt(1), this.streams);
}
if (textHandler && !textHandler(data)) {
client.close();
}
} else if (data instanceof Buffer) {
const streamNum = data.readUint8(0);
if (streamNum === WebSocketHandler.CloseStream) {
WebSocketHandler.closeStream(data.readInt8(1), this.streams);
}
if (binaryHandler && !binaryHandler(streamNum, data.slice(1))) {
client.close();
}
}
};
});
}
}
function copyChunkForWebSocket(
streamNum: number,
chunk: string | Buffer,
encoding?: BufferEncoding | null,
): Buffer {
let buff: Buffer;
if (chunk instanceof Buffer) {
buff = Buffer.alloc(chunk.length + 1);
chunk.copy(buff, 1);
} else {
encoding ??= 'utf-8';
const size = Buffer.byteLength(chunk, encoding);
buff = Buffer.alloc(size + 1);
buff.write(chunk as string, 1, size, encoding);
}
buff.writeInt8(streamNum, 0);
return buff;
}