Last set of patches from review

Author: Matt Gaunt

src/vapid-helper.js

@@ -104,6 +104,11 @@ function getVapidHeaders(audience, subject, publicKey, privateKey, expiration) {
     throw new Error('Vapid private key should be 32 bytes long');
   }
 
+  if (expiration) {
+    // TODO: Check if expiration is valid and use it in place of the hard coded
+    // expiration of 24hours.
+  }
+
   const header = {
     typ: 'JWT',
     alg: 'ES256'
@@ -115,10 +120,6 @@ function getVapidHeaders(audience, subject, publicKey, privateKey, expiration) {
     sub: subject
   };
 
-  if (expiration) {
-    console.log('expiration', expiration);
-  }
-
   const jwt = jws.sign({
     header: header,
     payload: jwtPayload,

src/web-push-lib.js

@@ -103,6 +103,21 @@ WebPushLib.prototype.sendNotification =
     let timeToLive = DEFAULT_TTL;
 
     if (options) {
+      const validOptionKeys = [
+        'gcmAPIKey',
+        'vapidDetails',
+        'TTL'
+      ];
+      const optionKeys = Object.keys(options);
+      for (let i = 0; i < optionKeys.length; i++) {
+        const optionKey = optionKeys[i];
+        if (validOptionKeys.indexOf(optionKey) === -1) {
+          return Promise.reject('\'' + optionKey + '\' is an invalid option. ' +
+            'The valid options are [\'' + validOptionKeys.join('\', \'') +
+            '\'].');
+        }
+      }
+
       if (options.gcmAPIKey) {
         currentGCMAPIKey = options.gcmAPIKey;
       }
@@ -160,6 +175,7 @@ WebPushLib.prototype.sendNotification =
 
     const isGCM = subscription.endpoint.indexOf(
       'https://android.googleapis.com/gcm/send') === 0;
+    // VAPID isn't supported by GCM hence the if, else if.
     if (isGCM) {
       if (!currentGCMAPIKey) {
         console.warn('Attempt to send push notification to GCM endpoint, ' +
@@ -168,7 +184,6 @@ WebPushLib.prototype.sendNotification =
         requestOptions.headers.Authorization = 'key=' + currentGCMAPIKey;
       }
     } else if (currentVapidDetails) {
-      // VAPID isn't supported by GCM.
       const parsedUrl = url.parse(subscription.endpoint);
       const audience = parsedUrl.protocol + '//' +
         parsedUrl.hostname;
@@ -217,7 +232,6 @@ WebPushLib.prototype.sendNotification =
       });
 
       pushRequest.on('error', function(e) {
-        console.error(e);
         reject(e);
       });
 

test/test-vapid-helper.js

@@ -4,6 +4,13 @@ const assert = require('assert');
 const webPush = require('../src/index');
 const vapidHelper = require('../src/vapid-helper');
 
+const VALID_AUDIENCE = 'https://example.com';
+const VALID_SUBJECT_MAILTO = 'mailto: [email protected]';
+const VALID_SUBJECT_URL = 'https://exampe.com/contact';
+const VALID_PUBLIC_KEY = new Buffer(65);
+const VALID_PRIVATE_KEY = new Buffer(32);
+const VALID_EXPIRATION = Math.floor(Date.now() / 1000) + (60 * 60 * 12);
+
 suite('Test Vapid Helpers', function() {
   test('is defined', function() {
     assert(webPush.generateVAPIDKeys);
@@ -32,12 +39,6 @@ suite('Test Vapid Helpers', function() {
   });
 
   test('should throw errors on bad input', function() {
-    const VALID_AUDIENCE = 'https://example.com';
-    const VALID_SUBJECT_MAILTO = 'mailto: [email protected]';
-    const VALID_SUBJECT_URL = 'https://exampe.com/contact';
-    const VALID_PUBLIC_KEY = new Buffer(65);
-    const VALID_PRIVATE_KEY = new Buffer(5);
-
     const badInputs = [
       function() {
         // No args
@@ -93,6 +94,32 @@ suite('Test Vapid Helpers', function() {
     });
   });
 
-  // TODO:2 good tests for the vapid headers
-  // TODO: Make sure you can v
+  test('should get valid VAPID headers', function() {
+    const validInputs = [
+      function() {
+        return vapidHelper.getVapidHeaders(VALID_AUDIENCE, VALID_SUBJECT_URL,
+          VALID_PUBLIC_KEY, VALID_PRIVATE_KEY);
+      },
+      function() {
+        return vapidHelper.getVapidHeaders(VALID_AUDIENCE, VALID_SUBJECT_MAILTO,
+          VALID_PUBLIC_KEY, VALID_PRIVATE_KEY);
+      },
+      function() {
+        return vapidHelper.getVapidHeaders(VALID_AUDIENCE, VALID_SUBJECT_URL,
+          VALID_PUBLIC_KEY, VALID_PRIVATE_KEY, VALID_EXPIRATION);
+      }
+    ];
+
+    validInputs.forEach(function(validInput, index) {
+      try {
+        const headers = validInput();
+        assert(headers.Authorization);
+        assert(headers['Crypto-Key']);
+      } catch (err) {
+        console.warn('Valid input call for getVapidHeaders() threw an ' +
+          'error. [' + index + ']');
+        throw err;
+      }
+    });
+  });
 });

test/testSelenium.js

@@ -35,11 +35,6 @@
   const testDirectory = './test/output/';
 
   webPush.setGCMAPIKey('AIzaSyAwmdX6KKd4hPfIcGU2SOfj9vuRDW6u-wo');
-  webPush.setVapidDetails(
-    VAPID_PARAM.subject,
-    VAPID_PARAM.publicKey,
-    VAPID_PARAM.privateKey
-  );
 
   let globalServer;
   let globalDriver;
@@ -179,15 +174,15 @@
 
         if (!pushPayload) {
           promise = webPush.sendNotification(subscription, null, {
-            vapid: vapid
+            vapidDetails: vapid
           });
         } else {
           if (!subscription.keys) {
             throw new Error('Require subscription.keys not found.');
           }
 
           promise = webPush.sendNotification(subscription, pushPayload, {
-            vapid: vapid
+            vapidDetails: vapid
           });
         }
 

test/testSendNotification.js

@@ -267,7 +267,7 @@ suite('sendNotification', function() {
         },
         message: 'hello',
         extraOptions: {
-          vapid: {
+          vapidDetails: {
             subject: 'mailto:[email protected]',
             privateKey: vapidKeys.privateKey,
             publicKey: vapidKeys.publicKey
@@ -350,7 +350,7 @@ suite('sendNotification', function() {
         subscription: {
         },
         extraOptions: {
-          vapid: {
+          vapidDetails: {
             subject: 'mailto:[email protected]',
             privateKey: vapidKeys.privateKey,
             publicKey: vapidKeys.publicKey
@@ -553,6 +553,22 @@ suite('sendNotification', function() {
       },
       addEndpoint: true,
       serverFlags: ['statusCode=404']
+    }, {
+      testTitle: 'send notification with invalid vapid option',
+      requestOptions: {
+        subscription: {
+          keys: VALID_KEYS
+        },
+        message: 'hello',
+        addEndpoint: true,
+        extraOptions: {
+          vapid: {
+            subject: 'mailto:[email protected]',
+            privateKey: vapidKeys.privateKey,
+            publicKey: vapidKeys.publicKey
+          }
+        }
+      }
     }
   ];
 

test/testSetGCMAPIKey.js

@@ -32,7 +32,7 @@ suite('setGCMAPIKey', function() {
     }, Error);
   });
 
-  test('undefined valud', function() {
+  test('undefined value', function() {
     assert.throws(function() {
       webPush.setGCMAPIKey();
     }, Error);