Add ServiceWorker.updateViaCache and ServiceWorker.forceInstall options

NekR · Apr 8, 2018 · 39acf1f · 39acf1f
1 parent be4d744
commit 39acf1f
Show file tree

Hide file tree

Showing 29 changed files with 193 additions and 114 deletions.
diff --git a/lib/app-cache.js b/lib/app-cache.js
@@ -141,7 +141,7 @@ var AppCache = (function () {
   }, {
     key: 'getPageTemplate',
     value: function getPageTemplate(name, content) {
-      return ('\n      <!doctype html>\n      <html manifest="' + name + '.appcache">' + (content || '') + '</html>\n    ').trim().replace(/^      */gm, '');
+      return ('\n      <!doctype html>\n      <html manifest="' + name + '.appcache"><meta charset="utf-8">' + (content || '') + '</html>\n    ').trim().replace(/^      */gm, '');
     }
   }, {
     key: 'getPageContent',

diff --git a/lib/default-options.js b/lib/default-options.js
@@ -12,6 +12,9 @@ var _path2 = _interopRequireDefault(_path);
 
 var _miscUtils = require('./misc/utils');
 
+var DEFAULT_AUTO_UPDATE_INTERVAL = 3600000;
+
+exports.DEFAULT_AUTO_UPDATE_INTERVAL = DEFAULT_AUTO_UPDATE_INTERVAL;
 var AppCacheOptions = {
   NETWORK: '*',
   FALLBACK: null,
@@ -53,6 +56,9 @@ exports['default'] = {
     scope: null,
     events: false,
     minify: null,
+    forceInstall: false,
+
+    updateViaCache: 'imports',
 
     prefetchRequest: {
       credentials: 'same-origin',

diff --git a/lib/index.js b/lib/index.js
@@ -52,8 +52,6 @@ var _require = require('../package.json');
 
 var pluginVersion = _require.version;
 
-var AUTO_UPDATE_INTERVAL = 3600000;
-
 var hasOwn = ({}).hasOwnProperty;
 var updateStrategies = ['all', 'hash', 'changed'];
 
@@ -98,7 +96,7 @@ var OfflinePlugin = (function () {
     var autoUpdate = this.options.autoUpdate;
 
     if (autoUpdate === true) {
-      this.autoUpdate = AUTO_UPDATE_INTERVAL;
+      this.autoUpdate = _defaultOptions.DEFAULT_AUTO_UPDATE_INTERVAL;
     } else if (typeof autoUpdate === 'number' && autoUpdate) {
       this.autoUpdate = autoUpdate;
     }

diff --git a/lib/service-worker.js b/lib/service-worker.js
@@ -51,7 +51,9 @@ var ServiceWorker = (function () {
     this.navigateFallbackURL = options.navigateFallbackURL;
     this.navigateFallbackForRedirects = options.navigateFallbackForRedirects;
     this.prefetchRequest = this.validatePrefetch(options.prefetchRequest);
+    this.updateViaCache = (options.updateViaCache || '') + '';
     this.navigationPreload = options.navigationPreload;
+    this.forceInstall = !!options.forceInstall;
 
     var cacheNameQualifier = '';
 
@@ -251,7 +253,9 @@ var ServiceWorker = (function () {
       return {
         location: this.location,
         scope: this.scope,
-        events: this.events
+        updateViaCache: this.updateViaCache,
+        events: this.events,
+        force: this.forceInstall
       };
     }
   }, {

diff --git a/src/default-options.js b/src/default-options.js
@@ -1,6 +1,8 @@
 import path from 'path';
 import { isAbsoluteURL } from './misc/utils';
 
+export const DEFAULT_AUTO_UPDATE_INTERVAL = 3600000;
+
 export const AppCacheOptions = {
   NETWORK: '*',
   FALLBACK: null,
@@ -41,6 +43,9 @@ export default {
     scope: null,
     events: false,
     minify: null,
+    forceInstall: false,
+
+    updateViaCache: 'imports',
 
     prefetchRequest: {
       credentials: 'same-origin',

diff --git a/src/index.js b/src/index.js
@@ -1,7 +1,10 @@
 import AppCache from './app-cache';
 import ServiceWorker from './service-worker';
 import defaultOptions,
-  { AppCacheOptions as defaultAppCacheOptions } from './default-options';
+  {
+    AppCacheOptions as defaultAppCacheOptions,
+    DEFAULT_AUTO_UPDATE_INTERVAL
+  } from './default-options';
 
 import {
   hasMagic, interpolateString,
@@ -17,7 +20,6 @@ import loaderUtils from 'loader-utils';
 import slash from 'slash';
 
 const { version: pluginVersion } = require('../package.json');
-const AUTO_UPDATE_INTERVAL = 3600000;
 
 const hasOwn = {}.hasOwnProperty;
 const updateStrategies = ['all', 'hash', 'changed'];
@@ -59,7 +61,7 @@ export default class OfflinePlugin {
     const autoUpdate = this.options.autoUpdate;
 
     if (autoUpdate === true) {
-      this.autoUpdate = AUTO_UPDATE_INTERVAL;
+      this.autoUpdate = DEFAULT_AUTO_UPDATE_INTERVAL;
     } else if (typeof autoUpdate === 'number' && autoUpdate) {
       this.autoUpdate = autoUpdate;
     }

diff --git a/src/service-worker.js b/src/service-worker.js
@@ -31,7 +31,9 @@ export default class ServiceWorker {
     this.navigateFallbackURL = options.navigateFallbackURL;
     this.navigateFallbackForRedirects = options.navigateFallbackForRedirects;
     this.prefetchRequest = this.validatePrefetch(options.prefetchRequest);
+    this.updateViaCache = (options.updateViaCache || '') + '';
     this.navigationPreload = options.navigationPreload;
+    this.forceInstall = !!options.forceInstall;
 
     let cacheNameQualifier = '';
 
@@ -234,7 +236,9 @@ export default class ServiceWorker {
     return {
       location: this.location,
       scope: this.scope,
-      events: this.events
+      updateViaCache: this.updateViaCache,
+      events: this.events,
+      force: this.forceInstall
     };
   }
 

diff --git a/tests/legacy/compare.js b/tests/legacy/compare.js
@@ -10,7 +10,7 @@ var log = console.log;
 
 var options = {
   compareContent: true,
-  excludeFilter: '.DS_Store'
+  excludeFilter: '.DS_Store,manifest.html'
 };
 
 function logFile(file, state) {

diff --git a/tests/legacy/fixtures/basic-with-custom-time-update-service/__expected/webpack2/main.js b/tests/legacy/fixtures/basic-with-custom-time-update-service/__expected/webpack2/main.js
@@ -73,11 +73,13 @@
 var appCacheIframe;
 
 function hasSW() {
-  return 'serviceWorker' in navigator &&
-    // This is how I block Chrome 40 and detect Chrome 41, because first has
-    // bugs with history.pustState and/or hashchange
-    (window.fetch || 'imageRendering' in document.documentElement.style) &&
-    (window.location.protocol === 'https:' || window.location.hostname === 'localhost' || window.location.hostname.indexOf('127.') === 0)
+
+    return 'serviceWorker' in navigator && (
+      window.location.protocol === 'https:' ||
+      window.location.hostname === 'localhost' ||
+      window.location.hostname.indexOf('127.') === 0
+    );
+
 }
 
 function install(options) {
@@ -87,8 +89,10 @@ function install(options) {
     if (hasSW()) {
       var registration = navigator.serviceWorker
         .register(
-          "sw.js"
-
+          "sw.js", {
+
+
+          }
         );
 
 

diff --git a/tests/legacy/fixtures/basic-with-custom-time-update-service/__expected/webpack3/main.js b/tests/legacy/fixtures/basic-with-custom-time-update-service/__expected/webpack3/main.js
@@ -76,11 +76,13 @@ __webpack_require__(1);
 var appCacheIframe;
 
 function hasSW() {
-  return 'serviceWorker' in navigator &&
-    // This is how I block Chrome 40 and detect Chrome 41, because first has
-    // bugs with history.pustState and/or hashchange
-    (window.fetch || 'imageRendering' in document.documentElement.style) &&
-    (window.location.protocol === 'https:' || window.location.hostname === 'localhost' || window.location.hostname.indexOf('127.') === 0)
+
+    return 'serviceWorker' in navigator && (
+      window.location.protocol === 'https:' ||
+      window.location.hostname === 'localhost' ||
+      window.location.hostname.indexOf('127.') === 0
+    );
+
 }
 
 function install(options) {
@@ -90,8 +92,10 @@ function install(options) {
     if (hasSW()) {
       var registration = navigator.serviceWorker
         .register(
-          "sw.js"
-
+          "sw.js", {
+
+
+          }
         );
 
 

diff --git a/tests/legacy/fixtures/basic-with-custom-time-update-service/__expected/webpack4/main.js b/tests/legacy/fixtures/basic-with-custom-time-update-service/__expected/webpack4/main.js
@@ -82,11 +82,13 @@ __webpack_require__(1);
 var appCacheIframe;
 
 function hasSW() {
-  return 'serviceWorker' in navigator &&
-    // This is how I block Chrome 40 and detect Chrome 41, because first has
-    // bugs with history.pustState and/or hashchange
-    (window.fetch || 'imageRendering' in document.documentElement.style) &&
-    (window.location.protocol === 'https:' || window.location.hostname === 'localhost' || window.location.hostname.indexOf('127.') === 0)
+
+    return 'serviceWorker' in navigator && (
+      window.location.protocol === 'https:' ||
+      window.location.hostname === 'localhost' ||
+      window.location.hostname.indexOf('127.') === 0
+    );
+
 }
 
 function install(options) {
@@ -96,8 +98,10 @@ function install(options) {
     if (hasSW()) {
       var registration = navigator.serviceWorker
         .register(
-          "sw.js"
-
+          "sw.js", {
+
+
+          }
         );
 
 

diff --git a/tests/legacy/fixtures/basic-with-default-update-service/__expected/webpack2/main.js b/tests/legacy/fixtures/basic-with-default-update-service/__expected/webpack2/main.js
@@ -73,11 +73,13 @@
 var appCacheIframe;
 
 function hasSW() {
-  return 'serviceWorker' in navigator &&
-    // This is how I block Chrome 40 and detect Chrome 41, because first has
-    // bugs with history.pustState and/or hashchange
-    (window.fetch || 'imageRendering' in document.documentElement.style) &&
-    (window.location.protocol === 'https:' || window.location.hostname === 'localhost' || window.location.hostname.indexOf('127.') === 0)
+
+    return 'serviceWorker' in navigator && (
+      window.location.protocol === 'https:' ||
+      window.location.hostname === 'localhost' ||
+      window.location.hostname.indexOf('127.') === 0
+    );
+
 }
 
 function install(options) {
@@ -87,8 +89,10 @@ function install(options) {
     if (hasSW()) {
       var registration = navigator.serviceWorker
         .register(
-          "sw.js"
-
+          "sw.js", {
+
+
+          }
         );
 
 

diff --git a/tests/legacy/fixtures/basic-with-default-update-service/__expected/webpack3/main.js b/tests/legacy/fixtures/basic-with-default-update-service/__expected/webpack3/main.js
@@ -76,11 +76,13 @@ __webpack_require__(1);
 var appCacheIframe;
 
 function hasSW() {
-  return 'serviceWorker' in navigator &&
-    // This is how I block Chrome 40 and detect Chrome 41, because first has
-    // bugs with history.pustState and/or hashchange
-    (window.fetch || 'imageRendering' in document.documentElement.style) &&
-    (window.location.protocol === 'https:' || window.location.hostname === 'localhost' || window.location.hostname.indexOf('127.') === 0)
+
+    return 'serviceWorker' in navigator && (
+      window.location.protocol === 'https:' ||
+      window.location.hostname === 'localhost' ||
+      window.location.hostname.indexOf('127.') === 0
+    );
+
 }
 
 function install(options) {
@@ -90,8 +92,10 @@ function install(options) {
     if (hasSW()) {
       var registration = navigator.serviceWorker
         .register(
-          "sw.js"
-
+          "sw.js", {
+
+
+          }
         );
 
 

diff --git a/tests/legacy/fixtures/basic-with-default-update-service/__expected/webpack4/main.js b/tests/legacy/fixtures/basic-with-default-update-service/__expected/webpack4/main.js
@@ -82,11 +82,13 @@ __webpack_require__(1);
 var appCacheIframe;
 
 function hasSW() {
-  return 'serviceWorker' in navigator &&
-    // This is how I block Chrome 40 and detect Chrome 41, because first has
-    // bugs with history.pustState and/or hashchange
-    (window.fetch || 'imageRendering' in document.documentElement.style) &&
-    (window.location.protocol === 'https:' || window.location.hostname === 'localhost' || window.location.hostname.indexOf('127.') === 0)
+
+    return 'serviceWorker' in navigator && (
+      window.location.protocol === 'https:' ||
+      window.location.hostname === 'localhost' ||
+      window.location.hostname.indexOf('127.') === 0
+    );
+
 }
 
 function install(options) {
@@ -96,8 +98,10 @@ function install(options) {
     if (hasSW()) {
       var registration = navigator.serviceWorker
         .register(
-          "sw.js"
-
+          "sw.js", {
+
+
+          }
         );
 
 

diff --git a/tests/legacy/fixtures/basic-with-runtime/__expected/webpack2/main.js b/tests/legacy/fixtures/basic-with-runtime/__expected/webpack2/main.js
@@ -73,11 +73,13 @@
 var appCacheIframe;
 
 function hasSW() {
-  return 'serviceWorker' in navigator &&
-    // This is how I block Chrome 40 and detect Chrome 41, because first has
-    // bugs with history.pustState and/or hashchange
-    (window.fetch || 'imageRendering' in document.documentElement.style) &&
-    (window.location.protocol === 'https:' || window.location.hostname === 'localhost' || window.location.hostname.indexOf('127.') === 0)
+
+    return 'serviceWorker' in navigator && (
+      window.location.protocol === 'https:' ||
+      window.location.hostname === 'localhost' ||
+      window.location.hostname.indexOf('127.') === 0
+    );
+
 }
 
 function install(options) {
@@ -87,8 +89,10 @@ function install(options) {
     if (hasSW()) {
       var registration = navigator.serviceWorker
         .register(
-          "sw.js"
-
+          "sw.js", {
+
+
+          }
         );