feat(migration): add v9.6.3 migration and enhance SMTP options handling

- Introduced a new migration script for version 9.6.3 to flatten SMTP options in the database.
- Updated the configuration schema to directly include SMTP host, port, and secure settings, improving clarity and usability.
- Enhanced the email service to utilize the new SMTP configuration structure, ensuring proper handling of email notifications.

These changes improve the email configuration process and streamline the migration to the latest version.

Signed-off-by: Innei <tukon479@gmail.com>

Author: Innei

apps/core/src/migration/history.ts

@@ -19,6 +19,7 @@ import v9_3_2 from './version/v9.3.2'
 import v9_4_1 from './version/v9.4.1'
 import v9_5_0 from './version/v9.5.0'
 import v9_6_0 from './version/v9.6.0'
+import v9_6_3 from './version/v9.6.3'
 
 export default [
   v200Alpha1,
@@ -42,4 +43,5 @@ export default [
   v9_4_1,
   v9_5_0,
   v9_6_0,
+  v9_6_3,
 ]

apps/core/src/migration/version/v9.6.3.ts

@@ -0,0 +1,32 @@
+import type { Db } from 'mongodb'
+import { defineMigration } from '../helper'
+
+export default defineMigration(
+  'v9.6.3-flatten-smtp-options',
+  async (db: Db) => {
+    const optionsCollection = db.collection('options')
+
+    const mailOptionsDoc = await optionsCollection.findOne({
+      name: 'mailOptions',
+    })
+
+    if (mailOptionsDoc?.value?.smtp?.options) {
+      const { smtp } = mailOptionsDoc.value as any
+      const { options, ...restSmtp } = smtp
+
+      await optionsCollection.updateOne(
+        { name: 'mailOptions' },
+        {
+          $set: {
+            'value.smtp': {
+              ...restSmtp,
+              host: options?.host ?? '',
+              port: options?.port ?? 465,
+              secure: options?.secure ?? true,
+            },
+          },
+        },
+      )
+    }
+  },
+)

apps/core/src/modules/configs/configs.encrypt.util.ts

@@ -316,3 +316,48 @@ export const sanitizeConfigForResponse = <T extends object>(
 
   return result
 }
+
+/**
+ * Remove empty string values from encrypted fields
+ * This prevents empty values from overwriting existing encrypted data during merge
+ */
+export const removeEmptyEncryptedFields = <T extends object>(
+  target: T,
+  prefix = '',
+): T => {
+  const result = { ...target }
+  const keys = Object.keys(result)
+
+  for (const key of keys) {
+    const currentPath = prefix ? `${prefix}.${key}` : key
+    const value = (result as any)[key]
+
+    if (Array.isArray(value)) {
+      ;(result as any)[key] = value
+        .map((item, i) => {
+          const itemPath = `${currentPath}.${i}`
+          if (isObject(item) && !isArrayLike(item)) {
+            return removeEmptyEncryptedFields(item, itemPath)
+          } else if (
+            typeof item === 'string' &&
+            item === '' &&
+            isEncryptedPath(itemPath)
+          ) {
+            return undefined
+          }
+          return item
+        })
+        .filter((item) => item !== undefined)
+    } else if (isObject(value) && !isArrayLike(value)) {
+      ;(result as any)[key] = removeEmptyEncryptedFields(value, currentPath)
+    } else if (
+      typeof value === 'string' &&
+      value === '' &&
+      isEncryptedPath(currentPath)
+    ) {
+      delete (result as any)[key]
+    }
+  }
+
+  return result
+}

apps/core/src/modules/configs/configs.schema.ts

@@ -24,30 +24,21 @@ export class UrlDto extends createZodDto(UrlSchema) {}
 export type UrlConfig = z.infer<typeof UrlSchema>
 
 // ==================== Mail Options ====================
-const SmtpOptionsSchema = z.object({
-  port: field.number(
-    z.preprocess(
-      (val) => (val ? Number(val) : val),
-      z.number().int().optional(),
-    ),
-    'SMTP 端口',
-    { 'ui:options': { halfGrid: true } },
-  ),
-  host: field.halfGrid(
-    z.url({ message: 'host must be a valid URL' }).optional().or(z.literal('')),
-    'SMTP 主机',
-  ),
-  secure: field.toggle(z.boolean().optional(), '使用 SSL/TLS'),
-})
-
 const SmtpConfigSchema = withMeta(
   z
     .object({
       user: field.halfGrid(z.string().optional(), 'SMTP 用户名'),
       pass: field.passwordHalfGrid(z.string().min(1).optional(), 'SMTP 密码'),
-      options: withMeta(SmtpOptionsSchema.optional(), {
-        'ui:options': { connect: true },
-      }),
+      host: field.halfGrid(z.string().optional(), 'SMTP 主机'),
+      port: field.number(
+        z.preprocess(
+          (val) => (val ? Number(val) : val),
+          z.number().int().optional(),
+        ),
+        'SMTP 端口',
+        { 'ui:options': { halfGrid: true } },
+      ),
+      secure: field.toggle(z.boolean().optional(), '使用 SSL/TLS'),
     })
     .optional(),
   {

apps/core/src/modules/configs/configs.service.ts

@@ -19,6 +19,7 @@ import { generateDefaultConfig } from './configs.default'
 import {
   decryptObject,
   encryptObject,
+  removeEmptyEncryptedFields,
   sanitizeConfigForResponse,
 } from './configs.encrypt.util'
 import { configDtoMapping, IConfig } from './configs.interface'
@@ -203,6 +204,9 @@ export class ConfigsService {
     value: Partial<IConfig[T]>,
   ) {
     value = camelcaseKeys(value) as any
+    value = removeEmptyEncryptedFields(value as object, key) as Partial<
+      IConfig[T]
+    >
 
     if (key === 'ai') {
       value = await this.hydrateAiProviderApiKeys(value as any)

apps/core/src/processors/helper/helper.email.service.ts

@@ -152,16 +152,16 @@ export class EmailService implements OnModuleInit, OnModuleDestroy {
           }
         } else {
           const { smtp } = mailOptions
-          const { user, pass, options } = smtp || {}
+          const { user, pass, host, port, secure } = smtp || {}
           if (!user && !pass) {
             const message = '未启动邮件通知'
             this.logger.warn(message)
             return
           }
           this.instance = createTransport({
-            host: options?.host || '',
-            port: Number.parseInt((options?.port as any) || '465'),
-            secure: options?.secure,
+            host: host || '',
+            port: Number.parseInt((port as any) || '465'),
+            secure,
             auth: { user, pass },
             tls: {
               rejectUnauthorized: false,