Merge pull request #112 from PolymerElements/2.0-preview

2.0 hybrid implementation
PolymerElements · Jul 20, 2017 · a238008 · a238008
2 parents a8e6592 + b95038e
commit a238008
Show file tree

Hide file tree

Showing 10 changed files with 93 additions and 58 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-bower_components
+bower_components*
+bower-*.json
diff --git a/.travis.yml b/.travis.yml
@@ -1,38 +1,25 @@
 language: node_js
-sudo: required
-matrix:
-  include:
-    - node_js: stable
-      script: xvfb-run wct
-      addons:
-        firefox: latest
-        apt:
-          sources:
-            - google-chrome
-          packages:
-            - google-chrome-stable
-    - node_js: node
-      script:
-        - |
-          if [ "${TRAVIS_PULL_REQUEST}" = "false" ]; then
-            wct -s 'default'
-          fi
-before_script:
-  - npm install -g bower polylint web-component-tester
-  - bower install
-  - polylint
-node_js: '6'
+node_js: stable
 addons:
   firefox: latest
   apt:
     sources:
       - google-chrome
     packages:
       - google-chrome-stable
-dist: trusty
+before_script:
+  - npm install -g polymer-cli
+  - polymer install --variants
+script:
+  - xvfb-run polymer test
+  - >-
+    if [ "${TRAVIS_PULL_REQUEST}" = "false" ]; then polymer test -s 'default';
+    fi
 env:
   global:
     - secure: >-
-        BmIBRLipjyXtAB13z4QjER1s70X4uRwGkn2LiNMlZUgU8/4ZhbHefj728hLnk0HkoSVYIInLmz2gx2BS4vT2bnlQYLyVTO6KUA6vbIU8XQGqOTJeDASlfHR8qr+YAxlJ3vovwkzldAdzhS90cqAdmNOZxfMIjHTtLoqJX2YvkhHKT/joJvAYQFBSqkMZMI7mZf3PN70RNqMDz3S4I6P1ETpgL0JuuG54/hFjAVN7F/6pdYeI/G5gfixrfk8Na+Ys5PSnZB8yjol5fX6395gxNOjUYIH2kP44ewGNKJEy4ZIQmguNjlq734HGqfTvtpzoCTIuuTvgAwo+0aJyK8YSBLKUXiWDJdqfNLPbYKJ1QYOkqQ+WcsKYFTPJF43C2mmZiuyi7Oks2ovxYFgRwiS5VLF8FklxlfaEIkNLh+JRgvkGMKEHmRdSzgnjaXEFuYh/JtvR/Xbww9I6QfIVg+ZpObvIEeaMMeS3M08Pct9zj6mdVC/wjE3OFEyc4N82QBGjzGQUrGJBXc94mDfVgZ8G2kQdIr+4UsJEcJ4PlEMHnvFmpyYsgrfQ2YPE5BG2bNkq17IUzApQ0cYlrhKdRdQyQX0rRFteM4YXJ04MCzc7KqkFevV+6Oc2V8Fjtav36F/ODjSMP4Dx10is4dcFPukjHdc79mVuNIhkPfd+EParND8=
+        SdJLH4y+NPZVkMh+LUmv2xut5DyX/4zyTTTBX+AMQPrI9ON9nudUdx2ylvCYtI0/9+No+CL5ZSuXDWba7tdhTJFQ++m+zhDlH+YeDN1owpHFQD+zhzXJnrZf2enrNyg8fN2ZSS/0ySmO9S0vaULgkoKAI1We1f1u9UVLT40mjyC6zrX5Nv3WRmOICwE2+vUdS4yKGX2zyK9b5Yw5bdQqJuxR0sCM1aXxsUiQVWK5fI9YFbbkqKgvolUspz9P9vhlYFXKxsc+7rxy+cb8l08GuUFQ1Ql2qYxnAspRFYN7H9AS67CThtvv51xGYmpqjW8kCR8o0q0ho/otc5sHLbkwWRYN6UsdmQ+bJSPU/PP+Kdx/VCC2KACQ36r+BNldXD2TQyGgNPNSDGd1Eosp2h5vAdvQZ69zpHkX081oxZoJfvrayzLddnRZWd4ioSpQ8/v2HrSn+feY9x8QUzMNkAFeyPfkrPDfAHg1iatM7kb9/qzhZk9ObQObzLqvSQdcBJ0ZwFyeJF8EtJl1e4Sjv43XWsV66LnVazvkeYkMruInprW7sdFOFEBKU9x6ak7Cml851CFLDdtgiac4N53o5rR/1gKa0/TmZGZKUf4Yo4SthYUGrOv2drmBMVL9l9IKel3qyko3E6keajb9OIjZNkln+ZShAzs2+T45iMPNm3qb1oA=
     - secure: >-
-        9AMx2b0dtVXNztxqThYEh8ENYmgt47rRjl/YYrBmgoy2XFjCybI8iUdmbagXjaFjAsFt8LTuQiwkdcjvnYgsZOAYwqWGskHTyi03rWdFNci0lbynzmLc6XigdfgW/nkSq5TzoqW6qCOHp0kjiCdQkUezmxgiedl4Tz46eteAHPXOW/jUskWu1xF2i1tfIGTLC5bXF/8iaQPOsGG7YHHLHni+zDKJkrhI5phZULN/qx93goZa+Ns/lE72S9V1S/w1Hwl0LWt/9FrvJF0E0G4pdbI1HkOfz4fH88ISfIalfLFBZP/T2pjaJ4GnaD8BP3af2tE8zi9YCkjp9HnxY56guqQUxi/QJz1O+fxn3PPuHFy1FDcrKLNewW0xthh1oVdr33eAgW4IkfgAZiGwtn2o9mGtiTFxIDwTLAIAT2nmIyIQe2iR9APL8mCNy7mRjYXRXeDDl6ApcMEylpfvo4sQMmH6UKNeOMVsQlpXcBMnuGxncvdpkXCG7ShI4kIrqJ8kf4y96IkixJzxw5Gfvwy3Yw7epuvsAZznHHqOWXk1nVrpTmGnJE7tb1KfUcTXSNvrVoZF3EKki3Ncxp/jA9yWtiJa7T0Cl/S607uDdqmaGyJXjFQusJcnEqMsuGsNrP20ETEHvVLFapxJsLyImYGx8rDxpeYoRs/oS9gSkk6Jn24=
+        LPPkiA6fg0wybI+vqY7c93EPDKv4WjmWdIBoOT41TMdFyc3yAluQ3VsMLhJJEdANJyvGEkKvUb9pWsCXnmr1/S0LeE7pJSqen29RA0OkvGIWLGnl1t0+Xa+I/eRZLC08ZKjbg4gN5ObK1UQbGG/aJUnJliN84ky4bhUn5IfKycRG528kokuN9OGlU6ngP9WZMwL+xYenAVc+lBkkx+cCSdIoyXjtap/7Yi0jWFL020kmyOOmkNU5sRWKc4938accX32N+Mq4Hz7uxDfzLmNUUKd4pomyzPCUSdSCpURP35Fz5slWN/rwTdVKY/ELW7x3WBozizbf8CV5vm5rTJNE/rSQCGEXWcqPDgvGUHmjXZUzfyUgSAGmrrfkjodNdQ+D7yq0tQLHVU+2o6gnolGqfJw8dBG1uGlByjYSzw3RyjaE8k5zLbwLkgbnUcprRgx0+4OOKVTOIOEhR/HMv5V6f7gJrNPSWSvutm0zJE5k78eYqFBQbVqoMuteBlVpbBrwf6HtQ3kmqwpRHruSfaZSV68k0D4cjKvZAKxGBWKdbysuDL6GHaLbO7dANuwyW7VW8FhYsWoppfY70vYsmtT/YAxOu0XXMeyzQJPNOoYhV/JMFR+nV0+x1FTxfc8+BWdgMLkWt8LZUk6wMY1LG3W0t+Muc460QhiIT1WL5u6WkVw=
+dist: trusty
+sudo: required
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+⚠️ This Element is now deprecated in favor of [workbox](https://github.com/GoogleChrome/workbox) and [sw-toolbox](https://github.com/GoogleChrome/sw-toolbox) ⚠️
+
 # Platinum Service Worker Elements
 A set of Polymer elements that simplify service worker registration and caching, powered by the
 [`sw-toolbox` library](https://github.com/googlechrome/sw-toolbox).

diff --git a/bootstrap/sw-toolbox-setup.js b/bootstrap/sw-toolbox-setup.js
@@ -16,7 +16,7 @@
   if (cacheId) {
     global.toolbox.options.cacheName = cacheId + '$$$' + global.registration.scope;
   }
-  
+
   if (global.params.has('defaultCacheStrategy')) {
     var strategy = global.params.get('defaultCacheStrategy');
     global.toolbox.router.default = global.toolbox[strategy] || global[strategy];
@@ -43,7 +43,7 @@
   }
 
   global.toolbox.precache(precachePromise);
-  
+
   if (global.params.has('route')) {
     var setsOfRouteParams = global.params.get('route');
     while (setsOfRouteParams.length > 0) {

diff --git a/bower.json b/bower.json
@@ -1,7 +1,7 @@
 {
   "name": "platinum-sw",
   "private": true,
-  "version": "1.2.4",
+  "version": "2.0.0",
   "license": "http://polymer.github.io/LICENSE.txt",
   "authors": [
     "The Polymer Authors"
@@ -23,13 +23,35 @@
     "bower_components"
   ],
   "dependencies": {
-    "polymer": "Polymer/polymer#^1.5.0",
-    "sw-toolbox": "^3.1.1"
+    "polymer": "Polymer/polymer#1.9 - 2",
+    "sw-toolbox": "^3.6.1"
   },
   "devDependencies": {
-    "iron-component-page": "PolymerElements/iron-component-page#^1.0.2",
-    "marked-element": "PolymerElements/marked-element#^1.0.0",
-    "web-component-tester": "^4.0.0",
-    "fetch": "^0.9.0"
+    "fetch": "^0.9.0",
+    "iron-component-page": "PolymerElements/iron-component-page#1 - 2",
+    "marked-element": "PolymerElements/marked-element#1 - 2",
+    "web-component-tester": "Polymer/web-component-tester#^6.0.0",
+    "webcomponentsjs": "webcomponents/webcomponentsjs#^1.0.0"
+  },
+  "variants": {
+    "1.x": {
+      "dependencies": {
+        "polymer": "Polymer/polymer#^1.5.0",
+        "sw-toolbox": "^3.6.1"
+      },
+      "devDependencies": {
+        "fetch": "^0.9.0",
+        "iron-component-page": "PolymerElements/iron-component-page#^1.0.2",
+        "marked-element": "PolymerElements/marked-element#^1.0.0",
+        "web-component-tester": "^4.0.0",
+        "webcomponentsjs": "webcomponents/webcomponentsjs#^0.7.0"
+      },
+      "resolutions": {
+        "webcomponentsjs": "^0.7"
+      }
+    }
+  },
+  "resolutions": {
+    "webcomponentsjs": "^1.0.0"
   }
 }
diff --git a/platinum-sw-register.html b/platinum-sw-register.html
@@ -108,7 +108,8 @@
         // Fallback to './' as a default, though current browsers that don't support
         // document.currentScript also don't support service workers.
         value: document._currentScript ? document._currentScript.baseURI :
-          (document.currentScript ? document.currentScript.baseURI : './')
+          (HTMLImports.importForElement ? HTMLImports.importForElement(document.currentScript).baseURI :
+          (document.currentScript ? document.currentScript.baseURI : './'))
       },
 
       /**
@@ -251,9 +252,6 @@
         this._constructServiceWorkerUrl().then(function(serviceWorkerUrl) {
           this._registerServiceWorker(serviceWorkerUrl);
         }.bind(this));
-      } else {
-        this._setState('unsupported');
-        this.fire('service-worker-error', 'Service workers are not available in the current browser.');
       }
     },
 
@@ -376,8 +374,33 @@
     },
 
     attached: function() {
+      var isSupported = 'serviceWorker' in navigator;
+
+      if (!isSupported) {
+        this._setState('unsupported');
+        return;
+      }
+
       if (this.autoRegister) {
-        this.async(this.register);
+        /**
+          * Register requires all elements in the light dom to be upgraded. This
+          * behavior was expected in Polymer 1 but no longer in Polymer 2.
+          * Elements that are imported synchronously should be upgraded after
+          * the document's readyState is interactive and a
+          * requestAnimationFrame.
+          */
+        if (document.readyState !== 'complete' &&
+            document.readyState !== 'interactive') {
+
+          document.onreadystatechange = function() {
+            if (document.readyState === 'interactive') {
+              window.requestAnimationFrame(this.register.bind(this));
+            }
+          }.bind(this);
+
+        } else {
+          window.requestAnimationFrame(this.register.bind(this));
+        }
       }
     }
   });

diff --git a/service-worker.js b/service-worker.js
@@ -10,7 +10,7 @@
 
 (function(global) {
   var VERSION = '1.0';
-  
+
   function deserializeUrlParams(queryString) {
     return new Map(queryString.split('&').map(function(keyValuePair) {
       var splits = keyValuePair.split('=');
@@ -19,18 +19,18 @@
       if (value.indexOf(',') >= 0) {
         value = value.split(',');
       }
-  
+
       return [key, value];
     }));
   }
-  
+
   global.params = deserializeUrlParams(location.search.substring(1));
-  
+
   if (global.params.get('version') !== VERSION) {
     throw 'The registered script is version ' + VERSION +
           ' and cannot be used with <platinum-sw-register> version ' + global.params.get('version');
   }
-  
+
   if (global.params.has('importscript')) {
     var scripts = global.params.get('importscript');
     if (Array.isArray(scripts)) {
@@ -39,13 +39,13 @@
       importScripts(scripts);
     }
   }
-  
+
   if (global.params.get('skipWaiting') === 'true' && global.skipWaiting) {
     global.addEventListener('install', function(e) {
       e.waitUntil(global.skipWaiting());
     });
   }
-  
+
   if (global.params.get('clientsClaim') === 'true' && global.clients && global.clients.claim) {
     global.addEventListener('activate', function(e) {
       e.waitUntil(global.clients.claim());

diff --git a/test/index.html b/test/index.html
@@ -21,22 +21,22 @@
           // Keep each test suite in its own directory so that it gets a SW registered with a
           // limited scope, just in case the browser environment is not cleared in between each
           // test suite.
-          'platinum-sw-register/index.html',
-          'platinum-sw-cache/index.html',
-          'platinum-sw-import-script/index.html',
-          'platinum-sw-fetch/index.html',
           'platinum-sw-register/index.html?dom=shadow',
           'platinum-sw-cache/index.html?dom=shadow',
           'platinum-sw-import-script/index.html?dom=shadow',
-          'platinum-sw-fetch/index.html?dom=shadow'
+          'platinum-sw-fetch/index.html?dom=shadow',
+          'platinum-sw-register/index.html?wc-shadowdom=true&wc-ce=true',
+          'platinum-sw-cache/index.html?wc-shadowdom=true&wc-ce=true',
+          'platinum-sw-import-script/index.html?wc-shadowdom=true&wc-ce=true',
+          'platinum-sw-fetch/index.html?wc-shadowdom=true&wc-ce=true'
         ]);
       } else {
         WCT.loadSuites([
-          'platinum-sw-unsupported.html',
-          'platinum-sw-unsupported.html?dom=shadow'
+          'platinum-sw-unsupported.html?dom=shadow',
+          'platinum-sw-unsupported.html?wc-shadowdom=true&wc-ce=true'
         ]);
       }
     </script>
-  
+
 
 </body></html>
diff --git a/test/platinum-sw-import-script/index.html b/test/platinum-sw-import-script/index.html
@@ -29,7 +29,7 @@
     <script>
       suite('Importing Service Worker Scripts', function() {
         test('message handler is registered via imported script', function(done) {
-          return window._controlledPromise.then(function(registration) {
+          window._controlledPromise.then(function(registration) {
             var message = 'hello';
             var messageChannel = new MessageChannel();
             messageChannel.port1.onmessage = function(event) {

diff --git a/test/platinum-sw-unsupported.html b/test/platinum-sw-unsupported.html
@@ -23,7 +23,7 @@
     <platinum-sw-register auto-register></platinum-sw-register>
 
     <script>
-      document.addEventListener('WebComponentsReady', function() {
+      window.addEventListener('WebComponentsReady', function() {
         var sw = document.querySelector('platinum-sw-register');
         suite('Unsupported', function() {
           test('state is properly set', function() {