jekyll-pwa-plugin 1.0.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 736c5288f23d891eabdacb0cc80dea6d1f31a584
-  data.tar.gz: eda060eef3b7f071b04faeb74b58ea5348302bd2
+  metadata.gz: edb1a030cb36acead1e1e0a115afded7f0056746
+  data.tar.gz: 51f9e25a5899c119ca0fa732aa44b97b70315f60
 SHA512:
-  metadata.gz: e43a49b5d72ae651756c98f0b8b9cb8dc9d393c1eb361806347828854d1afa1866815e181ba0d2b7b2237e5f50e3bfaa3599a3f1e43bc1e9fe767c4e74b8b7fe
-  data.tar.gz: 98300254bf2b5d8928e755f641f3b1a0c5504557693baee64cf85216ba239f326fe131abd214d30f481c1490c8fa07708445f6b5d858bdad45db97d5b2a82669
+  metadata.gz: befb34733473223be3a0c8c6a493060f5d478792d47a7db0afe23410e12334439e80e3c4d3f1a0f72a6e60b4338aaef251286ee24f566e596dbf19c5e6e29d3e
+  data.tar.gz: 619e67040cb46c2acc940b3ef2a9c61f426ba80b128d9afcb2e00d7a253c38df955e61910463a39e58f60781c993f4127a433ff26e15e95b0e586e1de6f77b30

data/lib/jekyll-pwa-plugin.rb

@@ -1,8 +1,10 @@
 class SWHelper
+    WORKBOX_VERSION = 'v3.3.1'
     def initialize(site, config)
         @site = site
         @config = config
-        @sw_filename = @config['sw_filename'] || 'service-worker.js'
+        @sw_filename = @config['sw_dest_filename'] || 'service-worker.js'
+        @sw_src_filepath = @config['sw_src_filepath'] || 'service-worker.js'
     end
 
     def write_sw_register()
@@ -93,19 +95,13 @@ class SWHelper
     end
 
     def write_sw()
-        cache_name = @config['cache_name'] || 'workbox'
-        runtime_cache = @config['runtime_cache'] || []
+
         dest_js_directory = @config['dest_js_directory'] || 'js'
 
         # copy polyfill & workbox.js to js/
-        copied_vendor_files = []
         script_directory = @site.in_dest_dir(dest_js_directory)
         FileUtils.mkdir_p(script_directory) unless Dir.exist?(script_directory)
-        Dir.glob(File.expand_path('../vendor/**/*', __FILE__)) do |filepath_to_copy|
-            basename = File.basename(filepath_to_copy)
-            FileUtils.copy_file(filepath_to_copy, File.join(script_directory, basename))
-            copied_vendor_files.push(basename)
-        end
+        FileUtils.cp_r(File.expand_path('../vendor/', __FILE__) + '/.', script_directory)
 
         # generate precache list
         precache_list_str = @precache_list.map do |precache_item|
@@ -113,38 +109,24 @@ class SWHelper
         end
         .join(",")
 
-        # generate runtime cache route
-        runtime_cache_str = runtime_cache.map do |runtime_item|
-            <<-SCRIPT
-                workboxSW.router.registerRoute(#{runtime_item['route']},
-                    workboxSW.strategies.#{runtime_item['strategy'] || 'networkFirst'}());
-            SCRIPT
-        end
-        .join("\n")
-
         # write service-worker.js
-        import_scripts_str = copied_vendor_files.map do |vendor_filename|
-            vendor_url = File.join(@site.baseurl.to_s, dest_js_directory, vendor_filename)
-            <<-SCRIPT
-                importScripts('#{vendor_url}');
-            SCRIPT
-        end
-        .join("\n")
-        sw_file = File.new(@site.in_dest_dir(@sw_filename), 'w')
-        sw_file.puts(
+        sw_src_file_str = File.read(@site.in_source_dir(@sw_src_filepath))
+        workbox_dir = File.join(@site.baseurl.to_s, dest_js_directory, "workbox-#{SWHelper::WORKBOX_VERSION}")
+        import_scripts_str = 
+        <<-SCRIPT
+            importScripts("#{workbox_dir}/workbox-sw.js");
+            workbox.setConfig({modulePathPrefix: "#{workbox_dir}"});
+        SCRIPT
+
+        sw_dest_file = File.new(@site.in_dest_dir(@sw_filename), 'w')
+        sw_dest_file.puts(
         <<-SCRIPT
             #{import_scripts_str}
-            const workboxSW = new WorkboxSW({
-                cacheId: '#{cache_name}',
-                ignoreUrlParametersMatching: [/^utm_/],
-                skipWaiting: true,
-                clientsClaim: true
-            });
-            workboxSW.precache([#{precache_list_str}]);
-            #{runtime_cache_str}
+            self.__precacheManifest = [#{precache_list_str}];
+            #{sw_src_file_str}
         SCRIPT
         )
-        sw_file.close
+        sw_dest_file.close
     end
 
     def self.insert_sw_register_into_body(page)

data/lib/vendor/workbox-v3.3.1/workbox-background-sync.dev.js

@@ -0,0 +1,593 @@
+this.workbox = this.workbox || {};
+this.workbox.backgroundSync = (function (DBWrapper_mjs,WorkboxError_mjs,logger_mjs,assert_mjs,getFriendlyURL_mjs) {
+  'use strict';
+
+  try {
+    self.workbox.v['workbox:background-sync:3.3.1'] = 1;
+  } catch (e) {} // eslint-disable-line
+
+  /*
+   Copyright 2017 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.
+  */
+
+  const serializableProperties = ['method', 'referrer', 'referrerPolicy', 'mode', 'credentials', 'cache', 'redirect', 'integrity', 'keepalive'];
+
+  /**
+   * A class to make it easier to serialize and de-serialize requests so they
+   * can be stored in IndexedDB.
+   *
+   * @private
+   */
+  class StorableRequest {
+    /**
+     * Converts a Request object to a plain object that can be structured
+     * cloned or JSON-stringified.
+     *
+     * @param {Request} request
+     * @return {Promise<StorableRequest>}
+     *
+     * @private
+     */
+    static fromRequest(request) {
+      return babelHelpers.asyncToGenerator(function* () {
+        const requestInit = { headers: {} };
+
+        // Set the body if present.
+        if (request.method !== 'GET') {
+          // Use blob to support non-text request bodies,
+          // and clone first in case the caller still needs the request.
+          requestInit.body = yield request.clone().blob();
+        }
+
+        // Convert the headers from an iterable to an object.
+        for (const [key, value] of request.headers.entries()) {
+          requestInit.headers[key] = value;
+        }
+
+        // Add all other serializable request properties
+        for (const prop of serializableProperties) {
+          if (request[prop] !== undefined) {
+            requestInit[prop] = request[prop];
+          }
+        }
+
+        return new StorableRequest({ url: request.url, requestInit });
+      })();
+    }
+
+    /**
+     * Accepts a URL and RequestInit dictionary that can be used to create a
+     * new Request object. A timestamp is also generated so consumers can
+     * reference when the object was created.
+     *
+     * @param {Object} param1
+     * @param {string} param1.url
+     * @param {Object} param1.requestInit
+     *     See: https://fetch.spec.whatwg.org/#requestinit
+     * @param {number} param1.timestamp The time the request was created,
+     *     defaulting to the current time if not specified.
+     *
+     * @private
+     */
+    constructor({ url, requestInit, timestamp = Date.now() }) {
+      this.url = url;
+      this.requestInit = requestInit;
+
+      // "Private"
+      this._timestamp = timestamp;
+    }
+
+    /**
+     * Gets the private _timestamp property.
+     *
+     * @return {number}
+     *
+     * @private
+     */
+    get timestamp() {
+      return this._timestamp;
+    }
+
+    /**
+     * Coverts this instance to a plain Object.
+     *
+     * @return {Object}
+     *
+     * @private
+     */
+    toObject() {
+      return {
+        url: this.url,
+        timestamp: this.timestamp,
+        requestInit: this.requestInit
+      };
+    }
+
+    /**
+     * Converts this instance to a Request.
+     *
+     * @return {Request}
+     *
+     * @private
+     */
+    toRequest() {
+      return new Request(this.url, this.requestInit);
+    }
+
+    /**
+     * Creates and returns a deep clone of the instance.
+     *
+     * @return {StorableRequest}
+     *
+     * @private
+     */
+    clone() {
+      const requestInit = Object.assign({}, this.requestInit);
+      requestInit.headers = Object.assign({}, this.requestInit.headers);
+      if (this.requestInit.body) {
+        requestInit.body = this.requestInit.body.slice();
+      }
+
+      return new StorableRequest({
+        url: this.url,
+        timestamp: this.timestamp,
+        requestInit
+      });
+    }
+  }
+
+  /*
+   Copyright 2017 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.
+  */
+
+  const DB_NAME = 'workbox-background-sync';
+  const OBJECT_STORE_NAME = 'requests';
+  const INDEXED_PROP = 'queueName';
+  const TAG_PREFIX = 'workbox-background-sync';
+  const MAX_RETENTION_TIME = 60 * 24 * 7; // 7 days in minutes
+
+  /*
+   Copyright 2017 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.
+  */
+
+  /**
+   * A class to manage storing requests from a Queue in IndexedbDB,
+   * indexed by their queue name for easier access.
+   *
+   * @private
+   */
+  class QueueStore {
+    /**
+     * Associates this instance with a Queue instance, so entries added can be
+     * identified by their queue name.
+     *
+     * @param {Queue} queue
+     *
+     * @private
+     */
+    constructor(queue) {
+      this._queue = queue;
+      this._db = new DBWrapper_mjs.DBWrapper(DB_NAME, 1, {
+        onupgradeneeded: evt => evt.target.result.createObjectStore(OBJECT_STORE_NAME, { autoIncrement: true }).createIndex(INDEXED_PROP, INDEXED_PROP, { unique: false })
+      });
+    }
+
+    /**
+     * Takes a StorableRequest instance, converts it to an object and adds it
+     * as an entry in the object store.
+     *
+     * @param {StorableRequest} storableRequest
+     *
+     * @private
+     */
+    addEntry(storableRequest) {
+      var _this = this;
+
+      return babelHelpers.asyncToGenerator(function* () {
+        yield _this._db.add(OBJECT_STORE_NAME, {
+          queueName: _this._queue.name,
+          storableRequest: storableRequest.toObject()
+        });
+      })();
+    }
+
+    /**
+     * Gets the oldest entry in the object store, removes it, and returns the
+     * value as a StorableRequest instance. If no entry exists, it returns
+     * undefined.
+     *
+     * @return {StorableRequest|undefined}
+     *
+     * @private
+     */
+    getAndRemoveOldestEntry() {
+      var _this2 = this;
+
+      return babelHelpers.asyncToGenerator(function* () {
+        const [entry] = yield _this2._db.getAllMatching(OBJECT_STORE_NAME, {
+          index: INDEXED_PROP,
+          query: IDBKeyRange.only(_this2._queue.name),
+          count: 1,
+          includeKeys: true
+        });
+
+        if (entry) {
+          yield _this2._db.delete(OBJECT_STORE_NAME, entry.primaryKey);
+          return new StorableRequest(entry.value.storableRequest);
+        }
+      })();
+    }
+  }
+
+  /*
+   Copyright 2017 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.
+  */
+
+  const queueNames = new Set();
+
+  /**
+   * A class to manage storing failed requests in IndexedDB and retrying them
+   * later. All parts of the storing and replaying process are observable via
+   * callbacks.
+   *
+   * @memberof workbox.backgroundSync
+   */
+  class Queue {
+    /**
+     * Creates an instance of Queue with the given options
+     *
+     * @param {string} name The unique name for this queue. This name must be
+     *     unique as it's used to register sync events and store requests
+     *     in IndexedDB specific to this instance. An error will be thrown if
+     *     a duplicate name is detected.
+     * @param {Object} [options]
+     * @param {Object} [options.callbacks] Callbacks to observe the lifecycle of
+     *     queued requests. Use these to respond to or modify the requests
+     *     during the replay process.
+     * @param {function(StorableRequest):undefined}
+     *     [options.callbacks.requestWillEnqueue]
+     *     Invoked immediately before the request is stored to IndexedDB. Use
+     *     this callback to modify request data at store time.
+     * @param {function(StorableRequest):undefined}
+     *     [options.callbacks.requestWillReplay]
+     *     Invoked immediately before the request is re-fetched. Use this
+     *     callback to modify request data at fetch time.
+     * @param {function(Array<StorableRequest>):undefined}
+     *     [options.callbacks.queueDidReplay]
+     *     Invoked after all requests in the queue have successfully replayed.
+     * @param {number} [options.maxRetentionTime = 7 days] The amount of time (in
+     *     minutes) a request may be retried. After this amount of time has
+     *     passed, the request will be deleted from the queue.
+     */
+    constructor(name, {
+      callbacks = {},
+      maxRetentionTime = MAX_RETENTION_TIME
+    } = {}) {
+      // Ensure the store name is not already being used
+      if (queueNames.has(name)) {
+        throw new WorkboxError_mjs.WorkboxError('duplicate-queue-name', { name });
+      } else {
+        queueNames.add(name);
+      }
+
+      this._name = name;
+      this._callbacks = callbacks;
+      this._maxRetentionTime = maxRetentionTime;
+      this._queueStore = new QueueStore(this);
+
+      this._addSyncListener();
+    }
+
+    /**
+     * @return {string}
+     */
+    get name() {
+      return this._name;
+    }
+
+    /**
+     * Stores the passed request into IndexedDB. The database used is
+     * `workbox-background-sync` and the object store name is the same as
+     * the name this instance was created with (to guarantee it's unique).
+     *
+     * @param {Request} request The request object to store.
+     */
+    addRequest(request) {
+      var _this = this;
+
+      return babelHelpers.asyncToGenerator(function* () {
+        {
+          assert_mjs.assert.isInstance(request, Request, {
+            moduleName: 'workbox-background-sync',
+            className: 'Queue',
+            funcName: 'addRequest',
+            paramName: 'request'
+          });
+        }
+
+        const storableRequest = yield StorableRequest.fromRequest(request.clone());
+        yield _this._runCallback('requestWillEnqueue', storableRequest);
+        yield _this._queueStore.addEntry(storableRequest);
+        yield _this._registerSync();
+        {
+          logger_mjs.logger.log(`Request for '${getFriendlyURL_mjs.getFriendlyURL(storableRequest.url)}' has been
+          added to background sync queue '${_this._name}'.`);
+        }
+      })();
+    }
+
+    /**
+     * Retrieves all stored requests in IndexedDB and retries them. If the
+     * queue contained requests that were successfully replayed, the
+     * `queueDidReplay` callback is invoked (which implies the queue is
+     * now empty). If any of the requests fail, a new sync registration is
+     * created to retry again later.
+     */
+    replayRequests() {
+      var _this2 = this;
+
+      return babelHelpers.asyncToGenerator(function* () {
+        const now = Date.now();
+        const replayedRequests = [];
+        const failedRequests = [];
+
+        let storableRequest;
+        while (storableRequest = yield _this2._queueStore.getAndRemoveOldestEntry()) {
+          // Make a copy so the unmodified request can be stored
+          // in the event of a replay failure.
+          const storableRequestClone = storableRequest.clone();
+
+          // Ignore requests older than maxRetentionTime.
+          const maxRetentionTimeInMs = _this2._maxRetentionTime * 60 * 1000;
+          if (now - storableRequest.timestamp > maxRetentionTimeInMs) {
+            continue;
+          }
+
+          yield _this2._runCallback('requestWillReplay', storableRequest);
+
+          const replay = { request: storableRequest.toRequest() };
+
+          try {
+            // Clone the request before fetching so callbacks get an unused one.
+            replay.response = yield fetch(replay.request.clone());
+            {
+              logger_mjs.logger.log(`Request for '${getFriendlyURL_mjs.getFriendlyURL(storableRequest.url)}'
+             has been replayed`);
+            }
+          } catch (err) {
+            {
+              logger_mjs.logger.log(`Request for '${getFriendlyURL_mjs.getFriendlyURL(storableRequest.url)}'
+             failed to replay`);
+            }
+            replay.error = err;
+            failedRequests.push(storableRequestClone);
+          }
+
+          replayedRequests.push(replay);
+        }
+
+        yield _this2._runCallback('queueDidReplay', replayedRequests);
+
+        // If any requests failed, put the failed requests back in the queue
+        // and rethrow the failed requests count.
+        if (failedRequests.length) {
+          yield Promise.all(failedRequests.map(function (storableRequest) {
+            return _this2._queueStore.addEntry(storableRequest);
+          }));
+
+          throw new WorkboxError_mjs.WorkboxError('queue-replay-failed', { name: _this2._name, count: failedRequests.length });
+        }
+      })();
+    }
+
+    /**
+     * Runs the passed callback if it exists.
+     *
+     * @private
+     * @param {string} name The name of the callback on this._callbacks.
+     * @param {...*} args The arguments to invoke the callback with.
+     */
+    _runCallback(name, ...args) {
+      var _this3 = this;
+
+      return babelHelpers.asyncToGenerator(function* () {
+        if (typeof _this3._callbacks[name] === 'function') {
+          yield _this3._callbacks[name].apply(null, args);
+        }
+      })();
+    }
+
+    /**
+     * In sync-supporting browsers, this adds a listener for the sync event.
+     * In non-sync-supporting browsers, this will retry the queue on service
+     * worker startup.
+     *
+     * @private
+     */
+    _addSyncListener() {
+      if ('sync' in registration) {
+        self.addEventListener('sync', event => {
+          if (event.tag === `${TAG_PREFIX}:${this._name}`) {
+            {
+              logger_mjs.logger.log(`Background sync for tag '${event.tag}'
+                has been received, starting replay now`);
+            }
+            event.waitUntil(this.replayRequests());
+          }
+        });
+      } else {
+        {
+          logger_mjs.logger.log(`Background sync replaying without background sync event`);
+        }
+        // If the browser doesn't support background sync, retry
+        // every time the service worker starts up as a fallback.
+        this.replayRequests();
+      }
+    }
+
+    /**
+     * Registers a sync event with a tag unique to this instance.
+     *
+     * @private
+     */
+    _registerSync() {
+      var _this4 = this;
+
+      return babelHelpers.asyncToGenerator(function* () {
+        if ('sync' in registration) {
+          try {
+            yield registration.sync.register(`${TAG_PREFIX}:${_this4._name}`);
+          } catch (err) {
+            // This means the registration failed for some reason, possibly due to
+            // the user disabling it.
+            {
+              logger_mjs.logger.warn(`Unable to register sync event for '${_this4._name}'.`, err);
+            }
+          }
+        }
+      })();
+    }
+
+    /**
+     * Returns the set of queue names. This is primarily used to reset the list
+     * of queue names in tests.
+     *
+     * @return {Set}
+     *
+     * @private
+     */
+    static get _queueNames() {
+      return queueNames;
+    }
+  }
+
+  /*
+   Copyright 2017 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.
+  */
+
+  /**
+   * A class implementing the `fetchDidFail` lifecycle callback. This makes it
+   * easier to add failed requests to a background sync Queue.
+   *
+   * @memberof workbox.backgroundSync
+   */
+  class Plugin {
+    /**
+     * @param {...*} queueArgs Args to forward to the composed Queue instance.
+     *    See the [Queue]{@link workbox.backgroundSync.Queue} documentation for
+     *    parameter details.
+     */
+    constructor(...queueArgs) {
+      this._queue = new Queue(...queueArgs);
+      this.fetchDidFail = this.fetchDidFail.bind(this);
+    }
+
+    /**
+     * @param {Object} options
+     * @param {Request} options.request
+     * @private
+     */
+    fetchDidFail({ request }) {
+      var _this = this;
+
+      return babelHelpers.asyncToGenerator(function* () {
+        yield _this._queue.addRequest(request);
+      })();
+    }
+  }
+
+  /*
+   Copyright 2017 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.
+  */
+
+  var publicAPI = /*#__PURE__*/Object.freeze({
+    Queue: Queue,
+    Plugin: Plugin
+  });
+
+  /*
+   Copyright 2017 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.
+  */
+
+  return publicAPI;
+
+}(workbox.core._private,workbox.core._private,workbox.core._private,workbox.core._private,workbox.core._private));
+
+//# sourceMappingURL=workbox-background-sync.dev.js.map