[Refactor] Messagebird -> Twilio

Switched SMS backend to Twilio as the response contains "accountSid", which I will use as user token. References #61.
fanton-dev · Feb 8, 2021 · b528447 · b528447
1 parent 9909901
commit b528447
Show file tree

Hide file tree

Showing 8 changed files with 266 additions and 42 deletions.
diff --git a/server/.env.template b/server/.env.template
@@ -1,7 +1,9 @@
 POSTGRES_USER=*insert username here*
 POSTGRES_PASSWORD=*insert password here*
 STRIPE_SECRET_KEY=*insert secret key here*
-MESSAGEBIRD_SECRET_KEY=*insert secret key here*
+TWILIO_SERVICE_ID=*insert secret key here*
+TWILIO_ACCOUNT_SID=*insert secret key here*
+TWILIO_AUTH_TOKEN=*insert secret key here*
 
 RABBITMQ_URL=amqp://queue
 RABBITMQ_URL_TEST=amqp://localhost

diff --git a/server/package-lock.json b/server/package-lock.json
diff --git a/server/package.json b/server/package.json
@@ -35,12 +35,12 @@
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
     "faker": "^5.3.1",
-    "messagebird": "^3.5.0",
     "moment": "^2.29.1",
     "pg": "^8.5.1",
     "pgmock2": "^2.0.6",
     "stripe": "^8.134.0",
     "ts-node": "^9.1.1",
+    "twilio": "^3.55.1",
     "uuid": "^8.3.2"
   },
   "devDependencies": {

diff --git a/server/schema.sql b/server/schema.sql
@@ -49,4 +49,10 @@ CREATE TABLE IF NOT EXISTS order_logs (
     order_id UUID REFERENCES orders(id),
     subject TEXT NOT NULL,
     body TEXT NOT NULL
+)
+
+CREATE TABLE users(
+  id INTEGER PRIMARY KEY,
+  token TEXT NOT NULL,
+  phone_number TEXT NOT NULL
 )
diff --git a/server/services/core/@types/global.d.ts b/server/services/core/@types/global.d.ts
@@ -5,7 +5,13 @@ import {QueryConfig, QueryResult, QueryResultRow} from 'pg';
 import * as Bluebird from 'bluebird';
 import Stripe from 'stripe';
 import {AxiosRequestConfig, AxiosResponse} from 'axios';
-import {MessageBird} from 'messagebird';
+import Twilio from 'twilio';
+import {
+  VerificationInstance,
+} from 'twilio/lib/rest/verify/v2/service/verification';
+import {
+  VerificationCheckInstance
+} from 'twilio/lib/rest/verify/v2/service/verificationCheck';
 
 /**
  * Validator object structure.
@@ -630,12 +636,51 @@ export interface RequestLibrary {
   ): Promise<R>;
 }
 
+/**
+ * SMS Client object structure.
+ *
+ * @export
+ * @interface SMSClient
+ */
 export interface SMSClient {
-  verify: MessageBird['verify'];
+  verify: Twilio.Twilio['verify'];
 }
+
+/**
+ * SMS Verification Instance object structure.
+ *
+ * @export
+ * @interface SMSVerificationInstance
+ * @extends {VerificationInstance}
+ */
+export interface SMSVerificationInstance extends VerificationInstance {}
+
+/**
+ * SMS Verification Instance object structure.
+ *
+ * @export
+ * @interface SMSVerificationInstance
+ * @extends {VerificationInstance}
+ */
+export interface SMSVerificationCheckInstance
+extends VerificationCheckInstance {}
+
+/**
+ * SMS API object structure.
+ *
+ * @export
+ * @interface SMSApi
+ */
 export interface SMSApi {
   sendToken(
     phoneNumber: string,
-    callback: (id: string) => any,
+    callback: (verificationInstance: SMSVerificationInstance) => any,
+    channel: 'sms' | 'call',
+  ): void;
+
+  verifyCode(
+    phoneNumber: string,
+    code: string,
+    callback: (phoneNumber: any) => any,
   ): void;
 }
diff --git a/server/services/core/config.ts b/server/services/core/config.ts
@@ -6,7 +6,9 @@ const config = Object.freeze({
   postgresUser: String(process.env.POSTGRES_USER),
   postgresPassword: String(process.env.POSTGRES_PASSWORD),
   stripeSecretKey: String(process.env.STRIPE_SECRET_KEY),
-  messagebirdSecretKey: String(process.env.MESSAGEBIRD_SECRET_KEY),
+  twilioServiceId: String(process.env.TWILIO_SERVICE_ID),
+  twilioAccountSid: String(process.env.TWILIO_ACCOUNT_SID),
+  twilioAuthToken: String(process.env.TWILIO_AUTH_TOKEN),
 
   rabbitMqUrl: String(process.env.RABBITMQ_URL),
   rabbitMqUrlTest: String(process.env.RABBITMQ_URL_TEST),