History: Add history service and usage

Add history service to allow for CRUD operations.
Use history service in controllers to:
  1. Allow manipulating of history entries
  2. Guaranty the correct existence of history entries

Signed-off-by: Philip Molares <philip.molares@udo.edu>

src/api/public/me/me.controller.ts

@@ -17,15 +17,16 @@ import {
   Request,
 } from '@nestjs/common';
 import { HistoryEntryUpdateDto } from '../../../history/history-entry-update.dto';
-import { HistoryEntryDto } from '../../../history/history-entry.dto';
 import { HistoryService } from '../../../history/history.service';
 import { ConsoleLoggerService } from '../../../logger/console-logger.service';
 import { NoteMetadataDto } from '../../../notes/note-metadata.dto';
 import { NotesService } from '../../../notes/notes.service';
-import { UserInfoDto } from '../../../users/user-info.dto';
 import { UsersService } from '../../../users/users.service';
 import { TokenAuthGuard } from '../../../auth/token-auth.guard';
 import { ApiSecurity } from '@nestjs/swagger';
+import { HistoryEntryDto } from '../../../history/history-entry.dto';
+import { UserInfoDto } from '../../../users/user-info.dto';
+import { NotInDBError } from '../../../errors/errors';
 
 @ApiSecurity('token')
 @Controller('me')
@@ -49,19 +50,37 @@ export class MeController {
 
   @UseGuards(TokenAuthGuard)
   @Get('history')
-  getUserHistory(@Request() req): HistoryEntryDto[] {
-    return this.historyService.getUserHistory(req.user.userName);
+  async getUserHistory(@Request() req): Promise<HistoryEntryDto[]> {
+    const foundEntries = await this.historyService.getEntriesByUser(req.user);
+    return Promise.all(
+      foundEntries.map(
+        async (entry) => await this.historyService.toHistoryEntryDto(entry),
+      ),
+    );
   }
 
   @UseGuards(TokenAuthGuard)
   @Put('history/:note')
-  updateHistoryEntry(
+  async updateHistoryEntry(
     @Request() req,
     @Param('note') note: string,
     @Body() entryUpdateDto: HistoryEntryUpdateDto,
-  ): HistoryEntryDto {
+  ): Promise<HistoryEntryDto> {
     // ToDo: Check if user is allowed to pin this history entry
-    return this.historyService.updateHistoryEntry(note, entryUpdateDto);
+    try {
+      return this.historyService.toHistoryEntryDto(
+        await this.historyService.updateHistoryEntry(
+          note,
+          req.user,
+          entryUpdateDto,
+        ),
+      );
+    } catch (e) {
+      if (e instanceof NotInDBError) {
+        throw new NotFoundException(e.message);
+      }
+      throw e;
+    }
   }
 
   @UseGuards(TokenAuthGuard)
@@ -70,9 +89,12 @@ export class MeController {
   deleteHistoryEntry(@Request() req, @Param('note') note: string) {
     // ToDo: Check if user is allowed to delete note
     try {
-      return this.historyService.deleteHistoryEntry(note);
+      return this.historyService.deleteHistoryEntry(note, req.user);
     } catch (e) {
-      throw new NotFoundException(e.message);
+      if (e instanceof NotInDBError) {
+        throw new NotFoundException(e.message);
+      }
+      throw e;
     }
   }
 

src/api/public/notes/notes.controller.ts

@@ -28,6 +28,7 @@ import { RevisionsService } from '../../../revisions/revisions.service';
 import { MarkdownBody } from '../../utils/markdownbody-decorator';
 import { TokenAuthGuard } from '../../../auth/token-auth.guard';
 import { ApiSecurity } from '@nestjs/swagger';
+import { HistoryService } from '../../../history/history.service';
 import { NoteDto } from '../../../notes/note.dto';
 import { NoteMetadataDto } from '../../../notes/note-metadata.dto';
 import { RevisionMetadataDto } from '../../../revisions/revision-metadata.dto';
@@ -40,6 +41,7 @@ export class NotesController {
     private readonly logger: ConsoleLoggerService,
     private noteService: NotesService,
     private revisionsService: RevisionsService,
+    private historyService: HistoryService,
   ) {
     this.logger.setContext(NotesController.name);
   }
@@ -57,6 +59,22 @@ export class NotesController {
     );
   }
 
+  @UseGuards(TokenAuthGuard)
+  @Get(':noteIdOrAlias')
+  async getNote(@Request() req, @Param('noteIdOrAlias') noteIdOrAlias: string) {
+    // ToDo: check if user is allowed to view this note
+    try {
+      const note = await this.noteService.getNoteByIdOrAlias(noteIdOrAlias);
+      await this.historyService.createOrUpdateHistoryEntry(note, req.user);
+      return this.noteService.toNoteDto(note);
+    } catch (e) {
+      if (e instanceof NotInDBError) {
+        throw new NotFoundException(e.message);
+      }
+      throw e;
+    }
+  }
+
   @UseGuards(TokenAuthGuard)
   @Post(':noteAlias')
   async createNamedNote(
@@ -71,25 +89,6 @@ export class NotesController {
     );
   }
 
-  @UseGuards(TokenAuthGuard)
-  @Get(':noteIdOrAlias')
-  async getNote(
-    @Request() req,
-    @Param('noteIdOrAlias') noteIdOrAlias: string,
-  ): Promise<NoteDto> {
-    // ToDo: check if user is allowed to view this note
-    try {
-      return this.noteService.toNoteDto(
-        await this.noteService.getNoteByIdOrAlias(noteIdOrAlias),
-      );
-    } catch (e) {
-      if (e instanceof NotInDBError) {
-        throw new NotFoundException(e.message);
-      }
-      throw e;
-    }
-  }
-
   @UseGuards(TokenAuthGuard)
   @Delete(':noteIdOrAlias')
   async deleteNote(