Merge pull request #90 from Dialogue-Bot/DIAL-42-implement-test-your-bot

hi02102002 · web-flow · commit 8935e89e3cba · 2024-04-17T21:47:35.000+07:00
Dial 42 implement test your bot
diff --git a/client/src/components/forms/variables-setting.tsx b/client/src/components/forms/variables-setting.tsx
@@ -120,7 +120,7 @@ export const VariablesSettingForm = ({
 
     if (
       !_.isEmpty(form.formState.errors.variables) ||
-      variablesWatch?.some((field) => !field.name || !field.value)
+      variablesWatch?.some((field) => !field.name)
     )
       return
 
diff --git a/client/src/components/pages/flow-detail/node-dialog/message.tsx b/client/src/components/pages/flow-detail/node-dialog/message.tsx
@@ -113,15 +113,20 @@ export const MessageDialogContent = () => {
         </Select>
       </div>
       <div className='space-y-2'>
-        <Label required>{t('message_dialog.forms.bot_response.label')}</Label>
+        <Label required>{t('forms:bot_response.label')}</Label>
         {messageType === EMessageTypes.TEXT && (
-          <Input
-            placeholder={t('message_dialog.forms.bot_response.placeholder')}
-            value={botResponse}
-            onChange={(e) => {
-              setBotResponse(e.target.value)
-            }}
-          />
+          <>
+            <Input
+              placeholder={t('forms:bot_response.placeholder')}
+              value={botResponse}
+              onChange={(e) => {
+                setBotResponse(e.target.value)
+              }}
+            />
+            <p className='text-[0.8rem] text-muted-foreground'>
+              {t('forms:bot_response.description')}
+            </p>
+          </>
         )}
         {messageType === EMessageTypes.IMAGE && (
           <InputImage
diff --git a/client/src/locales/en/forms.json b/client/src/locales/en/forms.json
@@ -142,6 +142,14 @@
       "required": "Please enter button label."
     }
   },
+  "bot_response": {
+    "label": "Bot Response",
+    "placeholder": "Type your bot response here",
+    "errors": {
+      "required": "Please enter bot response."
+    },
+    "description": "To access variable values, use {variable_name}, {variable_name->key}, {variable_name->0->key}, etc. {user->name} retrieves the 'name' key of the 'user' variable. For an array 'users' with an object at index 0 and a 'name' key, use {users->0->name}."
+  },
   "button_url": {
     "label": "Button URL",
     "placeholder": "Enter button URL",
diff --git a/client/src/locales/vi/forms.json b/client/src/locales/vi/forms.json
@@ -360,5 +360,13 @@
     "errors": {
       "required": "Vui lòng chọn biến đầu ra."
     }
+  },
+  "bot_response": {
+    "label": "Bot trả lời",
+    "placeholder": "Nhập câu trả lời của bot",
+    "errors": {
+      "required": "Vui lòng nhập câu trả lời của bot."
+    },
+    "description": "Để truy cập các giá trị biến, hãy sử dụng {variable_name}, {variable_name->key}, {variable_name->0->key}, v.v. {user->name} lấy khóa 'name' của biến 'user'. Đối với mảng 'người dùng' có đối tượng ở chỉ mục 0 và khóa 'tên', hãy sử dụng {users->0->name}."
   }
 }
diff --git a/server/src/constants/index.ts b/server/src/constants/index.ts
@@ -39,6 +39,7 @@ export const ENDPOINTS = {
   SETTING: {
     INDEX: '/setting',
     MAIL: '/setting/email',
+    BY_CONTACT_ID: '/setting/by-contact-id/:contactId',
   },
   USER: {
     UPDATE_INFO: '/user/update-info',
@@ -59,7 +60,7 @@ export const ENDPOINTS = {
     ADD_CHANNELS: '/flow/add-channels',
     SELECT_FLOWS_FOR_CHANNEL: '/flow/select',
     BOT_GET_CONTACT_ID: '/bot/flow/:contactId',
-    BOT_GET_ID: '/bot/flow/:id'
+    BOT_GET_ID: '/bot/flow/:id',
   },
   INTENT: {
     INDEX: '/intent',
@@ -70,6 +71,9 @@ export const ENDPOINTS = {
     INDEX: '/conversation-live-chat',
     GET_MESSAGES: '/conversation-live-chat/:userId/:contactId',
   },
+  BOT_MAIL: {
+    SEND_MAIL: '/bot-mail/send',
+  },
 }
 
 export const LOCALE_KEY = 'lang'
diff --git a/server/src/controllers/bot-mail.controller.ts b/server/src/controllers/bot-mail.controller.ts
@@ -0,0 +1,20 @@
+import { LOCALE_KEY } from '@/constants'
+import { BotMailDto } from '@/dtos/bot-mail.dto'
+import { LocaleService } from '@/i18n/ctx'
+import { BotMailService } from '@/services/bot-mail.service'
+import { catchAsync } from '@/utils/catch-async'
+import { StatusCodes } from 'http-status-codes'
+import Container from 'typedi'
+
+export class BotMailController {
+  private readonly botMailService = Container.get(BotMailService)
+  private readonly localeService: LocaleService = Container.get(LOCALE_KEY)
+
+  sendMail = catchAsync(async (req, res) => {
+    await this.botMailService.sendMail(req.body as BotMailDto)
+
+    res.status(StatusCodes.OK).json({
+      message: this.localeService.i18n().COMMON.SEND_MAIL_SUCCESS(),
+    })
+  })
+}
diff --git a/server/src/controllers/setting.controller.ts b/server/src/controllers/setting.controller.ts
@@ -7,8 +7,8 @@ import { StatusCodes } from 'http-status-codes'
 import Container from 'typedi'
 
 export class SettingController {
-  private settingService = Container.get(SettingService)
-  private localeService: LocaleService = Container.get(LOCALE_KEY)
+  private readonly settingService = Container.get(SettingService)
+  private readonly localeService: LocaleService = Container.get(LOCALE_KEY)
 
   public getSetting = catchAsync(async (req: RequestWithUser, res) => {
     const setting = await this.settingService.findByUserId(req.user.id)
@@ -29,4 +29,13 @@ export class SettingController {
       message: this.localeService.i18n().SETTING.UPDATE_EMAIL_SUCCESS(),
     })
   })
+
+  public getByContactId = catchAsync(async (req, res) => {
+    const setting = await this.settingService.findByContactId(
+      req.params.contactId,
+    )
+    res.status(StatusCodes.OK).json({
+      data: setting,
+    })
+  })
 }
diff --git a/server/src/dtos/bot-mail.dto.ts b/server/src/dtos/bot-mail.dto.ts
@@ -1,5 +1,4 @@
-import { TTemplate } from '@/mail/send-mail'
-import { IsEmail, IsNotEmpty, IsObject, IsString } from 'class-validator'
+import { IsEmail, IsNotEmpty, IsString } from 'class-validator'
 
 export class BotMailDto {
   @IsString()
@@ -18,8 +17,9 @@ export class BotMailDto {
 
   @IsString()
   @IsNotEmpty()
-  template: TTemplate
+  template: string
 
-  @IsObject()
-  variables: Record<string, any>
+  @IsString()
+  @IsNotEmpty()
+  contactId: string
 }
diff --git a/server/src/i18n/ctx.ts b/server/src/i18n/ctx.ts
@@ -10,17 +10,28 @@ export class LocaleService {
     this.locale = locale
   }
 
+  /**
+   * Gets the current locale.
+   *
+   * @returns The current locale.
+   */
   getLocale() {
     return this.locale
   }
 
+  /**
+   * Sets the locale for the context.
+   * @param locale The locale to set.
+   */
   setLocale(locale: Locales) {
-    console.log('setLocale', locale)
     this.locale = locale
   }
 
+  /**
+   * Returns the localized language object based on the current locale.
+   * @returns The localized language object.
+   */
   i18n() {
-    console.log(this.locale)
     return L[this.locale]
   }
 }
diff --git a/server/src/i18n/en/common.ts b/server/src/i18n/en/common.ts
@@ -4,4 +4,5 @@ export const COMMON = {
   NAME: 'Name',
   CONFIRM_PASSWORD: 'Confirm password',
   OLD_PASSWORD: 'Old password',
+  SEND_MAIL_SUCCESS: 'Send mail successfully',
 }
diff --git a/server/src/i18n/i18n-types.ts b/server/src/i18n/i18n-types.ts
@@ -188,6 +188,10 @@ type RootTranslation = {
 		 * O​l​d​ ​p​a​s​s​w​o​r​d
 		 */
 		OLD_PASSWORD: string
+		/**
+		 * S​e​n​d​ ​m​a​i​l​ ​s​u​c​c​e​s​s​f​u​l​l​y
+		 */
+		SEND_MAIL_SUCCESS: string
 	}
 	CHANNEL: {
 		/**
@@ -481,6 +485,10 @@ export type TranslationFunctions = {
 		 * Old password
 		 */
 		OLD_PASSWORD: () => LocalizedString
+		/**
+		 * Send mail successfully
+		 */
+		SEND_MAIL_SUCCESS: () => LocalizedString
 	}
 	CHANNEL: {
 		/**
diff --git a/server/src/i18n/vi/common.ts b/server/src/i18n/vi/common.ts
@@ -4,4 +4,5 @@ export const COMMON = {
   NAME: 'Tên',
   CONFIRM_PASSWORD: 'Xác nhận mật khẩu',
   OLD_PASSWORD: 'Mật khẩu cũ',
+  SEND_MAIL_SUCCESS: 'Gửi mail thành công',
 }
diff --git a/server/src/mail/send-mail.ts b/server/src/mail/send-mail.ts
@@ -24,11 +24,13 @@ const MAP_TEMPLATES: TMapTemplates = {
 
 export type TTemplate = keyof TemplateProps
 
-export const sendMail = async <T extends keyof TemplateProps>(opts: {
+export const sendMail = async <
+  T extends keyof TemplateProps = keyof TemplateProps & string,
+>(opts: {
   to: string
   subject: string
   template: T
-  props: TemplateProps[T]
+  props: T extends keyof TemplateProps ? TemplateProps[T] : any
   from?: string
   user?: string
   pass?: string
@@ -43,7 +45,9 @@ export const sendMail = async <T extends keyof TemplateProps>(opts: {
     from = MAIL_USER,
   } = opts
   try {
-    const html = MAP_TEMPLATES[template](props)
+    const isNotInKey = !Object.keys(MAP_TEMPLATES).includes(template)
+
+    const html = isNotInKey ? template : MAP_TEMPLATES[template](props)
 
     const transporter = nodemailer.createTransport({
       service: 'gmail',
diff --git a/server/src/routes/bot-mail.route.ts b/server/src/routes/bot-mail.route.ts
@@ -0,0 +1,23 @@
+import { ENDPOINTS } from '@/constants'
+import { BotMailController } from '@/controllers/bot-mail.controller'
+import { BotMailDto } from '@/dtos/bot-mail.dto'
+import { Routes } from '@/interfaces/routes.interface'
+import { validate } from '@/middlewares/validation.middleware'
+import { Router } from 'express'
+
+export class BotMailRoute implements Routes {
+  router = Router()
+  controller = new BotMailController()
+
+  constructor() {
+    this.initializeRoutes()
+  }
+
+  initializeRoutes() {
+    this.router.post(
+      ENDPOINTS.BOT_MAIL.SEND_MAIL,
+      validate(BotMailDto),
+      this.controller.sendMail,
+    )
+  }
+}
diff --git a/server/src/routes/setting.route.ts b/server/src/routes/setting.route.ts
@@ -29,5 +29,10 @@ export class SettingRoute implements Routes {
       authMiddleware,
       this.controller.updateEmailSetting,
     )
+
+    this.router.get(
+      ENDPOINTS.SETTING.BY_CONTACT_ID,
+      this.controller.getByContactId,
+    )
   }
 }
diff --git a/server/src/services/bot-mail.service.ts b/server/src/services/bot-mail.service.ts
@@ -4,33 +4,41 @@ import { BotMailDto } from '@/dtos/bot-mail.dto'
 import { SendMailQueue } from '@/queues/mail.queue'
 import { eq } from 'drizzle-orm'
 import { Service } from 'typedi'
+import { ChannelService } from './channels.service'
 
 @Service()
 export class BotMailService {
-  constructor(private readonly sendMailQueue: SendMailQueue) {}
+  constructor(
+    private readonly sendMailQueue: SendMailQueue,
+    private readonly channelService: ChannelService,
+  ) {}
 
   async sendMail(fields: BotMailDto) {
-    const { from, subject, template, to, variables } = fields
+    const { from, subject, template, to, contactId } = fields
 
-    const userId = '1'
+    const channel = await this.channelService.findOneByContactId(contactId)
 
-    const [user] = await db
+    if (!channel) {
+      return
+    }
+
+    const [userSetting] = await db
       .select()
       .from(settings)
-      .where(eq(settings.userId, userId))
+      .where(eq(settings.userId, channel.userId))
 
-    if (!user) {
+    if (!userSetting) {
       return
     }
 
-    const { email, password } = user.email
+    const { email, password } = userSetting.email
 
     await this.sendMailQueue.addJob({
       from,
       to,
-      props: variables as any,
+      props: {} as any,
       subject,
-      template,
+      template: template as any,
       pass: password,
       user: email,
     })
diff --git a/server/src/services/channels.service.ts b/server/src/services/channels.service.ts
@@ -97,6 +97,7 @@ export class ChannelService {
         channelType: channelTypes.name,
         credentials: channels.credentials,
         flowId: channels.flowId,
+        userId: channels.userId,
       })
       .from(channels)
       .where(
diff --git a/server/src/services/setting.service.ts b/server/src/services/setting.service.ts
@@ -1,12 +1,15 @@
 import { db } from '@/database/db'
 import { settings } from '@/database/schema'
 import { UpdateEmailSettingDto } from '@/dtos/setting.dto'
+import { encrypt } from '@/utils/crypto'
 import { eq } from 'drizzle-orm'
 import { Service } from 'typedi'
-import { decrypt, encrypt } from '@/utils/crypto'
+import { ChannelService } from './channels.service'
 @Service()
 export class SettingService {
-  async findByUserId(userId: string): Promise<string> {
+  constructor(private readonly channelService: ChannelService) {}
+
+  async findByUserId(userId: string, isEnCrypt = true) {
     const [setting] = await db
       .select()
       .from(settings)
@@ -20,10 +23,12 @@ export class SettingService {
         })
         .returning()
 
-      return encrypt(JSON.stringify(settingInserted))
+      return isEnCrypt
+        ? encrypt(JSON.stringify(settingInserted))
+        : settingInserted
     }
 
-    return encrypt(JSON.stringify(setting))
+    return isEnCrypt ? encrypt(JSON.stringify(setting)) : setting
   }
 
   async updateEmailSetting(userId: string, fields: UpdateEmailSettingDto) {
@@ -61,4 +66,16 @@ export class SettingService {
 
     return encrypt(JSON.stringify(emailSetting))
   }
+
+  async findByContactId(contactId: string) {
+    const channel = await this.channelService.findOneByContactId(contactId)
+
+    if (!channel) {
+      return null
+    }
+
+    const setting = await this.findByUserId(channel.userId)
+
+    return setting
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ export const VariablesSettingForm = ({`
`120`	`120`
`121`	`121`	`if (`
`122`	`122`	`!_.isEmpty(form.formState.errors.variables) \|\|`
`123`		`- variablesWatch?.some((field) => !field.name \|\| !field.value)`
	`123`	`+ variablesWatch?.some((field) => !field.name)`
`124`	`124`	`)`
`125`	`125`	`return`
`126`	`126`
Original file line number	Diff line number	Diff line change
`@@ -360,5 +360,13 @@`
`360`	`360`	`"errors": {`
`361`	`361`	`"required": "Vui lòng chọn biến đầu ra."`
`362`	`362`	`}`
	`363`	`+ },`
	`364`	`+ "bot_response": {`
	`365`	`+ "label": "Bot trả lời",`
	`366`	`+ "placeholder": "Nhập câu trả lời của bot",`
	`367`	`+ "errors": {`
	`368`	`+ "required": "Vui lòng nhập câu trả lời của bot."`
	`369`	`+ },`
	`370`	`+ "description": "Để truy cập các giá trị biến, hãy sử dụng {variable_name}, {variable_name->key}, {variable_name->0->key}, v.v. {user->name} lấy khóa 'name' của biến 'user'. Đối với mảng 'người dùng' có đối tượng ở chỉ mục 0 và khóa 'tên', hãy sử dụng {users->0->name}."`
`363`	`371`	`}`
`364`	`372`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,17 +10,28 @@ export class LocaleService {`
`10`	`10`	`this.locale = locale`
`11`	`11`	`}`
`12`	`12`
	`13`	`+ /**`
	`14`	`+ * Gets the current locale.`
	`15`	`+ *`
	`16`	`+ * @returns The current locale.`
	`17`	`+ */`
`13`	`18`	`getLocale() {`
`14`	`19`	`return this.locale`
`15`	`20`	`}`
`16`	`21`
	`22`	`+ /**`
	`23`	`+ * Sets the locale for the context.`
	`24`	`+ * @param locale The locale to set.`
	`25`	`+ */`
`17`	`26`	`setLocale(locale: Locales) {`
`18`		`- console.log('setLocale', locale)`
`19`	`27`	`this.locale = locale`
`20`	`28`	`}`
`21`	`29`
	`30`	`+ /**`
	`31`	`+ * Returns the localized language object based on the current locale.`
	`32`	`+ * @returns The localized language object.`
	`33`	`+ */`
`22`	`34`	`i18n() {`
`23`		`- console.log(this.locale)`
`24`	`35`	`return L[this.locale]`
`25`	`36`	`}`
`26`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,5 @@ export const COMMON = {`
`4`	`4`	`NAME: 'Name',`
`5`	`5`	`CONFIRM_PASSWORD: 'Confirm password',`
`6`	`6`	`OLD_PASSWORD: 'Old password',`
	`7`	`+ SEND_MAIL_SUCCESS: 'Send mail successfully',`
`7`	`8`	`}`