Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(gatsby): add history fallback for client-only routes #11610

Merged
merged 8 commits into from
Feb 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion packages/gatsby/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@
"eslint-plugin-react": "^7.8.2",
"express": "^4.16.3",
"express-graphql": "^0.6.12",
"express-history-api-fallback": "^2.2.1",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bye felicia

"fast-levenshtein": "~2.0.4",
"file-loader": "^1.1.11",
"flat": "^4.0.0",
Expand Down
40 changes: 32 additions & 8 deletions packages/gatsby/src/commands/serve.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,39 @@
/* @flow weak */
const path = require(`path`)
const openurl = require(`better-opn`)
const fs = require(`fs-extra`)
const signalExit = require(`signal-exit`)
const compression = require(`compression`)
const express = require(`express`)
const historyFallback = require(`express-history-api-fallback`)
const getConfigFile = require(`../bootstrap/get-config-file`)
const preferDefault = require(`../bootstrap/prefer-default`)
const chalk = require(`chalk`)
const { match: reachMatch } = require(`@reach/router/lib/utils`)

const getPages = directory =>
fs
.readFile(path.join(directory, `.cache`, `pages.json`))
.then(contents => JSON.parse(contents))
.catch(() => [])

const clientOnlyPathsRouter = (pages, options) => {
const clientOnlyRoutes = pages
.filter(page => page.matchPath)
.map(page => page.matchPath)
return (req, res, next) => {
const { url } = req
if (req.accepts(`html`)) {
if (clientOnlyRoutes.some(route => reachMatch(route, url) !== null)) {
return res.sendFile(`index.html`, options, err => {
pieh marked this conversation as resolved.
Show resolved Hide resolved
if (err) {
next()
}
})
}
}
return next()
}
}

module.exports = async program => {
let { prefixPaths, port, open, host } = program
Expand All @@ -21,18 +47,18 @@ module.exports = async program => {
pathPrefix = prefixPaths && pathPrefix ? pathPrefix : `/`

const root = path.join(program.directory, `public`)
const pages = await getPages(program.directory)

const app = express()
const router = express.Router()
router.use(compression())
router.use(express.static(`public`))
router.use(historyFallback(`index.html`, { root }))
router.use(clientOnlyPathsRouter(pages, { root }))
router.use((req, res, next) => {
if (req.accepts(`html`)) {
res.status(404).sendFile(`404.html`, { root })
} else {
next()
return res.status(404).sendFile(`404.html`, { root })
}
return next()
})
app.use(pathPrefix, router)

Expand All @@ -55,7 +81,5 @@ module.exports = async program => {
}
})

signalExit((code, signal) => {
server.close()
})
signalExit(() => server.close())
}
5 changes: 0 additions & 5 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7597,11 +7597,6 @@ express-graphql@^0.6.12:
http-errors "^1.3.0"
raw-body "^2.3.2"

express-history-api-fallback@^2.2.1:
version "2.2.1"
resolved "https://registry.yarnpkg.com/express-history-api-fallback/-/express-history-api-fallback-2.2.1.tgz#3a2ad27f7bebc90fc533d110d7c6d83097bcd057"
integrity sha1-OirSf3vryQ/FM9EQ18bYMJe80Fc=

express@^4.16.2, express@^4.16.3:
version "4.16.3"
resolved "http://registry.npmjs.org/express/-/express-4.16.3.tgz#6af8a502350db3246ecc4becf6b5a34d22f7ed53"
Expand Down