🎨 improvements (#189)

* 🔧 chore: update federated server default config

* 🐛 fix: SMS service send payload

* 🏷️ chore: add send sms payload type

* 🎨 fix: pepper fetching

* 🚀 chore: update docker compose

* 🧪 chore: update SMS service tests

Author: rezk2ll

docker-compose.yml

@@ -89,6 +89,9 @@ services:
       - ADDITIONAL_FEATURES=true
       - FEDERATED_IDENTITY_SERVICES=fed.docker.localhost
       - NODE_TLS_REJECT_UNAUTHORIZED=0
+      - SMS_API_KEY=SOME_SECRET_KEY
+      - [email protected]
+      - SMS_API_URL=https://api.octopush.com/v1/public
 
   fed:
     build:
@@ -121,8 +124,11 @@ services:
       # - UPDATE_FEDERATED_IDENTITY_HASHES_CRON=0-59/2 * * * *
       # - UPDATE_USERS_CRON=1-59/2 * * * *
       - ADDITIONAL_FEATURES=true
-      - TRUSTED_SERVERS_ADDRESSES=172.18.0.1/16
+      - TRUSTED_SERVERS_ADDRESSES=172.18.0.1/16,172.31.0.6,172.31.0.5,172.31.0.1/16
       - NODE_TLS_REJECT_UNAUTHORIZED=0
+      - SMS_API_KEY=SOME_SECRET_KEY
+      - [email protected]
+      - SMS_API_URL=https://api.octopush.com/v1/public
 
   chat:
     image: linagora/twake-web
@@ -151,6 +157,7 @@ services:
       - chat
       - synapse
       - tom
+      - fed
     networks:
       frontend:
         aliases:

packages/federated-identity-service/src/config.json

@@ -49,5 +49,9 @@
   "userdb_user": "",
   "template_dir": "./templates",
   "trust_x_forwarded_for": false,
-  "trusted_servers_addresses": []
-}
+  "trusted_servers_addresses": [],
+  "sms_api_login": "",
+  "sms_api_key": "",
+  "sms_api_url": "",
+  "chat_url": ""
+}

packages/matrix-identity-server/src/invitation/index.ts

@@ -230,9 +230,16 @@ const StoreInvit = <T extends string = never>(
             try {
               const authHeader = req.headers.authorization as string
               const validToken = authHeader.split(' ')[1]
-              const _pepper = idServer.db.get('keys', ['data'], {
+              const papperQuery = (await idServer.db.get('keys', ['data'], {
                 name: 'pepper'
-              })
+              })) as unknown as Record<'data', string>[]
+
+              if (!papperQuery || !papperQuery.length) {
+                send(res, 500, errMsg('unknown', 'No pepper found'))
+                return
+              }
+
+              const _pepper = papperQuery[0].data
 
               const response = await fetch(
                 buildUrl(idServer.conf.base_url, '/_matrix/identity/v2/lookup'),

packages/matrix-identity-server/src/types.ts

@@ -121,3 +121,14 @@ export interface invitationToken {
   address: string
   data: ThirPartyInvitePayload
 }
+
+export interface SendSmsPayload {
+  text: string
+  recipients: Recipient[]
+  type: 'sms_premium' | 'sms_low_cost'
+  sender: string
+}
+
+interface Recipient {
+  phone_number: string
+}

packages/matrix-identity-server/src/utils/sms-service.test.ts

@@ -68,9 +68,10 @@ describe('the SMS service', () => {
             'api-key': 'test_key'
           },
           body: JSON.stringify({
-            to: '+330744556688',
-            body: 'test sms',
-            from: 'Twake Chat'
+            sender: 'Twake',
+            recipients: [{ phone_number: '+330744556688' }],
+            text: 'test sms',
+            type: 'sms_low_cost'
           })
         }
       )

packages/matrix-identity-server/src/utils/sms-service.ts

@@ -1,5 +1,5 @@
 import type { TwakeLogger } from '@twake/logger'
-import { Config, ISMSService } from '../types'
+import { Config, ISMSService, SendSmsPayload } from '../types'
 import { buildUrl } from '../utils'
 
 export class SmsService implements ISMSService {
@@ -29,19 +29,20 @@ export class SmsService implements ISMSService {
   /**
    * sends an sms to the given number
    *
-   * @param to - the number to send the sms to
-   * @param body - the body of the sms to send
+   * @param {string} to - the number to send the sms to
+   * @param {string} text - the body of the sms to send
    */
-  async send(to: string, body: string): Promise<void> {
+  async send(to: string, text: string): Promise<void> {
     try {
       const response = await fetch(this.API_ENDPOINT, {
         method: 'POST',
         headers: this.HEADERS,
         body: JSON.stringify({
-          to,
-          body,
-          from: this.sender
-        })
+          sender: 'Twake',
+          recipients: [{ phone_number: to }],
+          text,
+          type: 'sms_low_cost'
+        } satisfies SendSmsPayload)
       })
 
       const responseBody = await response.json()