refactor: use shared function to initialize models (#1172)

opengovsg · May 4, 2021 · 8cdd8d6 · 8cdd8d6
1 parent aaaaa73
commit 8cdd8d6
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 126 deletions.
diff --git a/backend/src/core/loaders/sequelize.loader.ts b/backend/src/core/loaders/sequelize.loader.ts
@@ -2,35 +2,7 @@ import { Sequelize, SequelizeOptions } from 'sequelize-typescript'
 import { parse } from 'pg-connection-string'
 
 import config from '@core/config'
-import {
-  Credential,
-  JobQueue,
-  Campaign,
-  Worker,
-  User,
-  UserFeature,
-  UserCredential,
-  UserDemo,
-  Statistic,
-  ProtectedMessage,
-  Unsubscriber,
-  Agency,
-} from '@core/models'
-import {
-  EmailMessage,
-  EmailTemplate,
-  EmailOp,
-  EmailBlacklist,
-  EmailFromAddress,
-} from '@email/models'
-import { SmsMessage, SmsTemplate, SmsOp } from '@sms/models'
-import {
-  BotSubscriber,
-  TelegramMessage,
-  TelegramOp,
-  TelegramSubscriber,
-  TelegramTemplate,
-} from '@telegram/models'
+import { Credential, initializeModels } from '@core/models'
 
 import { loggerWithLabel } from '@core/logger'
 import { MutableConfig, generateRdsIamAuthToken } from '@core/utils/rds-iam'
@@ -76,41 +48,7 @@ const sequelizeLoader = async (): Promise<void> => {
     },
   } as SequelizeOptions)
 
-  const coreModels = [
-    Credential,
-    JobQueue,
-    Campaign,
-    Worker,
-    User,
-    UserFeature,
-    UserCredential,
-    UserDemo,
-    Statistic,
-    Unsubscriber,
-    Agency,
-  ]
-  const emailModels = [
-    EmailMessage,
-    EmailTemplate,
-    EmailOp,
-    EmailBlacklist,
-    ProtectedMessage,
-    EmailFromAddress,
-  ]
-  const smsModels = [SmsMessage, SmsTemplate, SmsOp]
-  const telegramModels = [
-    BotSubscriber,
-    TelegramOp,
-    TelegramMessage,
-    TelegramTemplate,
-    TelegramSubscriber,
-  ]
-  sequelize.addModels([
-    ...coreModels,
-    ...emailModels,
-    ...smsModels,
-    ...telegramModels,
-  ])
+  initializeModels(sequelize)
 
   try {
     await sequelize.sync()

diff --git a/backend/src/core/models/index.ts b/backend/src/core/models/index.ts
@@ -10,3 +10,4 @@ export * from './statistic'
 export * from './protected_message'
 export * from './unsubscriber'
 export * from './agency'
+export * from './initialize-models'
diff --git a/backend/src/core/models/initialize-models.ts b/backend/src/core/models/initialize-models.ts
@@ -0,0 +1,70 @@
+import { Sequelize } from 'sequelize-typescript'
+import {
+  Credential,
+  JobQueue,
+  Campaign,
+  Worker,
+  User,
+  UserFeature,
+  UserCredential,
+  UserDemo,
+  Statistic,
+  ProtectedMessage,
+  Unsubscriber,
+  Agency,
+} from '@core/models'
+import {
+  EmailMessage,
+  EmailTemplate,
+  EmailOp,
+  EmailBlacklist,
+  EmailFromAddress,
+} from '@email/models'
+import { SmsMessage, SmsTemplate, SmsOp } from '@sms/models'
+import {
+  BotSubscriber,
+  TelegramMessage,
+  TelegramOp,
+  TelegramSubscriber,
+  TelegramTemplate,
+} from '@telegram/models'
+
+export const initializeModels = (sequelize: Sequelize): void => {
+  const coreModels = [
+    Credential,
+    JobQueue,
+    Campaign,
+    Worker,
+    User,
+    UserFeature,
+    UserCredential,
+    UserDemo,
+    Statistic,
+    Unsubscriber,
+    Agency,
+  ]
+  const emailModels = [
+    EmailMessage,
+    EmailTemplate,
+    EmailOp,
+    EmailBlacklist,
+    ProtectedMessage,
+    EmailFromAddress,
+  ]
+  const smsModels = [SmsMessage, SmsTemplate, SmsOp]
+  const telegramModels = [
+    BotSubscriber,
+    TelegramOp,
+    TelegramMessage,
+    TelegramTemplate,
+    TelegramSubscriber,
+  ]
+  sequelize.addModels([
+    ...coreModels,
+    ...emailModels,
+    ...smsModels,
+    ...telegramModels,
+  ])
+}
+
+export default initializeModels
diff --git a/backend/src/test-utils/sequelize-loader.ts b/backend/src/test-utils/sequelize-loader.ts
@@ -1,33 +1,6 @@
 import { Sequelize, SequelizeOptions } from 'sequelize-typescript'
 import config from '@core/config'
-import {
-  Credential,
-  JobQueue,
-  Campaign,
-  Worker,
-  User,
-  UserFeature,
-  UserCredential,
-  UserDemo,
-  Statistic,
-  ProtectedMessage,
-  Unsubscriber,
-} from '@core/models'
-import {
-  EmailMessage,
-  EmailTemplate,
-  EmailOp,
-  EmailBlacklist,
-  EmailFromAddress,
-} from '@email/models'
-import { SmsMessage, SmsTemplate, SmsOp } from '@sms/models'
-import {
-  BotSubscriber,
-  TelegramMessage,
-  TelegramOp,
-  TelegramSubscriber,
-  TelegramTemplate,
-} from '@telegram/models'
+import { Credential, initializeModels } from '@core/models'
 
 import { DefaultCredentialName } from '@core/constants'
 import { formatDefaultCredentialName } from '@core/utils'
@@ -41,40 +14,7 @@ const sequelizeLoader = async (dbName: string): Promise<Sequelize> => {
     pool: config.get('database.poolOptions'),
   } as SequelizeOptions)
 
-  const coreModels = [
-    Credential,
-    JobQueue,
-    Campaign,
-    Worker,
-    User,
-    UserFeature,
-    UserCredential,
-    UserDemo,
-    Statistic,
-    Unsubscriber,
-  ]
-  const emailModels = [
-    EmailMessage,
-    EmailTemplate,
-    EmailOp,
-    EmailBlacklist,
-    ProtectedMessage,
-    EmailFromAddress,
-  ]
-  const smsModels = [SmsMessage, SmsTemplate, SmsOp]
-  const telegramModels = [
-    BotSubscriber,
-    TelegramOp,
-    TelegramMessage,
-    TelegramTemplate,
-    TelegramSubscriber,
-  ]
-  sequelize.addModels([
-    ...coreModels,
-    ...emailModels,
-    ...smsModels,
-    ...telegramModels,
-  ])
+  initializeModels(sequelize)
 
   try {
     await sequelize.sync()