🔐 동시성 이슈를 해결하기 위한 LockManager 만들기

GameManager에서 Map을 많이 사용하게 되는데 Map은 동시성 이슈에서 자유롭지 않다.

그래서 동시성 이슈를 해결하기 위해 자바에서는 ConcurrentHashMap같은 객체를 사용할 수 있는데 노드에서는 없다. 그래서 직접 Custom해서 만들어야 하고 직접 만들어 사용하기로 했다.

1. 설치

 npm install async-mutex

• 직접 사용하는 것보다는 프로덕트 환경에서 안전하게 사용할 수 있고 많이 사용하는 async-mutex를 사용하기로 생각했다.

2. 구현

import { Mutex } from 'async-mutex';

export class LockManager<K> {
  private locks = new Map<K, Mutex>();
  private globalMutex = new Mutex();

  private getLock(key: K): Mutex {
    let lock = this.locks.get(key);
    if (!lock) {
      lock = new Mutex();
      this.locks.set(key, lock);
    }
    return lock;
  }

  async withKeyLock<T>(key: K, callback: () => Promise<T>): Promise<T> {
    const lock = this.getLock(key);
    const release = await lock.acquire();
    try {
      return await callback();
    } finally {
      release();
    }
  }

  async withGlobalLock<T>(callback: () => Promise<T>): Promise<T> {
    const release = await this.globalMutex.acquire();
    try {
      return await callback();
    } finally {
      release();
    }
  }

  releaseKey(key: K): void {
    this.locks.delete(key);
  }

  async clear(): Promise<void> {
    return await this.withGlobalLock(async () => {
      this.locks.clear();
    });
  }
}

• async-mutex에서 제공하는 Mutex 를 통해 동시성 제어를 진행하려고 한다.
• lock.acquire 을 통해 락을 획득하고, 해당 비즈니스 로직이 끝나면 release 를 통해 락을 반납하는 형식으로 진행된다.
• 가장 중요한 private method withKeyLock

async withKeyLock<T>(key: K, callback: () => Promise<T>): Promise<T> {
  const lock = this.getLock(key);
  const release = await lock.acquire();
  try {
    return await callback();
  } finally {
    release();
  }
}

• 각 게임방마다 락이 존재하며 해당 락을 통해 동시성 제어를 할 수 있다.
• mutex.acquire를 통해 락을 획득하고 해당 callback함수를 실행한 후 다시 락을 반납하는 형식을 진행한다.

3. 사용시

return await this.lockManager.withKeyLock(gameRoom.roomId, async () => {
      if (this.games.has(gameRoom.roomId)) {
        return;
      }

      const gameInfo = new Map<string, PlayerInfo>();
      players.forEach((role, client) => {
        gameInfo.set(client.nickname, { role, status: USER_STATUS.ALIVE });
        client.job = role;
        if (role === MAFIA_ROLE.MAFIA) {
          gameRoom.addMafia(client);
        }
      });
      this.games.set(gameRoom.roomId, gameInfo);
    });

• lockManager.withKeyLock(gameRoom.roodId,를 통해 해당 방에 대한 락을 획득합니다. 그 후 해당하는 비즈니스 로직을 실행하게 됩니다. 그리고 해당 비즈니스 로직 실행이 끝나면 다시 락을 반납하여 끝냅니다.
• lockManager 통해 동시성 이슈에서 자유롭게 되었고 비즈니스 로직을 하나의 트랜잭션으로 묶어 원자성을 보장합니다. 그리고 비즈니스 로직 시작 앞에서 검증 로직을 추가하여 동시성 이슈에서 자유로워졌습니다.