Skip to content

Commit

Permalink
Fix service worker
Browse files Browse the repository at this point in the history
CRA v4 moved the service worker out of the core and into a template.
Incorporate the template into the app.

facebook/create-react-app#9776
  • Loading branch information
kfarnung committed Feb 3, 2021
1 parent 00cb94a commit 2314661
Show file tree
Hide file tree
Showing 7 changed files with 202 additions and 83 deletions.
47 changes: 26 additions & 21 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 10 additions & 4 deletions package.json
Expand Up @@ -6,11 +6,11 @@
"dependencies": {
"@reduxjs/toolkit": "^1.5.0",
"@testing-library/jest-dom": "^5.11.9",
"@testing-library/react": "^11.1.0",
"@testing-library/user-event": "^12.6.2",
"@testing-library/react": "^11.2.5",
"@testing-library/user-event": "^12.6.3",
"@types/jest": "^26.0.19",
"@types/node": "^14.14.22",
"@types/react": "^17.0.0",
"@types/react": "^17.0.1",
"@types/react-document-title": "^2.0.4",
"@types/react-dom": "^17.0.0",
"@types/react-loadable": "^5.5.4",
Expand All @@ -36,7 +36,13 @@
"react-scripts": "^4.0.1",
"redux": "^4.0.5",
"redux-persist": "^6.0.0",
"typescript": "^4.1.3"
"typescript": "^4.1.3",
"web-vitals": "^0.2.4",
"workbox-core": "^5.1.3",
"workbox-expiration": "^5.1.3",
"workbox-precaching": "^5.1.3",
"workbox-routing": "^5.1.3",
"workbox-strategies": "^5.1.3"
},
"scripts": {
"build": "react-scripts build",
Expand Down
2 changes: 1 addition & 1 deletion public/manifest.json
Expand Up @@ -22,7 +22,7 @@
"purpose": "maskable"
}
],
"start_url": "./",
"start_url": ".",
"display": "standalone",
"theme_color": "#000000",
"background_color": "#ffffff"
Expand Down
52 changes: 33 additions & 19 deletions src/index.tsx
@@ -1,25 +1,39 @@
import { createBrowserHistory } from 'history';
import ReactDOM from 'react-dom';
import { PersistGate } from 'redux-persist/integration/react'
import { Provider } from 'react-redux';
import { Router } from 'react-router-dom';
import App from './App';
import * as serviceWorker from './serviceWorker';
import configureStore from './Store/configureStore';
import './index.scss';
import { createBrowserHistory } from "history";
import React from "react";
import ReactDOM from "react-dom";
import { PersistGate } from "redux-persist/integration/react";
import { Provider } from "react-redux";
import { Router } from "react-router-dom";
import App from "./App";
import * as serviceWorkerRegistration from "./serviceWorkerRegistration";
import reportWebVitals from "./reportWebVitals";
import configureStore from "./Store/configureStore";
import "./index.scss";

const baseUrl = document.getElementsByTagName('base')[0].getAttribute('href') || '';
const baseUrl =
document.getElementsByTagName("base")[0].getAttribute("href") || "";
const history = createBrowserHistory({ basename: baseUrl });
const { store, persistor } = configureStore();

ReactDOM.render(
<Provider store={store}>
<PersistGate persistor={persistor}>
<Router history={history}>
<App />
</Router>
</PersistGate>
</Provider>,
document.getElementById('root'));
<React.StrictMode>
<Provider store={store}>
<PersistGate persistor={persistor}>
<Router history={history}>
<App />
</Router>
</PersistGate>
</Provider>
</React.StrictMode>,
document.getElementById("root")
);

serviceWorker.register();
// If you want your app to work offline and load faster, you can change
// unregister() to register() below. Note this comes with some pitfalls.
// Learn more about service workers: https://cra.link/PWA
serviceWorkerRegistration.register();

// If you want to start measuring performance in your app, pass a function
// to log results (for example: reportWebVitals(console.log))
// or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals
reportWebVitals();
15 changes: 15 additions & 0 deletions src/reportWebVitals.ts
@@ -0,0 +1,15 @@
import { ReportHandler } from "web-vitals";

const reportWebVitals = (onPerfEntry?: ReportHandler) => {
if (onPerfEntry && onPerfEntry instanceof Function) {
import("web-vitals").then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
getCLS(onPerfEntry);
getFID(onPerfEntry);
getFCP(onPerfEntry);
getLCP(onPerfEntry);
getTTFB(onPerfEntry);
});
}
};

export default reportWebVitals;
81 changes: 81 additions & 0 deletions src/service-worker.ts
@@ -0,0 +1,81 @@
/// <reference lib="webworker" />
/* eslint-disable no-restricted-globals */

// This service worker can be customized!
// See https://developers.google.com/web/tools/workbox/modules
// for the list of available Workbox modules, or add any other
// code you'd like.
// You can also remove this file if you'd prefer not to use a
// service worker, and the Workbox build step will be skipped.

import { clientsClaim } from "workbox-core";
import { ExpirationPlugin } from "workbox-expiration";
import { precacheAndRoute, createHandlerBoundToURL } from "workbox-precaching";
import { registerRoute } from "workbox-routing";
import { StaleWhileRevalidate } from "workbox-strategies";

declare const self: ServiceWorkerGlobalScope;

clientsClaim();

// Precache all of the assets generated by your build process.
// Their URLs are injected into the manifest variable below.
// This variable must be present somewhere in your service worker file,
// even if you decide not to use precaching. See https://cra.link/PWA
precacheAndRoute(self.__WB_MANIFEST);

// Set up App Shell-style routing, so that all navigation requests
// are fulfilled with your index.html shell. Learn more at
// https://developers.google.com/web/fundamentals/architecture/app-shell
const fileExtensionRegexp = new RegExp("/[^/?]+\\.[^/]+$");
registerRoute(
// Return false to exempt requests from being fulfilled by index.html.
({ request, url }: { request: Request; url: URL }) => {
// If this isn't a navigation, skip.
if (request.mode !== "navigate") {
return false;
}

// If this is a URL that starts with /_, skip.
if (url.pathname.startsWith("/_")) {
return false;
}

// If this looks like a URL for a resource, because it contains
// a file extension, skip.
if (url.pathname.match(fileExtensionRegexp)) {
return false;
}

// Return true to signal that we want to use the handler.
return true;
},
createHandlerBoundToURL(process.env.PUBLIC_URL + "/index.html")
);

// An example runtime caching route for requests that aren't handled by the
// precache, in this case same-origin .png requests like those from in public/
registerRoute(
// Add in any other file extensions or routing criteria as needed.
({ url }) =>
url.origin === self.location.origin && url.pathname.endsWith(".png"),
// Customize this strategy as needed, e.g., by changing to CacheFirst.
new StaleWhileRevalidate({
cacheName: "images",
plugins: [
// Ensure that once this runtime cache reaches a maximum size the
// least-recently used images are removed.
new ExpirationPlugin({ maxEntries: 50 }),
],
})
);

// This allows the web app to trigger skipWaiting via
// registration.waiting.postMessage({type: 'SKIP_WAITING'})
self.addEventListener("message", (event) => {
if (event.data && event.data.type === "SKIP_WAITING") {
self.skipWaiting();
}
});

// Any other custom service worker logic can go here.

0 comments on commit 2314661

Please sign in to comment.