348 - endpoint to send push notification

packages/api/src/controllers/v2/user.ts

@@ -343,6 +343,17 @@ class UserController {
  standardResponse(res, 400, false, '', { error: e.message })
  );
  };
+
+ public sendPushNotifications = (req: Request, res: Response) => {
+ const { country, communities, title, body, data } = req.body;
+
+ this.userService
+ .sendPushNotifications(title, body, country, communities, data)
+ .then((r) => standardResponse(res, 200, true, r))
+ .catch((e) =>
+ standardResponse(res, 400, false, '', { error: e.message })
+ );
+ };
 }
 
 export default UserController;

packages/api/src/routes/v2/user.ts

@@ -1,7 +1,7 @@
 import { Router } from 'express';
 
 import UserController from '../../controllers/v2/user';
-import { authenticateToken } from '../../middlewares';
+import { authenticateToken, adminAuthentication } from '../../middlewares';
 import userValidators from '../../validators/user';
 
 export default (app: Router): void => {
@@ -495,4 +495,11 @@ export default (app: Router): void => {
  * - "write:modify":
  */
  route.get('/:address', authenticateToken, userController.findBy);
+
+ route.post(
+ '/push-notifications',
+ adminAuthentication,
+ userValidators.sendPushNotifications,
+ userController.sendPushNotifications
+ );
 };

packages/api/src/validators/user.ts

@@ -63,6 +63,16 @@ const readNotifications = celebrate({
  }),
 });
 
+const sendPushNotifications = celebrate({
+ body: defaultSchema.object({
+ country: Joi.string().optional(),
+ communities: Joi.array().items(Joi.number().required()).optional(),
+ title: Joi.string().required(),
+ body: Joi.string().required(),
+ data: Joi.object().optional(),
+ }),
+});
+
 //
 
 const reportv1 = celebrate({
@@ -207,4 +217,5 @@ export default {
  subscribeNewsletter,
  saveSurvey,
  readNotifications,
+ sendPushNotifications,
 };

packages/core/src/services/app/user/index.ts

@@ -1,4 +1,5 @@
-import { Op, WhereOptions } from 'sequelize';
+import { ethers } from 'ethers';
+import { Op } from 'sequelize';
 
 import config from '../../../config';
 import { models, sequelize } from '../../../database';
@@ -11,10 +12,12 @@ import {
  AppUser,
 } from '../../../interfaces/app/appUser';
 import { ProfileContentStorage } from '../../../services/storage';
+import { getAllBeneficiaries } from '../../../subgraph/queries/beneficiary';
 import { getUserRoles } from '../../../subgraph/queries/user';
 import { BaseError } from '../../../utils/baseError';
 import { generateAccessToken } from '../../../utils/jwt';
 import { Logger } from '../../../utils/logger';
+import { sendPushNotification } from '../../../utils/util';
 import UserLogService from './log';
 
 export default class UserService {
@@ -402,7 +405,10 @@ export default class UserService {
  }
  );
  if (updated[0] === 0) {
- throw new Error('notifications were not updated!');
+ throw new BaseError(
+ 'UPDATE_FAILED',
+ 'notifications were not updated!'
+ );
  }
  return true;
  }
@@ -416,6 +422,85 @@ export default class UserService {
  });
  }
 
+ public async sendPushNotifications(
+ title: string,
+ body: string,
+ country?: string,
+ communitiesIds?: number[],
+ data?: any
+ ) {
+ if (country) {
+ const users = await models.appUser.findAll({
+ attributes: ['pushNotificationToken'],
+ where: {
+ country,
+ pushNotificationToken: {
+ [Op.not]: null,
+ },
+ },
+ });
+ users.forEach((user) => {
+ sendPushNotification(
+ user.address,
+ title,
+ body,
+ data,
+ user.pushNotificationToken
+ );
+ });
+ } else if (communitiesIds && communitiesIds.length) {
+ const communities = await models.community.findAll({
+ attributes: ['contractAddress'],
+ where: {
+ id: {
+ [Op.in]: communitiesIds,
+ },
+ contractAddress: {
+ [Op.not]: null,
+ },
+ },
+ });
+ const beneficiaryAddress: string[] = [];
+
+ // get beneficiaries
+ for (let index = 0; index < communities.length; index++) {
+ const community = communities[index];
+ const beneficiaries = await getAllBeneficiaries(
+ community.contractAddress!
+ );
+ beneficiaries.forEach((beneficiary) => {
+ beneficiaryAddress.push(
+ ethers.utils.getAddress(beneficiary.address)
+ );
+ });
+ }
+ // get users
+ const users = await models.appUser.findAll({
+ attributes: ['pushNotificationToken'],
+ where: {
+ address: {
+ [Op.in]: beneficiaryAddress,
+ },
+ pushNotificationToken: {
+ [Op.not]: null,
+ },
+ },
+ });
+
+ users.forEach((user) => {
+ sendPushNotification(
+ user.address,
+ title,
+ body,
+ data,
+ user.pushNotificationToken
+ );
+ });
+ } else {
+ throw new BaseError('INVALID_OPTION', 'invalid option');
+ }
+ }
+
  private async _overwriteUser(user: AppUserCreationAttributes) {
  try {
  const usersToInactive = await models.appUser.findAll({

packages/core/src/subgraph/queries/beneficiary.ts

@@ -26,6 +26,7 @@ export const getAllBeneficiaries = async (
  lastClaimAt_gte: ${aMonthAgo.getTime() / 1000}
  }
  ) {
+ address
  lastClaimAt
  preLastClaimAt
  claims

packages/core/src/utils/util.ts

@@ -182,16 +182,17 @@ export async function sendPushNotification(
  userAddress: string,
  title: string,
  body: string,
- data: any
+ data: any,
+ pushNotificationToken?: string | null
 ): Promise<boolean> {
- const user = await UserService.get(userAddress);
- if (
- user !== null &&
- user.pushNotificationToken !== null &&
-  user.pushNotificationToken.length > 0
- ) {
+ if (!pushNotificationToken) {
+  const user = await UserService.get(userAddress);
+ if (!user) return false;
+ pushNotificationToken = user.pushNotificationToken;
+ }
+ if (pushNotificationToken !== null && pushNotificationToken.length > 0) {
  const message = {
- to: user.pushNotificationToken,
+ to: pushNotificationToken,
  sound: 'default',
  title,
  body,