Make networkFirstResponse answer behaviour configurable

docs/options.md

@@ -129,6 +129,10 @@ Allows you to adjust what and how to cache the assets.
 > Default: `'all'`.
 
 
+* `shouldServeFromNetwork`: `(response: Response, urlString: string, cacheUrl: string) => boolean`. 
+Allows to customize the behaviour when to fallback to a cached version of a resource if `responseStrategy: 'network-first'`. 
+Defaults to `(response) => response.ok`, meaning a response is only valid when the server returns a 2xx status code (see https://developer.mozilla.org/de/docs/Web/API/Response).
+
 #### `AppCache: Object | null | false`
 
 Settings for the `AppCache` cache. Use `null` or `false` to disable `AppCache` generation.

lib/misc/sw-loader.js

@@ -51,7 +51,7 @@ module.exports.pitch = function pitch(remainingRequest, precedingRequest, data)
 
  var navigationPreloadCode = params.navigationPreload;
 
- var helpersCode = [', {', 'loaders: ' + loadersCode + ',', 'cacheMaps: ' + cacheMapsCode + ',', 'navigationPreload: ' + navigationPreloadCode + ',', '}'];
+ var helpersCode = [', {', 'shouldServeFromNetwork: ' + params.shouldServeFromNetwork + ',', 'loaders: ' + loadersCode + ',', 'cacheMaps: ' + cacheMapsCode + ',', 'navigationPreload: ' + navigationPreloadCode + ',', '}'];
 
  Promise.all([].concat(_toConsumableArray(modules.map(function (mod) {
  return readFile(path.join(__dirname, mod));

lib/misc/sw-template.js

@@ -382,9 +382,16 @@ function WebpackServiceWorker(params, helpers) {
  });
  }
 
+ function shouldServeFromNetwork(response, urlString, cacheUrl) {
+ if (helpers.shouldServeFromNetwork) {
+ return helpers.shouldServeFromNetwork(response, urlString, cacheUrl);
+ }
+ return response.ok;
+ }
+
  function networkFirstResponse(event, urlString, cacheUrl) {
  return fetchWithPreload(event).then(function (response) {
- if (response.ok) {
+ if (shouldServeFromNetwork(response, urlString, cacheUrl)) {
  if (DEBUG) {
  console.log('[SW]:', 'URL [' + urlString + '] from network');
  }

lib/service-worker.js

@@ -26,6 +26,8 @@ var _deepExtend2 = _interopRequireDefault(_deepExtend);
 
 var _miscUtils = require('./misc/utils');
 
+var REGEX_MINIFY_FUNC = /(\r\n|\n|\r|\s+)/gm;
+
 var ServiceWorker = (function () {
  function ServiceWorker(options) {
  _classCallCheck(this, ServiceWorker);
@@ -37,7 +39,7 @@ var ServiceWorker = (function () {
  this.minify = options.minify;
  this.output = options.output.replace(/^\.\/+/, '');
  this.publicPath = options.publicPath;
-
+ this.shouldServeFromNetwork = options.shouldServeFromNetwork;
  this.basePath = null;
  this.location = null;
  this.pathRewrite = null;
@@ -76,6 +78,7 @@ var ServiceWorker = (function () {
  var data = JSON.stringify({
  data_var_name: this.SW_DATA_VAR,
  cacheMaps: plugin.cacheMaps,
+ shouldServeFromNetwork: (0, _miscUtils.functionToString)(this.shouldServeFromNetwork),
  navigationPreload: this.stringifyNavigationPreload(this.navigationPreload, plugin)
  });
 
@@ -222,15 +225,16 @@ var ServiceWorker = (function () {
  pluginVersion = plugin.pluginVersion;
  }
 
- return ('\n var ' + this.SW_DATA_VAR + ' = ' + JSON.stringify({
+ var loaders = Object.keys(plugin.loaders || {}).length ? plugin.loaders : void 0;
+
+ var result = ('\n var ' + this.SW_DATA_VAR + ' = ' + JSON.stringify({
  assets: {
  main: cache('main'),
  additional: cache('additional'),
  optional: cache('optional')
  },
 
  externals: externals,
-
  hashesMap: hashesMap,
 
  strategy: plugin.strategy,
@@ -241,12 +245,14 @@ var ServiceWorker = (function () {
  relativePaths: plugin.relativePaths,
 
  prefetchRequest: this.prefetchRequest,
-
+ loaders: loaders,
  // These aren't added
  alwaysRevalidate: plugin.alwaysRevalidate,
  preferOnline: plugin.preferOnline,
  ignoreSearch: plugin.ignoreSearch
  }, null, minify ? void 0 : ' ') + ';\n ').trim();
+
+ return result;
  }
  }, {
  key: 'getConfig',

src/misc/sw-loader.js

@@ -57,6 +57,7 @@ module.exports.pitch = function pitch(remainingRequest, precedingRequest, data)
 
  const helpersCode = [
  ', {',
+ `shouldServeFromNetwork: ${params.shouldServeFromNetwork},`,
  `loaders: ${loadersCode},`,
  `cacheMaps: ${cacheMapsCode},`,
  `navigationPreload: ${navigationPreloadCode},`,
@@ -90,4 +91,4 @@ function readFile(path) {
  resolve(file);
  });
  });
-}
+}

src/misc/sw-template.js

@@ -397,10 +397,17 @@ function WebpackServiceWorker(params, helpers) {
  });
  }
 
+ function shouldServeFromNetwork(response, urlString, cacheUrl) {
+ if (helpers.shouldServeFromNetwork) {
+ return helpers.shouldServeFromNetwork(response, urlString, cacheUrl);
+ }
+ return response.ok;
+ }
+
  function networkFirstResponse(event, urlString, cacheUrl) {
  return fetchWithPreload(event)
  .then((response) => {
- if (response.ok) {
+ if (shouldServeFromNetwork(response, urlString, cacheUrl)) {
  if (DEBUG) {
  console.log('[SW]:', `URL [${ urlString }] from network`);
  }
@@ -748,4 +755,4 @@ function logGroup(title, assets) {
  });
 
  console.groupEnd();
-}
+}

src/service-worker.js

@@ -7,6 +7,8 @@ import {
  isAbsolutePath, functionToString
 } from './misc/utils';
 
+const REGEX_MINIFY_FUNC = /(\r\n|\n|\r|\s+)/gm;
+
 export default class ServiceWorker {
  constructor(options) {
  if (isAbsolutePath(options.output)) {
@@ -19,7 +21,7 @@ export default class ServiceWorker {
  this.minify = options.minify;
  this.output = options.output.replace(/^\.\/+/, '');
  this.publicPath = options.publicPath;
-
+ this.shouldServeFromNetwork = options.shouldServeFromNetwork;
  this.basePath = null;
  this.location = null;
  this.pathRewrite = null;
@@ -56,6 +58,7 @@ export default class ServiceWorker {
  const data = JSON.stringify({
  data_var_name: this.SW_DATA_VAR,
  cacheMaps: plugin.cacheMaps,
+ shouldServeFromNetwork: functionToString(this.shouldServeFromNetwork),
  navigationPreload: this.stringifyNavigationPreload(this.navigationPreload, plugin)
  });
 
@@ -213,7 +216,10 @@ export default class ServiceWorker {
  pluginVersion = plugin.pluginVersion;
  }
 
- return `
+ const loaders = Object.keys(plugin.loaders || {}).length ?
+ plugin.loaders : void 0;
+
+ const result = `
  var ${ this.SW_DATA_VAR } = ${ JSON.stringify({
  assets: {
  main: cache('main'),
@@ -222,7 +228,6 @@ export default class ServiceWorker {
  },
 
  externals: externals,
-
  hashesMap: hashesMap,
 
  strategy: plugin.strategy,
@@ -233,13 +238,15 @@ export default class ServiceWorker {
  relativePaths: plugin.relativePaths,
 
  prefetchRequest: this.prefetchRequest,
-
+ loaders: loaders,
  // These aren't added
  alwaysRevalidate: plugin.alwaysRevalidate,
  preferOnline: plugin.preferOnline,
  ignoreSearch: plugin.ignoreSearch,
  }, null, minify ? void 0 : ' ') };
  `.trim();
+
+ return result;
  }
 
  getConfig(plugin) {

tests/legacy/fixtures/appshell-absolute-path/__expected/webpack2/sw.js

@@ -522,9 +522,16 @@ function WebpackServiceWorker(params, helpers) {
  });
  }
 
+ function shouldServeFromNetwork(response, urlString, cacheUrl) {
+ if (helpers.shouldServeFromNetwork) {
+ return helpers.shouldServeFromNetwork(response, urlString, cacheUrl);
+ }
+ return response.ok;
+ }
+
  function networkFirstResponse(event, urlString, cacheUrl) {
  return fetchWithPreload(event).then(function (response) {
- if (response.ok) {
+ if (shouldServeFromNetwork(response, urlString, cacheUrl)) {
  if (DEBUG) {
  console.log('[SW]:', 'URL [' + urlString + '] from network');
  }
@@ -870,6 +877,7 @@ function logGroup(title, assets) {
  console.groupEnd();
 }
  WebpackServiceWorker(__wpo, {
+shouldServeFromNetwork: (void 0),
 loaders: {},
 cacheMaps: [
  {

tests/legacy/fixtures/appshell-absolute-path/__expected/webpack3/sw.js

@@ -513,9 +513,16 @@ function WebpackServiceWorker(params, helpers) {
  });
  }
 
+ function shouldServeFromNetwork(response, urlString, cacheUrl) {
+ if (helpers.shouldServeFromNetwork) {
+ return helpers.shouldServeFromNetwork(response, urlString, cacheUrl);
+ }
+ return response.ok;
+ }
+
  function networkFirstResponse(event, urlString, cacheUrl) {
  return fetchWithPreload(event).then(function (response) {
- if (response.ok) {
+ if (shouldServeFromNetwork(response, urlString, cacheUrl)) {
  if (DEBUG) {
  console.log('[SW]:', 'URL [' + urlString + '] from network');
  }
@@ -861,6 +868,7 @@ function logGroup(title, assets) {
  console.groupEnd();
 }
  WebpackServiceWorker(__wpo, {
+shouldServeFromNetwork: (void 0),
 loaders: {},
 cacheMaps: [
  {

tests/legacy/fixtures/appshell-absolute-path/__expected/webpack4/sw.js

@@ -534,9 +534,16 @@ function WebpackServiceWorker(params, helpers) {
  });
  }
 
+ function shouldServeFromNetwork(response, urlString, cacheUrl) {
+ if (helpers.shouldServeFromNetwork) {
+ return helpers.shouldServeFromNetwork(response, urlString, cacheUrl);
+ }
+ return response.ok;
+ }
+
  function networkFirstResponse(event, urlString, cacheUrl) {
  return fetchWithPreload(event).then(function (response) {
- if (response.ok) {
+ if (shouldServeFromNetwork(response, urlString, cacheUrl)) {
  if (DEBUG) {
  console.log('[SW]:', 'URL [' + urlString + '] from network');
  }
@@ -882,6 +889,7 @@ function logGroup(title, assets) {
  console.groupEnd();
 }
  WebpackServiceWorker(__wpo, {
+shouldServeFromNetwork: (void 0),
 loaders: {},
 cacheMaps: [
  {

tests/legacy/fixtures/appshell-basic/__expected/webpack2/sw.js

@@ -522,9 +522,16 @@ function WebpackServiceWorker(params, helpers) {
  });
  }
 
+ function shouldServeFromNetwork(response, urlString, cacheUrl) {
+ if (helpers.shouldServeFromNetwork) {
+ return helpers.shouldServeFromNetwork(response, urlString, cacheUrl);
+ }
+ return response.ok;
+ }
+
  function networkFirstResponse(event, urlString, cacheUrl) {
  return fetchWithPreload(event).then(function (response) {
- if (response.ok) {
+ if (shouldServeFromNetwork(response, urlString, cacheUrl)) {
  if (DEBUG) {
  console.log('[SW]:', 'URL [' + urlString + '] from network');
  }
@@ -870,6 +877,7 @@ function logGroup(title, assets) {
  console.groupEnd();
 }
  WebpackServiceWorker(__wpo, {
+shouldServeFromNetwork: (void 0),
 loaders: {},
 cacheMaps: [
  {

tests/legacy/fixtures/appshell-basic/__expected/webpack3/sw.js

@@ -513,9 +513,16 @@ function WebpackServiceWorker(params, helpers) {
  });
  }
 
+ function shouldServeFromNetwork(response, urlString, cacheUrl) {
+ if (helpers.shouldServeFromNetwork) {
+ return helpers.shouldServeFromNetwork(response, urlString, cacheUrl);
+ }
+ return response.ok;
+ }
+
  function networkFirstResponse(event, urlString, cacheUrl) {
  return fetchWithPreload(event).then(function (response) {
- if (response.ok) {
+ if (shouldServeFromNetwork(response, urlString, cacheUrl)) {
  if (DEBUG) {
  console.log('[SW]:', 'URL [' + urlString + '] from network');
  }
@@ -861,6 +868,7 @@ function logGroup(title, assets) {
  console.groupEnd();
 }
  WebpackServiceWorker(__wpo, {
+shouldServeFromNetwork: (void 0),
 loaders: {},
 cacheMaps: [
  {

tests/legacy/fixtures/appshell-basic/__expected/webpack4/sw.js

@@ -534,9 +534,16 @@ function WebpackServiceWorker(params, helpers) {
  });
  }
 
+ function shouldServeFromNetwork(response, urlString, cacheUrl) {
+ if (helpers.shouldServeFromNetwork) {
+ return helpers.shouldServeFromNetwork(response, urlString, cacheUrl);
+ }
+ return response.ok;
+ }
+
  function networkFirstResponse(event, urlString, cacheUrl) {
  return fetchWithPreload(event).then(function (response) {
- if (response.ok) {
+ if (shouldServeFromNetwork(response, urlString, cacheUrl)) {
  if (DEBUG) {
  console.log('[SW]:', 'URL [' + urlString + '] from network');
  }
@@ -882,6 +889,7 @@ function logGroup(title, assets) {
  console.groupEnd();
 }
  WebpackServiceWorker(__wpo, {
+shouldServeFromNetwork: (void 0),
 loaders: {},
 cacheMaps: [
  {

tests/legacy/fixtures/basic-wIth-sw-out/__expected/webpack2/sw.js

@@ -522,9 +522,16 @@ function WebpackServiceWorker(params, helpers) {
  });
  }
 
+ function shouldServeFromNetwork(response, urlString, cacheUrl) {
+ if (helpers.shouldServeFromNetwork) {
+ return helpers.shouldServeFromNetwork(response, urlString, cacheUrl);
+ }
+ return response.ok;
+ }
+
  function networkFirstResponse(event, urlString, cacheUrl) {
  return fetchWithPreload(event).then(function (response) {
- if (response.ok) {
+ if (shouldServeFromNetwork(response, urlString, cacheUrl)) {
  if (DEBUG) {
  console.log('[SW]:', 'URL [' + urlString + '] from network');
  }
@@ -870,6 +877,7 @@ function logGroup(title, assets) {
  console.groupEnd();
 }
  WebpackServiceWorker(__wpo, {
+shouldServeFromNetwork: (void 0),
 loaders: {},
 cacheMaps: [],
 navigationPreload: false,