fix(gatsby): use pathPrefix for SSR/DSG page-data requests with `gats…

…by serve` (#36231) * test * wait with proxy until serve is up * fix(gatsby): use pathPrefix for SSR/DSG page-data requests with gatsby serve
gatsbyjs · Jul 26, 2022 · 3dee0f6 · 3dee0f6
1 parent 40073f8
commit 3dee0f6
Show file tree

Hide file tree

Showing 7 changed files with 118 additions and 50 deletions.
diff --git a/e2e-tests/path-prefix/cypress/integration/navigate.js b/e2e-tests/path-prefix/cypress/integration/navigate.js
@@ -58,6 +58,16 @@ describe(`navigate`, () => {
         .location(`pathname`)
         .should(`eq`, `${pathPrefix}/subdirectory/page-2`)
     })
+
+    it(`can navigate to SSR page`, () => {
+      cy.getTestElement(`page-ssr-button-link`)
+        .click()
+        .waitForRouteChange()
+        .location(`pathname`)
+        .should(`eq`, withTrailingSlash(`${pathPrefix}/ssr`))
+
+      cy.getTestElement(`server-data`).contains(`foo`)
+    })
   })
 
   it(`can navigate to 404`, () => {

diff --git a/e2e-tests/path-prefix/cypress/integration/path-prefix.js b/e2e-tests/path-prefix/cypress/integration/path-prefix.js
@@ -3,39 +3,43 @@ const { pathPrefix } = require(`../../gatsby-config`)
 const withTrailingSlash = url => `${url}/`
 
 describe(`Production pathPrefix`, () => {
-  beforeEach(() => {
-    cy.visit(`/`).waitForRouteChange()
-  })
+  describe(`navigation`, () => {
+    beforeEach(() => {
+      cy.visit(`/`).waitForRouteChange()
+    })
 
-  it(`returns 200 on base route`, () => {
-    cy.location(`pathname`).should(`eq`, withTrailingSlash(pathPrefix))
-  })
+    it(`returns 200 on base route`, () => {
+      cy.location(`pathname`).should(`eq`, withTrailingSlash(pathPrefix))
+    })
 
-  it(`renders static image`, () => {
-    cy.getTestElement(`static-image`)
-      .should(`have.attr`, `srcset`)
-      .and(srcset => {
-        srcset.split(/\s*,\s*/).forEach(part => {
-          expect(part).to.contain(`/blog`)
+    it(`renders static image`, () => {
+      cy.getTestElement(`static-image`)
+        .should(`have.attr`, `srcset`)
+        .and(srcset => {
+          srcset.split(/\s*,\s*/).forEach(part => {
+            expect(part).to.contain(`/blog`)
+          })
         })
-      })
-  })
+    })
 
-  it(`renders dynamic image`, () => {
-    cy.getTestElement(`gatsby-image`)
-      .should(`have.attr`, `srcset`)
-      .and(srcset => {
-        srcset.split(/\s*,\s*/).forEach(part => {
-          expect(part).to.contain(`/blog`)
+    it(`renders dynamic image`, () => {
+      cy.getTestElement(`gatsby-image`)
+        .should(`have.attr`, `srcset`)
+        .and(srcset => {
+          srcset.split(/\s*,\s*/).forEach(part => {
+            expect(part).to.contain(`/blog`)
+          })
         })
-      })
-  })
+    })
 
-  describe(`navigation`, () => {
     it(`prefixes link with /blog`, () => {
       cy.getTestElement(`page-2-link`)
         .should(`have.attr`, `href`)
         .and(`include`, `/blog`)
+
+      cy.getTestElement(`page-ssr-link`)
+        .should(`have.attr`, `href`)
+        .and(`include`, `/blog`)
     })
 
     it(`can navigate to secondary page`, () => {
@@ -73,5 +77,24 @@ describe(`Production pathPrefix`, () => {
         withTrailingSlash(`${pathPrefix}/blogtest`)
       )
     })
+
+    it(`can navigate to ssr page`, () => {
+      cy.getTestElement(`page-ssr-link`).click()
+
+      cy.location(`pathname`).should(
+        `eq`,
+        withTrailingSlash(`${pathPrefix}/ssr`)
+      )
+
+      cy.getTestElement(`server-data`).contains(`foo`)
+    })
+  })
+
+  it(`can visit ssr page`, () => {
+    cy.visit(`/ssr/`).waitForRouteChange()
+
+    cy.location(`pathname`).should(`eq`, withTrailingSlash(`${pathPrefix}/ssr`))
+
+    cy.getTestElement(`server-data`).contains(`foo`)
   })
 })
diff --git a/e2e-tests/path-prefix/package.json b/e2e-tests/path-prefix/package.json
@@ -15,6 +15,7 @@
     "gatsby-plugin-sitemap": "next",
     "gatsby-source-filesystem": "next",
     "gatsby-transformer-sharp": "next",
+    "http-proxy": "^1.18.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-helmet": "^5.2.0"
@@ -25,11 +26,11 @@
   "license": "MIT",
   "scripts": {
     "prebuild": "del-cli -f assets && make-dir assets/blog",
-    "build": "gatsby build --prefix-paths",
+    "build": "cross-env CYPRESS_SUPPORT=y gatsby build --prefix-paths",
     "postbuild": "cpy --cwd=./public --parents '**/*' '../assets/blog'",
     "develop": "gatsby develop",
     "format": "prettier --write '**/*.js'",
-    "test": "cross-env CYPRESS_SUPPORT=y npm run build && npm run start-server-and-test",
+    "test": "npm run build && npm run start-server-and-test",
     "start-server-and-test": "start-server-and-test serve \"http://localhost:9000/blog/|http://localhost:9001/blog/\" cy:run",
     "serve": "npm-run-all --parallel serve:*",
     "serve:site": "gatsby serve --prefix-paths",
@@ -46,11 +47,11 @@
     "make-dir-cli": "^2.0.0",
     "npm-run-all": "^4.1.5",
     "prettier": "2.0.4",
-    "serve-handler": "^6.0.0",
-    "start-server-and-test": "^1.7.1"
+    "start-server-and-test": "^1.7.1",
+    "wait-on": "^6.0.0"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/gatsbyjs/gatsby-starter-default"
   }
-}
+}
diff --git a/e2e-tests/path-prefix/scripts/serve.js b/e2e-tests/path-prefix/scripts/serve.js
@@ -1,24 +1,24 @@
-const handler = require(`serve-handler`)
 const http = require(`http`)
-const path = require(`path`)
+const httpProxy = require("http-proxy")
+const waitOn = require("wait-on")
 
-const server = http.createServer((request, response) =>
-  handler(request, response, {
-    public: path.resolve(`assets`),
-    headers: [
-      {
-        source: `**/*`,
-        headers: [
-          {
-            key: `Access-Control-Allow-Origin`,
-            value: `*`,
-          },
-        ],
-      },
-    ],
-  })
-)
+waitOn(
+  {
+    resources: [`http://localhost:9000/blog/`],
+  },
+  function (err) {
+    if (err) {
+      console.error(err)
+      process.exit(1)
+    }
+
+    const proxy = httpProxy.createProxyServer()
+    const server = http.createServer((request, response) =>
+      proxy.web(request, response, { target: "http://localhost:9000" })
+    )
 
-server.listen(9001, () => {
-  console.log(`Running at http://localhost:9001`)
-})
+    server.listen(9001, () => {
+      console.log(`Assets server running at http://localhost:9001`)
+    })
+  }
+)
diff --git a/e2e-tests/path-prefix/src/pages/index.js b/e2e-tests/path-prefix/src/pages/index.js
@@ -40,6 +40,15 @@ const IndexPage = ({ data }) => {
       <Link data-testid="subdir-link" to="subdirectory/page-1">
         Go to subdirectory
       </Link>
+      <Link data-testid="page-ssr-link" to="/ssr/">
+        Go to SSR page
+      </Link>
+      <button
+        data-testid="page-ssr-button-link"
+        onClick={() => navigate(`/ssr/`)}
+      >
+        Go to SSR page with navigate()
+      </button>
     </Layout>
   )
 }

diff --git a/e2e-tests/path-prefix/src/pages/ssr.js b/e2e-tests/path-prefix/src/pages/ssr.js
@@ -0,0 +1,25 @@
+import * as React from "react"
+import { Link } from "gatsby"
+
+import Layout from "../components/layout"
+
+const SSRPage = ({ serverData }) => (
+  <Layout>
+    <h1>Hi from the SSR page</h1>
+    <p>Welcome to SSR page</p>
+    <Link data-testid="index-link" to="/">
+      Go back to the homepage
+    </Link>
+    <code data-testid="server-data">{serverData?.dataFromServer}</code>
+  </Layout>
+)
+
+export default SSRPage
+
+export function getServerData() {
+  return {
+    props: {
+      dataFromServer: `foo`,
+    },
+  }
+}
diff --git a/packages/gatsby/src/commands/serve.ts b/packages/gatsby/src/commands/serve.ts
@@ -202,7 +202,7 @@ module.exports = async (program: IServeProgram): Promise<void> => {
         dbPath: path.join(program.directory, `.cache`, `data`, `datastore`),
       })
 
-      app.get(
+      router.get(
         `/page-data/:pagePath(*)/page-data.json`,
         async (req, res, next) => {
           const requestedPagePath = req.params.pagePath