diff --git a/index.html b/index.html index 15ca56a2..30a474de 100644 --- a/index.html +++ b/index.html @@ -8,36 +8,12 @@ - - - plebchan
- diff --git a/src/index.tsx b/src/index.tsx index 6e0e1d0f..e759955a 100644 --- a/src/index.tsx +++ b/src/index.tsx @@ -7,7 +7,6 @@ import './lib/init-translations'; import './index.css'; import './themes.css'; import { App as CapacitorApp } from '@capacitor/app'; -import * as serviceWorkerRegistration from './service-worker-registration'; const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement); root.render( @@ -18,9 +17,6 @@ root.render( , ); -// set up PWA https://cra.link/PWA -serviceWorkerRegistration.register(); - // add back button in android app CapacitorApp.addListener('backButton', ({ canGoBack }) => { if (canGoBack) { diff --git a/src/service-worker-registration.js b/src/service-worker-registration.js deleted file mode 100644 index adec605e..00000000 --- a/src/service-worker-registration.js +++ /dev/null @@ -1,128 +0,0 @@ -// 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' || - // [::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) { - // 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', () => { - 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'); - }); - } else { - // Is not localhost. Just register service worker - registerValidSW(swUrl, config); - } - }); - } -} - -function registerValidSW(swUrl, config) { - navigator.serviceWorker - .register(swUrl) - .then((registration) => { - registration.onupdatefound = () => { - const installingWorker = registration.installing; - if (installingWorker == null) { - return; - } - installingWorker.onstatechange = () => { - 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.'); - - // Execute callback - if (config && config.onUpdate) { - config.onUpdate(registration); - } - } else { - // 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); - } - } - } - }; - }; - }) - .catch((error) => { - console.error('Error during service worker registration:', error); - }); -} - -function checkValidServiceWorker(swUrl, config) { - // 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)) { - // 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.'); - }); -} - -export function unregister() { - if ('serviceWorker' in navigator) { - navigator.serviceWorker.ready - .then((registration) => { - registration.unregister(); - }) - .catch((error) => { - console.error(error.message); - }); - } -} diff --git a/src/service-worker.js b/src/service-worker.js deleted file mode 100644 index ee05a7a6..00000000 --- a/src/service-worker.js +++ /dev/null @@ -1,80 +0,0 @@ -/* 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'; - -clientsClaim(); - -// fix index.html not refreshing on new plebbit-react versions -registerRoute( - // match index.html - ({ url }) => url.pathname === '/', - // serve cached index.html first but revalidate in background - new StaleWhileRevalidate(), -); - -// 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 }) => { - // 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. diff --git a/vite.config.js b/vite.config.js index 17bdbb85..c5f0881b 100644 --- a/vite.config.js +++ b/vite.config.js @@ -3,6 +3,7 @@ import react from '@vitejs/plugin-react'; import { resolve } from 'path'; import { nodePolyfills } from 'vite-plugin-node-polyfills'; import eslint from 'vite-plugin-eslint'; +import { VitePWA } from 'vite-plugin-pwa'; const isProduction = process.env.NODE_ENV === 'production'; @@ -33,6 +34,107 @@ export default defineConfig({ protocolImports: true, include: ['crypto', 'stream', 'util', 'buffer', 'events'], }), + VitePWA({ + registerType: 'autoUpdate', + includeAssets: ['favicon.ico', 'robots.txt', 'apple-touch-icon.png'], + manifest: { + name: 'Seedit', + short_name: 'Seedit', + description: 'A GUI for plebbit similar to old.reddit', + theme_color: '#ffffff', + background_color: '#ffffee', + display: 'standalone', + icons: [ + { + src: '/android-chrome-192x192.png', + sizes: '192x192', + type: 'image/png' + }, + { + src: '/android-chrome-512x512.png', + sizes: '512x512', + type: 'image/png' + }, + { + src: '/android-chrome-512x512.png', + sizes: '512x512', + type: 'image/png', + purpose: 'any maskable' + } + ] + }, + workbox: { + clientsClaim: true, + skipWaiting: true, + cleanupOutdatedCaches: true, + + navigateFallback: 'index.html', + navigateFallbackDenylist: [/^\/api/, /^\/_(.*)/], + + runtimeCaching: [ + // Fix index.html not refreshing on new versions + { + urlPattern: ({ url }) => url.pathname === '/' || url.pathname === '/index.html', + handler: 'StaleWhileRevalidate', + options: { + cacheName: 'html-cache' + } + }, + // PNG caching + { + urlPattern: ({ url }) => url.pathname.endsWith('.png'), + handler: 'StaleWhileRevalidate', + options: { + cacheName: 'images', + expiration: { + maxEntries: 50 + } + } + }, + // Add additional asset caching + { + urlPattern: /\.(?:js|css|woff2?|svg|gif|jpg|jpeg)$/, + handler: 'StaleWhileRevalidate', + options: { + cacheName: 'assets-cache', + expiration: { + maxEntries: 100, + maxAgeSeconds: 60 * 60 * 24 * 30 // 30 days + } + } + }, + // Google Fonts caching + { + urlPattern: /^https:\/\/fonts\.googleapis\.com\/.*/i, + handler: 'CacheFirst', + options: { + cacheName: 'google-fonts-cache', + expiration: { + maxEntries: 10, + maxAgeSeconds: 60 * 60 * 24 * 365 // 365 days + }, + cacheableResponse: { + statuses: [0, 200] + } + } + }, + { + urlPattern: /^https:\/\/fonts\.gstatic\.com\/.*/i, + handler: 'CacheFirst', + options: { + cacheName: 'google-fonts-webfonts', + expiration: { + maxEntries: 30, + maxAgeSeconds: 60 * 60 * 24 * 365 // 365 days + }, + cacheableResponse: { + statuses: [0, 200] + } + } + } + ] + } + }), ], resolve: { alias: {