cloudflare__vinext/tests/node-to-web-request.test.ts

import { describe, it, expect, beforeAll, vi } from "vite-plus/test";
import type { IncomingMessage } from "node:http";
import { Readable } from "node:stream";

/**
 * Tests for the nodeToWebRequest helper in prod-server.ts.
 *
 * Verifies the urlOverride parameter, which allows the App Router prod server
 * to pass an already-normalized URL to avoid redundant normalization by the
 * RSC handler downstream.
 */

/** Minimal mock that satisfies nodeToWebRequest's usage of IncomingMessage. */
function mockReq(overrides: Partial<IncomingMessage> = {}): IncomingMessage {
  return {
    headers: { host: "localhost:3000" },
    url: "/",
    method: "GET",
    ...overrides,
  } as unknown as IncomingMessage;
}

describe("nodeToWebRequest", () => {
  let nodeToWebRequest: (typeof import("../packages/vinext/src/server/prod-server.js"))["nodeToWebRequest"];
  let readNodeStream: (typeof import("../packages/vinext/src/server/prod-server.js"))["readNodeStream"];

  beforeAll(async () => {
    const mod = await import("../packages/vinext/src/server/prod-server.js");
    nodeToWebRequest = mod.nodeToWebRequest;
    readNodeStream = mod.readNodeStream;
  });

  it("uses req.url when no urlOverride is provided", () => {
    const req = mockReq({ url: "/test/page?q=1" });

    const webReq = nodeToWebRequest(req);

    const parsed = new URL(webReq.url);
    // Without override, the raw req.url is used as the path+query source
    expect(parsed.pathname).toBe("/test/page");
    expect(parsed.searchParams.get("q")).toBe("1");
  });

  it("uses urlOverride when provided instead of req.url", () => {
    const req = mockReq({ url: "/raw/unnormalized//path?q=1" });

    // After normalization, the prod server would pass the clean URL
    const webReq = nodeToWebRequest(req, "/normalized/path?q=1");

    const parsed = new URL(webReq.url);
    expect(parsed.pathname).toBe("/normalized/path");
    expect(parsed.searchParams.get("q")).toBe("1");
  });

  it("urlOverride replaces the entire path+query from req.url", () => {
    const req = mockReq({ url: "/original/path?old=param" });

    const webReq = nodeToWebRequest(req, "/overridden/path?new=param");

    const parsed = new URL(webReq.url);
    expect(parsed.pathname).toBe("/overridden/path");
    expect(parsed.searchParams.get("new")).toBe("param");
    // The old query param should NOT be present
    expect(parsed.searchParams.has("old")).toBe(false);
  });

  it("preserves headers and host when urlOverride is used", () => {
    const req = mockReq({
      url: "/raw/url",
      method: "GET",
      headers: {
        host: "example.com",
        "x-custom": "value",
      },
    });

    const webReq = nodeToWebRequest(req, "/normalized/url");

    expect(webReq.method).toBe("GET");
    expect(webReq.headers.get("x-custom")).toBe("value");
    const parsed = new URL(webReq.url);
    expect(parsed.hostname).toBe("example.com");
    expect(parsed.pathname).toBe("/normalized/url");
  });

  it("preserves internal prerender headers only with the matching build secret", () => {
    // No Next.js test port applies: this authenticated transport is vinext-specific.
    const previousPrerender = process.env.VINEXT_PRERENDER;
    process.env.VINEXT_PRERENDER = "1";
    const routeParams = encodeURIComponent(
      JSON.stringify({
        fallbackParamNames: ["slug"],
        params: { slug: "attacker" },
        routePattern: "/blog/:slug",
      }),
    );
    const request = (secret = "request-secret") =>
      mockReq({
        url: "/blog/attacker",
        headers: {
          host: "localhost:3000",
          "x-vinext-prerender-route-params": routeParams,
          "x-vinext-prerender-secret": secret,
          "x-vinext-prerender-speculative": "1",
        },
      });

    try {
      expect(nodeToWebRequest(request()).headers.get("x-vinext-prerender-route-params")).toBeNull();
      expect(nodeToWebRequest(request()).headers.get("x-vinext-prerender-speculative")).toBeNull();
      expect(
        nodeToWebRequest(request(""), undefined, "").headers.get("x-vinext-prerender-route-params"),
      ).toBeNull();
      expect(
        nodeToWebRequest(request(""), undefined, "").headers.get("x-vinext-prerender-speculative"),
      ).toBeNull();
      expect(
        nodeToWebRequest(request(), undefined, "wrong-secret").headers.get(
          "x-vinext-prerender-route-params",
        ),
      ).toBeNull();
      expect(
        nodeToWebRequest(request(), undefined, "wrong-secret").headers.get(
          "x-vinext-prerender-speculative",
        ),
      ).toBeNull();
      expect(
        nodeToWebRequest(request(), undefined, "request-secret").headers.get(
          "x-vinext-prerender-route-params",
        ),
      ).toBe(routeParams);
      expect(
        nodeToWebRequest(request(), undefined, "request-secret").headers.get(
          "x-vinext-prerender-speculative",
        ),
      ).toBe("1");
    } finally {
      if (previousPrerender === undefined) delete process.env.VINEXT_PRERENDER;
      else process.env.VINEXT_PRERENDER = previousPrerender;
    }
  });

  it("uses req.url fallback '/' when req.url is undefined and no override", () => {
    const req = mockReq({ url: undefined });

    const webReq = nodeToWebRequest(req);

    const parsed = new URL(webReq.url);
    expect(parsed.pathname).toBe("/");
  });

  it("urlOverride works for POST requests without affecting the body stream", async () => {
    const bodyContent = JSON.stringify({ hello: "world" });
    // Build a real Readable and graft the IncomingMessage properties onto it
    // so the Node request adapter receives a real streaming request body.
    const readable = Readable.from([Buffer.from(bodyContent)]) as unknown as IncomingMessage;
    readable.headers = { host: "localhost:3000", "content-type": "application/json" };
    readable.url = "/raw/unnormalized//api/submit";
    readable.method = "POST";

    const webReq = nodeToWebRequest(readable, "/api/submit");

    // URL is overridden correctly
    const parsed = new URL(webReq.url);
    expect(parsed.pathname).toBe("/api/submit");
    expect(webReq.method).toBe("POST");

    // Body stream is present and readable
    expect(webReq.body).not.toBeNull();
    const text = await webReq.text();
    expect(text).toBe(bodyContent);
  });

  it("reads from paused Node streams only as Web stream demand advances", async () => {
    let produced = 0;
    const request = new Readable({
      highWaterMark: 1,
      read() {
        if (produced === 100) {
          this.push(null);
          return;
        }
        produced += 1;
        this.push(Buffer.alloc(64 * 1024, produced));
      },
    });
    const reader = readNodeStream(request as IncomingMessage).getReader();
    await new Promise((resolve) => setTimeout(resolve, 20));

    expect(produced).toBeLessThan(100);
    expect(request.readableFlowing).not.toBe(true);

    const first = await reader.read();
    expect(first.done).toBe(false);
    expect(first.value?.byteLength).toBe(64 * 1024);
    await reader.cancel();
  });

  it("owns queued bytes when Node reuses a pooled chunk buffer", async () => {
    const request = new Readable({ read() {} });
    const body = readNodeStream(request as IncomingMessage);
    const reader = body.getReader();
    const pooledChunk = Buffer.allocUnsafe(8);
    pooledChunk.write("original");

    request.emit("data", pooledChunk);
    pooledChunk.write("mutated!");
    request.emit("end");

    const first = await reader.read();
    expect(first.done).toBe(false);
    expect(Buffer.from(first.value ?? []).toString()).toBe("original");
    expect(await reader.read()).toEqual({ done: true, value: undefined });
  });

  it("cancels without destroying the Node request and drains the remainder", async () => {
    const request = new Readable({
      read() {},
    });
    const resume = vi.spyOn(request, "resume");
    const destroy = vi.spyOn(request, "destroy");
    const body = readNodeStream(request as IncomingMessage);
    const reader = body.getReader();

    await reader.cancel();

    expect(resume).toHaveBeenCalled();
    expect(destroy).not.toHaveBeenCalled();
    expect(request.readableFlowing).toBe(true);
  });
});