キー付きロック

Asyncmux クラスを使って、キーごとに独立したロックと、すべてをブロックするグローバルロックを管理する方法を説明します。

Asyncmux クラス

Asyncmux クラスは、キーで識別される複数のロックを 1 つのインスタンスで管理します。同じキーの処理は排他され、異なるキーの処理は互いに影響しません。

import { Asyncmux } from "asyncmux";

const mux = new Asyncmux();

async function update(key: string) {
  using _ = await mux.lock(key);
  // key ごとに排他の書き込みを行います。
}

// 異なるキーは並行して実行できます。
await Promise.all([update("a"), update("b")]);

Asyncmux のインスタンス同士は独立しています。用途ごとに別のインスタンスを作ってください。

書き込みロックと読み取りロック

• lock(...) — 書き込みロック（排他ロック）。同じキーのロックやグローバルロックと競合します。
• rLock(...) — 読み取りロック（共有ロック）。読み取り同士は共存できます。

import { Asyncmux } from "asyncmux";

const mux = new Asyncmux();
const cache = new Map<string, string>();

async function read(key: string) {
  using _ = await mux.rLock(key);
  return cache.get(key);
}

async function write(key: string, value: string) {
  using _ = await mux.lock(key);
  cache.set(key, value);
}

キーの指定方法

各メソッドは 3 通りの呼び出し方があります。

await mux.lock(); // キーなし（グローバルロック）
await mux.lock("user:42"); // キーを指定
await mux.lock({ key: "user:42", signal }); // オプションで指定

rLock も同じ 3 通りです。オプションの key を省略すると、キーなしのグローバルロックになります。

グローバルロック

キーを指定しない場合、そのロックはインスタンス内のすべてのロックと競合します。

• mux.lock()（グローバル書き込みロック）は、ほかのすべてのロックをブロックします。
• mux.rLock()（グローバル読み取りロック）は、すべての書き込みロックをブロックしますが、読み取りロック同士は共存できます。

グローバル書き込みロックは、全キーを対象にした再構築やメンテナンス処理に向いています。

async function rebuildAll() {
  using _ = await mux.lock(); // すべてのキー付きロックを待たせます・
  // 全件の再構築などを行います。
}

競合規則

要求するロックが、現在保持されているロックと競合するかどうかは次のとおりです。

競合する要求は到着順（FIFO）で処理されます。競合しない要求はキューの後ろに並ばず、そのまま取得できます。

再入の注意

Asyncmux クラスは既定では再入を検出しません。同じキーのロックを保持したまま再度取得すると、デッドロックします。

async function deadlock() {
  using _ = await mux.lock("key");
  await mux.lock("key"); // デッドロックします。
}

preventReentrancy オプションで再入の検出を有効にできます。

const mux = new Asyncmux({ preventReentrancy: true });

async function update() {
  using _ = await mux.lock("key");
  await mux.lock("key"); // ReentrantLockError
}

検出は非同期コンテキスト単位で行われます。同じ同期実行内で開始された並行タスクからの要求は再入とみなされず、通常どおり待機します。また、node:async_hooks の AsyncLocalStorage を利用できない環境では検出は無効になります。

同じキーを複数回ロックする必要がある場合は、ロックの範囲を見直してください。