feat(parent structure): add method that return note parent structure

docker-compose.yml

@@ -1,4 +1,5 @@
-version: "3.2"
+version: '3.2'
+
 services:
   api:
     build:

src/domain/service/note.ts

@@ -9,6 +9,7 @@ import type User from '@domain/entities/user.js';
 import type { NoteList } from '@domain/entities/noteList.js';
 import type NoteHistoryRepository from '@repository/noteHistory.repository.js';
 import type { NoteHistoryMeta, NoteHistoryRecord, NoteHistoryPublic } from '@domain/entities/noteHistory.js';
+import { definePublicNote, type NotePublic } from '@domain/entities/notePublic.js';
 
 /**
  * Note service
@@ -441,4 +442,20 @@ export default class NoteService {
 
     return noteHistoryPublic;
   }
+
+  /**
+   * Get note parent structure recursively by note id and user id
+   * and check if user has access to the parent note.
+   * @param noteId - id of the note to get parent structure
+   * @returns - array of notes that are parent structure of the note
+   */
+  public async getNoteParents(noteId: NoteInternalId): Promise<NotePublic[]> {
+    const noteIds: NoteInternalId[] = await this.noteRelationsRepository.getNoteParentsIds(noteId);
+    const noteParents = await this.noteRelationsRepository.getNotesByIds(noteIds);
+    const noteParentsPublic: NotePublic[] = noteParents.map((note) => {
+      return definePublicNote(note);
+    });
+
+    return noteParentsPublic;
+  }
 }

src/presentation/http/router/note.test.ts

@@ -1,6 +1,7 @@
 import { MemberRole } from '@domain/entities/team.js';
 import { describe, test, expect, beforeEach } from 'vitest';
 import type User from '@domain/entities/user.js';
+import type { Note } from '@domain/entities/note.js';
 
 describe('Note API', () => {
   /**
@@ -180,6 +181,51 @@ describe('Note API', () => {
   });
 
   describe('GET note/:notePublicId ', () => {
+    let context: {
+      user: User;
+      anotherUser: User;
+      parentNote: Note;
+      childNote: Note;
+      differentChildNote: Note;
+      grandChildNote: Note;
+    } = {
+      user: {} as User,
+      anotherUser: {} as User,
+      parentNote: {} as Note,
+      childNote: {} as Note,
+      differentChildNote: {} as Note,
+      grandChildNote: {} as Note,
+    };
+
+    beforeEach(async () => {
+      if (expect.getState().currentTestName?.includes('Returns note parents by note public id in different note accessibility and authorization') ?? false) {
+        /** Create test user */
+        context.user = await global.db.insertUser();
+
+        context.anotherUser = await global.db.insertUser();
+
+        /** Create test note - a parent note */
+        context.parentNote = await global.db.insertNote({
+          creatorId: context.user.id,
+        });
+
+        /** Create test note - a child note */
+        context.childNote = await global.db.insertNote({
+          creatorId: context.user.id,
+        });
+
+        /** Create test note - create note with different user */
+        context.differentChildNote = await global.db.insertNote({
+          creatorId: context.anotherUser.id,
+        });
+
+        /** Create test note - a grandchild note */
+        context.grandChildNote = await global.db.insertNote({
+          creatorId: context.user.id,
+        });
+      }
+    });
+
     test.each([
       /** Returns 200 if user is team member with a Read role */
       {
@@ -518,6 +564,221 @@ describe('Note API', () => {
 
       expect(response?.json().message).toStrictEqual(expectedMessage);
     });
+
+    test('Returns two parents note in case of relation between child and parent note with status 200', async () => {
+      /** Create test user */
+      const user = await global.db.insertUser();
+
+      /** Create acces token for the user */
+      const accessToken = global.auth(user.id);
+
+      /** Create test note - a parent note */
+      const parentNote = await global.db.insertNote({
+        creatorId: user.id,
+      });
+
+      /** Create test note - a child note */
+      const childNote = await global.db.insertNote({
+        creatorId: user.id,
+      });
+
+      /** Create test note settings */
+      await global.db.insertNoteSetting({
+        noteId: childNote.id,
+        isPublic: true,
+      });
+
+      /** Create test note relation */
+      await global.db.insertNoteRelation({
+        parentId: parentNote.id,
+        noteId: childNote.id,
+      });
+
+      const response = await global.api?.fakeRequest({
+        method: 'GET',
+        headers: {
+          authorization: `Bearer ${accessToken}`,
+        },
+        url: `/note/${childNote.publicId}`,
+      });
+
+      expect(response?.statusCode).toBe(200);
+
+      expect(response?.json()).toMatchObject({
+        parents: [
+          {
+            id: parentNote.publicId,
+            content: parentNote.content,
+          },
+          {
+            id: childNote.publicId,
+            content: childNote.content,
+          },
+        ],
+      });
+    });
+
+    test('Returns three parents note in case of relation between all notes with status 200', async () => {
+      /** Create test user */
+      const user = await global.db.insertUser();
+
+      /** Create acces token for the user */
+      const accessToken = global.auth(user.id);
+
+      /** Create test note - a grand parent note */
+      const grandParentNote = await global.db.insertNote({
+        creatorId: user.id,
+      });
+
+      /** Create test note - a parent note */
+      const parentNote = await global.db.insertNote({
+        creatorId: user.id,
+      });
+
+      /** Create test note - a child note */
+      const childNote = await global.db.insertNote({
+        creatorId: user.id,
+      });
+
+      /** Create test note settings */
+      await global.db.insertNoteSetting({
+        noteId: childNote.id,
+        isPublic: true,
+      });
+
+      /** Create note relation between parent and grandParentNote */
+      await global.db.insertNoteRelation({
+        parentId: grandParentNote.id,
+        noteId: parentNote.id,
+      });
+
+      /** Create test note relation */
+      await global.db.insertNoteRelation({
+        parentId: parentNote.id,
+        noteId: childNote.id,
+      });
+
+      const response = await global.api?.fakeRequest({
+        method: 'GET',
+        headers: {
+          authorization: `Bearer ${accessToken}`,
+        },
+        url: `/note/${childNote.publicId}`,
+      });
+
+      expect(response?.statusCode).toBe(200);
+
+      expect(response?.json()).toMatchObject({
+        parents: [
+          {
+            id: grandParentNote.publicId,
+            content: grandParentNote.content,
+          },
+          {
+            id: parentNote.publicId,
+            content: parentNote.content,
+          },
+          {
+            id: childNote.publicId,
+            content: childNote.content,
+          },
+        ],
+      });
+    });
+
+    test('Returns two parents note in case where the note is not created by the same user but share relation with status 200', async () => {
+      /** Create test user */
+      const user = await global.db.insertUser();
+
+      /** Create another user */
+      const anotherUser = await global.db.insertUser();
+
+      /** Create acces token for the user */
+      const accessToken = global.auth(user.id);
+
+      /** Create test note - a parent note */
+      const parentNote = await global.db.insertNote({
+        creatorId: anotherUser.id,
+      });
+
+      /** Create test note - a child note */
+      const childNote = await global.db.insertNote({
+        creatorId: user.id,
+      });
+
+      /** Create test note settings */
+      await global.db.insertNoteSetting({
+        noteId: childNote.id,
+        isPublic: true,
+      });
+
+      /** Create test note relation */
+      await global.db.insertNoteRelation({
+        parentId: parentNote.id,
+        noteId: childNote.id,
+      });
+
+      const response = await global.api?.fakeRequest({
+        method: 'GET',
+        headers: {
+          authorization: `Bearer ${accessToken}`,
+        },
+        url: `/note/${childNote.publicId}`,
+      });
+
+      expect(response?.statusCode).toBe(200);
+
+      expect(response?.json()).toMatchObject({
+        parents: [
+          {
+            id: parentNote.publicId,
+            content: parentNote.content,
+          },
+          {
+            id: childNote.publicId,
+            content: childNote.content,
+          },
+        ],
+      });
+    });
+
+    test('Returns one note in case where there is no relation exist for the note with status 200', async () => {
+      /** Create test user */
+      const user = await global.db.insertUser();
+
+      /** Create acces token for the user */
+      const accessToken = global.auth(user.id);
+
+      /** Create test note - a child note */
+      const note = await global.db.insertNote({
+        creatorId: user.id,
+      });
+
+      /** Create test note settings */
+      await global.db.insertNoteSetting({
+        noteId: note.id,
+        isPublic: true,
+      });
+
+      const response = await global.api?.fakeRequest({
+        method: 'GET',
+        headers: {
+          authorization: `Bearer ${accessToken}`,
+        },
+        url: `/note/${note.publicId}`,
+      });
+
+      expect(response?.statusCode).toBe(200);
+
+      expect(response?.json()).toMatchObject({
+        parents: [
+          {
+            id: note.publicId,
+            content: note.content,
+          },
+        ],
+      });
+    });
   });
 
   describe('PATCH note/:notePublicId ', () => {

src/presentation/http/router/note.ts

@@ -85,6 +85,7 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
         canEdit: boolean;
       };
       tools: EditorTool[];
+      parents: NotePublic[];
     } | ErrorResponse;
   }>('/:notePublicId', {
     config: {
@@ -123,6 +124,12 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
                 $ref: 'EditorToolSchema',
               },
             },
+            parents: {
+              type: 'array',
+              items: {
+                $ref: 'NoteSchema',
+              },
+            },
           },
         },
       },
@@ -172,11 +179,14 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
      */
     const canEdit = memberRole === MemberRole.Write;
 
+    const noteParentStructure = await noteService.getNoteParents(noteId);
+
     return reply.send({
       note: notePublic,
       parentNote: parentNote,
       accessRights: { canEdit: canEdit },
       tools: noteTools,
+      parents: noteParentStructure,
     });
   });
 

src/repository/index.ts

@@ -139,6 +139,7 @@ export async function init(orm: Orm, s3Config: S3StorageConfig): Promise<Reposit
   /**
    * Create associations between note and relations table
    */
+  noteStorage.createAssociationWithNoteRelationModel(noteRelationshipStorage.model);
   noteRelationshipStorage.createAssociationWithNoteModel(noteStorage.model);
 
   /**

src/repository/noteRelations.repository.ts

@@ -1,4 +1,4 @@
-import type { NoteInternalId } from '@domain/entities/note.js';
+import type { Note, NoteInternalId } from '@domain/entities/note.js';
 import type NoteRelationshipStorage from '@repository/storage/noteRelations.storage.js';
 
 /**
@@ -67,4 +67,22 @@ export default class NoteRelationsRepository {
   public async hasRelation(noteId: NoteInternalId): Promise<boolean> {
     return await this.storage.hasRelation(noteId);
   }
+
+  /**
+   * Get all note parents based on note id
+   * @param noteId : note id to get all its parents
+   * @returns an array of note parents ids
+   */
+  public async getNoteParentsIds(noteId: NoteInternalId): Promise<NoteInternalId[]> {
+    return await this.storage.getAllNoteParentsIds(noteId);
+  }
+
+  /**
+   * Get all notes based on their ids
+   * @param noteIds : list of note ids
+   * @returns an array of notes
+   */
+  public async getNotesByIds(noteIds: NoteInternalId[]): Promise<Note[]> {
+    return await this.storage.getNotesByIds(noteIds);
+  }
 }