yehor/ha_client_fcf
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1 from estevez-dev/v2

Browse Source 
V2
This commit is contained in:
Yegor Vialov 2020-05-24 13:22:48 +03:00 committed by GitHub
commit 783752ed65
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 285 additions and 185 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

159
functions/index.js
View File

@ -1,5 +1,7 @@
'use strict';
const worker = require('./worker');
const functions = require('firebase-functions');
const admin = require('firebase-admin');
@ -7,11 +9,14 @@ admin.initializeApp();
var db = admin.firestore();
const MAX_NOTIFICATIONS_PER_DAY = 50;
const MAX_NOTIFICATIONS_PER_DAY = 100;
//==============================
// Legacy function begin
//==============================
exports.sendPushNotification = functions.https.onRequest(async (req, res) => {
if (debug()) console.log('Received payload', req.body);
var currentRateLimitDocName = getCurrentRateLimitsDocName();
var currentRateLimitDocName = legacyGetCurrentRateLimitsDocName();
var token = req.body.push_token;
var ref = db.collection('rateLimits').doc(currentRateLimitDocName).collection('tokens').doc(token);
@ -66,11 +71,11 @@ exports.sendPushNotification = functions.https.onRequest(async (req, res) => {
}
} catch(err) {
console.error('Error getting document!', err);
return handleError(res, 'getDoc', err);
return legacyHandleError(res, 'getDoc', err);
}
if(docData.deliveredCount > MAX_NOTIFICATIONS_PER_DAY) {
return res.status(429).send({
return res.status(429).json({
errorType: 'RateLimited',
message: 'The given target has reached the maximum number of notifications allowed per day. Please try again later.',
target: token,
@ -87,53 +92,177 @@ exports.sendPushNotification = functions.https.onRequest(async (req, res) => {
} catch(err) {
docData.errorCount = docData.errorCount + 1;
await setRateLimitDoc(ref, docExists, docData, res);
return handleError(res, 'sendNotification', err);
return legacyHandleError(res, 'sendNotification', err);
}
if (debug()) console.log('Successfully sent message:', messageId);
await setRateLimitDoc(ref, docExists, docData, res);
return res.status(201).send({
return res.status(201).json({
messageId: messageId,
sentPayload: payload,
target: token,
rateLimits: getRateLimitsObject(docData),
});
});
async function setRateLimitDoc(ref, docExists, docData, res) {
try {
if(docExists) {
if (debug()) console.log('Updating existing doc');
await ref.update(docData);
} else {
if (debug()) console.log('Creating new doc');
await ref.set(docData);
}
} catch(err) {
if(docExists) {
console.error('Error updating document', err);
} else {
console.error('Error creating document', err);
}
return legacyHandleError(res, 'setDocument', err);
}
return true;
}
function legacyGetCurrentRateLimitsDocName() {
var today = new Date();
var dd = String(today.getDate()).padStart(2, '0');
var mm = String(today.getMonth() + 1).padStart(2, '0');
var yyyy = today.getFullYear();
return yyyy + mm + dd;
}
function legacyHandleError(res, step, incomingError) {
if (!incomingError) return null;
console.error('InternalError during', step, incomingError);
return res.status(500).json({
errorType: 'InternalError',
errorStep: step,
message: incomingError.message,
});
}
//==============================
// Legacy function end
//==============================
exports.pushNotifyV2 = functions.https.onRequest(async (req, res) => {
return handleRequest(req, res, worker.createPayload);
});
async function handleRequest(req, res, payloadHandler) {
if (debug()) console.log('Received payload', req.body);
var today = getToday();
var token = req.body.push_token;
if (!token) {
return res.status(403).json({ 'errorMessage': 'Missed token' });
}
if (token.indexOf(':') === -1) {
return res.status(403).json({'errorMessage': 'Invalid token'});
}
var workerResult = payloadHandler(req);
var updateRateLimits = workerResult.updateRateLimits;
var payload = workerResult.payload;
payload['token'] = token;
var ref = db.collection('rateLimitsV2').doc(today).collection('tokens').doc(token);
var docExists = false;
var docData = {
deliveredCount: 0,
errorCount: 0,
totalCount: 0,
};
try {
var currentDoc = await ref.get();
docExists = currentDoc.exists;
if (currentDoc.exists) {
docData = currentDoc.data();
}
} catch(err) {
console.error('Error getting document', err);
return handleError(res, 'getDoc', err);
}
if (updateRateLimits && docData.deliveredCount > MAX_NOTIFICATIONS_PER_DAY) {
return res.status(429).json({
errorType: 'RateLimited',
message: 'You have exited the maximum number of notifications allowed per day. Please try again later.',
target: token,
rateLimits: getRateLimitsObject(docData),
});
}
docData.totalCount = docData.totalCount + 1;
if (debug) console.log('Sending payload', JSON.stringify(payload));
var messageId;
try {
messageId = await admin.messaging().send(payload);
docData.deliveredCount = docData.deliveredCount + 1;
} catch(err) {
docData.errorCount = docData.errorCount + 1;
await writeRateLimits(ref, docExists, docData, res);
return handleError(res, payload, 'sendNotification', err);
}
if (debug()) console.log('Successfully sent message:', messageId);
if (updateRateLimits) {
await writeRateLimits(ref, docExists, docData, res);
} else {
if (debug) console.log('Not updating rate limits because notification is critical or command');
}
return res.status(201).json({
messageId: messageId,
sentPayload: payload,
target: token,
rateLimits: getRateLimitsObject(docData),
});
});
};
async function setRateLimitDoc(ref, docExists, docData, res) {
async function writeRateLimits(ref, docExists, docData, res) {
try {
if (docExists) {
if (debug()) console.log('Updating existing doc!');
if (debug()) console.log('Updating existing doc');
await ref.update(docData);
} else {
if (debug()) console.log('Creating new doc!');
if (debug()) console.log('Creating new doc');
await ref.set(docData);
}
} catch(err) {
if (docExists) {
console.error('Error updating document!', err);
console.error('Error updating document', err);
} else {
console.error('Error creating document!', err);
console.error('Error creating document', err);
}
return handleError(res, 'setDocument', err);
}
return true;
}
function handleError(res, step, incomingError) {
function handleError(res, payload, step, incomingError) {
if (!incomingError) return null;
if (payload) {
console.error('InternalError during', step, 'with payload', JSON.stringify(payload), incomingError);
} else {
console.error('InternalError during', step, incomingError);
return res.status(500).send({
}
return res.status(500).json({
errorType: 'InternalError',
errorStep: step,
message: incomingError.message,
});
}
function getCurrentRateLimitsDocName() {
function getToday() {
var today = new Date();
var dd = String(today.getDate()).padStart(2, '0');
var mm = String(today.getMonth() + 1).padStart(2, '0');

70
functions/payloader.js
View File

@ -1,70 +0,0 @@
module.exports = {
createPayload: function createPayload(req) {
let payload = {
android: {},
data: {},
fcm_options: {
analytics_label: "androidV1Notification"
}
};
let updateRateLimits = true;
if(req.body.data){
// Handle the web actions by changing them into a format the app can handle
// https://www.home-assistant.io/integrations/html5/#actions
if(req.body.data.actions) {
for (let i = 0; i < req.body.data.actions.length; i++) {
const action = req.body.data.actions[i];
if(action.action){
payload.data["action_"+(i+1)+"_key"] = action.action
}
if(action.title) {
payload.data["action_"+(i+1)+"_title"] = action.title
}
if(action.uri){
payload.data["action_"+(i+1)+"_uri"] = action.uri
}
}
}
// Allow setting of ttl
// https://firebase.google.com/docs/reference/admin/node/admin.messaging.AndroidConfig.html#optional-ttl
if(req.body.data.ttl){
payload.android.ttl = req.body.data.ttl
}
// https://firebase.google.com/docs/reference/admin/node/admin.messaging.AndroidConfig.html#optional-priority
if(req.body.data.priority){
payload.android.priority = req.body.data.priority
}
// https://firebase.google.com/docs/reference/admin/node/admin.messaging.AndroidNotification.html
for (const key of [
'icon', 'color', 'sound', 'tag', 'clickAction',
'bodyLocKey', 'bodyLocArgs', 'titleLocKey', 'titleLocArgs', 'channelId',
'ticker', 'sticky', 'eventTime', 'localOnly', 'notificationPriority',
'defaultSound', 'defaultVibrateTimings', 'defaultLightSettings', 'vibrateTimings',
'visibility', 'notificationCount', 'lightSettings', 'image'
]) {
if(req.body.data[key]){
payload.data[key] = String(req.body.data[key])
}
}
}
// Always put message, title, and image in data so that the application can handle creating
// the notifications. This allows us to safely create actionable/imaged notifications.
if(req.body.message) {
payload.data.message = req.body.message
if(req.body.message in ['request_location_update', 'clear_notification']) {
updateRateLimits = false
}
}
if(req.body.title) {
payload.data.title = req.body.title
}
return { updateRateLimits: updateRateLimits, payload: payload };
}
}

41
functions/worker.js Normal file
View File

@ -0,0 +1,41 @@
module.exports = {
createPayload: function createPayload(req) {
// Payload according to
// https://firebase.google.com/docs/reference/admin/node/TokenMessage
var payload = {
android: {
collapseKey: "haclient",
notification: {
icon: "mini_icon",
clickAction: "FLUTTER_NOTIFICATION_CLICK",
channelId: "ha_notify"
}
},
notification: {},
data: {},
};
var updateRateLimits = true;
if (req.body.message) {
payload.notification.body = req.body.message;
}
if (req.body.title) {
payload.notification.title = req.body.title;
}
// https://firebase.google.com/docs/reference/admin/node/admin.messaging.AndroidNotification
if (req.body.data) {
if (req.body.data.image) {
payload.notification.imageUrl = req.body.data.image;
}
for (const key of ['tag', 'color', 'channelId']) {
if (req.body.data[key]) {
payload.android.notification[key] = String(req.body.data[key])
}
}
}
return { updateRateLimits: updateRateLimits, payload: payload };
}
}