@tsed/platform-serverless 8.11.1 → 8.12.0-rc.1

package/src/domain/ServerlessResponse.spec.ts

@@ -1,139 +0,0 @@
-import {PlatformServerlessTest} from "@tsed/platform-serverless-testing";
-
-import {createServerlessContext} from "../../test/utils/createServerlessContext.js";
-
-describe("ServerlessResponse", () => {
-  beforeEach(() => PlatformServerlessTest.create());
-  afterEach(() => PlatformServerlessTest.reset());
-
-  describe("isHeadersSent", () => {
-    it("should push callback", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-      expect(context.response.isHeadersSent).toEqual(false);
-
-      context.response.destroy();
-
-      expect(context.response.isHeadersSent).toEqual(true);
-    });
-  });
-  describe("statusCode", () => {
-    it("should return the statusCode", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-      context.response.statusCode = 201;
-      expect(context.response.statusCode).toEqual(201);
-    });
-  });
-  describe("locals()", () => {
-    it("should return the locals", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-
-      expect(context.response.locals).toEqual({});
-    });
-  });
-  describe("contentLength()", () => {
-    it("should return the content length", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-      context.response.contentLength(300);
-      expect(context.response.getContentLength()).toEqual(300);
-    });
-
-    it("should return the default content length", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-      context.response.contentLength(" " as any);
-      expect(context.response.getContentLength()).toEqual(0);
-    });
-  });
-  describe("location()", () => {
-    it("should set location", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-
-      context.response.location("/path/to");
-
-      expect(context.response.getHeaders()).toEqual({
-        location: "/path/to"
-      });
-    });
-    it("should set location (back)", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-
-      context.request.headers["Referrer"] = "https://referrer.com";
-      context.response.location("back");
-
-      expect(context.response.getHeaders()).toEqual({
-        location: "https://referrer.com"
-      });
-    });
-  });
-  describe("redirect()", () => {
-    it("should set location", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-
-      context.response.redirect(301, "/path/to");
-
-      expect(context.response.getHeaders()).toEqual({
-        "content-length": 42,
-        location: "/path/to"
-      });
-      expect(context.response.statusCode).toEqual(301);
-      expect(context.response.getBody()).toEqual("Moved Permanently. Redirecting to /path/to");
-    });
-    it("should set location (back)", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-
-      context.request.headers["Referrer"] = "https://referrer.com";
-      context.response.redirect(301, "back");
-
-      expect(context.response.getHeaders()).toEqual({
-        "content-length": 54,
-        location: "https://referrer.com"
-      });
-      expect(context.response.statusCode).toEqual(301);
-      expect(context.response.getStatus()).toEqual(301);
-      expect(context.response.getContentLength()).toEqual(54);
-      expect(context.response.getContentType()).toEqual("");
-      expect(context.response.getBody()).toEqual("Moved Permanently. Redirecting to https://referrer.com");
-    });
-  });
-  describe("setHeader()", () => {
-    it("should set location", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-
-      context.event.headers["Referrer"] = "https://referrer.com";
-      context.response.set("location", "back");
-      expect(context.response.getHeaders()).toEqual({
-        location: "https://referrer.com"
-      });
-    });
-    it("should set location back with default value", () => {
-      const context = createServerlessContext({
-        endpoint: {} as any
-      });
-
-      context.event.headers["Referrer"] = "";
-      context.response.set("location", "back");
-      expect(context.response.getHeaders()).toEqual({
-        location: "/"
-      });
-    });
-  });
-});

package/src/domain/ServerlessResponse.ts

@@ -1,226 +0,0 @@
-import {getValue} from "@tsed/core";
-import {getStatusMessage} from "@tsed/schema";
-import type {APIGatewayProxyEvent} from "aws-lambda";
-import encodeUrl from "encodeurl";
-import mime from "mime";
-
-import {ServerlessContext} from "./ServerlessContext.js";
-
-export type HeaderValue = boolean | number | string;
-
-/**
- * @platform
- */
-export class ServerlessResponse<Event extends object = APIGatewayProxyEvent> {
-  #status: number = 200;
-  #body: any = undefined;
-  #headers: Record<string, HeaderValue> = {};
-  #locals: Record<string, any> = {};
-  #isHeadersSent = false;
-
-  constructor(protected $ctx: ServerlessContext<Event>) {}
-
-  get event() {
-    return this.$ctx.event;
-  }
-
-  get raw() {
-    return this.event;
-  }
-
-  get request() {
-    return this.$ctx.request;
-  }
-
-  /**
-   * Get the current statusCode
-   */
-  get statusCode() {
-    return this.#status;
-  }
-
-  set statusCode(status) {
-    this.#status = status;
-  }
-
-  /**
-   * 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.#locals;
-  }
-
-  get isHeadersSent() {
-    return this.#isHeadersSent;
-  }
-
-  getStatus() {
-    return this.#status;
-  }
-
-  /**
-   * Sets the HTTP status for the response.
-   *
-   * @param status
-   */
-  status(status: number) {
-    this.#status = status;
-    return this;
-  }
-
-  set(name: string, value: any) {
-    return this.setHeader(name, value);
-  }
-
-  /**
-   * 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): string | number | boolean | undefined {
-    return getValue(this.#headers, name.toLowerCase());
-  }
-
-  getHeaders(): Record<string, HeaderValue> {
-    return {
-      ...this.#headers
-    };
-  }
-
-  hasStatus() {
-    return this.#status !== 200;
-  }
-
-  /**
-   * 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: Record<string, HeaderValue>) {
-    // apply headers
-    Object.entries(headers).forEach(([key, item]) => {
-      this.setHeader(key, item);
-    });
-
-    return this;
-  }
-
-  setHeader(key: string, item: HeaderValue | null | undefined) {
-    if (item !== null && item !== undefined) {
-      key = key.toLowerCase();
-
-      if (key === "location") {
-        // "back" is an alias for the referrer
-        if (item === "back") {
-          item = this.request.get("Referrer") || "/";
-        }
-
-        item = encodeUrl(String(item));
-      }
-
-      this.#headers = {
-        ...this.#headers,
-        [key.toLowerCase()]: item as any
-      };
-    }
-
-    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.setHeader("Content-Type", mime.getType(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") as any, 10) || 0;
-    }
-  }
-
-  getContentType() {
-    return String(this.get("Content-Type") || "").split(";")[0];
-  }
-
-  /**
-   * 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) {
-    // Set location header
-    const address = this.location(url).get("Location");
-    const body = `${getStatusMessage(status)}. Redirecting to ${address}`;
-
-    this.status(status).set("Content-Length", Buffer.byteLength(body)).body(body);
-
-    return this;
-  }
-
-  /**
-   * Sets the response Location HTTP header to the specified path parameter.
-   *
-   * @param url
-   */
-  location(url: string) {
-    return this.set("Location", url);
-  }
-
-  /**
-   * Send any data to your consumer.
-   *
-   * This method accept a ReadableStream, a plain object, boolean, string, number, null and undefined data.
-   * It choose the better way to send the data.
-   *
-   * @param body
-   */
-  body(body: any) {
-    this.#body = body;
-
-    return this;
-  }
-
-  getBody() {
-    return this.#body;
-  }
-
-  isDone(): boolean {
-    return this.#isHeadersSent;
-  }
-
-  destroy() {
-    this.#isHeadersSent = true;
-  }
-}

package/src/domain/ServerlessResponseStream.spec.ts

@@ -1,63 +0,0 @@
-import {ServerlessResponseStream} from "./ServerlessResponseStream.js";
-
-describe("ServerlessResponseStream", () => {
-  describe("streamifyResponse", () => {
-    describe("when isInAWS", () => {
-      beforeEach(() => {
-        // @ts-ignore
-        globalThis.awslambda = {
-          streamifyResponse: vi.fn().mockImplementation((handler) => handler)
-        };
-      });
-      afterEach(() => {
-        // @ts-ignore
-        delete globalThis.awslambda;
-      });
-
-      it("should wrap then handler without fallback responseStream", async () => {
-        const handler = vi.fn();
-        const event = {};
-        const context = {};
-        const responseStream = new ServerlessResponseStream();
-
-        vi.spyOn(ServerlessResponseStream as any, "buildResponse").mockReturnValue({});
-
-        const wrapped = ServerlessResponseStream.streamifyResponse(handler);
-
-        const result = await wrapped(event as any, responseStream, context as any);
-
-        expect(result).toEqual(undefined);
-        expect(handler).toHaveBeenCalledWith(event, responseStream, context);
-        // @ts-ignore
-        expect(ServerlessResponseStream.buildResponse).not.toHaveBeenCalled();
-      });
-      it("should wrap then handler with fallback responseStream", async () => {
-        const handler = vi.fn();
-        const event = {};
-        const context = {};
-
-        vi.spyOn(ServerlessResponseStream as any, "buildResponse").mockReturnValue({
-          statusCode: 200
-        });
-        vi.spyOn(console, "warn").mockReturnValue(undefined);
-
-        const wrapped = ServerlessResponseStream.streamifyResponse(handler);
-
-        const result = await wrapped(event as any, context as any);
-
-        expect(handler).toHaveBeenCalledWith(event, expect.any(ServerlessResponseStream), context);
-
-        expect(result).toEqual({
-          statusCode: 200
-        });
-        // @ts-ignore
-        expect(ServerlessResponseStream.buildResponse).toHaveBeenCalledWith(expect.any(ServerlessResponseStream));
-        expect(console.warn).toHaveBeenCalledWith({
-          event: "WRONG_AWS_STREAM_CONFIGURATION",
-          message:
-            "The lambda didn't receive a ResponseStream from AWS. Ts.ED therefore generated a ServerlessResponseStream as a fallback. This mode is not optimized for use in PRODUCTION. Please check the AWS configuration of your lambda."
-        });
-      });
-    });
-  });
-});

package/src/domain/ServerlessResponseStream.ts

@@ -1,113 +0,0 @@
-import {Stream} from "node:stream";
-
-import type {APIGatewayProxyEventV2, Callback, Context, Handler} from "aws-lambda";
-
-import {isInAWS} from "../utils/isInAWS.js";
-
-export type ServerlessResponseMeta = {statusCode: number; headers: Record<string, string>};
-
-declare global {
-  const awsLambda: {
-    streamifyResponse(handler: Handler): unknown | Promise<unknown>;
-    HttpResponseStream: {
-      from(resStream: ServerlessResponseStream | unknown, meta: ServerlessResponseMeta): ServerlessResponseStream;
-    };
-  };
-}
-
-export type RequestHandler = (
-  ev: APIGatewayProxyEventV2,
-  streamResponse?: ServerlessResponseStream,
-  ctx?: Context,
-  callback?: Callback
-) => unknown | Promise<unknown>;
-
-export class ServerlessResponseStream extends Stream.Writable {
-  public _meta: ServerlessResponseMeta = {statusCode: 200, headers: {}};
-  #response: Buffer[];
-
-  constructor() {
-    super();
-    this.#response = [];
-  }
-
-  static setMeta(resStream: ServerlessResponseStream, meta: ServerlessResponseMeta) {
-    if (isInAWS()) {
-      // @ts-ignore
-      return awslambda.HttpResponseStream.from(resStream, meta);
-    }
-
-    resStream.setMeta(meta);
-
-    return resStream;
-  }
-
-  static streamifyResponse(handler: RequestHandler): RequestHandler {
-    // Check for global awslambda
-    if (isInAWS()) {
-      // @ts-ignore
-      return awslambda.streamifyResponse(
-        async (event: APIGatewayProxyEventV2, responseStream: ServerlessResponseStream | Context | undefined, context?: Context) => {
-          const isFallbackMode = context === undefined;
-
-          if (context === undefined) {
-            context = responseStream as Context;
-            responseStream = new ServerlessResponseStream();
-
-            console.warn({
-              event: "WRONG_AWS_STREAM_CONFIGURATION",
-              message:
-                "The lambda didn't receive a ResponseStream from AWS. Ts.ED therefore generated a ServerlessResponseStream as a fallback. This mode is not optimized for use in PRODUCTION. Please check the AWS configuration of your lambda."
-            });
-          }
-
-          await handler(event, responseStream as ServerlessResponseStream, context);
-
-          if (isFallbackMode) {
-            return ServerlessResponseStream.buildResponse(responseStream as ServerlessResponseStream);
-          }
-        }
-      );
-    } else {
-      return async (event, response, context) => {
-        const args: any[] = patchArgs([event, response, context]);
-        const responseStream: ServerlessResponseStream = args[1];
-
-        await (handler as any)(...args);
-
-        return ServerlessResponseStream.buildResponse(responseStream);
-      };
-    }
-  }
-
-  private static buildResponse(responseStream: ServerlessResponseStream) {
-    return {
-      ...responseStream._meta,
-      body: responseStream.getBufferedData().toString()
-    };
-  }
-
-  // streams, `chunk` may be any JavaScript value.
-  _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void {
-    this.#response.push(Buffer.from(chunk, encoding));
-    callback();
-  }
-
-  setMeta(meta: ServerlessResponseMeta) {
-    this._meta = meta;
-  }
-
-  getBufferedData(): Buffer {
-    return Buffer.concat(this.#response);
-  }
-}
-
-function patchArgs(args: any[]) {
-  if (!(args[1] instanceof ServerlessResponseStream)) {
-    const responseStream = new ServerlessResponseStream();
-
-    return [args[0], responseStream, ...args.splice(1, -1)];
-  }
-
-  return args;
-}

package/src/exports.ts

@@ -1 +0,0 @@
-export {Operation as Lambda} from "@tsed/schema";

package/src/index.ts

@@ -1,14 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./builder/PlatformServerless.js";
-export * from "./builder/PlatformServerlessHandler.js";
-export * from "./domain/ServerlessContext.js";
-export * from "./domain/ServerlessEvent.js";
-export * from "./domain/ServerlessRequest.js";
-export * from "./domain/ServerlessResponse.js";
-export * from "./domain/ServerlessResponseStream.js";
-export * from "./exports.js";
-export * from "./utils/getRequestId.js";
-export * from "./utils/isInAWS.js";
-export * from "./utils/setResponseHeaders.js";

package/src/utils/getRequestId.spec.ts

@@ -1,43 +0,0 @@
-import {getRequestId} from "./getRequestId.js";
-
-describe("getRequestId", () => {
-  it("should return request id (uuid)", () => {
-    const event: any = {};
-    const context: any = {};
-
-    expect(typeof getRequestId(event, context)).toEqual("string");
-  });
-
-  it("should return request id (requestId)", () => {
-    const event: any = {
-      requestContext: {
-        requestId: "requestId"
-      }
-    };
-    const context: any = {};
-
-    expect(getRequestId(event, context)).toEqual("requestId");
-  });
-
-  it("should return request id (awsRequestId)", () => {
-    const event: any = {};
-    const context: any = {
-      awsRequestId: "awsRequestId"
-    };
-
-    expect(getRequestId(event, context)).toEqual("awsRequestId");
-  });
-
-  it("should return request id (headers)", () => {
-    const event: any = {
-      headers: {
-        "x-request-id": "x-request-id"
-      }
-    };
-    const context: any = {
-      awsRequestId: "awsRequestId"
-    };
-
-    expect(getRequestId(event, context)).toEqual("x-request-id");
-  });
-});

package/src/utils/getRequestId.ts

@@ -1,16 +0,0 @@
-import type {Context} from "aws-lambda";
-import {v4} from "uuid";
-
-import type {ServerlessEvent} from "../domain/ServerlessEvent.js";
-
-export function getRequestId(event: ServerlessEvent, context: Context) {
-  if ("headers" in event && event.headers["x-request-id"]) {
-    return event.headers["x-request-id"];
-  }
-
-  if ("requestContext" in event) {
-    return event?.requestContext?.requestId;
-  }
-
-  return context?.awsRequestId || v4().replace(/-/gi, "");
-}

package/src/utils/isInAWS.ts

@@ -1,8 +0,0 @@
-export function isInAWS(): boolean {
-  return (
-    // @ts-ignore
-    globalThis.awslambda !== undefined &&
-    // @ts-ignore
-    awslambda.streamifyResponse !== undefined
-  );
-}