@anjianshi/utils 3.6.1 → 3.7.0

package/env-service/prisma/adapt-logging.d.ts

@@ -1,6 +1,14 @@
-import type { getPrismaClient } from '@prisma/client/runtime/library.js';
+import type { getPrismaClient } from '@prisma/client/runtime/client.js';
 import { type Logger } from '../../logging/index.js';
-type PrismalClient = ReturnType<typeof getPrismaClient> extends new () => infer T ? T : never;
+type PrismalClient = InstanceType<ReturnType<typeof getPrismaClient>>;
+/**
+ * 生成 Prisma 日志配置项
+ *
+ * * 使用方法：
+ * 1. 初始化 PrismaClient 时传入 getPrismaLoggingOptions() 的返回值，来开启日志：
+ *    new PrismaClient({ xxx, ...getPrismaLoggingOptions('xxx') })
+ * 2. client 初始化完成后，传给 adaptPrismaLogging() 完整与 logger 的对接。
+ */
 export declare function getPrismaLoggingOptions(level: 'debug' | 'info' | 'warn' | 'error'): {
     errorFormat: "pretty";
     log: ({
@@ -17,5 +25,8 @@ export declare function getPrismaLoggingOptions(level: 'debug' | 'info' | 'warn'
         level: "error";
     })[];
 };
-export declare function adaptPrismaLogging<T extends Pick<PrismalClient, '$on'>>(prisma: T, baseLogger: Logger): void;
+/** 把 Prisma 日志重定向到 logger 中 */
+export declare function adaptPrismaLogging(prisma: Pick<PrismalClient, '$on'>, logger: Logger, enableDebugLog?: boolean): void;
+/** 开启调试日志，并改为通过 logger 记录日志内容 */
+export declare function adaptPrismaDebugLogging(logger: Logger): void;
 export {};

package/env-service/prisma/adapt-logging.js

@@ -1,14 +1,42 @@
 /**
  * 对接 Prisma 的日志记录
  *
- * 注意：Prisma 的 debugging 日志是直接输出到 console 的，没有提供处理渠道，所以无法记录进日志文件。
- * 理论上可以重写 console.log/debug... 等方法来实现捕获，但这牵扯面太广，暂不这样做。
- *
  * 使用前提：
  * - 安装 chalk 依赖
+ *
+ * Prisma 输出的日志分两部分：
+ * 1. 日常运行日志，可通过 PrismaClient 的 log 选项控制。
+ * 2. 调试日志，不由 log 选项控制，通过 @prisma/debug 包输出（与 debug 包类似）。
+ *
+ * [@prisma/debug 包的存在形式]
+ * prisma 直接把此包打进了其代码里，不通过依赖的方式引入，无法通过引用相同的依赖来对其自定义。
+ *
+ * [调试日志的开关]
+ * - @prisma/debug 包会读取 DEBUG 环境变量即 `process.env.DEBUG` 的值写入到 `globalThis.DEBUG` 中，作为全局的开关配置。
+ *   此配置也可调用 enable() / disable() 方法来修改，不过因为我们引用不到这个模块，所以没法调用。
+ * - 每个 prisma 模块还会生成一个 debug 子实例，它会根据当前的全局配置来决定自身是否开启，但生成后就不再跟随全局配置的变化而修改。
+ * - 最终输出日志时，只要全局配置和子实例中有任意一个是开启的，就会输出日志。
+ *   因为这一特性，不建议在涉及 Prisma 的项目里事先指定 DEBUG 环境变量。
+ *   最好引入完 Prisma 代码后，再在代码里修改 process.env.DEBUG，以避免调试日志被意外开启。
+ *
+ * [调试日志的输出方式]
+ * 在 @prisma/debug 代码里，它所有输出行为都是统一调用 log() 方法来完成。
+ * 而这个方法底层调用的是 console.warn() 和 console.log()。
+ * 我们引用不到 prisma 使用的 @prisma/debug 库，无法修改器 log() 方法，但可以修改全局的 console.warn() 来实现自定义。
+ *
+ * [相关代码]
+ * https://github.com/prisma/prisma/ => `packages/debug/src/index.ts`
  */
 import nodeUtil from 'node:util';
 import chalk from 'chalk';
+/**
+ * 生成 Prisma 日志配置项
+ *
+ * * 使用方法：
+ * 1. 初始化 PrismaClient 时传入 getPrismaLoggingOptions() 的返回值，来开启日志：
+ *    new PrismaClient({ xxx, ...getPrismaLoggingOptions('xxx') })
+ * 2. client 初始化完成后，传给 adaptPrismaLogging() 完整与 logger 的对接。
+ */
 export function getPrismaLoggingOptions(level) {
     return {
         errorFormat: 'pretty',
@@ -22,14 +50,44 @@ export function getPrismaLoggingOptions(level) {
         ],
     };
 }
-// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
-export function adaptPrismaLogging(prisma, baseLogger) {
-    // 记录 Prisma 相关日志
-    const queryLogger = baseLogger.getChild('query');
+/** 把 Prisma 日志重定向到 logger 中 */
+export function adaptPrismaLogging(prisma, logger, enableDebugLog = false) {
+    const queryLogger = logger.getChild('query');
     prisma.$on('query', e => {
         queryLogger.debug(e.query, chalk.green(nodeUtil.format(e.params) + ` +${e.duration}ms`));
     });
-    prisma.$on('info', e => baseLogger.info(e.message));
-    prisma.$on('warn', e => baseLogger.warn(e.message));
-    prisma.$on('error', e => baseLogger.error(e.message));
+    prisma.$on('info', e => logger.info(e.message));
+    prisma.$on('warn', e => logger.warn(e.message));
+    prisma.$on('error', e => logger.error(e.message));
+    if (enableDebugLog)
+        adaptPrismaDebugLogging(logger);
+}
+/** 开启调试日志，并改为通过 logger 记录日志内容 */
+export function adaptPrismaDebugLogging(logger) {
+    ;
+    globalThis.DEBUG = '*';
+    const loggers = new Map();
+    function fixedConsoleWarn(...args) {
+        const [initialArg, ...restArgs] = args;
+        if (typeof initialArg === 'string') {
+            const pattern = /(?<=^(?:\x1b\[\d+m){2})(prisma(?::[\w-]+)+)\x1b\[22m\x1b\[39m ([\s\S]*)/;
+            const match = pattern.exec(initialArg);
+            if (match) {
+                const namespace = match[1];
+                const format = match[2] ?? '';
+                if (!loggers.has(namespace)) {
+                    loggers.set(namespace, logger.getChild(namespace.replace(/^prisma:/, '').replaceAll(':', '/')));
+                }
+                const childLogger = loggers.get(namespace);
+                if (format)
+                    childLogger.debug(nodeUtil.format(format, ...restArgs));
+                else
+                    childLogger.debug(...restArgs);
+                return;
+            }
+        }
+        originalConsoleWarn(...args);
+    }
+    console.warn = fixedConsoleWarn;
 }
+const originalConsoleWarn = console.warn.bind(console);

package/env-service/prisma/extensions/exist.d.ts

@@ -2,8 +2,11 @@ import { Prisma } from '@prisma/client/extension.js';
 /**
  * 快速检查指定条件的数据是否存在
  * const exists = await prisma.xxx.exists({ id: '1' })
+ *
+ * 注意：
+ * 此扩展使用了 soft-delete 扩展定义的 withDeleted 选项，因此必须与 soft-delete 扩展一起使用。
  */
-export declare const exists: (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/library").InternalArgs<{}, {
+export declare const exists: (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/client").InternalArgs<{}, {
     $allModels: {
         exists<T>(this: T, where: Prisma.Args<T, "count">["where"], withDeleted?: boolean): Promise<boolean>;
     };

package/env-service/prisma/extensions/exist.js

@@ -2,6 +2,9 @@ import { Prisma } from '@prisma/client/extension.js';
 /**
  * 快速检查指定条件的数据是否存在
  * const exists = await prisma.xxx.exists({ id: '1' })
+ *
+ * 注意：
+ * 此扩展使用了 soft-delete 扩展定义的 withDeleted 选项，因此必须与 soft-delete 扩展一起使用。
  */
 export const exists = Prisma.defineExtension({
     name: 'exists',

package/env-service/prisma/extensions/find-and-count.d.ts

@@ -1,6 +1,6 @@
 import { Prisma } from '@prisma/client/extension.js';
 import { type SoftDeleteQueryArgs } from './soft-delete.js';
-export declare const findAndCount: (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/library").InternalArgs<{}, {
+export declare const findAndCount: (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/client").InternalArgs<{}, {
     $allModels: {
         findAndCount<T, A>(this: T, rawArgs: Prisma.Exact<A, Prisma.Args<T, "findMany"> & SoftDeleteQueryArgs>): Promise<[Awaited<Prisma.Result<T, A, "findMany">>, Awaited<Prisma.Result<T, A, "count">>]>;
     };

package/env-service/prisma/extensions/soft-delete.d.ts

@@ -14,7 +14,7 @@
  * 为保证其他扩展也应用到修改过的这些方法，此扩展应尽可能放在最前面。
  */
 import { Prisma } from '@prisma/client/extension.js';
-import type { Operation } from '@prisma/client/runtime/library.js';
+import type { Operation } from '@prisma/client/runtime/client.js';
 import { type OptionalFields } from '../../../index.js';
 type DeleteArgs<T> = Prisma.Args<T, 'delete'> & {
     soft?: boolean;
@@ -33,7 +33,7 @@ interface QueryExtraArgs {
 }
 export type { QueryExtraArgs as SoftDeleteQueryArgs };
 type QueryInputArgs<T, A, K extends Operation> = Prisma.Exact<A, Prisma.Args<T, K> & QueryExtraArgs>;
-export declare const softDelete: (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/library").InternalArgs<{}, {
+export declare const softDelete: (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/client").InternalArgs<{}, {
     $allModels: {
         withSoftDeleteExtension: boolean;
         delete<T, A>(this: T, rawArgs: Prisma.Exact<A, DeleteArgs<T>>): DeleteReturn<T, A>;
@@ -41,10 +41,10 @@ export declare const softDelete: (client: any) => import("@prisma/client/extensi
         restore<T, A>(this: T, rawArgs: Prisma.Exact<A, RestoreArgs<T>>): Promise<Prisma.Result<T, A, "update">>;
         restoreMany<T, A>(this: T, rawArgs: Prisma.Exact<A, RestoreManyArgs<T>>): Promise<Prisma.Result<T, A, "updateMany">>;
         aggregate<T, A>(this: T, inputArgs: QueryInputArgs<T, A, "aggregate">): Promise<Prisma.Result<T, A, "aggregate">>;
-        count<T, A>(this: T, inputArgs: QueryInputArgs<T, A, "count">): Promise<Prisma.Result<T, A, "count">>;
-        findFirst<T, A>(this: T, inputArgs: QueryInputArgs<T, A, "findFirst">): Promise<Prisma.Result<T, A, "findFirst">>;
-        findFirstOrThrow<T, A>(this: T, inputArgs: QueryInputArgs<T, A, "findFirstOrThrow">): Promise<Prisma.Result<T, A, "findFirstOrThrow">>;
-        findMany<T, A>(this: T, inputArgs: QueryInputArgs<T, A, "findMany">): Promise<Prisma.Result<T, A, "findMany">>;
+        count<T, A>(this: T, inputArgs?: QueryInputArgs<T, A, "count">): Promise<Prisma.Result<T, A, "count">>;
+        findFirst<T, A>(this: T, inputArgs?: QueryInputArgs<T, A, "findFirst">): Promise<Prisma.Result<T, A, "findFirst">>;
+        findFirstOrThrow<T, A>(this: T, inputArgs?: QueryInputArgs<T, A, "findFirstOrThrow">): Promise<Prisma.Result<T, A, "findFirstOrThrow">>;
+        findMany<T, A>(this: T, inputArgs?: QueryInputArgs<T, A, "findMany">): Promise<Prisma.Result<T, A, "findMany">>;
         findUnique<T, A>(this: T, inputArgs: QueryInputArgs<T, A, "findUnique">): Promise<Prisma.Result<T, A, "findUnique">>;
         findUniqueOrThrow<T, A>(this: T, inputArgs: QueryInputArgs<T, A, "findUniqueOrThrow">): Promise<Prisma.Result<T, A, "findUniqueOrThrow">>;
         groupBy<T, A>(this: T, inputArgs: QueryInputArgs<T, A, "groupBy">): Promise<Prisma.Result<T, A, "groupBy">>;

package/env-service/prisma/extensions/soft-delete.js

@@ -31,7 +31,7 @@ function getModel(that) {
 function query(that, inputArgs, method) {
     const { model, supportSoftDelete } = getModel(that);
     // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
-    const { withDeleted = false, ...args } = inputArgs;
+    const { withDeleted = false, ...args } = (inputArgs ?? {});
     return model[method]({
         ...args,
         where: !supportSoftDelete || withDeleted ? args.where : { ...args.where, deleteTime: null },

package/env-service/prisma/extensions/with-transaction.d.ts

@@ -1,9 +1,13 @@
-import { type ITXClientDenyList } from '@prisma/client/runtime/library.js';
+import { type ITXClientDenyList } from '@prisma/client/runtime/client.js';
 import type { Result, Failed } from '../../../index.js';
-export declare const withTransaction: (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/library").InternalArgs<{}, {}, {}, {
+export declare const withTransaction: (client: any) => import("@prisma/client/extension").PrismaClientExtends<import("@prisma/client/runtime/client").InternalArgs<{}, {}, {}, {
     $withTransaction: typeof $withTransaction;
 }>>;
 export type GetPrismaClientInTransaction<PrismaClient> = Omit<PrismaClient, ITXClientDenyList>;
 export type WithTransactionMethod = typeof $withTransaction;
-declare function $withTransaction<That extends object, R extends Result>(this: That, callback: (dbInTransaction: GetPrismaClientInTransaction<That>) => Promise<R>): Promise<R | Failed<unknown, any>>;
+export type TransactionIsolationLevel = 'ReadUncommitted' | 'ReadCommitted' | 'RepeatableRead' | 'Serializable';
+export interface TransactionOptions {
+    isolationLevel?: TransactionIsolationLevel;
+}
+declare function $withTransaction<That extends object, R extends Result>(this: That, callback: (dbInTransaction: GetPrismaClientInTransaction<That>) => Promise<R>, options?: TransactionOptions): Promise<Failed<any, any> | R>;
 export {};

package/env-service/prisma/extensions/with-transaction.js

@@ -1,5 +1,6 @@
 /**
- * 在事务中执行回调。与 $transaction 有几点不同：
+ * 在事务中执行操作（回调函数）。
+ * 与 prisma.$transaction 有几点不同：
  * 1. 回调必须返回 Result 值
  * 2. 回调返回 Failed 值或抛出异常都会触发回滚。
  *    如果是返回 Failed，会作为此方法的返回值；如果是抛出异常，则异常会继续向上传递，直到被捕获或触发请求失败。
@@ -30,7 +31,7 @@ class FailedInTransaction extends Error {
 // 这是有意为之的，`Failed<unknown, any>` 并不多余。
 // 因为有时 callback() 只会返回 success 结果，此时 R=Success<xxx>，
 // 但是 $withTransaction 整体的返回值仍有可能有 Failed<unknown, any>，所以不能用 R 作为整体返回值。
-async function $withTransaction(callback) {
+async function $withTransaction(callback, options) {
     const executeCallback = async (dbInTransaction) => {
         const result = await callback(dbInTransaction);
         if (result.success)
@@ -41,7 +42,7 @@ async function $withTransaction(callback) {
     if ('$transaction' in this && this.$transaction) {
         // 如果当前不在事务中，开启新事务并执行回调
         try {
-            return await this.$transaction(async (dbInTransaction) => executeCallback(dbInTransaction));
+            return await this.$transaction(async (dbInTransaction) => executeCallback(dbInTransaction), options);
         }
         catch (e) {
             if (e instanceof FailedInTransaction)

package/env-service/prisma/transaction-contexted.d.ts

@@ -1,7 +1,7 @@
 import type { WithTransactionMethod } from './extensions/with-transaction.js';
 /**
  * 返回一个可以在事务内和事务外通用的 PrismaClient 代理对象。
- * 当前在事务内时，调用它是调用事务内的 client；当前不在事务内时，调用它是调用全局 client。
+ * 在事务内时，对应事务内的 client；不在事务内时，对应全局 client。
  * 这样当一个事务涉及多个函数调用时，就不用把事务内 client 传递来传递去了。
  * 注意：应给每个线性流程（例如一个请求）单独生成一个此对象，不能作为全局对象使用，不然可能出现事务冲突。
  */

package/env-service/prisma/transaction-contexted.js

@@ -1,6 +1,6 @@
 /**
  * 返回一个可以在事务内和事务外通用的 PrismaClient 代理对象。
- * 当前在事务内时，调用它是调用事务内的 client；当前不在事务内时，调用它是调用全局 client。
+ * 在事务内时，对应事务内的 client；不在事务内时，对应全局 client。
  * 这样当一个事务涉及多个函数调用时，就不用把事务内 client 传递来传递去了。
  * 注意：应给每个线性流程（例如一个请求）单独生成一个此对象，不能作为全局对象使用，不然可能出现事务冲突。
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "3.6.1",
+  "version": "3.7.0",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-packages/utils",
   "bugs": {
@@ -26,7 +26,7 @@
     "@emotion/react": "^11.14.0",
     "@emotion/serialize": "^1.3.3",
     "@emotion/utils": "^1.4.2",
-    "@prisma/client": "^6.8.2",
+    "@prisma/client": "^7.4.0",
     "@types/lodash": "^4.17.20",
     "@types/node": "^22.16.0",
     "@types/react": "^19.1.8",
@@ -38,12 +38,12 @@
     "redis": "^5.5.6",
     "typescript": "^5.8.3",
     "vconsole": "^3.15.1",
-    "@anjianshi/presets-eslint-base": "6.1.0",
-    "@anjianshi/presets-eslint-node": "6.1.0",
-    "@anjianshi/presets-eslint-react": "6.1.1",
-    "@anjianshi/presets-eslint-typescript": "6.1.0",
-    "@anjianshi/presets-typescript": "3.2.5",
-    "@anjianshi/presets-prettier": "3.2.0"
+    "@anjianshi/presets-eslint-base": "6.1.2",
+    "@anjianshi/presets-eslint-node": "6.1.2",
+    "@anjianshi/presets-eslint-react": "6.1.3",
+    "@anjianshi/presets-eslint-typescript": "6.1.2",
+    "@anjianshi/presets-prettier": "3.2.0",
+    "@anjianshi/presets-typescript": "3.2.5"
   },
   "prettier": "@anjianshi/presets-prettier/prettierrc"
 }