@tsed/platform-http 8.11.0 → 8.11.2-rc.1

package/src/common/services/PlatformResponse.ts

@@ -1,393 +0,0 @@
-import {OutgoingHttpHeaders, ServerResponse} from "node:http";
-
-import {isArray, isBoolean, isNumber, isStream, isString} from "@tsed/core";
-import {injectable, lazyInject, ProviderScope} from "@tsed/di";
-import {getStatusMessage} from "@tsed/schema";
-import encodeUrl from "encodeurl";
-
-import type {PlatformContext} from "../domain/PlatformContext.js";
-import type {PlatformRequest} from "./PlatformRequest.js";
-
-declare global {
-  namespace TsED {
-    // @ts-ignore
-    export interface Response {}
-
-    export interface SetCookieOpts extends Record<string, unknown> {
-      maxAge?: number | undefined;
-      signed?: boolean | undefined;
-      expires?: Date | undefined;
-      httpOnly?: boolean | undefined;
-      path?: string | undefined;
-      domain?: string | undefined;
-      secure?: boolean | undefined;
-      encode?: ((val: string) => string) | undefined;
-      sameSite?: boolean | "lax" | "strict" | "none" | undefined;
-    }
-  }
-}
-
-/**
- * Platform Response abstraction layer.
- * @platform
- */
-export class PlatformResponse<Res extends Record<string, any> = any> {
-  data: any;
-
-  constructor(readonly $ctx: PlatformContext) {}
-
-  /**
-   * The current @@PlatformRequest@@.
-   */
-  get request(): PlatformRequest {
-    return this.$ctx.request;
-  }
-
-  get raw(): Res {
-    return this.$ctx.event.response as any;
-  }
-
-  /**
-   * Get the current statusCode
-   */
-  get statusCode() {
-    return this.raw.statusCode;
-  }
-
-  /**
-   * An object that contains response local variables scoped to the request, and therefore available only to the view(s) rendered during that request / response cycle (if any). Otherwise, this property is identical to app.locals.
-   *
-   * This property is useful for exposing request-level information such as the request path name, authenticated user, user settings, and so on.
-   */
-  get locals() {
-    return this.raw.locals;
-  }
-
-  /**
-   * Return the original response framework instance
-   */
-  get response() {
-    return this.getResponse();
-  }
-
-  /**
-   * Return the original response node.js instance
-   */
-  get res() {
-    return this.getRes();
-  }
-
-  /**
-   * Returns the HTTP response header specified by field. The match is case-insensitive.
-   *
-   * ```typescript
-   * response.get('Content-Type') // => "text/plain"
-   * ```
-   *
-   * @param name
-   */
-  get(name: string) {
-    return this.raw.get(name);
-  }
-
-  getHeaders(): OutgoingHttpHeaders {
-    return this.raw.getHeaders();
-  }
-
-  /**
-   * Return the Framework response object (express, koa, etc...)
-   */
-  getResponse<R = Res>(): R {
-    return this.raw as any;
-  }
-
-  /**
-   * Return the Node.js response object
-   */
-  getRes(): ServerResponse {
-    return this.raw as any;
-  }
-
-  hasStatus() {
-    return this.statusCode !== 200;
-  }
-
-  /**
-   * Sets the HTTP status for the response.
-   *
-   * @param status
-   */
-  status(status: number) {
-    this.raw.status(status);
-
-    return this;
-  }
-
-  /**
-   * Set header `field` to `val`, or pass
-   * an object of header fields.
-   *
-   * Examples:
-   * ```typescript
-   * response.setHeaders({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
-   * ```
-   *
-   * Aliased as `res.header()`.
-   */
-  setHeaders(headers: OutgoingHttpHeaders) {
-    // apply headers
-    Object.entries(headers).forEach(([key, item]) => {
-      this.setHeader(key, item);
-    });
-
-    return this;
-  }
-
-  setHeader(key: string, item: any) {
-    this.raw.set(key, this.formatHeader(key, item));
-
-    return this;
-  }
-
-  /**
-   * Set `Content-Type` response header with `type` through `mime.lookup()`
-   * when it does not contain "/", or set the Content-Type to `type` otherwise.
-   *
-   * Examples:
-   *
-   *     res.type('.html');
-   *     res.type('html');
-   *     res.type('json');
-   *     res.type('application/json');
-   *     res.type('png');
-   */
-  contentType(contentType: string) {
-    this.raw.contentType(contentType);
-
-    return this;
-  }
-
-  contentLength(length: number) {
-    this.setHeader("Content-Length", length);
-    return this;
-  }
-
-  getContentLength() {
-    if (this.get("Content-Length")) {
-      return parseInt(this.get("Content-Length"), 10) || 0;
-    }
-  }
-
-  getContentType() {
-    return (this.get("Content-Type") || "").split(";")[0];
-  }
-
-  /**
-   * Sets the HTTP response Content-Disposition header field to “attachment”.
-   * If a filename is given, then it sets the Content-Type based on the extension name via res.type(), and sets the Content-Disposition “filename=” parameter.
-   *
-   * ```typescript
-   * res.attachment()
-   * // Content-Disposition: attachment
-   *
-   * res.attachment('path/to/logo.png')
-   * // Content-Disposition: attachment; filename="logo.png"
-   * // Content-Type: image/png
-   * ```
-   *
-   * @param filename
-   */
-  attachment(filename: string) {
-    this.raw.attachment(filename);
-    return this;
-  }
-
-  /**
-   * Redirects to the URL derived from the specified path, with specified status, a positive integer that corresponds to an [HTTP status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
-   * If not specified, status defaults to `302 Found`.
-   *
-   * @param status
-   * @param url
-   */
-  redirect(status: number, url: string): this {
-    status = status || 302;
-
-    this.location(url);
-
-    // Set location header
-    url = this.get("Location");
-
-    const txt = `${getStatusMessage(status)}. Redirecting to ${url}`;
-
-    this.status(status);
-
-    if (this.request.method === "HEAD") {
-      this.end();
-    } else {
-      this.setHeader("Content-Length", Buffer.byteLength(txt)).end(txt);
-    }
-
-    return this;
-  }
-
-  /**
-   * Sets the response Location HTTP header to the specified path parameter.
-   *
-   * @param location
-   */
-  location(location: string): this {
-    this.setHeader("Location", location);
-
-    return this;
-  }
-
-  /**
-   * Stream the given data.
-   *
-   * @param data
-   */
-  stream(data: any) {
-    data.pipe(this.raw);
-
-    return this;
-  }
-
-  /**
-   * Renders a view and sends the rendered HTML string to the client.
-   *
-   * @param path
-   * @param options
-   */
-  async render(path: string, options: any = {}) {
-    const platformViews = await lazyInject(() => import("@tsed/platform-views"));
-
-    return platformViews.render(path, {
-      ...this.locals,
-      ...options
-    }) as unknown as string;
-  }
-
-  /**
-   * Send any data to your consumer.
-   *
-   * This method accept a ReadableStream, a plain object, boolean, string, number, null and undefined data.
-   * It chooses the better way to send the data.
-   *
-   * @param data
-   */
-  body(data: any) {
-    this.data = data;
-
-    if (data === undefined) {
-      this.end();
-
-      return this;
-    }
-
-    if (isStream(data)) {
-      this.stream(data);
-
-      return this;
-    }
-
-    if (Buffer.isBuffer(data)) {
-      this.buffer(data);
-
-      return this;
-    }
-
-    if (isBoolean(data) || isNumber(data) || isString(data) || data === null) {
-      if (data === null) {
-        this.status(204);
-      }
-
-      this.end(data);
-
-      return this;
-    }
-
-    this.json(data);
-
-    return this;
-  }
-
-  getBody() {
-    return this.data;
-  }
-
-  /**
-   * Add a listener to handler the end of the request/response.
-   * @param cb
-   */
-  onEnd(cb: () => Promise<void> | void): this {
-    const res: any = this.getRes();
-
-    res.on("finish", cb);
-
-    return this;
-  }
-
-  isDone(): boolean {
-    if (this.$ctx.isFinished()) {
-      return true;
-    }
-
-    const res = this.getRes();
-
-    return Boolean(this.isHeadersSent() || res.writableEnded || res.writableFinished);
-  }
-
-  isHeadersSent() {
-    return this.getRes().headersSent;
-  }
-
-  cookie(name: string, value: string | null, opts?: TsED.SetCookieOpts) {
-    if (value === null) {
-      this.raw.clearCookie(name, opts);
-      return this;
-    }
-
-    this.raw.cookie(name, value, opts);
-
-    const cookie = this.raw.get("set-cookie");
-
-    if (!isArray(value)) {
-      this.raw.set("set-cookie", [].concat(cookie));
-    }
-
-    return this;
-  }
-
-  protected formatHeader(key: string, item: any) {
-    if (key.toLowerCase() === "location") {
-      // "back" is an alias for the referrer
-      if (item === "back") {
-        item = this.request.get("Referrer") || "/";
-      }
-
-      item = encodeUrl(String(item));
-    }
-    return item;
-  }
-
-  protected json(data: any) {
-    this.raw.json(data);
-
-    return this;
-  }
-
-  protected buffer(data: any) {
-    if (!this.getContentType()) {
-      this.contentType("application/octet-stream");
-    }
-
-    this.contentLength(data.length);
-    this.end(data);
-  }
-
-  protected end(data?: string | Buffer) {
-    this.raw.send(data);
-  }
-}
-
-injectable(PlatformResponse).scope(ProviderScope.INSTANCE);

package/src/common/utils/closeServer.spec.ts

@@ -1,11 +0,0 @@
-import {closeServer} from "./closeServer.js";
-
-describe("closeServer", () => {
-  it("should close the server", async () => {
-    const server: any = {
-      close: vi.fn().mockImplementation((cb) => cb())
-    };
-    expect(await closeServer(server)).toEqual(undefined);
-    expect(server.close).toHaveBeenCalledWith(expect.any(Function));
-  });
-});

package/src/common/utils/closeServer.ts

@@ -1,8 +0,0 @@
-import type Http from "node:http";
-import type Https from "node:https";
-
-import type Http2 from "http2";
-
-export function closeServer(server: Http.Server | Https.Server | Http2.Http2Server) {
-  return new Promise((resolve) => server.close(() => resolve(undefined)));
-}

package/src/common/utils/createContext.spec.ts

@@ -1,111 +0,0 @@
-import {configuration, injector} from "@tsed/di";
-import {$asyncEmit} from "@tsed/hooks";
-
-import {PlatformTest} from "../../testing/PlatformTest.js";
-import {PlatformResponse} from "../services/PlatformResponse.js";
-import {createContext} from "./createContext.js";
-
-vi.mock("@tsed/hooks", async (importOriginal) => {
-  const mod = await importOriginal<typeof import("@tsed/hooks")>();
-  return {
-    ...mod,
-    $asyncEmit: vi.fn()
-  };
-});
-
-async function createContextFixture(reqOpts?: any) {
-  const request = PlatformTest.createRequest(reqOpts);
-  const response = PlatformTest.createResponse();
-
-  configuration().logger.level = "info";
-  configuration().logger.ignoreUrlPatterns = ["/admin", /\/admin2/];
-
-  const invoke = createContext();
-  const ctx = await invoke({request, response});
-  ctx.response.getRes().on = vi.fn();
-
-  ctx.response.onEnd(() => ctx.finish());
-
-  const call = async () => {
-    await ctx.start();
-
-    ctx.logger.info({event: "test"});
-    ctx.logger.flush();
-  };
-
-  return {call, injector: injector(), request, response, ctx};
-}
-
-describe("createContext", () => {
-  beforeEach(() => PlatformTest.create());
-  afterEach(() => PlatformTest.reset());
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-  it("should create context and attach it to the request", async () => {
-    // GIVEN
-    const {injector, ctx, call} = await createContextFixture();
-
-    vi.mocked($asyncEmit).mockResolvedValue(undefined);
-    vi.spyOn(injector.logger, "info").mockReturnValue(undefined);
-
-    // WHEN
-    await call();
-
-    // THEN
-    expect($asyncEmit).toHaveBeenCalledWith("$onRequest", [ctx]);
-
-    await vi.mocked(ctx.response.getRes().on).mock.calls[0][1](ctx);
-
-    expect($asyncEmit).toHaveBeenCalledWith("$onResponse", [ctx]);
-  });
-
-  it("should ignore logs", async () => {
-    // GIVEN
-    const {injector, call} = await createContextFixture({
-      url: "/admin",
-      originalUrl: "/admin"
-    });
-
-    vi.mocked($asyncEmit).mockResolvedValue(undefined);
-    vi.spyOn(injector.logger, "info").mockReturnValue(undefined);
-
-    // WHEN
-    await call();
-
-    // THEN
-    expect(injector.logger.info).toHaveBeenCalledTimes(0);
-  });
-
-  it("should add a x-request-id header to the response", async () => {
-    // GIVEN
-    vi.spyOn(PlatformResponse.prototype, "setHeader");
-
-    const {ctx, response, request, call} = await createContextFixture();
-    response.req = request;
-
-    // WHEN
-    await call();
-
-    // THEN
-    expect(ctx.response.setHeader).toHaveBeenCalledWith("x-request-id", expect.any(String));
-  });
-
-  it("should use an existing x-request-id request header for the response x-request-id header", async () => {
-    // GIVEN
-    vi.spyOn(PlatformResponse.prototype, "setHeader");
-
-    const {ctx, response, request, call} = await createContextFixture({
-      headers: {
-        "x-request-id": "test-id"
-      }
-    });
-    response.req = request;
-
-    // WHEN
-    await call();
-
-    // THEN
-    expect(ctx.response.setHeader).toHaveBeenCalledWith("x-request-id", "test-id");
-  });
-});

package/src/common/utils/createContext.ts

@@ -1,52 +0,0 @@
-import {configuration, injector} from "@tsed/di";
-import {v4} from "uuid";
-
-import {PlatformContext} from "../domain/PlatformContext.js";
-import {IncomingEvent} from "../interfaces/IncomingEvent.js";
-import {PlatformRequest} from "../services/PlatformRequest.js";
-import {PlatformResponse} from "../services/PlatformResponse.js";
-
-function defaultReqIdBuilder(req: any) {
-  return req.get?.("x-request-id") || v4().split("-").join("");
-}
-
-function mapIgnoreUrlPatterns(ignoreUrlPatterns: any[]) {
-  return ignoreUrlPatterns.map((pattern: string | RegExp) => (typeof pattern === "string" ? new RegExp(pattern, "gi") : pattern));
-}
-
-export function buildIgnoreLog(ignoreUrlPatterns: any[] | undefined) {
-  if (ignoreUrlPatterns) {
-    ignoreUrlPatterns = mapIgnoreUrlPatterns(ignoreUrlPatterns);
-    return (ignore: boolean, data: any, url: string) => ignoreUrlPatterns?.find((reg) => !!url.match(reg));
-  }
-}
-
-/**
- * Create the TsED context to wrap request, response, injector, etc...
- * @ignore
- */
-export function createContext(): (event: IncomingEvent) => PlatformContext {
-  const ResponseKlass = injector().getProvider(PlatformResponse)?.useClass;
-  const RequestKlass = injector().getProvider(PlatformRequest)?.useClass;
-  const {reqIdBuilder = defaultReqIdBuilder, ...loggerOptions} = configuration().logger;
-
-  const opts = {
-    ...loggerOptions,
-    ResponseKlass,
-    RequestKlass
-  };
-
-  const ignoreLog = buildIgnoreLog(loggerOptions.ignoreUrlPatterns);
-
-  return function invokeContext(event: IncomingEvent) {
-    const $ctx = new PlatformContext({
-      ...opts,
-      event,
-      id: reqIdBuilder(event.request)
-    });
-
-    ignoreLog && $ctx.logger.alterIgnoreLog((ignore, data) => ignoreLog(ignore, data, $ctx.url));
-
-    return $ctx;
-  };
-}

package/src/common/utils/createHttpServer.spec.ts

@@ -1,75 +0,0 @@
-import Http from "node:http";
-
-import {configuration, destroyInjector, injector, InjectorService, logger} from "@tsed/di";
-
-import {createHttpServer} from "./createHttpServer.js";
-
-describe("createHttpServer", () => {
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-  afterEach(() => destroyInjector());
-  it("should create an instance of Http (http port true)", async () => {
-    configuration().set("httpPort", true);
-
-    const fn: any = vi.fn();
-
-    const listener: any = createHttpServer(fn);
-
-    expect(!!injector().get(Http.Server)).toEqual(true);
-
-    expect(listener).toBeInstanceOf(Function);
-
-    const server = injector().get(Http.Server)!;
-
-    vi.spyOn(logger(), "info").mockReturnValue(undefined);
-    vi.spyOn(logger(), "debug").mockReturnValue(undefined);
-    vi.spyOn(server, "listen").mockReturnValue(undefined as never);
-    vi.spyOn(server, "address").mockReturnValue({port: 8089, address: "0.0.0.0"} as never);
-    vi.spyOn(server, "on").mockImplementation(((event: string, cb: any) => {
-      if (event === "listening") {
-        cb();
-      }
-    }) as never);
-
-    await listener();
-
-    expect(server.listen).toHaveBeenCalledWith(true, "0.0.0.0");
-    expect(logger().info).toHaveBeenCalledWith("Listen server on http://0.0.0.0:8089");
-  });
-
-  it("should create a raw object (http port false)", () => {
-    configuration().set("httpPort", false);
-
-    const fn: any = vi.fn();
-
-    const listener = createHttpServer(fn);
-
-    expect(injector().get(Http.Server)).toEqual(null);
-
-    expect(listener).toBeUndefined();
-  });
-
-  it("should create an instance of Http (http port 0)", () => {
-    configuration().set("httpPort", 0);
-
-    const fn: any = vi.fn();
-
-    const listener = createHttpServer(fn);
-
-    expect(!!injector().get(Http.Server)).toEqual(true);
-
-    expect(listener).toBeInstanceOf(Function);
-  });
-  it("should create an instance of Http (http port + address)", () => {
-    configuration().set("httpPort", "0.0.0.0:8080");
-
-    const fn: any = vi.fn();
-
-    const listener = createHttpServer(fn);
-
-    expect(!!injector().get(Http.Server)).toEqual(true);
-
-    expect(listener).toBeInstanceOf(Function);
-  });
-});

package/src/common/utils/createHttpServer.ts

@@ -1,16 +0,0 @@
-import Http from "node:http";
-
-import {configuration, constant} from "@tsed/di";
-
-import {createServer} from "./createServer.js";
-
-export function createHttpServer(requestListener: Http.RequestListener) {
-  const httpOptions = configuration().get<Http.ServerOptions>("httpOptions");
-
-  return createServer({
-    port: constant<string | false>("httpPort"),
-    type: "http",
-    token: Http.Server,
-    server: () => Http.createServer(httpOptions, requestListener)
-  });
-}