Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | import { IncomingMessage, Server } from "http";
import { Duplex as Socket } from "stream";
import { createHash } from "crypto";
import { TextDecoder } from "util";
import {
Duplex,
Endpoint,
SimpleMeta,
Transport,
TransportType,
} from "estuary-rpc";
import {
createErrorHandlers,
DEFAULT_NOT_FOUND,
DEFAULT_UNAUTHORIZED,
errorResponse,
} from "./errors";
import { getUrl, methodId } from "./middleware";
import { ApiContext, ServerOpts, WsEndpoints } from "./types";
import {
parseDataFrame,
sendBinaryFrame,
sendCloseFrame,
sendPongFrame,
sendTextFrame,
WsOpCode,
} from "./wsDataFrame";
import { isAuthenticated } from "./authentication";
/**
* Upgrade Response
*
* The Http Server must respond to a Connection: Upgrade request with the following HTTPish headers
* in order to signal to the client that it can handle websocket connections
*
* Technically there are extensions and subprotocols that could also be referenced here
*/
function upgradeConnection(req: IncomingMessage, socket: Socket) {
const clientKey = req.headers["sec-websocket-key"];
const reponseHeaders = [
"HTTP/1.1 101 Switching Protocols",
"Upgrade: websocket",
`Sec-WebSocket-Accept: ${createHash("sha1")
.update(clientKey + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11")
.digest("base64")}`,
"Connection: Upgrade",
"\r\n",
].join("\r\n");
socket.write(reponseHeaders);
}
const decoder = new TextDecoder();
/**
* Creates a callback function to set up a WebSocket "endpoint"
* @param endpoint
* @param meta
* @param serverOpts
* @returns
* @group Server
*/
export function wsEndpoint<Req, Res, Meta extends SimpleMeta>(
endpoint: Endpoint<Duplex<Req, Res>, void, ApiContext, unknown>,
meta: Meta,
serverOpts: ServerOpts<Meta>
) {
const transport = (meta.transport || {
transportType: TransportType.JSON,
}) as Transport<Req, Res>;
const sendRes = (res: Res, socket: Socket) => {
if (transport.transportType === TransportType.UNKNOWN) {
if (transport.isBinary) {
sendBinaryFrame(socket, transport.encode.res(res) as Uint8Array);
} else {
sendTextFrame(socket, transport.encode.res(res) as string);
}
} else {
sendTextFrame(socket, JSON.stringify(res));
}
};
return async (request: IncomingMessage, socket: Socket) => {
const duplex = new Duplex<Req, Res>();
const client = duplex.client;
socket.on("close", client.close);
socket.on("error", client.error);
let strBuffer = "";
let bufOffset = 0;
let buffer = new Uint8Array(2048);
socket.on("data", (data: Buffer) => {
const parsedFrame = parseDataFrame(data);
if (parsedFrame.opCode === WsOpCode.PING) {
sendPongFrame(socket, parsedFrame);
return;
} else if (parsedFrame.opCode === WsOpCode.CONNECTION_CLOSE) {
socket.end();
} else if (parsedFrame.opCode === WsOpCode.TEXT) {
strBuffer += decoder.decode(parsedFrame.payload);
Iif (parsedFrame.fin) {
try {
if (transport.transportType === TransportType.UNKNOWN) {
client.write(transport.decode.req(strBuffer));
} else {
client.write(JSON.parse(strBuffer) as Req);
}
} catch (err) {
console.error(
`Error: unable to parse string WS data ${strBuffer}`,
err
);
}
strBuffer = "";
}
} else Iif (parsedFrame.opCode === WsOpCode.BINARY) {
// somewhat efficiently grow the underlying buffer
Iif (parsedFrame.payloadLen + bufOffset > buffer.length) {
let newSize = buffer.length * 2;
while (parsedFrame.payloadLen + bufOffset > newSize) {
newSize *= 2;
}
const newBuffer = new Uint8Array(newSize);
newBuffer.set(buffer);
buffer = newBuffer;
}
buffer.set(parsedFrame.payload, bufOffset);
bufOffset += parsedFrame.payloadLen;
Iif (parsedFrame.fin) {
Iif (
transport.transportType === TransportType.UNKNOWN &&
transport.isBinary
) {
try {
client.write(transport.decode.req(buffer));
} catch (err) {
console.error("Unable to encode WS data", err);
}
}
bufOffset = 0;
}
}
});
client.addListener({
onMessage: (res: Res) => {
sendRes(res, socket);
},
onError: (error) => {
console.error(error.message);
},
onClose: () => {
sendCloseFrame(socket);
},
});
const respond = (_: number, message?: string) => {
sendTextFrame(socket, message ?? "");
};
const { badRequest, internalServerError } = createErrorHandlers(respond);
duplex.closeClient();
const [proceed, auth] = isAuthenticated(
request,
meta.authentication || serverOpts.defaultAuthentication,
serverOpts.authenticate
);
Iif (!proceed) {
sendCloseFrame(socket, errorResponse(DEFAULT_UNAUTHORIZED));
}
const apiContext = {
respond,
badRequest,
internalServerError,
req: request,
socket,
authentication: auth,
};
Iif (serverOpts.middlewares) {
for (const middleware of serverOpts.middlewares) {
Iif (!(await middleware(apiContext, meta))) {
return;
}
}
}
endpoint(duplex, apiContext);
};
}
/**
* Registers the wsEndpoints to the passed in Http Server
* @param server
* @param wsEndpoints
* @group Server
*/
export function createWsServer<Meta extends SimpleMeta>(
server: Server,
wsEndpoints: WsEndpoints,
_: ServerOpts<Meta>
) {
server.on("upgrade", (req, socket: Socket) => {
upgradeConnection(req, socket);
const endpoint =
wsEndpoints[
methodId({
method: "WS",
url: getUrl(req)?.pathname?.slice(1) ?? "",
})
];
if (endpoint) {
endpoint(req, socket);
} else {
sendCloseFrame(socket, errorResponse(DEFAULT_NOT_FOUND));
socket.end();
}
});
}
|