Skip to content

Commit ec77bed

Browse files
piehpieh
authored
perf(gatsby-adapter-netlify): improve adapt() performance (#38988)
* test: add ssg specific headers * fix: headers rule matching with path prefix * test: add NODE_NO_WARNING, axios seems to use fetch now under the hood causing fetch warning on node 18 impacting some logs assertions * perf: don't recreate headers from headerRoutes for each static route in route manifest * test: apply NODE_NO_WARNINGS env in correct place
1 parent 9584173 commit ec77bed

File tree

14 files changed

+109
-34
lines changed

14 files changed

+109
-34
lines changed

‎.circleci/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ executors:
1515
environment:
1616
GATSBY_CPU_COUNT: 2
1717
COMPILER_OPTIONS: GATSBY_MAJOR=<< parameters.gatsby_major >>
18+
NODE_NO_WARNINGS: 1
1819

1920
aliases:
2021
e2e-executor-env: &e2e-executor-env

‎e2e-tests/adapters/cypress/e2e/headers.cy.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ describe("Headers", () => {
7676

7777
beforeEach(() => {
7878
cy.intercept(PATH_PREFIX + "/", WorkaroundCachedResponse).as("index")
79+
cy.intercept(
80+
PATH_PREFIX + "/routes/ssg/static",
81+
WorkaroundCachedResponse
82+
).as("ssg")
7983
cy.intercept(
8084
PATH_PREFIX + "/routes/ssr/static",
8185
WorkaroundCachedResponse
@@ -128,6 +132,22 @@ describe("Headers", () => {
128132
checkHeaders("@js")
129133
})
130134

135+
it("should contain correct headers for ssg page", () => {
136+
cy.visit("routes/ssg/static").waitForRouteChange()
137+
138+
checkHeaders("@ssg", {
139+
...defaultHeaders,
140+
"x-custom-header": "my custom header value",
141+
"x-ssg-header": "my custom header value",
142+
"cache-control": "public,max-age=0,must-revalidate",
143+
})
144+
145+
checkHeaders("@app-data")
146+
checkHeaders("@page-data")
147+
checkHeaders("@slice-data")
148+
checkHeaders("@static-query-result")
149+
})
150+
131151
it("should contain correct headers for ssr page", () => {
132152
cy.visit("routes/ssr/static").waitForRouteChange()
133153

‎e2e-tests/adapters/cypress/e2e/remote-file.cy.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ const PATH_PREFIX = Cypress.env(`PATH_PREFIX`) || ``
1818
const configs = [
1919
{
2020
title: `remote-file (SSG, Page Query)`,
21-
pagePath: `/routes/remote-file/`,
21+
pagePath: `/routes/ssg/remote-file/`,
2222
placeholders: true,
2323
},
2424
{
2525
title: `remote-file (SSG, Page Context)`,
26-
pagePath: `/routes/remote-file-data-from-context/`,
26+
pagePath: `/routes/ssg/remote-file-data-from-context/`,
2727
placeholders: true,
2828
},
2929
{

‎e2e-tests/adapters/cypress/e2e/trailing-slash.cy.ts‎

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { assertPageVisits } from "../utils/assert-page-visits"
22
import { applyTrailingSlashOption } from "../../utils"
33

4-
Cypress.on("uncaught:exception", (err) => {
4+
Cypress.on("uncaught:exception", err => {
55
if (err.message.includes("Minified React error")) {
66
return false
77
}
@@ -12,38 +12,62 @@ const TRAILING_SLASH = Cypress.env(`TRAILING_SLASH`) || `never`
1212
describe("trailingSlash", () => {
1313
describe(TRAILING_SLASH, () => {
1414
it("should work when using Gatsby Link (without slash)", () => {
15-
cy.visit('/').waitForRouteChange()
15+
cy.visit("/").waitForRouteChange()
1616

17-
cy.get(`[data-testid="static-without-slash"]`).click().waitForRouteChange().assertRoute(applyTrailingSlashOption(`/routes/static`, TRAILING_SLASH))
17+
cy.get(`[data-testid="static-without-slash"]`)
18+
.click()
19+
.waitForRouteChange()
20+
.assertRoute(
21+
applyTrailingSlashOption(`/routes/ssg/static`, TRAILING_SLASH)
22+
)
1823
})
1924
it("should work when using Gatsby Link (with slash)", () => {
20-
cy.visit('/').waitForRouteChange()
25+
cy.visit("/").waitForRouteChange()
2126

22-
cy.get(`[data-testid="static-with-slash"]`).click().waitForRouteChange().assertRoute(applyTrailingSlashOption(`/routes/static`, TRAILING_SLASH))
27+
cy.get(`[data-testid="static-with-slash"]`)
28+
.click()
29+
.waitForRouteChange()
30+
.assertRoute(
31+
applyTrailingSlashOption(`/routes/ssg/static`, TRAILING_SLASH)
32+
)
2333
})
2434
it("should work on direct visit (with other setting)", () => {
25-
const destination = applyTrailingSlashOption("/routes/static", TRAILING_SLASH)
26-
const inverse = TRAILING_SLASH === `always` ? "/routes/static" : "/routes/static/"
35+
const destination = applyTrailingSlashOption(
36+
"/routes/ssg/static",
37+
TRAILING_SLASH
38+
)
39+
const inverse =
40+
TRAILING_SLASH === `always`
41+
? "/routes/ssg/static"
42+
: "/routes/ssg/static/"
2743

2844
assertPageVisits([
2945
{
3046
path: destination,
3147
status: 200,
3248
},
33-
{ path: inverse, status: 301, destinationPath: destination }
49+
{ path: inverse, status: 301, destinationPath: destination },
3450
])
3551

36-
cy.visit(inverse).waitForRouteChange().assertRoute(applyTrailingSlashOption(`/routes/static`, TRAILING_SLASH))
52+
cy.visit(inverse)
53+
.waitForRouteChange()
54+
.assertRoute(
55+
applyTrailingSlashOption(`/routes/ssg/static`, TRAILING_SLASH)
56+
)
3757
})
3858
it("should work on direct visit (with current setting)", () => {
3959
assertPageVisits([
4060
{
41-
path: applyTrailingSlashOption("/routes/static", TRAILING_SLASH),
61+
path: applyTrailingSlashOption("/routes/ssg/static", TRAILING_SLASH),
4262
status: 200,
4363
},
4464
])
4565

46-
cy.visit(applyTrailingSlashOption("/routes/static", TRAILING_SLASH)).waitForRouteChange().assertRoute(applyTrailingSlashOption(`/routes/static`, TRAILING_SLASH))
66+
cy.visit(applyTrailingSlashOption("/routes/ssg/static", TRAILING_SLASH))
67+
.waitForRouteChange()
68+
.assertRoute(
69+
applyTrailingSlashOption(`/routes/ssg/static`, TRAILING_SLASH)
70+
)
4771
})
4872
})
4973
})

‎e2e-tests/adapters/gatsby-config.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,15 @@ const config: GatsbyConfig = {
7777
},
7878
],
7979
},
80+
{
81+
source: `routes/ssg/*`,
82+
headers: [
83+
{
84+
key: "x-ssg-header",
85+
value: "my custom header value",
86+
},
87+
],
88+
},
8089
],
8190
...configOverrides,
8291
}

‎e2e-tests/adapters/gatsby-node.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export const createPages: GatsbyNode["createPages"] = async ({
5555

5656
createPage({
5757
path: applyTrailingSlashOption(
58-
`/routes/remote-file-data-from-context/`,
58+
`/routes/ssg/remote-file-data-from-context/`,
5959
TRAILING_SLASH
6060
),
6161
component: path.resolve(`./src/templates/remote-file-from-context.jsx`),

‎e2e-tests/adapters/src/pages/index.jsx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import "./index.css"
77
const routes = [
88
{
99
text: "Static",
10-
url: "/routes/static",
10+
url: "/routes/ssg/static",
1111
id: "static-without-slash",
1212
},
1313
{
1414
text: "Static (With Slash)",
15-
url: "/routes/static/",
15+
url: "/routes/ssg/static/",
1616
id: "static-with-slash",
1717
},
1818
{
@@ -41,11 +41,11 @@ const routes = [
4141
},
4242
{
4343
text: "RemoteFile (ImageCDN and FileCDN) (SSG, Page Query)",
44-
url: "/routes/remote-file",
44+
url: "/routes/ssg/remote-file",
4545
},
4646
{
4747
text: "RemoteFile (ImageCDN and FileCDN) (SSG, Page Context)",
48-
url: "/routes/remote-file-data-from-context",
48+
url: "/routes/ssg/remote-file-data-from-context",
4949
},
5050
{
5151
text: "RemoteFile (ImageCDN and FileCDN) (SSR, Page Query)",

‎e2e-tests/adapters/src/pages/routes/remote-file.jsx‎ renamed to ‎e2e-tests/adapters/src/pages/routes/ssg/remote-file.jsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { graphql } from "gatsby"
22
import React from "react"
33

44
import { GatsbyImage } from "gatsby-plugin-image"
5-
import Layout from "../../components/layout"
5+
import Layout from "../../../components/layout"
66

77
const RemoteFile = ({ data }) => {
88
return (

‎e2e-tests/adapters/src/pages/routes/static.jsx‎ renamed to ‎e2e-tests/adapters/src/pages/routes/ssg/static.jsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import * as React from "react"
2-
import Layout from "../../components/layout"
2+
import Layout from "../../../components/layout"
33

44
const StaticPage = () => {
55
return (
@@ -11,4 +11,4 @@ const StaticPage = () => {
1111

1212
export default StaticPage
1313

14-
export const Head = () => <title>Static</title>
14+
export const Head = () => <title>Static</title>

‎packages/gatsby-adapter-netlify/src/route-handler.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -236,13 +236,13 @@ export function processRoutesManifest(
236236
_headers += buildHeaderString(route.path, route.headers)
237237
}
238238
}
239+
}
239240

240-
if (headerRoutes) {
241-
_headers = headerRoutes.reduce((acc, curr) => {
242-
acc += buildHeaderString(curr.path, curr.headers)
243-
return acc
244-
}, ``)
245-
}
241+
if (headerRoutes) {
242+
_headers = headerRoutes.reduce((acc, curr) => {
243+
acc += buildHeaderString(curr.path, curr.headers)
244+
return acc
245+
}, ``)
246246
}
247247

248248
return {

0 commit comments

Comments
 (0)