@parse/push-adapter 5.1.1 → 6.0.0

package/README.md

@@ -5,6 +5,8 @@
 [![Coverage](https://img.shields.io/codecov/c/github/parse-community/parse-server-push-adapter/master.svg)](https://codecov.io/github/parse-community/parse-server-push-adapter?branch=master)
 [![auto-release](https://img.shields.io/badge/%F0%9F%9A%80-auto--release-9e34eb.svg)](https://github.com/parse-community/parse-server-push-adapter/releases)
 
+[![Node Version](https://img.shields.io/badge/nodejs-18,_20-green.svg?logo=node.js&style=flat)](https://nodejs.org)
+
 [![npm latest version](https://img.shields.io/npm/v/@parse/push-adapter.svg)](https://www.npmjs.com/package/@parse/push-adapter)
 
 ---

package/lib/FCM.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 
 Object.defineProperty(exports, "__esModule", {
   value: true
@@ -29,8 +29,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 var LOG_PREFIX = 'parse-server-push-adapter FCM';
 var FCMRegistrationTokensMax = 500;
 var FCMTimeToLiveMax = 4 * 7 * 24 * 60 * 60; // FCM allows a max of 4 weeks
+var apnsIntegerDataKeys = ['badge', 'content-available', 'mutable-content', 'priority', 'expiration_time'];
 
-function FCM(args) {
+function FCM(args, pushType) {
   if ((typeof args === 'undefined' ? 'undefined' : _typeof(args)) !== 'object' || !args.firebaseServiceAccount) {
     throw new _parse2.default.Error(_parse2.default.Error.PUSH_MISCONFIGURED, 'FCM Configuration is invalid');
   }
@@ -42,6 +43,7 @@ function FCM(args) {
     app = (0, _app.getApp)();
   }
   this.sender = (0, _messaging.getMessaging)(app);
+  this.pushType = pushType; // Push type is only used to remain backwards compatible with APNS and GCM
 }
 
 FCM.FCMRegistrationTokensMax = FCMRegistrationTokensMax;
@@ -65,7 +67,7 @@ FCM.prototype.send = function (data, devices) {
   // chunk if necessary
   var slices = sliceDevices(devices, FCM.FCMRegistrationTokensMax);
 
-  var sendToDeviceSlice = function sendToDeviceSlice(deviceSlice) {
+  var sendToDeviceSlice = function sendToDeviceSlice(deviceSlice, pushType) {
     var pushId = (0, _PushAdapterUtils.randomString)(10);
     var timestamp = Date.now();
 
@@ -76,7 +78,8 @@ FCM.prototype.send = function (data, devices) {
     }, {});
 
     var deviceTokens = Object.keys(devicesMap);
-    var fcmPayload = generateFCMPayload(data, pushId, timestamp, deviceTokens);
+
+    var fcmPayload = generateFCMPayload(data, pushId, timestamp, deviceTokens, pushType);
     var length = deviceTokens.length;
     _npmlog2.default.info(LOG_PREFIX, 'sending push to ' + length + ' devices');
 
@@ -108,21 +111,205 @@ FCM.prototype.send = function (data, devices) {
     });
   };
 
-  var allPromises = Promise.all(slices.map(sendToDeviceSlice)).catch(function (err) {
+  var allPromises = Promise.all(slices.map(function (slice) {
+    return sendToDeviceSlice(slice, _this.pushType);
+  })).catch(function (err) {
     _npmlog2.default.error(LOG_PREFIX, 'error sending push: ' + err);
   });
 
   return allPromises;
 };
 
+function _APNSToFCMPayload(requestData) {
+  var coreData = requestData;
+
+  if (requestData.hasOwnProperty('data')) {
+    coreData = requestData.data;
+  }
+
+  var expirationTime = requestData['expiration_time'] || coreData['expiration_time'];
+  var collapseId = requestData['collapse_id'] || coreData['collapse_id'];
+  var pushType = requestData['push_type'] || coreData['push_type'];
+  var priority = requestData['priority'] || coreData['priority'];
+
+  var apnsPayload = { apns: { payload: { aps: {} } } };
+  var headers = {};
+
+  // Set to alert by default if not set explicitly
+  headers['apns-push-type'] = 'alert';
+
+  if (expirationTime) {
+    headers['apns-expiration'] = Math.round(expirationTime / 1000);
+  }
+
+  if (collapseId) {
+    headers['apns-collapse-id'] = collapseId;
+  }
+  if (pushType) {
+    headers['apns-push-type'] = pushType;
+  }
+  if (priority) {
+    headers['apns-priority'] = priority;
+  }
+
+  if (Object.keys(headers).length > 0) {
+    apnsPayload.apns.headers = headers;
+  }
+
+  for (var key in coreData) {
+    switch (key) {
+      case 'aps':
+        apnsPayload['apns']['payload']['aps'] = coreData.aps;
+        break;
+      case 'alert':
+        if (!apnsPayload['apns']['payload']['aps'].hasOwnProperty('alert')) {
+          apnsPayload['apns']['payload']['aps']['alert'] = {};
+        }
+        // In APNS.js we set a body with the same value as alert in requestData.
+        // See L200 in APNS.spec.js
+        apnsPayload['apns']['payload']['aps']['alert']['body'] = coreData.alert;
+        break;
+      case 'title':
+        // Ensure the alert object exists before trying to assign the title
+        if (!apnsPayload['apns']['payload']['aps'].hasOwnProperty('alert')) {
+          apnsPayload['apns']['payload']['aps']['alert'] = {};
+        }
+        apnsPayload['apns']['payload']['aps']['alert']['title'] = coreData.title;
+        break;
+      case 'badge':
+        apnsPayload['apns']['payload']['aps']['badge'] = coreData.badge;
+        break;
+      case 'sound':
+        apnsPayload['apns']['payload']['aps']['sound'] = coreData.sound;
+        break;
+      case 'content-available':
+        apnsPayload['apns']['payload']['aps']['content-available'] = coreData['content-available'];
+        break;
+      case 'mutable-content':
+        apnsPayload['apns']['payload']['aps']['mutable-content'] = coreData['mutable-content'];
+        break;
+      case 'targetContentIdentifier':
+        apnsPayload['apns']['payload']['aps']['target-content-id'] = coreData.targetContentIdentifier;
+        break;
+      case 'interruptionLevel':
+        apnsPayload['apns']['payload']['aps']['interruption-level'] = coreData.interruptionLevel;
+        break;
+      case 'category':
+        apnsPayload['apns']['payload']['aps']['category'] = coreData.category;
+        break;
+      case 'threadId':
+        apnsPayload['apns']['payload']['aps']['thread-id'] = coreData.threadId;
+        break;
+      case 'expiration_time':
+        // Exclude header-related fields as these are set above
+        break;
+      case 'collapse_id':
+        break;
+      case 'push_type':
+        break;
+      case 'priority':
+        break;
+      default:
+        apnsPayload['apns']['payload'][key] = coreData[key]; // Custom keys should be outside aps
+        break;
+    }
+  }
+  return apnsPayload;
+}
+
+function _GCMToFCMPayload(requestData, timeStamp) {
+  var androidPayload = {
+    android: {
+      priority: 'high'
+    }
+  };
+
+  if (requestData.hasOwnProperty('notification')) {
+    androidPayload.android.notification = requestData.notification;
+  }
+
+  if (requestData.hasOwnProperty('data')) {
+    // FCM gives an error on send if we have apns keys that should have integer values
+    var _iteratorNormalCompletion = true;
+    var _didIteratorError = false;
+    var _iteratorError = undefined;
+
+    try {
+      for (var _iterator = apnsIntegerDataKeys[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+        var key = _step.value;
+
+        if (requestData.data.hasOwnProperty(key)) {
+          delete requestData.data[key];
+        }
+      }
+    } catch (err) {
+      _didIteratorError = true;
+      _iteratorError = err;
+    } finally {
+      try {
+        if (!_iteratorNormalCompletion && _iterator.return) {
+          _iterator.return();
+        }
+      } finally {
+        if (_didIteratorError) {
+          throw _iteratorError;
+        }
+      }
+    }
+
+    androidPayload.android.data = requestData.data;
+  }
+
+  if (requestData['expiration_time']) {
+    var expirationTime = requestData['expiration_time'];
+    // Convert to seconds
+    var timeToLive = Math.floor((expirationTime - timeStamp) / 1000);
+    if (timeToLive < 0) {
+      timeToLive = 0;
+    }
+    if (timeToLive >= FCMTimeToLiveMax) {
+      timeToLive = FCMTimeToLiveMax;
+    }
+
+    androidPayload.android.ttl = timeToLive;
+  }
+
+  return androidPayload;
+}
+
+/**
+ * Converts payloads used by APNS or GCM into a FCMv1-compatible payload.
+ * Purpose is to remain backwards-compatible will payloads used in the APNS.js and GCM.js modules.
+ * If the key rawPayload is present in the requestData, a raw payload will be used. Otherwise, conversion is done.
+ * @param {Object} requestData The request body
+ * @param {String} pushType Either apple or android.
+ * @param {Number} timeStamp Used during GCM payload conversion for ttl
+ * @returns {Object} A FCMv1-compatible payload.
+ */
+function payloadConverter(requestData, pushType, timeStamp) {
+  if (requestData.hasOwnProperty('rawPayload')) {
+    return requestData.rawPayload;
+  }
+
+  if (pushType === 'apple') {
+    return _APNSToFCMPayload(requestData);
+  } else if (pushType === 'android') {
+    return _GCMToFCMPayload(requestData, timeStamp);
+  } else {
+    throw new _parse2.default.Error(_parse2.default.Error.PUSH_MISCONFIGURED, 'Unsupported push type, apple or android only.');
+  }
+}
+
 /**
  * Generate the fcm payload from the data we get from api request.
  * @param {Object} requestData The request body
  * @param {String} pushId A random string
  * @param {Number} timeStamp A number in milliseconds since the Unix Epoch
+ * @param {Array.<String>} deviceTokens An array of deviceTokens
+ * @param {String} pushType Either apple or android
  * @returns {Object} A payload for FCM
  */
-function generateFCMPayload(requestData, pushId, timeStamp, deviceTokens) {
+function generateFCMPayload(requestData, pushId, timeStamp, deviceTokens, pushType) {
   delete requestData['where'];
 
   var payloadToUse = {
@@ -131,44 +318,10 @@ function generateFCMPayload(requestData, pushId, timeStamp, deviceTokens) {
     time: new Date(timeStamp).toISOString()
   };
 
-  // Use rawPayload instead of the GCM implementation if it exists
-  if (requestData.hasOwnProperty('rawPayload')) {
-    payloadToUse.data = _extends({}, requestData.rawPayload, {
-      tokens: deviceTokens
-    });
-  } else {
-    // Android payload according to GCM implementation
-    var androidPayload = {
-      android: {
-        priority: 'high'
-      },
-      tokens: deviceTokens
-    };
-
-    if (requestData.hasOwnProperty('notification')) {
-      androidPayload.notification = requestData.notification;
-    }
-
-    if (requestData.hasOwnProperty('data')) {
-      androidPayload.data = requestData.data;
-    }
-
-    if (requestData['expiration_time']) {
-      var expirationTime = requestData['expiration_time'];
-      // Convert to seconds
-      var timeToLive = Math.floor((expirationTime - timeStamp) / 1000);
-      if (timeToLive < 0) {
-        timeToLive = 0;
-      }
-      if (timeToLive >= FCMTimeToLiveMax) {
-        timeToLive = FCMTimeToLiveMax;
-      }
-
-      androidPayload.android.ttl = timeToLive;
-    }
-
-    payloadToUse.data = androidPayload;
-  }
+  var fcmPayload = payloadConverter(requestData, pushType, timeStamp);
+  payloadToUse.data = _extends({}, fcmPayload, {
+    tokens: deviceTokens
+  });
 
   return payloadToUse;
 }

package/lib/ParsePushAdapter.js

@@ -67,7 +67,7 @@ var ParsePushAdapter = function () {
           case 'tvos':
           case 'osx':
             if (pushConfig[pushType].hasOwnProperty('firebaseServiceAccount')) {
-              this.senderMap[pushType] = new _FCM2.default(pushConfig[pushType]);
+              this.senderMap[pushType] = new _FCM2.default(pushConfig[pushType], 'apple');
             } else {
               this.senderMap[pushType] = new _APNS2.default(pushConfig[pushType]);
             }
@@ -75,7 +75,7 @@ var ParsePushAdapter = function () {
           case 'android':
           case 'fcm':
             if (pushConfig[pushType].hasOwnProperty('firebaseServiceAccount')) {
-              this.senderMap[pushType] = new _FCM2.default(pushConfig[pushType]);
+              this.senderMap[pushType] = new _FCM2.default(pushConfig[pushType], 'android');
             } else {
               this.senderMap[pushType] = new _GCM2.default(pushConfig[pushType]);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parse/push-adapter",
-  "version": "5.1.1",
+  "version": "6.0.0",
   "description": "Base parse-server-push-adapter",
   "main": "lib/index.js",
   "files": [
@@ -22,6 +22,13 @@
   },
   "author": "Parse",
   "license": "MIT",
+  "dependencies": {
+    "@parse/node-apn": "6.0.1",
+    "@parse/node-gcm": "1.0.2",
+    "firebase-admin": "12.0.0",
+    "npmlog": "7.0.1",
+    "parse": "5.0.0"
+  },
   "devDependencies": {
     "@semantic-release/changelog": "5.0.1",
     "@semantic-release/commit-analyzer": "8.0.1",
@@ -39,14 +46,7 @@
     "nyc": "14.1.1",
     "semantic-release": "17.4.6"
   },
-  "dependencies": {
-    "@parse/node-apn": "6.0.1",
-    "@parse/node-gcm": "1.0.2",
-    "firebase-admin": "12.0.0",
-    "npmlog": "7.0.1",
-    "parse": "4.2.0"
-  },
   "engines": {
-    "node": ">= 14"
+    "node": ">=18.0.0 <21"
   }
 }