feat: page 연산에 redis Lock 적용

Author: ezcolin2

apps/backend/src/page/page.service.spec.ts

@@ -11,13 +11,16 @@ import { PageNotFoundException } from '../exception/page.exception';
 import { WorkspaceRepository } from '../workspace/workspace.repository';
 import { WorkspaceNotFoundException } from '../exception/workspace.exception';
 const RED_LOCK_TOKEN = 'RED_LOCK';
+type RedisLock = {
+  acquire(): Promise<{ release: Function }>;
+};
 
 describe('PageService', () => {
   let service: PageService;
   let pageRepository: PageRepository;
   let nodeRepository: NodeRepository;
   let workspaceRepository: WorkspaceRepository;
-
+  let redisLock: RedisLock;
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
       providers: [
@@ -60,10 +63,15 @@ describe('PageService', () => {
     pageRepository = module.get<PageRepository>(PageRepository);
     nodeRepository = module.get<NodeRepository>(NodeRepository);
     workspaceRepository = module.get<WorkspaceRepository>(WorkspaceRepository);
+    redisLock = module.get<RedisLock>(RED_LOCK_TOKEN);
   });
 
   it('서비스 클래스가 정상적으로 인스턴스화된다.', () => {
     expect(service).toBeDefined();
+    expect(pageRepository).toBeDefined();
+    expect(nodeRepository).toBeDefined();
+    expect(workspaceRepository).toBeDefined();
+    expect(redisLock).toBeDefined();
   });
 
   describe('createPage', () => {
@@ -154,7 +162,9 @@ describe('PageService', () => {
         .spyOn(pageRepository, 'delete')
         .mockResolvedValue({ affected: true } as any);
       jest.spyOn(pageRepository, 'findOneBy').mockResolvedValue(new Page());
-
+      jest.spyOn(redisLock, 'acquire').mockResolvedValue({
+        release: jest.fn(),
+      });
       await service.deletePage(1);
 
       expect(pageRepository.delete).toHaveBeenCalledWith(1);
@@ -164,7 +174,9 @@ describe('PageService', () => {
       jest
         .spyOn(pageRepository, 'delete')
         .mockResolvedValue({ affected: false } as any);
-
+      jest.spyOn(redisLock, 'acquire').mockResolvedValue({
+        release: jest.fn(),
+      });
       await expect(service.deletePage(1)).rejects.toThrow(
         PageNotFoundException,
       );
@@ -202,10 +214,11 @@ describe('PageService', () => {
         emoji: '📝',
         workspace: null,
       };
-
       jest.spyOn(pageRepository, 'findOneBy').mockResolvedValue(originPage);
       jest.spyOn(pageRepository, 'save').mockResolvedValue(newPage);
-
+      jest.spyOn(redisLock, 'acquire').mockResolvedValue({
+        release: jest.fn(),
+      });
       const result = await service.updatePage(1, dto);
 
       expect(result).toEqual(newPage);
@@ -219,7 +232,9 @@ describe('PageService', () => {
       jest
         .spyOn(nodeRepository, 'findOneBy')
         .mockResolvedValue({ affected: false } as any);
-
+      jest.spyOn(redisLock, 'acquire').mockResolvedValue({
+        release: jest.fn(),
+      });
       await expect(service.updatePage(1, new UpdatePageDto())).rejects.toThrow(
         PageNotFoundException,
       );

apps/backend/src/page/page.service.ts

@@ -19,7 +19,19 @@ export class PageService {
     private readonly workspaceRepository: WorkspaceRepository,
     @Inject(RED_LOCK_TOKEN) private readonly redisLock: Redlock,
   ) {}
-
+  /**
+   * redis에 저장된 페이지 정보를 다음 과정을 통해 주기적으로 데이터베이스에 반영한다.
+   *
+   * 1. redis에서 해당 페이지의 title과 content를 가져온다.
+   * 2. 데이터베이스에 해당 페이지의 title과 content를 갱신한다.
+   * 3. redis에서 해당 페이지 정보를 삭제한다.
+   *
+   * 만약 1번 과정을 진행한 상태에서 page가 삭제된다면 오류가 발생한다.
+   * 위 과정을 진행하는 동안 page 정보 수정을 막기 위해 lock을 사용한다.
+   *
+   * 동기화를 위해 기존 페이지에 접근하여 수정하는 로직은 RedLock 알고리즘을 통해 락을 획득할 수 있을 때만 수행한다.
+   * 기존 페이지에 접근하여 연산하는 로직의 경우 RedLock 알고리즘을 사용하여 동시 접근을 방지한다.
+   */
   async createPage(dto: CreatePageDto): Promise<Page> {
     const { title, content, workspaceId, x, y, emoji } = dto;
 
@@ -51,29 +63,42 @@ export class PageService {
   }
 
   async deletePage(id: number): Promise<void> {
-    // 페이지를 삭제한다.
-    const deleteResult = await this.pageRepository.delete(id);
-
-    // 만약 삭제된 페이지가 없으면 페이지를 찾지 못한 것
-    if (!deleteResult.affected) {
-      throw new PageNotFoundException();
+    // 락을 획득할 때까지 기다린다.
+    const lock = await this.redisLock.acquire([id.toString()], 1000);
+    try {
+      // 페이지를 삭제한다.
+      const deleteResult = await this.pageRepository.delete(id);
+
+      // 만약 삭제된 페이지가 없으면 페이지를 찾지 못한 것
+      if (!deleteResult.affected) {
+        throw new PageNotFoundException();
+      }
+    } finally {
+      // 락을 해제한다.
+      await lock.release();
     }
   }
 
   async updatePage(id: number, dto: UpdatePageDto): Promise<Page> {
-    // 갱신할 페이지를 조회한다.
-    // 페이지를 조회한다.
-    const page = await this.pageRepository.findOneBy({ id });
-
-    // 페이지가 없으면 NotFound 에러
-    if (!page) {
-      throw new PageNotFoundException();
+    // 락을 획득할 때까지 기다린다.
+    const lock = await this.redisLock.acquire(['user:' + id.toString()], 1000);
+    try {
+      // 갱신할 페이지를 조회한다.
+      // 페이지를 조회한다.
+      const page = await this.pageRepository.findOneBy({ id });
+
+      // 페이지가 없으면 NotFound 에러
+      if (!page) {
+        throw new PageNotFoundException();
+      }
+      // 페이지 정보를 갱신한다.
+      const newPage = Object.assign({}, page, dto);
+
+      // 변경된 페이지를 저장
+      return await this.pageRepository.save(newPage);
+    } finally {
+      await lock.release();
     }
-    // 페이지 정보를 갱신한다.
-    const newPage = Object.assign({}, page, dto);
-
-    // 변경된 페이지를 저장
-    return await this.pageRepository.save(newPage);
   }
 
   async updateBulkPage(pages: UpdatePartialPageDto[]) {

apps/backend/src/yjs/yjs.service.ts

@@ -117,7 +117,7 @@ export class YjsService
           // );
 
           this.redisService.setField(
-            pageId.toString(),
+            `page:${pageId.toString()}`,
             'content',
             JSON.stringify(yXmlFragmentToProsemirrorJSON(editorDoc)),
           );
@@ -153,6 +153,7 @@ export class YjsService
       // title의 변경 사항을 감지한다.
       title.observeDeep(async (event) => {
         // path가 존재할 때만 페이지 갱신
+        
         event[0].path.toString().split('_')[1] &&
           // this.pageService.updatePage(
           //   parseInt(event[0].path.toString().split('_')[1]),
@@ -161,7 +162,7 @@ export class YjsService
           //   },
           // );
           this.redisService.setField(
-            event[0].path.toString().split('_')[1],
+            `page:${event[0].path.toString().split('_')[1]}`,
             'title',
             event[0].target.toString(),
           );