cloudflare__vinext/tests/pages-readiness.test.ts

import { describe, expect, it } from "vite-plus/test";
import { buildPagesReadinessNextData } from "../packages/vinext/src/server/pages-readiness.js";
import App from "../packages/vinext/src/shims/app.js";
import { getPagesNavigationIsReadyFromSerializedState } from "../packages/vinext/src/shims/router.js";

describe("buildPagesReadinessNextData", () => {
  // Ported from Next.js: test/e2e/auto-export/auto-export.test.ts
  // https://github.com/vercel/next.js/blob/v16.3.0-canary.80/test/e2e/auto-export/auto-export.test.ts
  it("marks automatically exported pages with nextExport", () => {
    expect(
      buildPagesReadinessNextData({
        pageModule: { default: () => null },
        appComponent: null,
        hasRewrites: false,
      }),
    ).toMatchObject({
      autoExport: true,
      nextExport: true,
    });
  });

  it("omits nextExport for data-driven pages", () => {
    expect(
      buildPagesReadinessNextData({
        pageModule: {
          default: () => null,
          getServerSideProps: async () => ({ props: {} }),
        },
        appComponent: null,
        hasRewrites: false,
      }).nextExport,
    ).toBeUndefined();
  });

  // Next.js classifies a custom _app as data-driven only when it overrides the
  // built-in implementation. A subclass that inherits both static functions
  // remains automatically optimized.
  // Ported from Next.js: packages/next/src/server/render.tsx
  // https://github.com/vercel/next.js/blob/v16.3.0-canary.80/packages/next/src/server/render.tsx
  it("keeps an _app inheriting the default getInitialProps automatically optimized", () => {
    class InheritedApp extends App {}

    expect(InheritedApp.getInitialProps).toBe(InheritedApp.origGetInitialProps);

    const nextData = buildPagesReadinessNextData({
      pageModule: { default: () => null },
      appComponent: InheritedApp,
      hasRewrites: false,
    });

    expect(nextData).toMatchObject({
      autoExport: true,
      nextExport: true,
    });
    expect(nextData.appGip).toBeUndefined();

    // The auto-export markers keep the dynamic route pre-ready so the client
    // can replace the route-pattern query/asPath with the live URL state on
    // mount, matching Next.js's auto-export router transition.
    expect(
      getPagesNavigationIsReadyFromSerializedState("/[post]", "", {
        props: {},
        page: "/[post]",
        query: {},
        ...nextData,
      }),
    ).toBe(false);
    expect(
      getPagesNavigationIsReadyFromSerializedState("/zeit/[slug]", "?from=query", {
        props: {},
        page: "/zeit/[slug]",
        query: {},
        ...nextData,
      }),
    ).toBe(false);
  });

  it("marks an _app override as appGip", () => {
    class CustomApp extends App {
      static override async getInitialProps() {
        return { pageProps: {} };
      }
    }

    expect(
      buildPagesReadinessNextData({
        pageModule: { default: () => null },
        appComponent: CustomApp,
        hasRewrites: false,
      }),
    ).toMatchObject({
      appGip: true,
      autoExport: undefined,
      nextExport: undefined,
    });
  });

  it("omits false Next.js data-fetching markers from the serialized shape", () => {
    expect(
      buildPagesReadinessNextData({
        pageModule: {},
        appComponent: null,
        hasRewrites: false,
      }),
    ).toEqual({
      autoExport: true,
      nextExport: true,
      __vinext: { hasRewrites: false },
    });
  });

  it("emits true getServerSideProps marker", () => {
    expect(
      buildPagesReadinessNextData({
        pageModule: { getServerSideProps: async () => ({ props: {} }) },
        appComponent: null,
        hasRewrites: false,
      }),
    ).toMatchObject({ gssp: true });
  });
});