From 5c03a13b8e3fe36860286acbbe41ead53024a018 Mon Sep 17 00:00:00 2001 From: sagar Date: Fri, 25 Oct 2024 19:42:10 +0530 Subject: [PATCH] fix:Build the file name based on the timestamp and revert the old code. There's an issue where a hard refresh is needed after deployment. --- packages/student-app/craco.config.js | 11 +++ packages/teacher-app/src/bootstrap.js | 23 ++--- packages/teacher-app/src/service-worker.js | 85 ++++++++++------- .../src/serviceWorkerRegistration.js | 93 +++++++++++++------ 4 files changed, 135 insertions(+), 77 deletions(-) diff --git a/packages/student-app/craco.config.js b/packages/student-app/craco.config.js index 5c25484d..79777a39 100644 --- a/packages/student-app/craco.config.js +++ b/packages/student-app/craco.config.js @@ -1,5 +1,6 @@ const cracoModuleFederation = require("craco-module-federation"); const ExternalTemplateRemotesPlugin = require("external-remotes-plugin"); +const path = require("path"); module.exports = { devServer: { @@ -7,6 +8,16 @@ module.exports = { }, webpack: { plugins: [new ExternalTemplateRemotesPlugin()], + configure: (webpackConfig) => { + const timestamp = new Date().getTime(); + webpackConfig.output = { + ...webpackConfig.output, + filename: `static/js/[name].[hash]-${timestamp}.js`, + chunkFilename: `static/js/[name].[hash]-${timestamp}.chunk.js`, + path: path.resolve(__dirname, "build"), + }; + return webpackConfig; + }, }, plugins: [ { diff --git a/packages/teacher-app/src/bootstrap.js b/packages/teacher-app/src/bootstrap.js index 7930d7a0..5e5847c9 100644 --- a/packages/teacher-app/src/bootstrap.js +++ b/packages/teacher-app/src/bootstrap.js @@ -12,21 +12,12 @@ ReactDOM.render( document.getElementById("root") ); -// Register service worker -serviceWorkerRegistration.register({ - onUpdate: registration => { - // Notify user about new updates - if (window.confirm("New version available! Would you like to update?")) { - if (registration && registration.waiting) { - registration.waiting.postMessage({ type: "SKIP_WAITING" }); - registration.waiting.addEventListener("statechange", (e) => { - if (e.target.state === "activated") { - window.location.reload(); - } - }); - } - } - } -}); +// 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.unregister(); +// 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(); diff --git a/packages/teacher-app/src/service-worker.js b/packages/teacher-app/src/service-worker.js index 5389c5cb..a0d2c5e6 100644 --- a/packages/teacher-app/src/service-worker.js +++ b/packages/teacher-app/src/service-worker.js @@ -1,58 +1,73 @@ /* 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"; -// Import Workbox from CDN -importScripts("https://storage.googleapis.com/workbox-cdn/releases/6.1.5/workbox-sw.js"); - -// Claim clients immediately clientsClaim(); -// Listen for messages from the client to skip waiting -self.addEventListener("message", (event) => { - if (event.data && event.data.type === "SKIP_WAITING") { - self.skipWaiting(); - } -}); - -// Precache all of the assets generated by your build process +// 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); -// Use StaleWhileRevalidate strategy for navigation requests to ensure fresh content +// 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( - ({ request }) => request.mode === "navigate", - new StaleWhileRevalidate({ - cacheName: "pages-cache", - plugins: [ - new ExpirationPlugin({ maxEntries: 50 }), - ], - }) + // Return false to exempt requests from being fulfilled by index.html. + ({ request, 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") ); -// Use StaleWhileRevalidate strategy for images and other assets +// 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( - ({ request }) => request.destination === "image", + // 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-cache", + cacheName: "images", plugins: [ + // Ensure that once this runtime cache reaches a maximum size the + // least-recently used images are removed. new ExpirationPlugin({ maxEntries: 50 }), ], }) ); -// Do not cache API calls, they should always go to the network -// No route registered for API calls +// 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(); + } +}); -// Fallback for other requests -registerRoute( - ({ request }) => request.destination !== "image" && request.mode !== "navigate" && !request.url.includes('/mw/'), - new StaleWhileRevalidate({ - cacheName: "default-cache", - plugins: [ - new ExpirationPlugin({ maxEntries: 50 }), - ], - }) -); +// Any other custom service worker logic can go here. diff --git a/packages/teacher-app/src/serviceWorkerRegistration.js b/packages/teacher-app/src/serviceWorkerRegistration.js index 23552d84..fd0e8c5a 100644 --- a/packages/teacher-app/src/serviceWorkerRegistration.js +++ b/packages/teacher-app/src/serviceWorkerRegistration.js @@ -1,30 +1,53 @@ +// This optional code is used to register a service worker. +// register() is not called by default. + +// This lets the app load faster on subsequent visits in production, and gives +// it offline capabilities. However, it also means that developers (and users) +// will only see deployed updates on subsequent visits to a page, after all the +// existing tabs open on the page have been closed, since previously cached +// resources are updated in the background. + +// To learn more about the benefits of this model and instructions on how to +// opt-in, read https://cra.link/PWA + const isLocalhost = Boolean( - window.location.hostname === 'localhost' || - window.location.hostname === '[::1]' || - window.location.hostname.match( - /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ - ) + window.location.hostname === "localhost" || + // [::1] is the IPv6 localhost address. + window.location.hostname === "[::1]" || + // 127.0.0.0/8 are considered localhost for IPv4. + window.location.hostname.match( + /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ + ) ); export function register(config) { - if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { + if (process.env.NODE_ENV === "production" && "serviceWorker" in navigator) { + // The URL constructor is available in all browsers that support SW. const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href); if (publicUrl.origin !== window.location.origin) { + // Our service worker won't work if PUBLIC_URL is on a different origin + // from what our page is served on. This might happen if a CDN is used to + // serve assets; see https://github.com/facebook/create-react-app/issues/2374 return; } - window.addEventListener('load', () => { + window.addEventListener("load", () => { const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; if (isLocalhost) { + // This is running on localhost. Let's check if a service worker still exists or not. checkValidServiceWorker(swUrl, config); + + // Add some additional logging to localhost, pointing developers to the + // service worker/PWA documentation. navigator.serviceWorker.ready.then(() => { console.log( - 'This web app is being served cache-first by a service worker. ' + - 'To learn more, visit https://cra.link/PWA' + "This web app is being served cache-first by a service " + + "worker. To learn more, visit https://cra.link/PWA" ); }); } else { + // Is not localhost. Just register service worker registerValidSW(swUrl, config); } }); @@ -34,26 +57,34 @@ export function register(config) { function registerValidSW(swUrl, config) { navigator.serviceWorker .register(swUrl) - .then(registration => { + .then((registration) => { registration.onupdatefound = () => { const installingWorker = registration.installing; if (installingWorker == null) { return; } installingWorker.onstatechange = () => { - if (installingWorker.state === 'installed') { + if (installingWorker.state === "installed") { if (navigator.serviceWorker.controller) { + // At this point, the updated precached content has been fetched, + // but the previous service worker will still serve the older + // content until all client tabs are closed. console.log( - 'New content is available and will be used when all ' + - 'tabs for this page are closed. See https://cra.link/PWA.' + "New content is available and will be used when all " + + "tabs for this page are closed. See https://cra.link/PWA." ); + // Execute callback if (config && config.onUpdate) { config.onUpdate(registration); } } else { - console.log('Content is cached for offline use.'); + // At this point, everything has been precached. + // It's the perfect time to display a + // "Content is cached for offline use." message. + console.log("Content is cached for offline use."); + // Execute callback if (config && config.onSuccess) { config.onSuccess(registration); } @@ -62,39 +93,49 @@ function registerValidSW(swUrl, config) { }; }; }) - .catch(error => { - console.error('Error during service worker registration:', error); + .catch((error) => { + console.error("Error during service worker registration:", error); }); } function checkValidServiceWorker(swUrl, config) { - fetch(swUrl) - .then(response => { - const contentType = response.headers.get('content-type'); + // Check if the service worker can be found. If it can't reload the page. + fetch(swUrl, { + headers: { "Service-Worker": "script" }, + }) + .then((response) => { + // Ensure service worker exists, and that we really are getting a JS file. + const contentType = response.headers.get("content-type"); if ( response.status === 404 || - (contentType != null && contentType.indexOf('javascript') === -1) + (contentType != null && contentType.indexOf("javascript") === -1) ) { - navigator.serviceWorker.ready.then(registration => { + // No service worker found. Probably a different app. Reload the page. + navigator.serviceWorker.ready.then((registration) => { registration.unregister().then(() => { window.location.reload(); }); }); } else { + // Service worker found. Proceed as normal. registerValidSW(swUrl, config); } }) .catch(() => { console.log( - 'No internet connection found. App is running in offline mode.' + "No internet connection found. App is running in offline mode." ); }); } export function unregister() { - if ('serviceWorker' in navigator) { - navigator.serviceWorker.ready.then(registration => { - registration.unregister(); - }); + if ("serviceWorker" in navigator) { + navigator.serviceWorker.ready + .then((registration) => { + registration.unregister(); + }) + .catch((error) => { + console.error(error.message); + }); } }