Merge pull request #251 from delapuente/issue-235-extra-headers

Adding headers key to options for supporting future headers.

Author: marco-c

src/web-push-lib.js

@@ -106,9 +106,11 @@ WebPushLib.prototype.generateRequestDetails =
     let currentGCMAPIKey = gcmAPIKey;
     let currentVapidDetails = vapidDetails;
     let timeToLive = DEFAULT_TTL;
+    let extraHeaders = {};
 
     if (options) {
       const validOptionKeys = [
+        'headers',
         'gcmAPIKey',
         'vapidDetails',
         'TTL'
@@ -123,6 +125,20 @@ WebPushLib.prototype.generateRequestDetails =
         }
       }
 
+      if (options.headers) {
+        extraHeaders = options.headers;
+        let duplicates = Object.keys(extraHeaders)
+            .filter(function (header) {
+              return typeof options[header] !== 'undefined';
+            });
+
+        if (duplicates.length > 0) {
+          throw new Error('Duplicated headers defined [' +
+            duplicates.join(',') + ']. Please either define the header in the' +
+            'top level options OR in the \'headers\' key.');
+        }
+      }
+
       if (options.gcmAPIKey) {
         currentGCMAPIKey = options.gcmAPIKey;
       }
@@ -146,6 +162,9 @@ WebPushLib.prototype.generateRequestDetails =
         TTL: timeToLive
       }
     };
+    Object.keys(extraHeaders).forEach(function (header) {
+      requestDetails.headers[header] = extraHeaders[header];
+    });
     let requestPayload = null;
 
     if (payload) {

test/test-generate-request-details.js

@@ -184,6 +184,21 @@ suite('Test Generate Request Details', function() {
           }
         }
       }
+    }, {
+      testTitle: 'duplicated headers',
+      requestOptions: {
+        subscription: {
+          keys: VALID_KEYS
+        },
+        message: 'hello',
+        addEndpoint: true,
+        extraOptions: {
+          TTL: 100,
+          headers: {
+            'TTL': 900
+          }
+        }
+      }
     }
   ];
 
@@ -208,4 +223,24 @@ suite('Test Generate Request Details', function() {
       });
     });
   });
+
+  test('Extra headers', function() {
+    let subscription = { endpoint: 'https://127.0.0.1:8080' };
+    let message;
+    let extraOptions = {
+      TTL: 100,
+      headers: {
+        'Topic': 'topic',
+        'Urgency': 'urgency'
+      }
+    };
+    let details = webPush.generateRequestDetails(
+      subscription,
+      message,
+      extraOptions
+    );
+    assert.equal(details.headers.TTL, extraOptions.TTL);
+    assert.equal(details.headers.Topic, extraOptions.headers.Topic);
+    assert.equal(details.headers.Urgency, extraOptions.headers.Urgency);
+  });
 });

test/testSendNotification.js

@@ -191,6 +191,14 @@ suite('sendNotification', function() {
         assert.equal(requestDetails.headers.authorization, 'key=my_gcm_key', 'Check GCM Authorization header');
       }
     }
+
+    const extraHeaders = options.extraOptions && options.extraOptions.headers;
+    if (extraHeaders) {
+      Object.keys(extraHeaders).forEach(function (header) {
+        const normalizedName = header.toLowerCase();
+        assert.equal(requestDetails.headers[normalizedName], extraHeaders[header], 'Check presence of header ' + header);
+      });
+    }
   }
 
   const validRequests = [
@@ -284,6 +292,19 @@ suite('sendNotification', function() {
           TTL: 5
         }
       }
+    }, {
+      testTitle: 'send/receive extra headers',
+      requestOptions: {
+        subscription: {
+          // The default endpoint will be added by the test
+        },
+        extraOptions: {
+          headers: {
+            Extra: 'extra',
+            'extra-2': 'extra-2'
+          }
+        }
+      }
     }
   ];