Move payment request notifications to Cloud Function (#430)

gnardini · web-flow · commit fc146fe305f1 · 2021-06-08T19:52:12.000Z
### Description Moved the payment requests notification sending from the notification service to a database-triggered Cloud Function. See https://www.notion.so/clabsco/Notification-Service-Indexer-064ca4f58be64c3384ac8fb5f00fca56 for more information on the motivation for doing this. ### Other changes N/A ### Tested Manually and added unit test. This is deployed in Alfajores. ### How others should test Send a payment request to an address. See that the requested address receives a push notification. ### Related issues - Fixes #428 ### Backwards compatibility N/A
diff --git a/crowdin.yml b/crowdin.yml
@@ -5,3 +5,5 @@ files:
     translation: /packages/mobile/ios/celo/%osx_code%/%original_file_name%
   - source: /packages/notification-service/locales/en.json
     translation: /packages/notification-service/locales/%two_letters_code%.json
+  - source: /packages/cloud-functions/locales/en.json
+    translation: /packages/cloud-functions/locales/%two_letters_code%.json
diff --git a/packages/cloud-functions/.firebaserc b/packages/cloud-functions/.firebaserc
@@ -2,6 +2,7 @@
   "projects": {
     "alfajores": "celo-mobile-alfajores",
     "mainnet": "celo-mobile-mainnet",
-    "testnet": "celo-testnet-production"
+    "testnet": "celo-testnet-production",
+    "default": "celo-mobile-alfajores"
   }
 }
diff --git a/packages/cloud-functions/.gitignore b/packages/cloud-functions/.gitignore
@@ -2,6 +2,9 @@ dist/
 
 # Firebase cache
 .firebase/
+.runtimeconfig.json
+database-debug.log
+ui-debug.log
 
 # Only check in encrypted .env file
 .env
diff --git a/packages/cloud-functions/firebase.json b/packages/cloud-functions/firebase.json
@@ -1,6 +1,20 @@
 {
   "functions": {
     "source": ".",
-    "predeploy": ["yarn run lint", "yarn run build"]
+    "predeploy": [
+      "yarn run lint",
+      "yarn run build"
+    ]
+  },
+  "emulators": {
+    "functions": {
+      "port": 5001
+    },
+    "database": {
+      "port": 9000
+    },
+    "ui": {
+      "enabled": true
+    }
   }
 }
diff --git a/packages/cloud-functions/jest_setup.ts b/packages/cloud-functions/jest_setup.ts
@@ -6,6 +6,11 @@ jest.mock('firebase-functions', () => ({
   https: {
     onRequest: jest.fn,
   },
+  database: {
+    ref: () => ({
+      onWrite: jest.fn,
+    }),
+  },
   pubsub: {
     schedule: () => ({
       onRun: jest.fn,
diff --git a/packages/cloud-functions/locales/en.json b/packages/cloud-functions/locales/en.json
@@ -0,0 +1,4 @@
+{
+  "paymentRequestedTitle": "Payment Requested",
+  "paymentRequestedBody": "Payment of {{amount}} {{currency}} has been requested"
+}
diff --git a/packages/cloud-functions/locales/es.json b/packages/cloud-functions/locales/es.json
@@ -0,0 +1,4 @@
+{
+  "paymentRequestedTitle": "Pago solicitado",
+  "paymentRequestedBody": "Se ha solicitado pago de {{amount}} {{currency}}."
+}
diff --git a/packages/cloud-functions/locales/pt.json b/packages/cloud-functions/locales/pt.json
@@ -0,0 +1,4 @@
+{
+  "paymentRequestedTitle": "Pagamento solicitado",
+  "paymentRequestedBody": "Foi solicitado um pagamento de {{amount}} {{currency}}."
+}
diff --git a/packages/cloud-functions/package.json b/packages/cloud-functions/package.json
@@ -18,26 +18,26 @@
   },
   "dependencies": {
     "@celo/contractkit": "1.2.2-beta",
-    "@celo/eslint-config-typescript": "0.0.1",
     "@celo/utils": "1.2.2-beta",
     "@google-cloud/bigquery": "~5.5.0",
-    "@typescript-eslint/eslint-plugin": "^4.25.0",
-    "eslint": "^7.27.0",
-    "eslint-plugin-import": "^2.23.3",
-    "eslint-plugin-react": "^7.23.2",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "eslint-plugin-react-native": "^3.11.0",
     "bignumber.js": "^9.0.0",
     "fast-json-stable-stringify": "~2.1.0",
     "firebase-admin": "^9.5.0",
     "firebase-functions": "^3.6.0",
+    "i18next": "~19.0.2",
     "jsonwebtoken": "~8.5.1",
-    "prom-client": "^13.1.0",
     "uuid": "^8.3.0"
   },
   "devDependencies": {
+    "@celo/eslint-config-typescript": "0.0.1",
     "@types/jsonwebtoken": "~8.5.0",
     "@types/uuid": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^4.25.0",
+    "eslint": "^7.27.0",
+    "eslint-plugin-import": "^2.23.3",
+    "eslint-plugin-react": "^7.23.2",
+    "eslint-plugin-react-hooks": "^4.2.0",
+    "eslint-plugin-react-native": "^3.11.0",
     "firebase-functions-test": "^0.2.0",
     "jest-fetch-mock": "^3.0.3"
   },
diff --git a/packages/cloud-functions/src/config.ts b/packages/cloud-functions/src/config.ts
@@ -1,4 +1,6 @@
-const functions = require('firebase-functions')
+import * as functions from 'firebase-functions'
+import i18next from 'i18next'
+
 // This allows us to access Cloud Function environment variables
 const config = functions.config()
 
@@ -78,3 +80,28 @@ export enum DigitalAsset {
 }
 
 export const FETCH_TIMEOUT_DURATION = 10000 // 10 seconds
+export const NOTIFICATIONS_TTL_MS = 3600 * 1000 * 24 * 7 // 1 week in milliseconds
+
+const en = require('../locales/en.json')
+const es = require('../locales/es.json')
+const pt = require('../locales/pt.json')
+
+i18next
+  .init({
+    lng: 'en',
+    resources: {
+      en: {
+        translation: en,
+      },
+      es: {
+        translation: es,
+      },
+      pt: {
+        translation: pt,
+      },
+    },
+    fallbackLng: {
+      default: ['en'],
+    },
+  })
+  .catch((reason: any) => console.error('Config', 'Failed to init i18n', reason))
diff --git a/packages/cloud-functions/src/exchangeRate/index.ts b/packages/cloud-functions/src/exchangeRate/index.ts
@@ -5,7 +5,6 @@ import * as functions from 'firebase-functions'
 import { performance } from 'perf_hooks'
 import { getContractKit } from '../contractKit'
 import { database } from '../firebase'
-import { metrics } from '../metrics'
 
 interface ExchangeRateObject {
   exchangeRate: string
@@ -73,7 +72,15 @@ async function getExchangeRate(
   )
 
   const t1 = performance.now()
-  metrics.setExchangeQueryDuration(t1 - t0)
+  console.info(
+    JSON.stringify({
+      context: 'Exchange Rate Fetch Duration',
+      duration: t1 - t0,
+      rate: rate.toString(),
+      makerToken,
+      stableToken,
+    })
+  )
 
   return rate
 }
diff --git a/packages/cloud-functions/src/firebase.ts b/packages/cloud-functions/src/firebase.ts
@@ -14,6 +14,10 @@ export function database() {
   return admin.database()
 }
 
+export function messaging() {
+  return admin.messaging()
+}
+
 export function saveTxHashProvider(address: string, txHash: string, provider: string) {
   database()
     .ref(`/registrations/${address}/txHashes/${txHash}`)
diff --git a/packages/cloud-functions/src/index.ts b/packages/cloud-functions/src/index.ts
@@ -5,3 +5,4 @@ export { moonpayWebhook } from './cico/moonpayWebhook'
 export { rampWebhook } from './cico/rampWebhook'
 export { transakWebhook } from './cico/transakWebhook'
 export { updateExchangeRates } from './exchangeRate'
+export { notifyPaymentRequests } from './paymentRequests'
diff --git a/packages/cloud-functions/src/metrics.ts b/packages/cloud-functions/src/metrics.ts
diff --git a/packages/cloud-functions/src/notifications/index.ts b/packages/cloud-functions/src/notifications/index.ts
@@ -0,0 +1,96 @@
+import * as admin from 'firebase-admin'
+import i18next, { TFunction } from 'i18next'
+import { NOTIFICATIONS_TTL_MS } from '../config'
+import { database, messaging } from '../firebase'
+
+const TAG = 'Notifications'
+
+export async function getTranslatorForAddress(address: string): Promise<TFunction> {
+  return new Promise((resolve, reject) => {
+    database()
+      .ref(`registrations/${address}/language`)
+      .once('value', (snapshot) => {
+        const language = snapshot.val()
+        if (language) {
+          resolve(i18next.getFixedT(language))
+        } else {
+          resolve(i18next.t.bind(i18next))
+        }
+      })
+      .catch(reject)
+  })
+}
+
+export async function getTokenFromAddress(address: string): Promise<string | null> {
+  return new Promise((resolve, reject) => {
+    database()
+      .ref(`registrations/${address}/fcmToken`)
+      .once('value', (snapshot) => {
+        const token = snapshot.val()
+        resolve(token)
+      })
+      .catch(reject)
+  })
+}
+
+export async function sendNotification(
+  title: string,
+  body: string,
+  address: string,
+  data: { [key: string]: string }
+) {
+  const token = await getTokenFromAddress(address)
+  if (!token) {
+    console.info(TAG, 'FCM token missing for address:', address)
+    return
+  }
+
+  // https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message
+  const message: admin.messaging.Message = {
+    notification: {
+      title,
+      body,
+    },
+    android: {
+      ttl: NOTIFICATIONS_TTL_MS,
+      priority: 'normal',
+      notification: {
+        icon: 'ic_stat_rings',
+        color: '#42D689',
+      },
+    },
+    data,
+    token,
+  }
+
+  try {
+    // TODO: Use a logger that abstracts the json stringifying thing.
+    console.info(
+      JSON.stringify({
+        context: 'Sending Notification',
+        type: data.type,
+        recipient: address,
+      })
+    )
+    const response = await messaging().send(message)
+    console.info(
+      JSON.stringify({
+        context: 'Notification Sent Successfully',
+        type: data.type,
+        recipient: address,
+        response,
+        latency: data.timestamp ? Date.now() - Number(data.timestamp) : null,
+      })
+    )
+  } catch (error) {
+    console.error(
+      JSON.stringify({
+        context: 'Notification Send Failed',
+        type: data.type,
+        recipient: address,
+        error,
+        latency: data.timestamp ? Date.now() - Number(data.timestamp) : null,
+      })
+    )
+  }
+}
diff --git a/packages/cloud-functions/src/notifications/types.ts b/packages/cloud-functions/src/notifications/types.ts
@@ -0,0 +1,11 @@
+export enum NotificationTypes {
+  PAYMENT_RECEIVED = 'PAYMENT_RECEIVED',
+  PAYMENT_REQUESTED = 'PAYMENT_REQUESTED',
+  INVITE_REDEEMED = 'INVITE_REDEEMED',
+}
+
+export enum Currencies {
+  Celo = 'cGLD',
+  Dollar = 'cUSD',
+  Euro = 'cEUR',
+}
diff --git a/packages/cloud-functions/src/paymentRequests/index.ts b/packages/cloud-functions/src/paymentRequests/index.ts
@@ -0,0 +1,74 @@
+import * as functions from 'firebase-functions'
+import { database } from '../firebase'
+import { getTranslatorForAddress, sendNotification } from '../notifications'
+import { Currencies, NotificationTypes } from '../notifications/types'
+
+export enum PaymentRequestStatus {
+  REQUESTED = 'REQUESTED',
+  COMPLETED = 'COMPLETED',
+  DECLINED = 'DECLINED',
+  CANCELLED = 'CANCELLED',
+}
+
+interface PaymentRequest {
+  amount: string
+  timestamp?: string
+  requesterE164Number?: string
+  requesterAddress: string
+  requesteeAddress: string
+  currency: Currencies
+  comment?: string
+  status: PaymentRequestStatus
+  notified: boolean
+  type?: NotificationTypes.PAYMENT_REQUESTED
+}
+
+export async function notifyPaymentRequest(id: string, request: PaymentRequest) {
+  if (request.notified) {
+    return
+  }
+  console.info('Received payment request', id)
+  await database().ref(`/pendingRequests/${id}`).update({ notified: true })
+  await sendRequestedPaymentNotification(id, request)
+}
+
+function paymentObjectToNotification(po: PaymentRequest): { [key: string]: string } {
+  return {
+    amount: po.amount,
+    ...(po.timestamp ? { timestamp: po.timestamp } : {}),
+    ...(po.requesterE164Number ? { requesterE164Number: po.requesterE164Number } : {}),
+    requesterAddress: po.requesterAddress,
+    requesteeAddress: po.requesteeAddress,
+    currency: po.currency,
+    ...(po.comment ? { comment: po.comment } : {}),
+    status: po.status,
+    type: String(po.type),
+  }
+}
+
+export async function sendRequestedPaymentNotification(id: string, data: PaymentRequest) {
+  const { requesteeAddress, amount, currency } = data
+  const t = await getTranslatorForAddress(requesteeAddress)
+  data.type = NotificationTypes.PAYMENT_REQUESTED
+  return sendNotification(
+    t('paymentRequestedTitle'),
+    t('paymentRequestedBody', {
+      amount,
+      // TODO: Use local currency for this.
+      currency: t(currency, { count: parseInt(amount, 10) }),
+    }),
+    requesteeAddress,
+    { uid: id, ...paymentObjectToNotification(data) }
+  )
+}
+
+export const notifyPaymentRequests = functions.database
+  .ref('pendingRequests/{requestId}')
+  .onWrite(async (change, context) => {
+    if (!change.after.exists()) {
+      return
+    }
+    const requestId = context.params.requestId
+    const paymentRequest: PaymentRequest = change.after.val()
+    await notifyPaymentRequest(requestId, paymentRequest)
+  })
diff --git a/packages/cloud-functions/src/paymentRequests/test.ts b/packages/cloud-functions/src/paymentRequests/test.ts
diff --git a/packages/cloud-functions/tsconfig.json b/packages/cloud-functions/tsconfig.json
diff --git a/packages/notification-service/src/firebase.ts b/packages/notification-service/src/firebase.ts
diff --git a/packages/notification-service/src/handlers.ts b/packages/notification-service/src/handlers.ts
diff --git a/packages/notification-service/src/metrics.ts b/packages/notification-service/src/metrics.ts
diff --git a/packages/notification-service/src/polling.ts b/packages/notification-service/src/polling.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`"projects": {`
`3`	`3`	`"alfajores": "celo-mobile-alfajores",`
`4`	`4`	`"mainnet": "celo-mobile-mainnet",`
`5`		`- "testnet": "celo-testnet-production"`
	`5`	`+ "testnet": "celo-testnet-production",`
	`6`	`+ "default": "celo-mobile-alfajores"`
`6`	`7`	`}`
`7`	`8`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "paymentRequestedTitle": "Payment Requested",
 +  "paymentRequestedBody": "Payment of {{amount}} {{currency}} has been requested"
 +}