@tsed/platform-http 8.0.0 → 8.0.2

package/src/common/services/PlatformRequest.spec.ts

@@ -0,0 +1,185 @@
+import {PlatformHandlerMetadata} from "@tsed/platform-router";
+
+import {FakeAdapter} from "../../testing/index.js";
+import {PlatformTest} from "../../testing/PlatformTest.js";
+import {PlatformAdapter} from "./PlatformAdapter.js";
+import {PlatformRequest} from "./PlatformRequest.js";
+
+function createRequest() {
+  const $ctx = PlatformTest.createRequestContext();
+
+  return {req: $ctx.request.request, request: $ctx.request};
+}
+
+describe("PlatformRequest", () => {
+  beforeEach(() => PlatformTest.create());
+  afterEach(() => PlatformTest.reset());
+
+  it("should create a PlatformRequest instance", () => {
+    const request = PlatformTest.createRequest();
+    const response = PlatformTest.createResponse();
+    const $ctx = PlatformTest.createRequestContext({
+      event: {
+        request,
+        response
+      }
+    });
+
+    expect($ctx.request.raw).toEqual(request);
+    expect($ctx.request.response).toEqual($ctx.response);
+    expect($ctx.request.headers).toEqual({});
+    expect($ctx.request.get("host")).toEqual(undefined);
+    expect($ctx.request.getHeader("host")).toEqual(undefined);
+    expect($ctx.request.method).toEqual("GET");
+  });
+
+  describe("secure()", () => {
+    it("should return the secure request state (false)", () => {
+      const $ctx = PlatformTest.createRequestContext();
+
+      $ctx.request.request.secure = false;
+
+      expect($ctx.request.secure).toEqual(false);
+    });
+    it("should return the secure request state (true)", () => {
+      const $ctx = PlatformTest.createRequestContext();
+
+      $ctx.request.request.secure = true;
+      expect($ctx.request.secure).toEqual(true);
+    });
+  });
+
+  describe("route()", () => {
+    it("should return route", () => {
+      const $ctx = PlatformTest.createRequestContext();
+      $ctx.handlerMetadata = new PlatformHandlerMetadata({
+        handler: () => {}
+      });
+      $ctx.handlerMetadata.path = "/id";
+
+      expect($ctx.request.route).toEqual("/id");
+    });
+  });
+
+  describe("protocol()", () => {
+    it("should return the protocol request state (http)", () => {
+      const $ctx = PlatformTest.createRequestContext();
+
+      $ctx.request.request.protocol = "http";
+
+      expect($ctx.request.protocol).toEqual("http");
+    });
+    it("should return the protocol request state (https)", () => {
+      const {req, request} = createRequest();
+
+      req.protocol = "https";
+      expect(request.protocol).toEqual("https");
+    });
+  });
+
+  describe("host()", () => {
+    it("should return the host", () => {
+      const {request} = createRequest();
+
+      request.raw.headers["host"] = "host";
+
+      expect(request.host).toEqual("host");
+    });
+  });
+
+  describe("accepts()", () => {
+    it("should set the accepts header", () => {
+      const {req, request} = createRequest();
+
+      vi.spyOn(req, "accepts");
+
+      request.accepts("application/json");
+
+      expect(req.accepts).toHaveBeenCalledWith("application/json");
+    });
+  });
+
+  describe("rawBody()", () => {
+    it("should return the rawBody", () => {
+      const {req, request} = createRequest();
+      req.rawBody = "raw";
+      const raw = request.rawBody;
+
+      expect(raw).toEqual("raw");
+    });
+    it("should return the body", () => {
+      const {req, request} = createRequest();
+      req.body = "raw";
+      const raw = request.rawBody;
+
+      expect(raw).toEqual("raw");
+    });
+  });
+
+  describe("files()", () => {
+    it("should return the files", () => {
+      const {req, request} = createRequest();
+      req.files = "files";
+
+      expect(request.files).toEqual("files");
+    });
+  });
+
+  describe("getReq()", () => {
+    it("should return req", () => {
+      const {req, request} = createRequest();
+
+      expect(request.req).toEqual(req);
+    });
+  });
+
+  describe("getters", () => {
+    it("should return the expected data", () => {
+      const {request} = createRequest();
+      request.raw.originalUrl = "/";
+      request.raw.query =
+        request.raw.session =
+        request.raw.cookies =
+        request.raw.params =
+        request.raw.body =
+          {
+            obj: {
+              test: "testValue"
+            },
+            test: "testValue"
+          };
+
+      expect(request.url).toEqual("/");
+      expect(request.body).toEqual({
+        obj: {
+          test: "testValue"
+        },
+        test: "testValue"
+      });
+      expect(request.params).toEqual({
+        obj: {
+          test: "testValue"
+        },
+        test: "testValue"
+      });
+      expect(request.query).toEqual({
+        obj: {
+          test: "testValue"
+        },
+        test: "testValue"
+      });
+      expect(request.cookies).toEqual({
+        obj: {
+          test: "testValue"
+        },
+        test: "testValue"
+      });
+      expect(request.session).toEqual({
+        obj: {
+          test: "testValue"
+        },
+        test: "testValue"
+      });
+    });
+  });
+});

package/src/common/services/PlatformRequest.ts

@@ -0,0 +1,181 @@
+import {Injectable, injectable, ProviderScope, Scope} from "@tsed/di";
+import {IncomingHttpHeaders, IncomingMessage} from "http";
+
+import type {PlatformContext} from "../domain/PlatformContext.js";
+import type {PlatformResponse} from "./PlatformResponse.js";
+
+declare global {
+  namespace TsED {
+    // @ts-ignore
+    export interface Request {
+      id: string;
+    }
+  }
+}
+
+/**
+ * Platform Request abstraction layer.
+ * @platform
+ */
+export class PlatformRequest<Req extends {[key: string]: any} = any> {
+  constructor(readonly $ctx: PlatformContext) {}
+  /**
+   * The current @@PlatformResponse@@.
+   */
+  get response(): PlatformResponse {
+    return this.$ctx.response;
+  }
+
+  get raw(): Req {
+    return this.$ctx.event.request as any;
+  }
+
+  get secure(): boolean {
+    return this.raw.secure;
+  }
+
+  get host(): string {
+    return this.get("host");
+  }
+
+  get protocol(): string {
+    return this.raw.protocol;
+  }
+
+  /**
+   * Get the url of the request.
+   *
+   * Is equivalent of `express.response.originalUrl || express.response.url`.
+   */
+  get url(): string {
+    return this.raw.originalUrl || this.raw.url;
+  }
+
+  get headers(): IncomingHttpHeaders {
+    return this.raw.headers;
+  }
+
+  get method(): string {
+    return this.raw.method;
+  }
+
+  /**
+   * Contains key-value pairs of data submitted in the request body. By default, it is `undefined`, and is populated when you use
+   * `body-parsing` middleware such as `express.json()` or `express.urlencoded()`.
+   */
+  get body(): any {
+    return this.raw.body;
+  }
+
+  get rawBody(): any {
+    return this.raw.rawBody || this.raw.body;
+  }
+
+  /**
+   * When using `cookie-parser` middleware, this property is an object that contains cookies sent by the request.
+   * If the request contains no cookies, it defaults to `{}`.
+   */
+  get cookies(): {[key: string]: any} {
+    return this.raw.cookies;
+  }
+
+  /**
+   * This property is an object containing properties mapped to the named route `parameters`.
+   * For example, if you have the route `/user/:name`, then the `name` property is available as `req.params.name`.
+   * This object defaults to `{}`.
+   */
+  get params(): {[key: string]: any} {
+    return this.raw.params;
+  }
+
+  /**
+   * This property is an object containing a property for each query string parameter in the route.
+   * When query parser is set to disabled, it is an empty object `{}`, otherwise it is the result of the configured query parser.
+   */
+  get query(): {[key: string]: any} {
+    return this.raw.query;
+  }
+
+  /**
+   * This property is an object containing a property for each session attributes set by any code.
+   * It requires to install a middleware like express-session to work.
+   */
+  get session(): {[key: string]: any} {
+    return this.raw.session as any;
+  }
+
+  get files() {
+    return this.raw.files;
+  }
+
+  get route() {
+    return this.$ctx.handlerMetadata?.path;
+  }
+
+  /**
+   * Return the original request framework instance
+   */
+  get request() {
+    return this.getRequest();
+  }
+
+  /**
+   * Return the original request node.js instance
+   */
+  get req() {
+    return this.getReq();
+  }
+
+  /**
+   * Returns the HTTP request header specified by field. The match is case-insensitive.
+   *
+   * ```typescript
+   * request.get('Content-Type') // => "text/plain"
+   * ```
+   *
+   * @param name
+   */
+  get(name: string) {
+    return this.raw.get(name);
+  }
+
+  getHeader(name: string) {
+    return this.get(name);
+  }
+
+  /**
+   * Checks if the specified content types are acceptable, based on the request’s Accept HTTP header field. The method returns the best match, or if none of the specified content types is acceptable, returns false (in which case, the application should respond with 406 "Not Acceptable").
+   *
+   * The type value may be a single MIME type string (such as “application/json”), an extension name such as “json”, a comma-delimited list, or an array. For a list or array, the method returns the best match (if any).
+   *
+   * @param mime
+   */
+  accepts(mime: string): string | false;
+
+  accepts(mime: string[]): string[] | false;
+
+  accepts(mime?: string | string[]): string | string[] | false {
+    // @ts-ignore
+    return this.raw.accepts(mime);
+  }
+
+  isAborted() {
+    return this.raw.aborted;
+  }
+
+  /**
+   * Return the Framework response object (express, koa, etc...)
+   */
+  getRequest<R = Req>(): R {
+    return this.raw as any;
+  }
+
+  /**
+   * Return the Node.js response object
+   */
+  getReq(): IncomingMessage {
+    return this.$ctx.event.request;
+  }
+}
+
+injectable(PlatformRequest).scope(ProviderScope.INSTANCE);

package/src/common/services/PlatformResponse.spec.ts

@@ -0,0 +1,344 @@
+import {PlatformViews} from "@tsed/platform-views";
+import {createReadStream} from "fs";
+
+import {PlatformTest} from "../../testing/PlatformTest.js";
+import {PlatformResponse} from "./PlatformResponse.js";
+
+const rootDir = import.meta.dirname; // automatically replaced by import.meta.dirname on build
+
+vi.mock("on-finished");
+
+function createResponse() {
+  const ctx = PlatformTest.createRequestContext();
+  const platformViews = PlatformTest.get(PlatformViews);
+
+  return {res: ctx.response.raw, response: ctx.response, platformViews, ctx};
+}
+
+describe("PlatformResponse", () => {
+  beforeEach(() => PlatformTest.create());
+  afterEach(() => PlatformTest.reset());
+  it("should create a PlatformResponse instance", () => {
+    const {res, response, ctx} = createResponse();
+
+    expect(response.raw).toEqual(res);
+    expect(response.request).toEqual(ctx.request);
+  });
+  describe("statusCode", () => {
+    it("should return status code", () => {
+      const {res, response} = createResponse();
+
+      res.statusCode = 201;
+
+      expect(response.statusCode).toEqual(201);
+    });
+  });
+  describe("status()", () => {
+    it("should set status code", () => {
+      const {res, response} = createResponse();
+      vi.spyOn(res, "status").mockReturnValue(undefined);
+      response.status(204);
+
+      expect(res.status).toHaveBeenCalledWith(204);
+    });
+  });
+  describe("setHeaders()", () => {
+    it("should set headers", () => {
+      const {res, response} = createResponse();
+
+      response.setHeaders({"x-token": "token"});
+
+      expect(res.headers).toEqual({
+        "x-request-id": "id",
+        "x-token": "token"
+      });
+    });
+  });
+  describe("contentType()", () => {
+    it("should set content Type", () => {
+      const {res, response} = createResponse();
+
+      response.contentType("application/json");
+
+      expect(res.headers).toEqual({
+        "content-type": "application/json",
+        "x-request-id": "id"
+      });
+    });
+  });
+  describe("getContentType()", () => {
+    it("should get content Type", () => {
+      const {res, response} = createResponse();
+
+      res.headers["content-type"] = "application/json";
+
+      expect(response.getContentType()).toEqual("application/json");
+    });
+  });
+  describe("contentLength()", () => {
+    it("should set content length", () => {
+      const {res, response} = createResponse();
+
+      response.contentLength(5);
+
+      expect(res.headers).toEqual({"content-length": 5, "x-request-id": "id"});
+    });
+  });
+  describe("getContentLength()", () => {
+    it("should set content Type", () => {
+      const {res, response} = createResponse();
+
+      response.contentLength(5);
+
+      expect(response.getContentLength()).toEqual(5);
+    });
+
+    it("should set content Type (size 0)", () => {
+      const {res, response} = createResponse();
+
+      response.contentLength(" " as any);
+
+      expect(response.getContentLength()).toEqual(0);
+    });
+  });
+  describe("redirect()", () => {
+    it("should set redirect", () => {
+      const {res, response} = createResponse();
+
+      response.redirect(302, "/path");
+
+      expect(res.headers).toEqual({location: "/path", "x-request-id": "id", "content-length": 27});
+      expect(res.statusCode).toEqual(302);
+    });
+
+    it("should set redirect (default status)", () => {
+      const {res, response} = createResponse();
+
+      response.redirect(0, "/path");
+
+      expect(res.headers).toEqual({location: "/path", "x-request-id": "id", "content-length": 27});
+      expect(res.statusCode).toEqual(302);
+    });
+
+    it("should set redirect (301)", () => {
+      const {res, response, ctx} = createResponse();
+      res.headers["location"] = "https://location";
+      ctx.request.getReq().method = "HEAD";
+
+      response.redirect(301, "https://location");
+
+      expect(res.headers).toEqual({
+        location: "https://location",
+        "x-request-id": "id"
+      });
+      expect(res.statusCode).toEqual(301);
+    });
+
+    it("should set redirect (302, back url)", () => {
+      const {res, response, ctx} = createResponse();
+      ctx.request.getReq().method = "HEAD";
+      ctx.request.headers["referrer"] = "https://referrer.com";
+
+      response.redirect(302, "back");
+
+      expect(res.headers).toEqual({
+        location: "https://referrer.com",
+        "x-request-id": "id"
+      });
+      expect(res.statusCode).toEqual(302);
+    });
+    it("should set redirect (302, back url, default)", () => {
+      const {res, response, ctx} = createResponse();
+      ctx.request.getReq().method = "HEAD";
+
+      response.redirect(302, "back");
+
+      expect(res.headers).toEqual({
+        location: "/",
+        "x-request-id": "id"
+      });
+      expect(res.statusCode).toEqual(302);
+    });
+  });
+  describe("render()", () => {
+    it("should return a string", async () => {
+      const {response, platformViews} = createResponse();
+
+      response.locals.locale = "fr-FR";
+      vi.spyOn(platformViews, "render").mockResolvedValue("HTML");
+
+      const result = await response.render("view", {
+        test: "test"
+      });
+
+      expect(platformViews.render).toHaveBeenCalledWith("view", {
+        locale: "fr-FR",
+        test: "test"
+      });
+      expect(result).toEqual("HTML");
+    });
+  });
+  describe("location()", () => {
+    it("should set location", () => {
+      const {res, response} = createResponse();
+
+      response.location("/path");
+
+      expect(res.headers).toEqual({
+        location: "/path",
+        "x-request-id": "id"
+      });
+    });
+  });
+  describe("body()", () => {
+    it("should call body with undefined", () => {
+      const {res, response} = createResponse();
+
+      response.body(undefined);
+
+      expect(res.data).toBeUndefined();
+    });
+    it("should call body with string", () => {
+      const {res, response} = createResponse();
+
+      response.body("string");
+
+      expect(res.data).toEqual("string");
+      expect(response.getBody()).toEqual("string");
+    });
+    it("should call body with stream", () => {
+      const {res, response} = createResponse();
+      const stream = createReadStream(rootDir + "/__mock__/data.txt");
+      vi.spyOn(stream, "pipe").mockReturnValue(undefined as any);
+
+      response.body(stream);
+
+      expect(stream.pipe).toHaveBeenCalledWith(res);
+    });
+    it("should call body with buffer", () => {
+      const {res, response} = createResponse();
+      const buffer = Buffer.from("string");
+
+      response.body(buffer);
+
+      expect(res.data).toEqual(buffer);
+      expect(res.headers).toEqual({
+        "content-length": 6,
+        "content-type": "application/octet-stream",
+        "x-request-id": "id"
+      });
+    });
+    it("should call body with {}", () => {
+      const {res, response} = createResponse();
+
+      response.body({});
+
+      expect(res.data).toEqual({});
+    });
+  });
+  describe("finish()", () => {
+    it("should finish context", async () => {
+      const {response, ctx} = createResponse();
+
+      expect(response.isDone()).toEqual(false);
+
+      await ctx.finish();
+
+      expect(response.isDone()).toEqual(true);
+    });
+  });
+  describe("getHeaders()", () => {
+    it("should get headers", () => {
+      const {res, response} = createResponse();
+
+      res.headers["content-type"] = "application/json";
+
+      expect(response.getHeaders()).toEqual({
+        "content-type": "application/json",
+        "x-request-id": "id"
+      });
+    });
+  });
+  describe("response()", () => {
+    it("should return the response framework", () => {
+      const {res, response} = createResponse();
+
+      expect(response.response).toEqual(res);
+    });
+  });
+  describe("getRes()", () => {
+    it("should return the response framework", () => {
+      const {res, response} = createResponse();
+
+      expect(response.getRes()).toEqual(res);
+    });
+  });
+  describe("res()", () => {
+    it("should return the response framework", () => {
+      const {res, response} = createResponse();
+
+      expect(response.res).toEqual(res);
+    });
+  });
+  describe("attachment()", () => {
+    it("should set attachment", () => {
+      const {res, response} = createResponse();
+
+      res.attachment = vi.fn();
+
+      response.attachment("filename");
+
+      expect(res.attachment).toHaveBeenCalledWith("filename");
+    });
+  });
+  describe("onEnd()", () => {
+    it("should listen onEnd event", () => {
+      const {res, response} = createResponse();
+      const cb = vi.fn();
+
+      res.on = vi.fn();
+
+      response.onEnd(cb);
+
+      expect(res.on).toHaveBeenCalledWith("finish", cb);
+    });
+  });
+  describe("cookie()", () => {
+    it("should manipulate cookies", () => {
+      const {res, response} = createResponse();
+
+      res.cookie = (...args: any[]) => {
+        let value = `${args[0]}=${args[1]}`;
+
+        if (!res.headers["set-cookie"]) {
+          res.headers["set-cookie"] = value;
+        } else {
+          res.headers["set-cookie"] = [].concat(res.headers["set-cookie"], value as any);
+        }
+      };
+
+      res.clearCookie = (name: string) => {
+        res.headers["set-cookie"] = res.headers["set-cookie"].filter((cookie: string) => cookie.startsWith(name + "="));
+      };
+
+      response.cookie("locale", "fr-FR");
+      expect(res.headers).toEqual({
+        "set-cookie": ["locale=fr-FR"],
+        "x-request-id": "id"
+      });
+
+      response.cookie("filename", "test");
+      expect(res.headers).toEqual({
+        "set-cookie": ["locale=fr-FR", "filename=test"],
+        "x-request-id": "id"
+      });
+
+      response.cookie("filename", null);
+
+      expect(res.headers).toEqual({
+        "set-cookie": ["filename=test"],
+        "x-request-id": "id"
+      });
+    });
+  });
+});