Support 304 responses on document requests

remix-run · Sep 6, 2024 · f6d61ba · f6d61ba
1 parent 1a97d25
commit f6d61ba
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 6 deletions.
diff --git a/.changeset/slow-socks-juggle.md b/.changeset/slow-socks-juggle.md
@@ -0,0 +1,5 @@
+---
+"@remix-run/server-runtime": patch
+---
+
+Support 304 responses on document requests
diff --git a/integration/single-fetch-test.ts b/integration/single-fetch-test.ts
@@ -1897,7 +1897,7 @@ test.describe("single-fetch", () => {
     ]);
   });
 
-  test("does not try to encode a turbo-stream body into 304 responses", async () => {
+  test.only("does not try to encode a turbo-stream body into 304 responses", async () => {
     let fixture = await createFixture({
       config: {
         future: {
@@ -1925,8 +1925,23 @@ test.describe("single-fetch", () => {
         `,
       },
     });
-    let res = await fixture.requestSingleFetchData("/_root.data");
-    expect(res.data).toEqual({
+
+    // Document requests
+    let documentRes = await fixture.requestDocument("/");
+    let html = await documentRes.text();
+    expect(html).toContain("<body>");
+    expect(html).toContain("<h1>Hello from the loader!</h1>");
+    documentRes = await fixture.requestDocument("/", {
+      headers: {
+        "If-None-Match": "1234",
+      },
+    });
+    expect(documentRes.status).toBe(304);
+    expect(await documentRes.text()).toBe("");
+
+    // Data requests
+    let dataRes = await fixture.requestSingleFetchData("/_root.data");
+    expect(dataRes.data).toEqual({
       root: {
         data: {
           message: "ROOT",
@@ -1938,13 +1953,13 @@ test.describe("single-fetch", () => {
         },
       },
     });
-    res = await fixture.requestSingleFetchData("/_root.data", {
+    dataRes = await fixture.requestSingleFetchData("/_root.data", {
       headers: {
         "If-None-Match": "1234",
       },
     });
-    expect(res.status).toBe(304);
-    expect(res.data).toBeNull();
+    expect(dataRes.status).toBe(304);
+    expect(dataRes.data).toBeNull();
   });
 
   test.describe("revalidations/_routes param", () => {

diff --git a/packages/remix-server-runtime/server.ts b/packages/remix-server-runtime/server.ts
@@ -465,6 +465,11 @@ async function handleDocumentRequest(
 
   let headers = getDocumentHeaders(build, context);
 
+  // 304 responses should not have a body or a content-type
+  if (context.statusCode === 304) {
+    return new Response(null, { status: 304, headers });
+  }
+
   // Sanitize errors outside of development environments
   if (context.errors) {
     Object.values(context.errors).forEach((err) => {