Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

Separate pure and side-effecting code #195

Merged
merged 1 commit into from
Oct 6, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 44 additions & 1 deletion lib/helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,52 @@ function renameCache(source, destination, options) {
});
}

function cache(url, options) {
return openCache(options).then(function(cache) {
return cache.add(url);
});
}

function uncache(url, options) {
return openCache(options).then(function(cache) {
return cache.delete(url);
});
}

function precache(items) {
if (!(items instanceof Promise)) {
validatePrecacheInput(items);
}

globalOptions.preCacheItems = globalOptions.preCacheItems.concat(items);
}

function validatePrecacheInput(items) {
var isValid = Array.isArray(items);
if (isValid) {
items.forEach(function(item) {
if (!(typeof item === 'string' || (item instanceof Request))) {
isValid = false;
}
});
}

if (!isValid) {
throw new TypeError('The precache method expects either an array of ' +
'strings and/or Requests or a Promise that resolves to an array of ' +
'strings and/or Requests.');
}

return items;
}

module.exports = {
debug: debug,
fetchAndCache: fetchAndCache,
openCache: openCache,
renameCache: renameCache
renameCache: renameCache,
cache: cache,
uncache: uncache,
precache: precache,
validatePrecacheInput: validatePrecacheInput
};
75 changes: 75 additions & 0 deletions lib/listeners.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/*
Copyright 2014 Google Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
'use strict';

// For cache.addAll.
require('serviceworker-cache-polyfill');

var helpers = require('./helpers');
var router = require('./router');
var options = require('./options');

// Event listeners

function fetchListener(event) {
var handler = router.match(event.request);

if (handler) {
event.respondWith(handler(event.request));
} else if (router.default &&
event.request.method === 'GET' &&
// Ensure that chrome-extension:// requests don't trigger the default route.
event.request.url.indexOf('http') === 0) {
event.respondWith(router.default(event.request));
}
}

function activateListener(event) {
helpers.debug('activate event fired');
var inactiveCache = options.cache.name + '$$$inactive$$$';
event.waitUntil(helpers.renameCache(inactiveCache, options.cache.name));
}

function flatten(items) {
return items.reduce(function(a, b) {
return a.concat(b);
}, []);
}

function installListener(event) {
var inactiveCache = options.cache.name + '$$$inactive$$$';
helpers.debug('install event fired');
helpers.debug('creating cache [' + inactiveCache + ']');
event.waitUntil(
helpers.openCache({cache: {name: inactiveCache}})
.then(function(cache) {
return Promise.all(options.preCacheItems)
.then(flatten)
.then(helpers.validatePrecacheInput)
.then(function(preCacheItems) {
helpers.debug('preCache list: ' +
(preCacheItems.join(', ') || '(none)'));
return cache.addAll(preCacheItems);
});
})
);
}

module.exports = {
fetchListener: fetchListener,
activateListener: activateListener,
installListener: installListener
};
103 changes: 11 additions & 92 deletions lib/sw-toolbox.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,103 +15,22 @@
*/
'use strict';

require('serviceworker-cache-polyfill');
// This is the entrypoint for the sw-toolbox bundle. All code with
// side effects (e.g. adding event listeners) should be in this file.

var options = require('./options');
var router = require('./router');
var helpers = require('./helpers');
var strategies = require('./strategies');
var listeners = require('./listeners');

helpers.debug('Service Worker Toolbox is loading');

// Install
var flatten = function(items) {
return items.reduce(function(a, b) {
return a.concat(b);
}, []);
};

var validatePrecacheInput = function(items) {
var isValid = Array.isArray(items);
if (isValid) {
items.forEach(function(item) {
if (!(typeof item === 'string' || (item instanceof Request))) {
isValid = false;
}
});
}

if (!isValid) {
throw new TypeError('The precache method expects either an array of ' +
'strings and/or Requests or a Promise that resolves to an array of ' +
'strings and/or Requests.');
}

return items;
};

self.addEventListener('install', function(event) {
var inactiveCache = options.cache.name + '$$$inactive$$$';
helpers.debug('install event fired');
helpers.debug('creating cache [' + inactiveCache + ']');
event.waitUntil(
helpers.openCache({cache: {name: inactiveCache}})
.then(function(cache) {
return Promise.all(options.preCacheItems)
.then(flatten)
.then(validatePrecacheInput)
.then(function(preCacheItems) {
helpers.debug('preCache list: ' +
(preCacheItems.join(', ') || '(none)'));
return cache.addAll(preCacheItems);
});
})
);
});

// Activate

self.addEventListener('activate', function(event) {
helpers.debug('activate event fired');
var inactiveCache = options.cache.name + '$$$inactive$$$';
event.waitUntil(helpers.renameCache(inactiveCache, options.cache.name));
});

// Fetch

self.addEventListener('fetch', function(event) {
var handler = router.match(event.request);

if (handler) {
event.respondWith(handler(event.request));
} else if (router.default &&
event.request.method === 'GET' &&
// Ensure that chrome-extension:// requests don't trigger the default route.
event.request.url.indexOf('http') === 0) {
event.respondWith(router.default(event.request));
}
});

// Caching

function cache(url, options) {
return helpers.openCache(options).then(function(cache) {
return cache.add(url);
});
}

function uncache(url, options) {
return helpers.openCache(options).then(function(cache) {
return cache.delete(url);
});
}

function precache(items) {
if (!(items instanceof Promise)) {
validatePrecacheInput(items);
}
// Set up listeners.

options.preCacheItems = options.preCacheItems.concat(items);
}
self.addEventListener('install', listeners.installListener);
self.addEventListener('activate', listeners.activateListener);
self.addEventListener('fetch', listeners.fetchListener);

module.exports = {
networkOnly: strategies.networkOnly,
Expand All @@ -121,7 +40,7 @@ module.exports = {
fastest: strategies.fastest,
router: router,
options: options,
cache: cache,
uncache: uncache,
precache: precache
cache: helpers.cache,
uncache: helpers.uncache,
precache: helpers.precache
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This cleans up the main sw-toolbox entry quite a bit while making it easier to just pull in the helpers. It's also passing our current CI tests. I'm personally fine with this change, but let's see what @jeffposnick and @gauntface think.