befly 3.19.8 → 3.20.0

package/checks/config.js

@@ -1,7 +1,7 @@
 import * as z from "zod";
 
 import { Logger } from "../lib/logger.js";
-import { DB_ID_MODE_VALUES, RUN_MODE_VALUES } from "../configs/constConfig.js";
+import { RUN_MODE_VALUES } from "../configs/constConfig.js";
 import { formatZodIssues } from "../utils/formatZodIssues.js";
 import { isNoTrimStringAllowEmpty, isValidTimeZone } from "../utils/is.js";
 
@@ -9,6 +9,7 @@ z.config(z.locales.zhCN());
 
 const boolIntSchema = z.union([z.literal(0), z.literal(1), z.literal(true), z.literal(false)]);
 const noTrimString = z.string().refine(isNoTrimStringAllowEmpty, "不允许首尾空格");
+const beflyModeSchema = z.union([z.literal("manual"), z.literal("auto")]);
 
 const configSchema = z
     .object({
@@ -36,14 +37,13 @@ const configSchema = z
 
         mysql: z
             .object({
-                idMode: z.enum(DB_ID_MODE_VALUES),
                 hostname: noTrimString,
                 port: z.int().min(1).max(65535),
                 username: noTrimString,
                 password: noTrimString,
                 database: noTrimString,
                 max: z.number().min(1),
-                beflyMode: z.union([z.literal(0), z.literal(1)]).optional()
+                beflyMode: beflyModeSchema.optional()
             })
             .strict(),
 

package/configs/beflyConfig.json

@@ -20,14 +20,13 @@
     },
 
     "mysql": {
-        "idMode": "timeId",
         "hostname": "127.0.0.1",
         "port": 3306,
         "username": "root",
         "password": "root",
         "database": "befly_dev",
         "max": 10,
-        "beflyMode": 1
+        "beflyMode": "auto"
     },
 
     "redis": {

package/configs/constConfig.js

@@ -30,9 +30,6 @@ export const ENUM_KIND_TYPES = ["enum"];
 // 运行模式可选值
 export const RUN_MODE_VALUES = ["development", "production"];
 
-// 数据库 ID 生成模式可选值
-export const DB_ID_MODE_VALUES = ["timeId", "autoId"];
-
 // ==========================
 // 字段验证规则配置
 // ==========================

package/lib/dbHelper/builders.js

@@ -354,8 +354,8 @@ export function processJoinOn(on) {
     return result;
 }
 
-export function addDefaultStateFilter(where = {}, table, hasJoins = false, beflyMode = 1) {
-    if (beflyMode === 0) {
+export function addDefaultStateFilter(where = {}, table, hasJoins = false, beflyMode = "auto") {
+    if (beflyMode === "manual") {
         return where;
     }
 
@@ -488,12 +488,12 @@ export function buildInsertRow(options) {
         result[key] = value;
     }
 
-    if (options.idMode === "timeId") {
+    if (options.beflyMode === "auto") {
         validateTimeIdValue(options.id);
         result["id"] = options.id;
     }
 
-    if (options.beflyMode !== 0) {
+    if (options.beflyMode !== "manual") {
         result["created_at"] = options.now;
         result["updated_at"] = options.now;
         result["state"] = 1;
@@ -509,7 +509,7 @@ export function buildUpdateRow(options) {
     for (const [key, value] of Object.entries(userData)) {
         result[key] = value;
     }
-    if (options.beflyMode !== 0) {
+    if (options.beflyMode !== "manual") {
         result["updated_at"] = options.now;
     }
     return result;

package/lib/dbHelper/dataOps.js

@@ -192,9 +192,8 @@ export const dataOpsMethods = {
         const now = Date.now();
 
         let processed;
-        if (this.idMode === "autoId") {
+        if (this.beflyMode === "manual") {
             processed = buildInsertRow({
-                idMode: "autoId",
                 data: data,
                 now: now,
                 beflyMode: this.beflyMode
@@ -213,7 +212,6 @@ export const dataOpsMethods = {
                 });
             }
             processed = buildInsertRow({
-                idMode: "timeId",
                 data: data,
                 id: id,
                 now: now,
@@ -231,9 +229,9 @@ export const dataOpsMethods = {
         const processedIdNum = isNumber(processedId) ? processedId : 0;
         const lastInsertRowidNum = toNumberFromSql(executeRes.data?.lastInsertRowid);
 
-        const insertedId = this.idMode === "autoId" ? lastInsertRowidNum || 0 : processedIdNum || lastInsertRowidNum || 0;
-        if (this.idMode === "autoId" && insertedId <= 0) {
-            throw new Error(`插入失败：autoId 模式下无法获取 lastInsertRowid (table: ${table})`, {
+        const insertedId = this.beflyMode === "manual" ? lastInsertRowidNum || 0 : processedIdNum || lastInsertRowidNum || 0;
+        if (this.beflyMode === "manual" && insertedId <= 0) {
+            throw new Error(`插入失败：beflyMode=manual 时无法获取 lastInsertRowid (table: ${table})`, {
                 cause: null,
                 code: "runtime"
             });
@@ -261,9 +259,9 @@ export const dataOpsMethods = {
         let ids = [];
 
         let processedList;
-        if (this.idMode === "autoId") {
+        if (this.beflyMode === "manual") {
             processedList = dataList.map((data) => {
-                return buildInsertRow({ idMode: "autoId", data: data, now: now, beflyMode: this.beflyMode });
+                return buildInsertRow({ data: data, now: now, beflyMode: this.beflyMode });
             });
         } else {
             const nextIds = [];
@@ -274,7 +272,7 @@ export const dataOpsMethods = {
             processedList = dataList.map((data, index) => {
                 const id = nextIds[index];
                 validateGeneratedBatchId(id, snakeTable, index);
-                return buildInsertRow({ idMode: "timeId", data: data, id: id, now: now, beflyMode: this.beflyMode });
+                return buildInsertRow({ data: data, id: id, now: now, beflyMode: this.beflyMode });
             });
         }
 
@@ -285,10 +283,10 @@ export const dataOpsMethods = {
         try {
             const executeRes = await this.execute(sql, params);
 
-            if (this.idMode === "autoId") {
+            if (this.beflyMode === "manual") {
                 const firstId = toNumberFromSql(executeRes.data?.lastInsertRowid);
                 if (firstId <= 0) {
-                    throw new Error(`批量插入失败：autoId 模式下无法获取 lastInsertRowid (table: ${table})`, {
+                    throw new Error(`批量插入失败：beflyMode=manual 时无法获取 lastInsertRowid (table: ${table})`, {
                         cause: null,
                         code: "runtime"
                     });
@@ -393,10 +391,10 @@ export const dataOpsMethods = {
             rows: processedList,
             fields: fields,
             quoteIdent: quoteIdentMySql,
-            updatedAtField: this.beflyMode === 1 ? "updated_at" : "",
-            updatedAtValue: this.beflyMode === 1 ? now : null,
+            updatedAtField: this.beflyMode === "auto" ? "updated_at" : "",
+            updatedAtValue: this.beflyMode === "auto" ? now : null,
             stateField: "state",
-            stateGtZero: this.beflyMode === 1
+            stateGtZero: this.beflyMode === "auto"
         });
 
         const executeRes = await this.execute(query.sql, query.params);
@@ -431,8 +429,8 @@ export const dataOpsMethods = {
         validateTableWhereOptions(options, "delData", true);
         const { table, where } = options;
 
-        // beflyMode=0：关闭默认 state 软删语义，delData 直接走物理删除
-        if (this.beflyMode === 0) {
+        // beflyMode=manual：关闭默认 state 软删语义，delData 直接走物理删除
+        if (this.beflyMode === "manual") {
             return await this.delForce({
                 table: table,
                 where: where
@@ -552,7 +550,6 @@ export const dataOpsMethods = {
                     dbName: this.dbName,
                     sql: tx,
                     isTransaction: true,
-                    idMode: this.idMode,
                     beflyMode: this.beflyMode
                 });
                 const result = await callback(trans);

package/lib/dbHelper/index.js

@@ -16,8 +16,7 @@ function DbHelper(options) {
 
     this.sql = options.sql || null;
     this.isTransaction = options.isTransaction === true;
-    this.idMode = options.idMode === "autoId" ? "autoId" : "timeId";
-    this.beflyMode = options.beflyMode === 0 ? 0 : 1;
+    this.beflyMode = options.beflyMode === "manual" ? "manual" : "auto";
 }
 
 Object.assign(DbHelper.prototype, builderMethods, executeMethods, dataOpsMethods);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "befly",
-    "version": "3.19.8",
-    "gitHead": "c0876969a14b2d6e66fd5105269e326581c0dde3",
+    "version": "3.20.0",
+    "gitHead": "218c4ffe07983e46bbb85f9e0a626a6b3b38c179",
     "private": false,
     "description": "Befly - 为 Bun 专属打造的 JavaScript API 接口框架核心引擎",
     "keywords": [

package/plugins/mysql.js

@@ -19,7 +19,6 @@ export default {
                 redis: befly.redis,
                 dbName: befly.config?.mysql?.database,
                 sql: Connect.getMysql(),
-                idMode: befly.config?.mysql?.idMode,
                 beflyMode: befly.config?.mysql?.beflyMode
             });
 

package/scripts/syncDb/context.js

@@ -9,6 +9,7 @@ import { isNonEmptyString, isPlainObject } from "../../utils/is.js";
 import { camelCase } from "../../utils/util.js";
 import { buildSyncDbDiff, groupSyncDbColumns } from "./diff.js";
 import { querySyncDbColumns } from "./query.js";
+import { printSyncDbProcessLog } from "./report.js";
 
 async function loadSyncDbTableDefs(tablesDir) {
     const tableMap = new Map();
@@ -52,6 +53,7 @@ async function loadSyncDbTableDefs(tablesDir) {
 export async function prepareSyncDbBaseContext(mysqlConfig) {
     const tablesDir = resolve(join(process.cwd(), "tables"));
     await mkdir(tablesDir, { recursive: true });
+    printSyncDbProcessLog(`tables目录=${tablesDir}`);
 
     if (!isPlainObject(mysqlConfig)) {
         throw new Error("syncDb 缺少 mysql 配置", {
@@ -62,16 +64,19 @@ export async function prepareSyncDbBaseContext(mysqlConfig) {
         });
     }
 
+    printSyncDbProcessLog(`beflyMode=${mysqlConfig.beflyMode === "manual" ? "manual" : "auto"}`);
+    printSyncDbProcessLog(`连接 MySQL，database=${mysqlConfig.database}`);
     await Connect.connectMysql(mysqlConfig);
     const mysql = new DbHelper({
         redis: null,
         dbName: mysqlConfig.database,
         sql: Connect.getMysql(),
-        idMode: mysqlConfig.idMode,
         beflyMode: mysqlConfig.beflyMode
     });
 
+    printSyncDbProcessLog("开始读取数据库字段信息");
     const dbColumns = await querySyncDbColumns(mysql);
+    printSyncDbProcessLog(`数据库字段读取完成，columnCount=${dbColumns.length}`);
     const skippedBeflyTables = new Set();
     for (const row of dbColumns) {
         const tableName = String(row?.tableName || "");
@@ -89,7 +94,9 @@ export async function prepareSyncDbBaseContext(mysqlConfig) {
 
     const groupedDbColumns = groupSyncDbColumns(dbColumns);
     const existingTableMap = await loadSyncDbTableDefs(tablesDir);
-    const diff = buildSyncDbDiff(groupedDbColumns, existingTableMap);
+    const diff = buildSyncDbDiff(groupedDbColumns, existingTableMap, mysqlConfig.beflyMode);
+    printSyncDbProcessLog(`tables定义文件数量=${existingTableMap.size}`);
+    printSyncDbProcessLog(`差异扫描完成，missingTableCount=${diff.missingTables.length}，missingFieldCount=${Object.values(diff.missingFieldsByTable).reduce((sum, item) => sum + item.fields.length, 0)}`);
 
     return {
         diff: diff,

package/scripts/syncDb/diff.js

@@ -2,8 +2,20 @@ import { join } from "node:path";
 
 import { isNonEmptyString, isPlainObject } from "../../utils/is.js";
 import { camelCase } from "../../utils/util.js";
+import { printSyncDbProcessLog } from "./report.js";
 import { toSyncDbFieldDef } from "./transform.js";
 
+const SYNC_DB_MANAGED_FIELD_NAMES = new Set(["id", "created_at", "updated_at", "deleted_at", "state"]);
+
+function shouldSkipSyncDbColumn(columnMeta, beflyMode) {
+    if (beflyMode !== "manual") {
+        return false;
+    }
+
+    const columnName = String(columnMeta?.columnName || "").toLowerCase();
+    return SYNC_DB_MANAGED_FIELD_NAMES.has(columnName);
+}
+
 export function groupSyncDbColumns(rows) {
     const grouped = new Map();
 
@@ -36,26 +48,31 @@ export function groupSyncDbColumns(rows) {
     return grouped;
 }
 
-export function buildSyncDbDiff(groupedDbColumns, existingTableMap) {
+export function buildSyncDbDiff(groupedDbColumns, existingTableMap, beflyMode = "auto") {
     const missingTables = [];
     const missingFieldsByTable = {};
 
     for (const [tableName, columns] of groupedDbColumns.entries()) {
         const tableFileName = camelCase(tableName);
         const existing = existingTableMap.get(String(tableFileName).toLowerCase());
+        const filteredColumns = columns.filter((columnMeta) => !shouldSkipSyncDbColumn(columnMeta, beflyMode));
 
         if (!existing) {
+            if (filteredColumns.length === 0) {
+                continue;
+            }
+
             missingTables.push({
                 tableName: tableName,
                 tableFileName: tableFileName,
-                columns: columns
+                columns: filteredColumns
             });
             continue;
         }
 
         const existingFields = isPlainObject(existing.tableDef) ? existing.tableDef : {};
         const missingFields = [];
-        for (const columnMeta of columns) {
+        for (const columnMeta of filteredColumns) {
             const fieldInfo = toSyncDbFieldDef(columnMeta);
             if (Object.hasOwn(existingFields, fieldInfo.fieldName)) {
                 continue;
@@ -103,6 +120,7 @@ export async function applySyncDbDiff(diff, tablesDir, existingTableMap) {
         const filePath = join(tablesDir, `${missingTable.tableFileName}.json`);
         await Bun.write(filePath, `${JSON.stringify(tableDef, null, 4)}\n`);
         createdTableFileCount = createdTableFileCount + 1;
+        printSyncDbProcessLog(`已生成表映射 ${filePath}`);
     }
 
     for (const [tableFileName, tableInfo] of Object.entries(diff.missingFieldsByTable)) {
@@ -116,6 +134,7 @@ export async function applySyncDbDiff(diff, tablesDir, existingTableMap) {
         }
 
         await Bun.write(targetFilePath, `${JSON.stringify(currentTableDef, null, 4)}\n`);
+        printSyncDbProcessLog(`已补充字段映射 ${targetFilePath}，fieldCount=${tableInfo.fields.length}`);
     }
 
     return {

package/scripts/syncDb/index.js

@@ -5,10 +5,11 @@ import { Connect } from "../../lib/connect.js";
 import { Logger } from "../../lib/logger.js";
 import { applySyncDbDiff, countSyncDbMissingFields } from "./diff.js";
 import { prepareSyncDbBaseContext } from "./context.js";
-import { printSyncDbDiffSummary, writeSyncDbCheckReport } from "./report.js";
+import { printSyncDbDiffSummary, printSyncDbProcessLog, writeSyncDbCheckReport } from "./report.js";
 
 export async function syncDbCheck(mysqlConfig) {
     try {
+        printSyncDbProcessLog("开始执行 check");
         const reportPath = resolve(join(process.cwd(), "db.check.md"));
         await mkdir(dirname(reportPath), { recursive: true });
         await Bun.write(reportPath, "");
@@ -17,6 +18,7 @@ export async function syncDbCheck(mysqlConfig) {
         const missingFieldCount = countSyncDbMissingFields(diff);
         const writtenReportPath = await writeSyncDbCheckReport(reportPath, diff, groupedDbColumns, existingTableMap);
         printSyncDbDiffSummary("check", diff);
+        printSyncDbProcessLog(`check完成，missingTableCount=${diff.missingTables.length}，missingFieldCount=${missingFieldCount}`);
 
         return {
             mode: "check",
@@ -42,10 +44,12 @@ export async function syncDbCheck(mysqlConfig) {
 
 export async function syncDbApply(mysqlConfig) {
     try {
+        printSyncDbProcessLog("开始执行 apply");
         const { diff, tablesDir, existingTableMap } = await prepareSyncDbBaseContext(mysqlConfig);
         printSyncDbDiffSummary("check", diff);
         const applyResult = await applySyncDbDiff(diff, tablesDir, existingTableMap);
         printSyncDbDiffSummary("apply", diff);
+        printSyncDbProcessLog(`apply完成，createdTableFileCount=${applyResult.createdTableFileCount}，appendedFieldCount=${applyResult.appendedFieldCount}`);
 
         return {
             mode: "apply",

package/scripts/syncDb/report.js

@@ -7,6 +7,10 @@ import { camelCase } from "../../utils/util.js";
 import { countSyncDbMissingFields } from "./diff.js";
 import { toSyncDbFieldDef } from "./transform.js";
 
+export function printSyncDbProcessLog(message) {
+    process.stdout.write(`[syncDb] ${message}\n`);
+}
+
 export function printSyncDbDiffSummary(mode, diff) {
     const tableNames = diff.missingTables.map((item) => item.tableName);
     const missingFieldGroups = Object.values(diff.missingFieldsByTable);
@@ -182,6 +186,7 @@ export async function writeSyncDbCheckReport(reportPath, diff, groupedDbColumns,
     await mkdir(dirname(reportPath), { recursive: true });
     const markdown = buildSyncDbCheckMarkdown(diff, groupedDbColumns, existingTableMap);
     await Bun.write(reportPath, markdown);
+    printSyncDbProcessLog(`差异报告已写入 ${reportPath}`);
     Logger.info("差异报告写入完成", {
         reportPath: reportPath
     });