PrivateAPI: Add pinStatus to HistoryEntryImportDto

As the DTO is only for importing an existing history the pinStatus of those entries should also be posted.

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

src/api/private/me/history/history.controller.ts

@@ -65,7 +65,11 @@ export class HistoryController {
         const note = await this.noteService.getNoteByIdOrAlias(
           historyEntry.note,
         );
-        await this.historyService.createOrUpdateHistoryEntry(note, user);
+        await this.historyService.createOrUpdateHistoryEntry(
+          note,
+          user,
+          historyEntry.pinStatus,
+        );
       }
     } catch (e) {
       if (e instanceof NotInDBError) {

src/history/history-entry-import.dto.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { IsString } from 'class-validator';
+import { IsBoolean, IsString } from 'class-validator';
 
 export class HistoryEntryImportDto {
   /**
@@ -12,4 +12,10 @@ export class HistoryEntryImportDto {
    */
   @IsString()
   note: string;
+  /**
+   * True if the note should be pinned
+   * @example true
+   */
+  @IsBoolean()
+  pinStatus: boolean;
 }

src/history/history.service.spec.ts

@@ -141,9 +141,10 @@ describe('HistoryService', () => {
 
   describe('createOrUpdateHistoryEntry', () => {
     describe('works', () => {
-      it('without an preexisting entry', async () => {
+      const user = {} as User;
-        const user = {} as User;
+      const alias = 'alias';
-        const alias = 'alias';
+      const pinStatus = true;
+      it('without an preexisting entry and without pinStatus', async () => {
         jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(undefined);
         jest
           .spyOn(historyRepo, 'save')
@@ -160,9 +161,25 @@ describe('HistoryService', () => {
         expect(createHistoryEntry.pinStatus).toEqual(false);
       });
 
-      it('with an preexisting entry', async () => {
+      it('without an preexisting entry and with pinStatus', async () => {
-        const user = {} as User;
+        jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(undefined);
-        const alias = 'alias';
+        jest
+          .spyOn(historyRepo, 'save')
+          .mockImplementation(
+            async (entry: HistoryEntry): Promise<HistoryEntry> => entry,
+          );
+        const createHistoryEntry = await service.createOrUpdateHistoryEntry(
+          Note.create(user, alias),
+          user,
+          pinStatus,
+        );
+        expect(createHistoryEntry.note.alias).toEqual(alias);
+        expect(createHistoryEntry.note.owner).toEqual(user);
+        expect(createHistoryEntry.user).toEqual(user);
+        expect(createHistoryEntry.pinStatus).toEqual(pinStatus);
+      });
+
+      it('with an preexisting entry and without pinStatus', async () => {
         const historyEntry = HistoryEntry.create(
           user,
           Note.create(user, alias),
@@ -185,6 +202,32 @@ describe('HistoryService', () => {
           historyEntry.updatedAt.getTime(),
         );
       });
+
+      it('with an preexisting entry and with pinStatus', async () => {
+        const historyEntry = HistoryEntry.create(
+          user,
+          Note.create(user, alias),
+          pinStatus,
+        );
+        jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(historyEntry);
+        jest
+          .spyOn(historyRepo, 'save')
+          .mockImplementation(
+            async (entry: HistoryEntry): Promise<HistoryEntry> => entry,
+          );
+        const createHistoryEntry = await service.createOrUpdateHistoryEntry(
+          Note.create(user, alias),
+          user,
+          pinStatus,
+        );
+        expect(createHistoryEntry.note.alias).toEqual(alias);
+        expect(createHistoryEntry.note.owner).toEqual(user);
+        expect(createHistoryEntry.user).toEqual(user);
+        expect(createHistoryEntry.pinStatus).toEqual(pinStatus);
+        expect(createHistoryEntry.updatedAt.getTime()).toBeGreaterThanOrEqual(
+          historyEntry.updatedAt.getTime(),
+        );
+      });
     });
   });
 

src/history/history.service.ts

@@ -80,15 +80,20 @@ export class HistoryService {
    * Create or update a history entry by the user and note. If the entry is merely updated the updatedAt date is set to the current date.
    * @param {Note} note - the note that the history entry belongs to
    * @param {User} user - the user that the history entry belongs to
+   * @param {boolean} pinStatus - if the pinStatus of the history entry should be set
    * @return {HistoryEntry} the requested history entry
    */
   async createOrUpdateHistoryEntry(
     note: Note,
     user: User,
+    pinStatus?: boolean,
   ): Promise<HistoryEntry> {
     let entry = await this.getEntryByNote(note, user);
     if (!entry) {
       entry = HistoryEntry.create(user, note);
+      if (pinStatus !== undefined) {
+        entry.pinStatus = pinStatus;
+      }
     } else {
       entry.updatedAt = new Date();
     }

test/private-api/history.e2e-spec.ts

@@ -100,8 +100,10 @@ describe('History', () => {
   });
 
   it('POST /me/history', async () => {
+    const pinStatus = true;
     const postEntryDto = new HistoryEntryImportDto();
     postEntryDto.note = note2.alias;
+    postEntryDto.pinStatus = pinStatus;
     await request(app.getHttpServer())
       .post('/me/history')
       .set('Content-Type', 'application/json')
@@ -110,6 +112,8 @@ describe('History', () => {
     const userEntries = await historyService.getEntriesByUser(user);
     expect(userEntries.length).toEqual(1);
     expect(userEntries[0].note.alias).toEqual(note2.alias);
+    expect(userEntries[0].user.userName).toEqual(user.userName);
+    expect(userEntries[0].pinStatus).toEqual(pinStatus);
   });
 
   it('DELETE /me/history', async () => {