Skip to content

Added notification field for fcm [WIP] #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 1, 2016
Merged

Added notification field for fcm [WIP] #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7672fde
Implemented notification field form fcm
mmazzarolo Nov 2, 2016
6fc7d87
Updated specs for notifications
mmazzarolo Nov 2, 2016
02e032a
Added 'fcm' to valid push types
mmazzarolo Nov 9, 2016
726f9a6
priority -> high, data no more stringified
mmazzarolo Nov 9, 2016
8a2dfcf
Fixed tests
mmazzarolo Nov 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 52 additions & 24 deletions spec/GCM.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,89 +20,117 @@ describe('GCM', () => {

it('can generate GCM Payload without expiration time', (done) => {
//Mock request data
var data = {
'alert': 'alert'
var requestData = {
data: {
'alert': 'alert'
},
notification: {
'title': 'I am a title',
'body': 'I am a body'
}
};
var pushId = 'pushId';
var timeStamp = 1454538822113;
var timeStampISOStr = new Date(timeStamp).toISOString();

var payload = GCM.generateGCMPayload(data, pushId, timeStamp);
var payload = GCM.generateGCMPayload(requestData, pushId, timeStamp);

expect(payload.priority).toEqual('normal');
expect(payload.priority).toEqual('high');
expect(payload.timeToLive).toEqual(undefined);
var dataFromPayload = payload.data;
expect(dataFromPayload.time).toEqual(timeStampISOStr);
expect(payload.notification).toEqual(requestData.notification);
expect(dataFromPayload['push_id']).toEqual(pushId);
var dataFromUser = JSON.parse(dataFromPayload.data);
expect(dataFromUser).toEqual(data);
var dataFromUser = dataFromPayload.data;
expect(dataFromUser).toEqual(requestData.data);
done();
});

it('can generate GCM Payload with valid expiration time', (done) => {
//Mock request data
var data = {
'alert': 'alert'
var requestData = {
data: {
'alert': 'alert'
},
notification: {
'title': 'I am a title',
'body': 'I am a body'
}
};
var pushId = 'pushId';
var timeStamp = 1454538822113;
var timeStampISOStr = new Date(timeStamp).toISOString();
var expirationTime = 1454538922113

var payload = GCM.generateGCMPayload(data, pushId, timeStamp, expirationTime);
var payload = GCM.generateGCMPayload(requestData, pushId, timeStamp, expirationTime);

expect(payload.priority).toEqual('normal');
expect(payload.priority).toEqual('high');
expect(payload.timeToLive).toEqual(Math.floor((expirationTime - timeStamp) / 1000));
var dataFromPayload = payload.data;
expect(dataFromPayload.time).toEqual(timeStampISOStr);
expect(payload.notification).toEqual(requestData.notification);
expect(dataFromPayload['push_id']).toEqual(pushId);
var dataFromUser = JSON.parse(dataFromPayload.data);
expect(dataFromUser).toEqual(data);
var dataFromUser = dataFromPayload.data;
expect(dataFromUser).toEqual(requestData.data);
done();
});

it('can generate GCM Payload with too early expiration time', (done) => {
//Mock request data
var data = {
'alert': 'alert'
var requestData = {
data: {
'alert': 'alert'
},
notification: {
'title': 'I am a title',
'body': 'I am a body'
}
};
var pushId = 'pushId';
var timeStamp = 1454538822113;
var timeStampISOStr = new Date(timeStamp).toISOString();
var expirationTime = 1454538822112;

var payload = GCM.generateGCMPayload(data, pushId, timeStamp, expirationTime);
var payload = GCM.generateGCMPayload(requestData, pushId, timeStamp, expirationTime);

expect(payload.priority).toEqual('normal');
expect(payload.priority).toEqual('high');
expect(payload.timeToLive).toEqual(0);
var dataFromPayload = payload.data;
expect(dataFromPayload.time).toEqual(timeStampISOStr);
expect(payload.notification).toEqual(requestData.notification);
expect(dataFromPayload['push_id']).toEqual(pushId);
var dataFromUser = JSON.parse(dataFromPayload.data);
expect(dataFromUser).toEqual(data);
var dataFromUser = dataFromPayload.data;
expect(dataFromUser).toEqual(requestData.data);
done();
});

it('can generate GCM Payload with too late expiration time', (done) => {
//Mock request data
var data = {
'alert': 'alert'
var requestData = {
data: {
'alert': 'alert'
},
notification: {
'title': 'I am a title',
'body': 'I am a body'
}
};
var pushId = 'pushId';
var timeStamp = 1454538822113;
var timeStampISOStr = new Date(timeStamp).toISOString();
var expirationTime = 2454538822113;

var payload = GCM.generateGCMPayload(data, pushId, timeStamp, expirationTime);
var payload = GCM.generateGCMPayload(requestData, pushId, timeStamp, expirationTime);

expect(payload.priority).toEqual('normal');
expect(payload.priority).toEqual('high');
// Four week in second
expect(payload.timeToLive).toEqual(4 * 7 * 24 * 60 * 60);
var dataFromPayload = payload.data;
expect(dataFromPayload.time).toEqual(timeStampISOStr);
expect(payload.notification).toEqual(requestData.notification);
expect(dataFromPayload['push_id']).toEqual(pushId);
var dataFromUser = JSON.parse(dataFromPayload.data);
expect(dataFromUser).toEqual(data);
var dataFromUser = dataFromPayload.data;
expect(dataFromUser).toEqual(requestData.data);
done();
});

Expand Down
4 changes: 2 additions & 2 deletions spec/ParsePushAdapter.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ describe('ParsePushAdapter', () => {
it('can get valid push types', (done) => {
var parsePushAdapter = new ParsePushAdapter();

expect(parsePushAdapter.getValidPushTypes()).toEqual(['ios', 'android']);
expect(parsePushAdapter.getValidPushTypes()).toEqual(['ios', 'android', 'fcm']);
done();
});

it('can classify installation', (done) => {
// Mock installations
var validPushTypes = ['ios', 'android'];
var validPushTypes = ['ios', 'android', 'fcm'];
var installations = [
{
deviceType: 'android',
Expand Down
25 changes: 15 additions & 10 deletions src/GCM.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ GCM.prototype.send = function(data, devices) {
}
// Generate gcm payload
// PushId is not a formal field of GCM, but Parse Android SDK uses this field to deduplicate push notifications
let gcmPayload = generateGCMPayload(data.data, pushId, timestamp, expirationTime);
let gcmPayload = generateGCMPayload(data, pushId, timestamp, expirationTime);
// Make and send gcm request
let message = new gcm.Message(gcmPayload);

Expand Down Expand Up @@ -114,22 +114,27 @@ GCM.prototype.send = function(data, devices) {

/**
* Generate the gcm payload from the data we get from api request.
* @param {Object} coreData The data field under api request body
* @param {Object} requestData The request body
* @param {String} pushId A random string
* @param {Number} timeStamp A number whose format is the Unix Epoch
* @param {Number|undefined} expirationTime A number whose format is the Unix Epoch or undefined
* @returns {Object} A promise which is resolved after we get results from gcm
*/
function generateGCMPayload(coreData, pushId, timeStamp, expirationTime) {
let payloadData = {
'time': new Date(timeStamp).toISOString(),
'push_id': pushId,
'data': JSON.stringify(coreData)
}
function generateGCMPayload(requestData, pushId, timeStamp, expirationTime) {
let payload = {
priority: 'normal',
data: payloadData
priority: 'high'
};
payload.data = {
data: requestData.data,
push_id: pushId,
time: new Date(timeStamp).toISOString()
}
if (requestData.content_available) {
payload.content_available = requestData.content_available;
}
if (requestData.notification) {
payload.notification = requestData.notification;
}
if (expirationTime) {
// The timeStamp and expiration is in milliseconds but gcm requires second
let timeToLive = Math.floor((expirationTime - timeStamp) / 1000);
Expand Down
3 changes: 2 additions & 1 deletion src/ParsePushAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export class ParsePushAdapter {
supportsPushTracking = true;

constructor(pushConfig = {}) {
this.validPushTypes = ['ios', 'android'];
this.validPushTypes = ['ios', 'android', 'fcm'];
this.senderMap = {};
// used in PushController for Dashboard Features
this.feature = {
Expand All @@ -30,6 +30,7 @@ export class ParsePushAdapter {
this.senderMap[pushType] = new APNS(pushConfig[pushType]);
break;
case 'android':
case 'fcm':
this.senderMap[pushType] = new GCM(pushConfig[pushType]);
break;
}
Expand Down