✨ [util] 新增locks

Gaubee · Gaubee · commit 452d6428df06 · 2025-06-19T11:38:28.000+08:00
diff --git a/deno.json b/deno.json
@@ -7,6 +7,7 @@
   },
   "compilerOptions": {
     "lib": ["deno.window", "dom", "ESNext"],
+    "types": ["node"],
     "noImplicitOverride": true
   },
   "workspace": [
diff --git a/flow/deno.json b/flow/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@gaubee/flow",
-  "version": "0.3.10",
+  "version": "0.3.11",
   "exports": {
     "./state_flow": "./src/state_flow.ts",
     "./shared_flow": "./src/shared_flow.ts",
diff --git a/flow/src/shared_flow.test.ts b/flow/src/shared_flow.test.ts
@@ -1,4 +1,5 @@
 import {delay} from "@gaubee/util";
+import assert from "node:assert";
 import {SharedFlow} from "./shared_flow.ts";
 
 Deno.test("stream", async () => {
diff --git a/flow/src/state_flow.test.ts b/flow/src/state_flow.test.ts
@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import {StateFlow} from "./state_flow.ts";
 
 // 测试构造函数初始值设置
diff --git a/nodekit/deno.json b/nodekit/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@gaubee/nodekit",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "exports": {
     "./colors": "./src/colors.ts",
     "./config_file": "./src/config_file.ts",
diff --git a/nodekit/src/git/find-changes-by-message.test.ts b/nodekit/src/git/find-changes-by-message.test.ts
@@ -2,7 +2,7 @@ import path from "node:path";
 import {findChangedFilesAfterMessage} from "./find-changes-by-message.ts";
 
 // --- 使用示例 ---
-async function test() {
+Deno.test("findChangedFilesAfterMessage", async () => {
   const messagePattern = "@jixo"; // 你要搜索的 commit message 内容
   const repoDir = "."; // Git 仓库的路径，默认为当前目录
 
@@ -14,9 +14,5 @@ async function test() {
   } else {
     console.log("\nNo changed files found based on the criteria.");
   }
-  return files;
-}
-if (import.meta.main) {
-  const files = await test();
   console.log(files?.map((file) => file.path));
-}
+});
diff --git a/nodekit/src/git/find-changes-by-time.test.ts b/nodekit/src/git/find-changes-by-time.test.ts
@@ -1,6 +1,6 @@
 import {findChangedFilesSinceTime} from "./find-changes-by-time.ts";
 
-async function main() {
+Deno.test("findChangedFilesSinceTime", async () => {
   const time = "Fri Jun 6 11:11:29 2025 +0800"; // 替换为你想要的时间
   const changedFiles = await findChangedFilesSinceTime(time);
 
@@ -12,8 +12,4 @@ async function main() {
   } else {
     console.log("Not a Git repository.");
   }
-}
-
-if (import.meta.main) {
-  await main();
-}
+});
diff --git a/nodekit/src/pnpm.test.ts b/nodekit/src/pnpm.test.ts
@@ -1,11 +1,11 @@
 import {pnpm_publish} from "./pnpm.ts";
 
-if (import.meta.main) {
+Deno.test("pnpm", async () => {
   const result = await pnpm_publish({
     cwd: import.meta.resolve("../../.npm"),
     noGitChecks: true,
     recursive: true,
     // otp:"713846"
   });
   console.log(result);
-}
+});
diff --git a/nodekit/src/shell.test.ts b/nodekit/src/shell.test.ts
@@ -1,7 +1,7 @@
 import {$} from "./shell.ts";
 
-if (import.meta.main) {
+Deno.test("shell", async () => {
   $.ls(import.meta.resolve("../"));
   await $.spawn("npm", "info @gaubee/util");
   await $`npm info @gaubee/util`;
-}
+});
diff --git a/util/deno.json b/util/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@gaubee/util",
-  "version": "0.32.1",
+  "version": "0.33.0",
   "exports": {
     "./abort": "./src/abort.ts",
     "./bigint": "./src/bigint.ts",
@@ -14,6 +14,8 @@
     "./event_target": "./src/event_target.ts",
     "./func": "./src/func.ts",
     "./generator": "./src/generator.ts",
+    "./json": "./src/json.ts",
+    "./locks": "./src/locks.ts",
     "./lrc": "./src/lrc.ts",
     "./map": "./src/map.ts",
     "./math": "./src/math.ts",
diff --git a/util/src/abort.test.ts b/util/src/abort.test.ts
@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import {abort_signal_race} from "./abort.ts";
 
 Deno.test("abort_signal_race resolve", async () => {
diff --git a/util/src/collections.test.ts b/util/src/collections.test.ts
@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import {iter_first_not_null} from "./collections.ts";
 
 Deno.test("iter_first_not_null", () => {
diff --git a/util/src/debounce.test.ts b/util/src/debounce.test.ts
@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import {func_debounce} from "./debounce.ts";
 import {delay} from "./promise.ts";
 
diff --git a/util/src/encoding.test.ts b/util/src/encoding.test.ts
@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import {Buffer} from "node:buffer";
 import {str_to_base64_binary, str_to_hex_binary, str_to_utf8_binary} from "./encoding.ts";
 const base64_str = "68656c6c6f20776f726c64";
diff --git a/util/src/generator.test.ts b/util/src/generator.test.ts
@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import {AGF, GF} from "./generator.ts";
 
 Deno.test("GF & AGF", () => {
diff --git a/util/src/index.ts b/util/src/index.ts
@@ -11,6 +11,7 @@ export * from "./event_target.ts";
 export * from "./func.ts";
 export * from "./generator.ts";
 export * from "./json.ts";
+export * from "./locks.ts";
 export * from "./lrc.ts";
 export * from "./map.ts";
 export * from "./math.ts";
diff --git a/util/src/locks.test.mts b/util/src/locks.test.mts
@@ -0,0 +1,109 @@
+import assert from "node:assert";
+import {locks} from "./locks.ts";
+import {delay} from "./promise.ts";
+import {str_trim_indent} from "./string.ts";
+
+Deno.test("locks", async () => {
+  const results: string[] = [];
+  const log = (...args: string[]) => {
+    const log = args.join(" ");
+    results.push(log);
+    console.log(log);
+  };
+
+  const exclusive = async (name: string) => {
+    using lock = await locks.request("task1");
+    log("start", name);
+    await delay(100);
+    log("end", name);
+  };
+
+  const shared = async (name: string) => {
+    using lock = await locks.request("task1", {mode: "shared"});
+
+    log("start", name);
+    await delay(100);
+    log("end", name);
+  };
+
+  exclusive("a");
+  exclusive("b");
+  shared("c");
+  shared("d");
+  shared("e");
+  exclusive("f");
+  shared("g");
+  await exclusive("h");
+  assert.deepEqual(
+    results.join("\n"),
+    str_trim_indent(`
+    start a
+    end a
+    start b
+    end b
+    start c
+    start d
+    start e
+    end c
+    end d
+    end e
+    start f
+    end f
+    start g
+    end g
+    start h
+    end h`),
+  );
+});
+
+Deno.test("locks2", async () => {
+  const results: string[] = [];
+  const log = (...args: string[]) => {
+    const log = args.join(" ");
+    results.push(log);
+    console.log(log);
+  };
+  const exclusive = async (name: string) => {
+    await locks.run("task1", {}, async () => {
+      log("start", name);
+      await delay(100);
+      log("end", name);
+    });
+  };
+  const shared = async (name: string) => {
+    await locks.run("task1", {mode: "shared"}, async () => {
+      log("start", name);
+      await delay(100);
+      log("end", name);
+    });
+  };
+
+  exclusive("a");
+  exclusive("b");
+  shared("c");
+  shared("d");
+  shared("e");
+  exclusive("f");
+  shared("g");
+  await exclusive("h");
+  assert.deepEqual(
+    results.join("\n"),
+    str_trim_indent(`
+    start a
+    end a
+    start b
+    end b
+    start c
+    start d
+    start e
+    end c
+    end d
+    end e
+    start f
+    end f
+    start g
+    end g
+    start h
+    end h`),
+  );
+});
diff --git a/util/src/locks.ts b/util/src/locks.ts
@@ -0,0 +1,129 @@
+/**
+ * https://developer.mozilla.org/zh-CN/docs/Web/API/Web_Locks_API
+ */
+
+import {arr_remove_first} from "./array.ts";
+import {map_get_or_put} from "./collections.ts";
+
+export type LockMode = "exclusive" | "shared";
+export interface LockOptions {
+  // ifAvailable?: boolean;
+  mode?: LockMode;
+  signal?: AbortSignal;
+  // steal?: boolean;
+}
+
+export class LockManger {
+  #locks = new Map<string, Lock[]>();
+  #getLocks(name: string) {
+    return map_get_or_put(this.#locks, name, () => []);
+  }
+  /**等到可以执行的时候，返回lock对象 */
+  async request(name: string, options: LockOptions = {}) {
+    const {mode = "exclusive", signal} = options || {};
+    const _locks = this.#getLocks(name);
+    const lock = new Lock(name, mode, signal, () => {
+      arr_remove_first(locks, lock);
+      if (locks.length === 0) {
+        this.#locks.delete(name);
+      }
+    });
+    // 首先拷贝一份旧的
+    const locks = _locks.slice();
+    // 然后立刻加入到队列中
+    _locks.push(lock);
+
+    /// 如果是共享锁，那么无视其它同批次的共享锁，只需要寻找最后一个互斥锁
+    if (mode === "shared") {
+      /// 寻找最后一个互斥锁
+      const lastExclusiveLock = locks.findLast((lock) => lock.mode === "exclusive");
+      // 等待互斥锁执行完毕
+      if (lastExclusiveLock != null) {
+        await lastExclusiveLock.promise;
+      }
+    }
+
+    /// 如果是互斥锁，参考最后一个锁
+    if (mode === "exclusive") {
+      const lastLock = locks.at(-1);
+      /// 如果之后一个也是互斥锁，那么等待互斥锁执行完毕
+      if (lastLock?.mode === "exclusive") {
+        await lastLock.promise;
+      } else if (lastLock?.mode === "shared") {
+        /// 如果之后一个锁是共享锁，那么找出同批次的共享锁，等待它们全部执行完毕
+        const sharedLocks = [lastLock];
+        for (let i = locks.length - 2; i >= 0; i--) {
+          const lock = locks[i];
+          if (lock.mode === "shared") {
+            sharedLocks.push(lock);
+          } else {
+            break;
+          }
+        }
+        await Promise.all(sharedLocks.map((lock) => lock.promise));
+      }
+    }
+
+    /// 返回锁
+    lock.pending = false;
+    return lock;
+  }
+  async run<R>(name: string, options: LockOptions, callback: (lock: Lock) => Promise<R>) {
+    using lock = await this.request(name, options);
+    return await callback(lock);
+  }
+  query(name: string) {
+    const locks = this.#locks.get(name);
+    const held: Lock[] = [];
+    const pending: Lock[] = [];
+
+    if (locks && locks.length > 0) {
+      for (const lock of locks) {
+        if (lock.pending) {
+          pending.push(lock);
+        } else {
+          held.push(lock);
+        }
+      }
+    }
+
+    return {
+      held,
+      pending,
+    };
+  }
+}
+
+class Lock {
+  /** 是否正在等待 */
+  public pending = true;
+  constructor(
+    readonly name: string,
+    readonly mode: LockMode,
+    readonly signal: AbortSignal | undefined,
+    private onRelease: () => void,
+  ) {
+    if (signal) {
+      if (signal.aborted) {
+        this.#job.reject(signal.reason);
+      } else {
+        signal.addEventListener("abort", () => {
+          this.#job.reject(signal.reason);
+        });
+      }
+    }
+  }
+  #job = Promise.withResolvers<void>();
+  release() {
+    this.#job.resolve();
+    this.onRelease();
+  }
+  get promise() {
+    return this.#job.promise;
+  }
+  [Symbol.dispose]() {
+    this.release();
+  }
+}
+
+export const locks = new LockManger();
diff --git a/util/src/map.test.ts b/util/src/map.test.ts
@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import {map_get_or_put_async} from "./map.ts";
 import {delay} from "./promise.ts";
 
diff --git a/util/src/pure_event.test.ts b/util/src/pure_event.test.ts
@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import {pureEvent} from "./pure_event.ts";
 
 Deno.test("pure_event", async () => {
diff --git a/util/src/string.test.ts b/util/src/string.test.ts
diff --git a/util/src/throttle.test.ts b/util/src/throttle.test.ts
diff --git a/util/src/typedarray.test.ts b/util/src/typedarray.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@gaubee/flow",`
`3`		`- "version": "0.3.10",`
	`3`	`+ "version": "0.3.11",`
`4`	`4`	`"exports": {`
`5`	`5`	`"./state_flow": "./src/state_flow.ts",`
`6`	`6`	`"./shared_flow": "./src/shared_flow.ts",`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import {delay} from "@gaubee/util";`
	`2`	`+import assert from "node:assert";`
`2`	`3`	`import {SharedFlow} from "./shared_flow.ts";`
`3`	`4`
`4`	`5`	`Deno.test("stream", async () => {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import assert from "node:assert";`
`1`	`2`	`import {StateFlow} from "./state_flow.ts";`
`2`	`3`
`3`	`4`	`// 测试构造函数初始值设置`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@gaubee/nodekit",`
`3`		`- "version": "0.9.1",`
	`3`	`+ "version": "0.9.2",`
`4`	`4`	`"exports": {`
`5`	`5`	`"./colors": "./src/colors.ts",`
`6`	`6`	`"./config_file": "./src/config_file.ts",`