feat: persist notes on realtime note unload and on interval

The realtime note map has been moved into its own class
to separate the realtime note business logic from the storing logic.

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>

src/realtime/realtime-note/realtime-note-store.spec.ts

@@ -0,0 +1,70 @@
+/*
+ * SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+import { Mock } from 'ts-mockery';
+
+import { Note } from '../../notes/note.entity';
+import * as realtimeNoteModule from './realtime-note';
+import { RealtimeNote } from './realtime-note';
+import { RealtimeNoteStore } from './realtime-note-store.service';
+import { mockRealtimeNote } from './test-utils/mock-realtime-note';
+import { WebsocketAwareness } from './websocket-awareness';
+import { WebsocketDoc } from './websocket-doc';
+
+describe('RealtimeNoteStore', () => {
+  let realtimeNoteStore: RealtimeNoteStore;
+  let mockedNote: Note;
+  let mockedRealtimeNote: RealtimeNote;
+  let realtimeNoteConstructorSpy: jest.SpyInstance;
+  const mockedContent = 'mockedContent';
+  const mockedNoteId = 'mockedNoteId';
+
+  beforeEach(async () => {
+    jest.resetAllMocks();
+    jest.resetModules();
+
+    realtimeNoteStore = new RealtimeNoteStore();
+
+    mockedNote = Mock.of<Note>({ id: mockedNoteId });
+    mockedRealtimeNote = mockRealtimeNote(
+      mockedNote,
+      Mock.of<WebsocketDoc>(),
+      Mock.of<WebsocketAwareness>(),
+    );
+    realtimeNoteConstructorSpy = jest
+      .spyOn(realtimeNoteModule, 'RealtimeNote')
+      .mockReturnValue(mockedRealtimeNote);
+  });
+
+  it("can create a new realtime note if it doesn't exist yet", () => {
+    expect(realtimeNoteStore.create(mockedNote, mockedContent)).toBe(
+      mockedRealtimeNote,
+    );
+    expect(realtimeNoteConstructorSpy).toBeCalledWith(
+      mockedNote,
+      mockedContent,
+    );
+    expect(realtimeNoteStore.find(mockedNoteId)).toBe(mockedRealtimeNote);
+    expect(realtimeNoteStore.getAllRealtimeNotes()).toStrictEqual([
+      mockedRealtimeNote,
+    ]);
+  });
+
+  it('throws if a realtime note has already been created for the given note', () => {
+    expect(realtimeNoteStore.create(mockedNote, mockedContent)).toBe(
+      mockedRealtimeNote,
+    );
+    expect(() => realtimeNoteStore.create(mockedNote, mockedContent)).toThrow();
+  });
+
+  it('deletes a note if it gets destroyed', () => {
+    expect(realtimeNoteStore.create(mockedNote, mockedContent)).toBe(
+      mockedRealtimeNote,
+    );
+    mockedRealtimeNote.emit('destroy');
+    expect(realtimeNoteStore.find(mockedNoteId)).toBe(undefined);
+    expect(realtimeNoteStore.getAllRealtimeNotes()).toStrictEqual([]);
+  });
+});