equipped 5.3.0-alpha.0 → 5.3.1

package/dist/cjs/server/index.cjs

@@ -51,6 +51,7 @@ __export(server_exports, {
 module.exports = __toCommonJS(server_exports);
 
 // src/server/adapters/base.ts
+var import_node_http = require("http");
 var import_cors = require("@fastify/cors");
 var import_cors2 = require("cors");
 var import_socket = require("socket.io");
@@ -1368,6 +1369,22 @@ var serverConfigPipe = () => import_valleyed7.v.object({
   ),
   socketsAuthMethods: import_valleyed7.v.defaults(import_valleyed7.v.array(import_valleyed7.v.instanceOf(BaseRequestAuthMethod)), [])
 });
+var rawResponseHandledSymbol = /* @__PURE__ */ Symbol("rawResponseHandled");
+var rawResponseHandled = Object.freeze({ [rawResponseHandledSymbol]: true });
+var rawResponseNotStartedMessage = "Raw not-found handler did not start or complete a response";
+function isRawResponseHandled(input) {
+  return Boolean(input && typeof input === "object" && rawResponseHandledSymbol in input);
+}
+function hasRawResponseStarted(response) {
+  return response.headersSent || response.writableEnded;
+}
+function writeRawHandlerError(response, error) {
+  if (hasRawResponseStarted(response)) return;
+  response.statusCode = StatusCodes.BadRequest;
+  response.setHeader("Content-Type", "application/json");
+  const message = error instanceof Error ? error.message : `${error}`;
+  response.end(JSON.stringify([{ message }]));
+}
 var errorsSchemas = Object.entries(StatusCodes).filter(([, value]) => value > 399).map(([key, value]) => ({
   status: value,
   contentType: "application/json",
@@ -1384,6 +1401,9 @@ var Server = class {
   #serverConfig;
   #queue = [];
   #routesByKey = /* @__PURE__ */ new Set();
+  #started = false;
+  #beforeListenHandlers = [];
+  #notFoundHandler = null;
   setup(httpServer, config) {
     this.#httpServer = httpServer;
     this.#serverConfig = config;
@@ -1433,10 +1453,21 @@ var Server = class {
       });
     });
   }
+  setNotFoundHandler(handler) {
+    if (this.#started) throw new EquippedError("Cannot set not-found handler after server has started", {});
+    this.#notFoundHandler = handler;
+    return this;
+  }
+  onBeforeListen(handler) {
+    if (this.#started) throw new EquippedError("Cannot add before-listen handler after server has started", {});
+    this.#beforeListenHandlers.push(handler);
+    return this;
+  }
   test() {
     return (0, import_supertest.default)(this.#httpServer);
   }
   async start() {
+    this.#started = true;
     const config = this.#serverConfig;
     const instance = Instance.get();
     const { app } = instance.settings;
@@ -1450,10 +1481,7 @@ var Server = class {
         })
       });
     await Promise.all(this.#queue.map((cb) => cb()));
-    this.registerNotFoundHandler(async (req) => {
-      const request = await this.parseRequest(req);
-      throw new NotFoundError(`Route ${request.path} not found`);
-    });
+    this.registerNotFoundHandler(async (req, res) => await this.#handleNotFound(req, res));
     this.registerErrorHandler(async (error, _, res) => {
       if (!(error instanceof EquippedError)) Instance.get().log.error({ error }, "Uncaught error in route handler");
       const response = error instanceof RequestError ? new Response({
@@ -1468,10 +1496,36 @@ var Server = class {
       });
       return await this.handleResponse(res, response);
     });
+    for (const handler of this.#beforeListenHandlers) await handler({ httpServer: this.#httpServer, port: config.port });
     const started = await this.startServer(config.port);
     if (started) Instance.get().log.info(`${instance.id}(${app.name}) service listening on port ${config.port}`);
     return started;
   }
+  createNodeRawResponder(input) {
+    return async (handler) => {
+      input.beforeHandle?.();
+      try {
+        await handler(input.request, input.response);
+      } catch (error) {
+        if (!hasRawResponseStarted(input.response)) {
+          writeRawHandlerError(input.response, error);
+          return rawResponseHandled;
+        }
+        throw error;
+      }
+      if (!hasRawResponseStarted(input.response))
+        writeRawHandlerError(input.response, new EquippedError(rawResponseNotStartedMessage, {}));
+      return rawResponseHandled;
+    };
+  }
+  async #handleNotFound(req, res) {
+    const request = await this.parseRequest(req);
+    if (!this.#notFoundHandler) throw new NotFoundError(`Route ${request.path} not found`);
+    const result = await this.#notFoundHandler({ request, respondWithRaw: this.createRawResponder(req, res) });
+    if (isRawResponseHandled(result)) return;
+    if (result instanceof Response) return await this.handleResponse(res, result);
+    throw new EquippedError("Not-found handler must return a Response or respondWithRaw(...)", {});
+  }
   #resolveSchema(method, schema) {
     const defaultStatusCode = schema?.defaultStatusCode ?? StatusCodes.Ok;
     const defaultContentType = schema?.defaultContentType ?? "application/json";
@@ -1562,6 +1616,209 @@ var Server = class {
     };
   }
 };
+if (void 0) {
+  let ensureTestInstance = function() {
+    const instance = Instance.maybeGet() ?? Instance.create({ app: { name: "equipped-test" }, log: { level: "silent" } });
+    if (!testInstanceState.__equippedTestInstanceAliased) {
+      instance.alias("equipped-test");
+      testInstanceState.__equippedTestInstanceAliased = true;
+    }
+  }, createRawResponse = function() {
+    const chunks = [];
+    return {
+      statusCode: 200,
+      headersSent: false,
+      writableEnded: false,
+      headers: {},
+      setHeader(key, value) {
+        this.headers[key] = value;
+      },
+      end(chunk) {
+        if (chunk !== void 0) chunks.push(Buffer.isBuffer(chunk) ? chunk.toString("utf8") : String(chunk));
+        this.headersSent = true;
+        this.writableEnded = true;
+      },
+      body() {
+        return chunks.join("");
+      }
+    };
+  };
+  ensureTestInstance2 = ensureTestInstance, createRawResponse2 = createRawResponse;
+  const { describe, expect, test } = void 0;
+  const testInstanceState = globalThis;
+  class TestServer extends Server {
+    handledResponse = null;
+    startedPorts = [];
+    notFoundHandler = null;
+    constructor() {
+      super();
+      this.setup(http.createServer(), {
+        port: 0,
+        cors: void 0,
+        eventBus: void 0,
+        publicPath: void 0,
+        healthPath: void 0,
+        openapi: { docsVersion: "1.0.0", docsBaseUrl: ["/"], docsPath: "/__docs" },
+        requests: {
+          log: false,
+          rateLimit: { enabled: false, periodInMs: 1, limit: 1 },
+          slowdown: { enabled: false, periodInMs: 1, delayAfter: 1, delayInMs: 1 }
+        },
+        socketsAuthMethods: []
+      });
+    }
+    async parseRequest(req) {
+      return new Request2({
+        ip: "127.0.0.1",
+        body: {},
+        cookies: {},
+        params: {},
+        query: {},
+        method: Methods.get,
+        path: req.path,
+        headers: {},
+        files: {}
+      });
+    }
+    async handleResponse(_, response) {
+      this.handledResponse = response;
+    }
+    createRawResponder(req, res) {
+      return this.createNodeRawResponder({ request: req.rawRequest, response: res.rawResponse });
+    }
+    registerRoute() {
+    }
+    registerErrorHandler() {
+    }
+    registerNotFoundHandler(cb) {
+      this.notFoundHandler = cb;
+    }
+    async startServer(port) {
+      this.startedPorts.push(port);
+      return true;
+    }
+    async dispatchNotFound(path) {
+      if (!this.notFoundHandler) throw new Error("not-found handler was not registered");
+      this.handledResponse = null;
+      const rawResponse = createRawResponse();
+      await this.notFoundHandler({ path, rawRequest: {} }, { rawResponse });
+      return { handledResponse: this.handledResponse, rawResponse };
+    }
+  }
+  describe("Server before-listen handlers", () => {
+    test("runs before-listen handlers before adapter listen in registration order", async () => {
+      ensureTestInstance();
+      const server = new TestServer();
+      const calls = [];
+      let receivedServer = null;
+      server.onBeforeListen(({ httpServer, port }) => {
+        calls.push(`first:${port}`);
+        receivedServer = httpServer;
+        expect(server.startedPorts).toEqual([]);
+      }).onBeforeListen(({ httpServer, port }) => {
+        calls.push(`second:${port}`);
+        expect(httpServer).toBe(receivedServer);
+        expect(server.startedPorts).toEqual([]);
+      });
+      await server.start();
+      expect(calls).toEqual(["first:0", "second:0"]);
+      expect(receivedServer).toBeInstanceOf(http.Server);
+      expect(server.startedPorts).toEqual([0]);
+    });
+    test("rejects startup when a before-listen handler fails before adapter listen", async () => {
+      ensureTestInstance();
+      const server = new TestServer();
+      server.onBeforeListen(async () => {
+        throw new Error("before-listen failed");
+      });
+      await expect(server.start()).rejects.toThrow("before-listen failed");
+      expect(server.startedPorts).toEqual([]);
+    });
+    test("rejects adding before-listen handlers after server startup", async () => {
+      ensureTestInstance();
+      const server = new TestServer();
+      await server.start();
+      expect(() => server.onBeforeListen(() => {
+      })).toThrow("Cannot add before-listen handler after server has started");
+    });
+  });
+  describe("Server not-found handler", () => {
+    test("throws the default Equipped not-found error when no custom handler is set", async () => {
+      ensureTestInstance();
+      const server = new TestServer();
+      await server.start();
+      await expect(server.dispatchNotFound("/missing")).rejects.toBeInstanceOf(NotFoundError);
+    });
+    test("allows a custom not-found handler to return an Equipped response", async () => {
+      ensureTestInstance();
+      const server = new TestServer();
+      server.setNotFoundHandler(
+        ({ request }) => new Response({
+          body: [{ message: `No route for ${request.path}` }],
+          status: StatusCodes.NotFound,
+          headers: {},
+          cookies: {},
+          contentType: "application/json"
+        })
+      );
+      await server.start();
+      const result = await server.dispatchNotFound("/custom");
+      expect(result.handledResponse?.status).toBe(StatusCodes.NotFound);
+      expect(result.handledResponse?.body).toEqual([{ message: "No route for /custom" }]);
+    });
+    test("allows a custom not-found handler to complete the response through a raw Node listener", async () => {
+      ensureTestInstance();
+      const server = new TestServer();
+      server.setNotFoundHandler(
+        ({ respondWithRaw }) => respondWithRaw((_, response) => {
+          response.statusCode = 203;
+          response.end("raw fallback");
+        })
+      );
+      await server.start();
+      const result = await server.dispatchNotFound("/page");
+      expect(result.handledResponse).toBeNull();
+      expect(result.rawResponse.statusCode).toBe(203);
+      expect(result.rawResponse.body()).toBe("raw fallback");
+    });
+    test("writes a clear raw error when a raw not-found handler does not start a response", async () => {
+      ensureTestInstance();
+      const server = new TestServer();
+      server.setNotFoundHandler(({ respondWithRaw }) => respondWithRaw(() => {
+      }));
+      await server.start();
+      const result = await server.dispatchNotFound("/page");
+      expect(result.handledResponse).toBeNull();
+      expect(result.rawResponse.statusCode).toBe(StatusCodes.BadRequest);
+      expect(result.rawResponse.body()).toContain(rawResponseNotStartedMessage);
+    });
+    test("rejects a custom not-found handler result that is neither an Equipped response nor raw completion", async () => {
+      ensureTestInstance();
+      const server = new TestServer();
+      server.setNotFoundHandler((() => void 0));
+      await server.start();
+      await expect(server.dispatchNotFound("/bad")).rejects.toThrow("Not-found handler must return a Response or respondWithRaw(...)");
+    });
+    test("rejects setting the custom not-found handler after server startup", async () => {
+      ensureTestInstance();
+      const server = new TestServer();
+      await server.start();
+      expect(
+        () => server.setNotFoundHandler(
+          () => new Response({
+            body: null,
+            status: StatusCodes.NotFound,
+            headers: {},
+            cookies: {},
+            contentType: "application/json"
+          })
+        )
+      ).toThrow("Cannot set not-found handler after server has started");
+    });
+  });
+}
+var ensureTestInstance2;
+var createRawResponse2;
 
 // src/server/middlewares/requireAuthUser.ts
 var requireAuthUser = (methods) => makeMiddleware(