Add tests for convertRequest (NodeJS sSDK runtime). (#711)

Co-authored-by: Alberto Pose <[email protected]>

Author: pose

smithy-typescript-ssdk-libs/server-node/src/index.spec.ts

@@ -0,0 +1,133 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { mkdtemp } from "fs/promises";
+import { createServer, IncomingMessage, request, RequestOptions, Server, ServerResponse } from "http";
+import * as os from "os";
+import * as path from "path";
+import { Readable } from "stream";
+
+import { convertRequest } from "./node";
+
+let socketPath: string;
+let promiseResolve: ([req, res]: [IncomingMessage, ServerResponse]) => void;
+
+let server: Server;
+beforeAll(async () => {
+  server = createServer(function (req, res) {
+    promiseResolve([req, res]);
+    resToEnd = res;
+  });
+  // Create a temporary named pipe where to run the server and obtain a request
+  socketPath = path.join(await mkdtemp(path.join(os.tmpdir(), "named-pipe-for-test-")), "server");
+  // TODO Add support to Windows by using '\\\\?\\pipe'
+  // See: https://nodejs.org/api/net.html#identifying-paths-for-ipc-connections
+  server.listen(socketPath);
+});
+
+let resToEnd: ServerResponse;
+
+function getRequest(options: RequestOptions & { body?: String }): Promise<[IncomingMessage, ServerResponse]> {
+  return new Promise((resolve, _) => {
+    promiseResolve = resolve;
+    request({
+      socketPath,
+      ...options,
+    }).end(Buffer.from(options.body || []));
+  });
+}
+
+afterAll(() => {
+  server?.close();
+});
+
+async function streamToString(stream: Readable) {
+  const chunks = [];
+
+  for await (const chunk of stream) {
+    chunks.push(Buffer.from(chunk));
+  }
+
+  return Buffer.concat(chunks).toString("utf-8");
+}
+
+describe("convertRequest", () => {
+  afterEach(async () => {
+    resToEnd?.end();
+  });
+  it("converts a simple GET / correctly", async () => {
+    const [req, _] = await getRequest({
+      host: "example.com",
+      path: "/",
+    });
+
+    const convertedReq = convertRequest(req);
+    expect(convertedReq.hostname).toEqual("example.com");
+    expect(convertedReq.method).toEqual("GET");
+    expect(convertedReq.path).toEqual("/");
+    expect(convertedReq.protocol).toEqual("http:");
+    expect(convertedReq.query).toEqual({});
+    expect(convertedReq.headers).toEqual({
+      connection: "close",
+      host: "example.com",
+    });
+    expect(await streamToString(convertedReq.body)).toEqual("");
+  });
+  it("converts a POST with query string correctly", async () => {
+    const [req, _] = await getRequest({
+      method: "POST",
+      host: "example.com",
+      path: "/some/endpoint?q=hello&a=world",
+      body: "hello",
+    });
+
+    const convertedReq = convertRequest(req);
+    expect(convertedReq.hostname).toEqual("example.com");
+    expect(convertedReq.method).toEqual("POST");
+    expect(convertedReq.path).toEqual("/some/endpoint");
+    expect(convertedReq.protocol).toEqual("http:");
+    expect(convertedReq.query).toEqual({
+      q: "hello",
+      a: "world",
+    });
+    expect(convertedReq.headers).toEqual({
+      connection: "close",
+      host: "example.com",
+      "content-length": "5",
+    });
+    expect(await streamToString(convertedReq.body)).toEqual("hello");
+  });
+  it("converts OPTIONS CORS requests", async () => {
+    const [req, _] = await getRequest({
+      method: "OPTIONS",
+      host: "example.com",
+      path: "/some/resource",
+      headers: {
+        "Access-Control-Request-Method": "DELETE",
+        "Access-Control-Request-Headers": "origin, x-requested-with",
+        Origin: "https://example.com",
+      },
+    });
+    const convertedReq = convertRequest(req);
+    expect(convertedReq.hostname).toEqual("example.com");
+    expect(convertedReq.method).toEqual("OPTIONS");
+    expect(convertedReq.path).toEqual("/some/resource");
+    expect(convertedReq.protocol).toEqual("http:");
+    expect(convertedReq.query).toEqual({});
+    expect(convertedReq.headers).toEqual({
+      "access-control-request-headers": "origin, x-requested-with",
+      "access-control-request-method": "DELETE",
+      origin: "https://example.com",
+      connection: "close",
+      host: "example.com",
+    });
+    expect(await streamToString(convertedReq.body)).toEqual("");
+  });
+});
+
+// TODO Implement writeResponse tests
+// describe("writeResponse", () => {
+//   it("converts a simple GET / correctly", async () => {});
+// });

smithy-typescript-ssdk-libs/server-node/src/node.ts

@@ -19,11 +19,14 @@ function convertQueryString(qs: URLSearchParams): QueryParameterBag {
 
 export function convertRequest(req: IncomingMessage): HttpRequest {
   const url = new URL(req.url || "", `http://${req.headers.host}`);
+
   return new HttpRequest({
+    hostname: url.hostname,
     method: req.method,
-    headers: convertHeaders(req.headers),
-    query: convertQueryString(url.searchParams),
     path: url.pathname,
+    protocol: url.protocol,
+    query: convertQueryString(url.searchParams),
+    headers: convertHeaders(req.headers),
     body: req,
   });
 }