Merge pull request #99 from codex-team/chore/get-note-by-id-tests

Tests for get note by id

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

@@ -1,6 +1,9 @@
 
 import { describe, test, expect } from 'vitest';
 
+import notes from '@tests/test-data/notes.json';
+import noteSettings from '@tests/test-data/notes-settings.json';
+
 describe('Note API', () => {
   describe('GET note/resolve-hostname/:hostname ', () => {
     test('Returns note with specified hostname', async () => {
@@ -49,4 +52,89 @@ describe('Note API', () => {
       expect(body).toStrictEqual({ message: 'Note not found' });
     });
   });
-});
+
+  describe('GET note/:notePublicId ', () => {
+    test('Returns note by public id with 200 status when note is publicly available', async () => {
+      const expectedStatus = 200;
+      const correctID = 'Pq1T9vc23Q';
+
+      const expectedNote = {
+        'id': 2,
+        'publicId': 'Pq1T9vc23Q',
+        'creatorId': 1,
+        'content': null,
+        'createdAt': '2023-10-16T13:49:19.000Z',
+        'updatedAt': '2023-10-16T13:49:19.000Z',
+      };
+
+      const response = await global.api?.fakeRequest({
+        method: 'GET',
+        url: `/note/${correctID}`,
+      });
+
+      expect(response?.statusCode).toBe(expectedStatus);
+
+      expect(response?.json()).toStrictEqual(expectedNote);
+    });
+
+    test('Returns 403 when public access is disabled, user is not creator of the note', async () => {
+      const expectedStatus = 403;
+
+      const notPublicNote = notes.find(newNote => {
+        const settings = noteSettings.find(ns => ns.note_id === newNote.id);
+
+        return settings!.is_public === false;
+      });
+
+      const response = await global.api?.fakeRequest({
+        method: 'GET',
+        url: `/note/${notPublicNote!.public_id}`,
+      });
+
+      expect(response?.statusCode).toBe(expectedStatus);
+
+      expect(response?.json()).toStrictEqual({ message: 'Permission denied' });
+    });
+
+    test('Returns 406 when the id  does not exist', async () => {
+      const expectedStatus = 406;
+      const nonexistentId = 'ishvm5qH84';
+
+      const response = await global.api?.fakeRequest({
+        method: 'GET',
+        url: `/note/${nonexistentId}`,
+      });
+
+      expect(response?.statusCode).toBe(expectedStatus);
+
+      expect(response?.json()).toStrictEqual({ message: 'Note not found' });
+    });
+
+    test.each([
+      { id: 'mVz3iHuez',
+        expectedMessage: 'params/notePublicId must NOT have fewer than 10 characters' },
+
+      { id: 'cR8eqF1mFf0',
+        expectedMessage: 'params/notePublicId must NOT have more than 10 characters' },
+
+      { id: '+=*&*5%&&^&-',
+        expectedMessage: '\'/note/+=*&*5%&&^&-\' is not a valid url component' },
+    ])
+    ('Returns 400 when id has incorrect characters and length', async ({ id, expectedMessage }) => {
+      const expectedStatus = 400;
+
+      const response = await global.api?.fakeRequest({
+        method: 'GET',
+        url: `/note/${id}`,
+      });
+
+      expect(response?.statusCode).toBe(expectedStatus);
+
+      expect(response?.json().message).toStrictEqual(expectedMessage);
+    });
+
+    test.todo('Returns note by public id with 200 status when access is disabled, but user is creator');
+
+    test.todo('API should not return internal id and "publicId".  It should return only "id" which is public id.');
+  });
+});

src/tests/test-data/notes-settings.json

@@ -4,5 +4,19 @@
     "note_id": 1,
     "custom_hostname": "codex.so",
     "is_public": true
+  },
+
+  {
+    "id": 2,
+    "note_id": 2,
+    "custom_hostname": "codex.so",
+    "is_public": true
+  },
+
+  {
+    "id": 3,
+    "note_id": 3,
+    "custom_hostname": "codex.so",
+    "is_public": false
   }
 ]

src/tests/test-data/notes.json

@@ -6,5 +6,23 @@
     "content": [],
     "created_at": "2023-10-16T13:49:19.000Z",
     "updated_at": "2023-10-16T13:49:19.000Z"
+  },
+
+  { 
+    "id": 2,
+    "public_id": "Pq1T9vc23Q",
+    "creator_id": 1,
+    "content": [],
+    "created_at": "2023-10-16T13:49:19.000Z",
+    "updated_at": "2023-10-16T13:49:19.000Z"
+  },
+
+  { 
+    "id": 3,
+    "public_id": "73NdxFZ4k7",
+    "creator_id": 1,
+    "content": [],
+    "created_at": "2023-10-16T13:49:19.000Z",
+    "updated_at": "2023-10-16T13:49:19.000Z"
   }
 ]

tsconfig.json

@@ -15,7 +15,8 @@
       "@presentation/*": ["presentation/*"],
       "@lib/*": ["lib/*"],
       "@domain/*": ["domain/*"],
-      "@repository/*": ["repository/*"]
+      "@repository/*": ["repository/*"],
+      "@tests/*": ["tests/*"]
     },
   },
   "include": [

vitest.config.js

@@ -14,6 +14,7 @@ export default defineConfig({
       '@lib/': '/src/lib/',
       '@domain/': '/src/domain/',
       '@repository/': '/src/repository/',
+      '@tests/': '/src/tests/',
     },
   },
 });