From 5e4a9fc2a5dce70ca0d3c987f76718f09b069a3b Mon Sep 17 00:00:00 2001 From: Jeffrey Posnick Date: Tue, 9 Jan 2018 21:08:39 -0500 Subject: [PATCH] Remove the navigateFallback behavior from the generated service worker (#3419) * Disables navigateFallback and updates the README * Typos * Updated a URL in a comment. --- .../config/webpack.config.prod.js | 9 ++-- packages/react-scripts/template/README.md | 47 ++++++++++++++----- 2 files changed, 39 insertions(+), 17 deletions(-) diff --git a/packages/react-scripts/config/webpack.config.prod.js b/packages/react-scripts/config/webpack.config.prod.js index d3673a723b5..dea5b99eac6 100644 --- a/packages/react-scripts/config/webpack.config.prod.js +++ b/packages/react-scripts/config/webpack.config.prod.js @@ -344,13 +344,12 @@ module.exports = { console.log(message); }, minify: true, - // For unknown URLs, fallback to the index page - navigateFallback: publicUrl + '/index.html', - // Ignores URLs starting from /__ (useful for Firebase): - // https://github.com/facebookincubator/create-react-app/issues/2237#issuecomment-302693219 - navigateFallbackWhitelist: [/^(?!\/__).*/], // Don't precache sourcemaps (they're large) and build asset manifest: staticFileGlobsIgnorePatterns: [/\.map$/, /asset-manifest\.json$/], + // `navigateFallback` and `navigateFallbackWhitelist` are disabled by default; see + // https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#service-worker-considerations + // navigateFallback: publicUrl + '/index.html', + // navigateFallbackWhitelist: [/^(?!\/__).*/], }), // Moment.js is an extremely popular library that bundles large locale files // by default due to how Webpack interprets its code. This is a practical diff --git a/packages/react-scripts/template/README.md b/packages/react-scripts/template/README.md index e5c0cf6bf77..647e116a530 100644 --- a/packages/react-scripts/template/README.md +++ b/packages/react-scripts/template/README.md @@ -83,6 +83,7 @@ You can find the most recent version of this guide [here](https://github.com/fac - [Static Server](#static-server) - [Other Solutions](#other-solutions) - [Serving Apps with Client-Side Routing](#serving-apps-with-client-side-routing) + - [Service Worker Considerations](#service-worker-considerations) - [Building for Relative Paths](#building-for-relative-paths) - [Azure](#azure) - [Firebase](#firebase) @@ -1788,8 +1789,14 @@ is integrated into production configuration, and it will take care of generating a service worker file that will automatically precache all of your local assets and keep them up to date as you deploy updates. The service worker will use a [cache-first strategy](https://developers.google.com/web/fundamentals/instant-and-offline/offline-cookbook/#cache-falling-back-to-network) -for handling all requests for local assets, including the initial HTML, ensuring -that your web app is reliably fast, even on a slow or unreliable network. +for handling all requests for local assets, including +[navigation requests](https://developers.google.com/web/fundamentals/primers/service-workers/high-performance-loading#first_what_are_navigation_requests) +for `/` and `/index.html`, ensuring that your web app is consistently fast, even +on a slow or unreliable network. + +>Note: If you are using the `pushState` history API and want to enable +cache-first navigations for URLs other than `/` and `/index.html`, please +[follow these steps](#service-worker-considerations). ### Opting Out of Caching @@ -1992,21 +1999,37 @@ If you’re using [Apache Tomcat](http://tomcat.apache.org/), you need to follow Now requests to `/todos/42` will be handled correctly both in development and in production. -On a production build, and in a browser that supports [service workers](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers), -the service worker will automatically handle all navigation requests, like for -`/todos/42`, by serving the cached copy of your `index.html`. This -service worker navigation routing can be configured or disabled by -[`eject`ing](#npm-run-eject) and then modifying the -[`navigateFallback`](https://github.com/GoogleChrome/sw-precache#navigatefallback-string) -and [`navigateFallbackWhitelist`](https://github.com/GoogleChrome/sw-precache#navigatefallbackwhitelist-arrayregexp) -options of the `SWPreachePlugin` [configuration](../config/webpack.config.prod.js). - -When users install your app to the homescreen of their device the default configuration will make a shortcut to `/index.html`. This may not work for client-side routers which expect the app to be served from `/`. Edit the web app manifest at [`public/manifest.json`](public/manifest.json) and change `start_url` to match the required URL scheme, for example: +When users install your app to the homescreen of their device the default +configuration will make a shortcut to `/index.html`. This may not work for +client-side routers which expect the app to be served from `/`. Edit the web app +manifest at [`public/manifest.json`](public/manifest.json) and change +`start_url` to match the required URL scheme, for example: ```js "start_url": ".", ``` +### Service Worker Considerations + +[Navigation requests](https://developers.google.com/web/fundamentals/primers/service-workers/high-performance-loading#first_what_are_navigation_requests) +for URLs like `/todos/42` will not be intercepted by the +[service worker](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers) +created by the production build. Navigations for those URLs will always +require a network connection, as opposed to navigations for `/` and +`/index.html`, both of which will be served from the cache by the service worker +and work without requiring a network connection. + +If you are using the `pushState` history API and would like to enable service +worker support for navigations to URLs like `/todos/42`, you need to +[`npm eject`](#npm-run-eject) and enable the +[`navigateFallback`](https://github.com/GoogleChrome/sw-precache#navigatefallback-string) +and [`navigateFallbackWhitelist`](https://github.com/GoogleChrome/sw-precache#navigatefallbackwhitelist-arrayregexp) +options of the `SWPreachePlugin` [configuration](../config/webpack.config.prod.js). + +>Note: This is a [change in default behavior](https://github.com/facebookincubator/create-react-app/issues/3248), +as earlier versions of `create-react-app` shipping with `navigateFallback` +enabled by default. + ### Building for Relative Paths By default, Create React App produces a build assuming your app is hosted at the server root.