Test that slashed v2 pages redirect and update the pinned contract

Author: RhysSullivan

apps/cloud/src/edge/marketing.test.ts

@@ -8,6 +8,7 @@ import {
   marketingProxyRequest,
   parseV2Edge,
   v2EdgeResponse,
+  v2PageForSlashedPath,
   type V2EdgeEnv,
   type V2Service,
 } from "./marketing";
@@ -145,6 +146,18 @@ describe("isV2Path", () => {
   }
 });
 
+describe("v2PageForSlashedPath", () => {
+  it("canonicalizes only v2's exact pages", () => {
+    expect(v2PageForSlashedPath("/pricing/")).toBe("/pricing");
+    expect(v2PageForSlashedPath("/google-workspace/")).toBe("/google-workspace");
+    expect(v2PageForSlashedPath("/pricing")).toBeNull();
+    expect(v2PageForSlashedPath("/pricing.md/")).toBeNull();
+    expect(v2PageForSlashedPath("/blog/")).toBeNull();
+    expect(v2PageForSlashedPath("/terms/")).toBeNull();
+    expect(v2PageForSlashedPath("/")).toBeNull();
+  });
+});
+
 describe("isSignUpPath", () => {
   it("claims /sign-up and /signup only", () => {
     expect(isSignUpPath("/sign-up")).toBe(true);
@@ -689,6 +702,66 @@ describe("v2EdgeResponse marketing", () => {
     return { received, service };
   };
 
+  // A signed-out visitor at `/pricing/` would otherwise reach v1's sign-in
+  // gate, which redirects to login.
+  it("redirects v2's slashed exact pages to the page, query kept, without forwarding", async () => {
+    const { received, service } = recordingService();
+
+    for (const [target, location] of [
+      ["/pricing/", "/pricing"],
+      ["/pricing/?ref=hn", "/pricing?ref=hn"],
+      ["/home/", "/home"],
+      ["/about-executor/", "/about-executor"],
+      ["/google-workspace/", "/google-workspace"],
+    ] as const) {
+      for (const method of ["GET", "HEAD"]) {
+        const response = await v2EdgeResponse(
+          new Request(`https://executor.sh${target}`, {
+            method,
+            headers: { cookie: "wos-session=sealed" },
+          }),
+          settings(service),
+        );
+        expect(response?.status, `${method} ${target}`).toBe(308);
+        expect(response?.headers.get("location"), `${method} ${target}`).toBe(
+          `https://executor.sh${location}`,
+        );
+      }
+    }
+    expect(received).toHaveLength(0);
+  });
+
+  it("forwards the slashed form of a page v2 owns below, such as /blog/", async () => {
+    const { received, service } = recordingService();
+
+    const response = await v2EdgeResponse(
+      new Request("https://executor.sh/docs/"),
+      settings(service),
+    );
+
+    expect(await response?.text()).toBe("v2");
+    expect(received[0]?.url).toBe("https://executor.sh/docs/");
+  });
+
+  it("keeps deeper paths, other methods and v1's own slashed pages with v1", () => {
+    const { received, service } = recordingService();
+
+    for (const [method, target] of [
+      ["GET", "/pricing/extra"],
+      ["GET", "/home/extra/"],
+      ["GET", "/pricing//"],
+      ["POST", "/pricing/"],
+      ["GET", "/terms/"],
+      ["GET", "/demo/"],
+    ] as const) {
+      expect(
+        v2EdgeResponse(new Request(`https://executor.sh${target}`, { method }), settings(service)),
+        `${method} ${target}`,
+      ).toBeNull();
+    }
+    expect(received).toHaveLength(0);
+  });
+
   it("sends the signed-out homepage to v2 with the URL unchanged", async () => {
     const { received, service } = recordingService();
 

apps/cloud/src/edge/production-config.test.ts

@@ -77,6 +77,10 @@ const EdgeContract = Schema.Struct({
   cases: Schema.Array(
     Schema.Struct({ method: Schema.String, target: Schema.String, forwards: Schema.Boolean }),
   ),
+  slashRedirects: Schema.Struct({
+    pages: Schema.Array(Schema.String),
+    cases: Schema.Array(Schema.Struct({ target: Schema.String, location: Schema.String })),
+  }),
 });
 const contract = Schema.decodeUnknownSync(Schema.fromJsonString(EdgeContract))(
   readFileSync(fileURLToPath(new URL("./v2-edge-contract.json", import.meta.url)), "utf8"),
@@ -134,6 +138,27 @@ describe("v2's edge contract", () => {
     expect(signUps.map((c) => c.target).toSorted()).toEqual(["/sign-up", "/signup"]);
   });
 
+  // A slashed exact page is not forwarded: the edge redirects it to the page,
+  // which is. Every page v2 lists has an example.
+  it("covers every slashed page v2 lists", () => {
+    expect(
+      contract.slashRedirects.cases
+        .map((c) => new URL(c.target, contract.origin).pathname)
+        .toSorted(),
+    ).toEqual(expect.arrayContaining(contract.slashRedirects.pages.map((page) => `${page}/`)));
+  });
+
+  for (const { target, location } of contract.slashRedirects.cases) {
+    for (const method of ["GET", "HEAD"]) {
+      it(`redirects ${method} ${target} to ${location} without forwarding`, async () => {
+        const { calls, response } = await runCase(method, target);
+        expect(calls).toHaveLength(0);
+        expect(response?.status).toBe(308);
+        expect(response?.headers.get("location")).toBe(`${contract.origin}${location}`);
+      });
+    }
+  }
+
   for (const { method, target } of signUps) {
     it(`redirects ${method} ${target} to v2's sign-up page without forwarding`, async () => {
       const { calls, response } = await runCase(method, target);

apps/cloud/src/edge/v2-edge-contract.json

@@ -116,6 +116,11 @@
       "target": "/blog",
       "forwards": true
     },
+    {
+      "method": "GET",
+      "target": "/blog/",
+      "forwards": true
+    },
     {
       "method": "GET",
       "target": "/blog/a-post",
@@ -126,6 +131,11 @@
       "target": "/docs",
       "forwards": true
     },
+    {
+      "method": "GET",
+      "target": "/docs/",
+      "forwards": true
+    },
     {
       "method": "GET",
       "target": "/docs/quickstart",
@@ -316,6 +326,21 @@
       "target": "/home/extra",
       "forwards": false
     },
+    {
+      "method": "GET",
+      "target": "/about-executor/extra",
+      "forwards": false
+    },
+    {
+      "method": "GET",
+      "target": "/google-workspace/extra",
+      "forwards": false
+    },
+    {
+      "method": "POST",
+      "target": "/pricing/",
+      "forwards": false
+    },
     {
       "method": "GET",
       "target": "/login",
@@ -371,5 +396,31 @@
       "target": "/api/webhooks/workos",
       "forwards": false
     }
-  ]
+  ],
+  "slashRedirects": {
+    "rule": "GET or HEAD <page>/ answers 308 to <page>, query kept, for each of pages",
+    "pages": ["/home", "/pricing", "/about-executor", "/google-workspace"],
+    "cases": [
+      {
+        "target": "/pricing/",
+        "location": "/pricing"
+      },
+      {
+        "target": "/pricing/?ref=hn",
+        "location": "/pricing?ref=hn"
+      },
+      {
+        "target": "/home/",
+        "location": "/home"
+      },
+      {
+        "target": "/about-executor/",
+        "location": "/about-executor"
+      },
+      {
+        "target": "/google-workspace/",
+        "location": "/google-workspace"
+      }
+    ]
+  }
 }