From 11e676cee0611d1d710a7c573c70184c9babc182 Mon Sep 17 00:00:00 2001 From: Michael Telatynski <7t3chguy@gmail.com> Date: Wed, 30 Sep 2020 17:35:12 +0100 Subject: [PATCH 1/2] Disable workbox when running in webpack dev server, not in dev mode Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --- src/vector/platform/WebPlatform.ts | 15 +++++++++++---- webpack.config.js | 6 +++++- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/src/vector/platform/WebPlatform.ts b/src/vector/platform/WebPlatform.ts index 0a82b28e3c..3f93ad712e 100644 --- a/src/vector/platform/WebPlatform.ts +++ b/src/vector/platform/WebPlatform.ts @@ -38,13 +38,20 @@ export default class WebPlatform extends VectorBasePlatform { super(); // load service worker if available on this platform - // Service worker is disabled in development: https://github.com/GoogleChrome/workbox/issues/1790 - if ('serviceWorker' in navigator && process.env.NODE_ENV === "production") { - navigator.serviceWorker.register('service-worker.js'); + if ('serviceWorker' in navigator) { + // clean up old dummy sw.js + navigator.serviceWorker.getRegistration('sw.js').then(reg => reg.unregister()); + + // Service worker is disabled in webpack-dev-server: https://github.com/GoogleChrome/workbox/issues/1790 + if (!process.env.WEBPACK_DEV_SERVER) { + navigator.serviceWorker.register('service-worker.js'); + } else { + // we no longer run workbox when in webpack-dev-server, clean it up + navigator.serviceWorker.getRegistration('service-worker.js').then(reg => reg.unregister()); + } } } - getHumanReadableName(): string { return 'Web Platform'; // no translation required: only used for analytics } diff --git a/webpack.config.js b/webpack.config.js index 1b59d87406..a3a8af31c5 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -1,4 +1,5 @@ const path = require('path'); +const {EnvironmentPlugin} = require('webpack'); const HtmlWebpackPlugin = require('html-webpack-plugin'); const MiniCssExtractPlugin = require('mini-css-extract-plugin'); const TerserPlugin = require('terser-webpack-plugin'); @@ -32,6 +33,8 @@ module.exports = (env, argv) => { const jsSdkSrcDir = path.resolve(require.resolve("matrix-js-sdk/package.json"), '..', 'src'); const plugins = [ + new EnvironmentPlugin(["WEBPACK_DEV_SERVER"]), // pass this as it is used for conditionally loading workbox + // This exports our CSS using the splitChunks and loaders above. new MiniCssExtractPlugin({ filename: 'bundles/[hash]/[name].css', @@ -92,7 +95,8 @@ module.exports = (env, argv) => { }), ]; - if (argv.mode === "production") { + const isDevServer = process.env.WEBPACK_DEV_SERVER; + if (!isDevServer) { plugins.push(new WorkboxPlugin.GenerateSW({ maximumFileSizeToCacheInBytes: 22000000, runtimeCaching: [{ From aa2f3918cc5ef62ca21a6d18c9fae11eec4879da Mon Sep 17 00:00:00 2001 From: Michael Telatynski <7t3chguy@gmail.com> Date: Wed, 30 Sep 2020 17:36:57 +0100 Subject: [PATCH 2/2] consolidate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --- src/vector/platform/WebPlatform.ts | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/vector/platform/WebPlatform.ts b/src/vector/platform/WebPlatform.ts index 3f93ad712e..d91bb2593e 100644 --- a/src/vector/platform/WebPlatform.ts +++ b/src/vector/platform/WebPlatform.ts @@ -39,15 +39,12 @@ export default class WebPlatform extends VectorBasePlatform { // load service worker if available on this platform if ('serviceWorker' in navigator) { - // clean up old dummy sw.js - navigator.serviceWorker.getRegistration('sw.js').then(reg => reg.unregister()); - // Service worker is disabled in webpack-dev-server: https://github.com/GoogleChrome/workbox/issues/1790 if (!process.env.WEBPACK_DEV_SERVER) { navigator.serviceWorker.register('service-worker.js'); } else { // we no longer run workbox when in webpack-dev-server, clean it up - navigator.serviceWorker.getRegistration('service-worker.js').then(reg => reg.unregister()); + navigator.serviceWorker.getRegistration().then(reg => reg && reg.unregister()); } } }