github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-24 18:56:32 -05:00
Code Issues Projects Releases Packages Wiki Activity

enhancement(realtime): send metadata update on revision save

Browse source 
When the frontend is notified about metadata updates, it refreshes the
data and therefore refreshes information like the timestamp of the last
revision save in the sidebar.
This commit adds such a notification from the backend to all clients on
each revision save, so that the "last saved at" value in the frontend is
correct.

Signed-off-by: Erik Michelson <github@erik.michelson.eu>
This commit is contained in:
Erik Michelson 2024-08-07 22:12:12 +02:00 committed by Philip Molares
parent 9cbd78f622
commit 6684b0f886
3 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
backend/src/realtime/realtime-note/realtime-note.service.ts
View file

@ -1,5 +1,5 @@
/* /*
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file) * SPDX-FileCopyrightText: 2024 The HedgeDoc developers (see AUTHORS file)
* *
* SPDX-License-Identifier: AGPL-3.0-only * SPDX-License-Identifier: AGPL-3.0-only
*/ */
@ -49,6 +49,9 @@ export class RealtimeNoteService implements BeforeApplicationShutdown {
realtimeNote.getRealtimeDoc().getCurrentContent(), realtimeNote.getRealtimeDoc().getCurrentContent(),
realtimeNote.getRealtimeDoc().encodeStateAsUpdate(), realtimeNote.getRealtimeDoc().encodeStateAsUpdate(),
) )
.then(() => {
realtimeNote.announceMetadataUpdate();
})
.catch((reason) => this.logger.error(reason)); .catch((reason) => this.logger.error(reason));
} }
@ -117,7 +120,7 @@ export class RealtimeNoteService implements BeforeApplicationShutdown {
const realtimeNote = this.realtimeNoteStore.find(note.id); const realtimeNote = this.realtimeNoteStore.find(note.id);
if (!realtimeNote) return; if (!realtimeNote) return;
realtimeNote.announcePermissionChange(); realtimeNote.announceMetadataUpdate();
const allConnections = realtimeNote.getConnections(); const allConnections = realtimeNote.getConnections();
await this.updateOrCloseConnection(allConnections, note); await this.updateOrCloseConnection(allConnections, note);
} }

6
backend/src/realtime/realtime-note/realtime-note.spec.ts
View file

@ -1,5 +1,5 @@
/* /*
* SPDX-FileCopyrightText: 2023 The HedgeDoc developers (see AUTHORS file) * SPDX-FileCopyrightText: 2024 The HedgeDoc developers (see AUTHORS file)
* *
* SPDX-License-Identifier: AGPL-3.0-only * SPDX-License-Identifier: AGPL-3.0-only
*/ */
@ -82,11 +82,11 @@ describe('realtime note', () => {
const sendMessage2Spy = jest.spyOn(client2.getTransporter(), 'sendMessage'); const sendMessage2Spy = jest.spyOn(client2.getTransporter(), 'sendMessage');
const metadataMessage = { type: MessageType.METADATA_UPDATED }; const metadataMessage = { type: MessageType.METADATA_UPDATED };
sut.announcePermissionChange(); sut.announceMetadataUpdate();
expect(sendMessage1Spy).toHaveBeenCalledWith(metadataMessage); expect(sendMessage1Spy).toHaveBeenCalledWith(metadataMessage);
expect(sendMessage2Spy).toHaveBeenCalledWith(metadataMessage); expect(sendMessage2Spy).toHaveBeenCalledWith(metadataMessage);
sut.removeClient(client2); sut.removeClient(client2);
sut.announcePermissionChange(); sut.announceMetadataUpdate();
expect(sendMessage1Spy).toHaveBeenCalledTimes(2); expect(sendMessage1Spy).toHaveBeenCalledTimes(2);
expect(sendMessage2Spy).toHaveBeenCalledTimes(1); expect(sendMessage2Spy).toHaveBeenCalledTimes(1);
}); });

7
backend/src/realtime/realtime-note/realtime-note.ts
View file

@ -1,5 +1,5 @@
/* /*
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file) * SPDX-FileCopyrightText: 2024 The HedgeDoc developers (see AUTHORS file)
* *
* SPDX-License-Identifier: AGPL-3.0-only * SPDX-License-Identifier: AGPL-3.0-only
*/ */
@ -149,9 +149,10 @@ export class RealtimeNote extends EventEmitter2<RealtimeNoteEventMap> {
} }
/** /**
* Announce to all clients that the permissions of the note have been changed. * Announce to all clients that the metadata of the note have been changed.
* This could for example be a permission change or a revision being saved.
*/ */
public announcePermissionChange(): void { public announceMetadataUpdate(): void {
this.sendToAllClients({ type: MessageType.METADATA_UPDATED }); this.sendToAllClients({ type: MessageType.METADATA_UPDATED });
} }