[pact] feat: Adding github action for contract test (#47)

backend/package.json

@@ -7,7 +7,7 @@
     "test:service": "npx vitest **/service/*.spec.ts",
     "test:unit": "npx vitest -c ./vitest.config.unit.mts",
     "test:coverage": "npx vitest **/unit/*.spec.ts --coverage",
-    "test:contract": "npx vitest **/contract/*.spec.ts",
+    "test:contract": "npx vitest --testTimeout 30000 **/contract/*.spec.ts",
     "start:local": "npx nodemon",
     "start": "node dist/index.js",
     "build": "tsc",

backend/prisma/migrations/20240526112710_init/migration.sql

@@ -0,0 +1,12 @@
+/*
+  Warnings:
+
+  - The primary key for the `Note` table will be changed. If it partially fails, the table could be left without primary key constraint.
+
+*/
+-- AlterTable
+ALTER TABLE "Note" DROP CONSTRAINT "Note_pkey",
+ALTER COLUMN "id" DROP DEFAULT,
+ALTER COLUMN "id" SET DATA TYPE TEXT,
+ADD CONSTRAINT "Note_pkey" PRIMARY KEY ("id");
+DROP SEQUENCE "Note_id_seq";

backend/prisma/schema.prisma

@@ -12,7 +12,7 @@ datasource db {
 }
 
 model Note {
-  id        Int      @id @default(autoincrement())
+  id        String      @id @default(uuid())
   title     String
   content   String
   createdAt DateTime @default(now()) @map("created_at")

backend/prisma/seed.ts

@@ -9,62 +9,71 @@ export const seed = [
     createdAt: '2024-02-05T23:33:42.252Z',
     updatedAt: '2024-02-05T23:33:42.252Z',
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
+    id: '328baf25-3cb5-46a8-a66e-d86ac9bd46d5',
   },
   {
     title: 'Different User - scoping check',
     content: 'Should not see this note with Test User',
     createdAt: '2024-02-05T23:33:42.253Z',
     updatedAt: '2024-02-05T23:33:42.253Z',
     userID: 'dcf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
+    id: '7b981062-92dc-40a5-b7e2-bda7fc9d5cd2',
   },
   {
     title: 'Recipe',
     content: 'Ingredients: Chicken, tomatoes, onions, garlic.',
     createdAt: '2024-02-05T23:33:42.254Z',
     updatedAt: '2024-02-05T23:33:42.254Z',
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
+    id: 'a37f39bc-9e4f-45f2-b1d6-fe668bba2b55',
   },
   {
     title: 'Ideas',
     content: 'Brainstorming ideas for the next feature release. 🚀',
     createdAt: '2024-02-05T23:33:42.255Z',
     updatedAt: '2024-02-05T23:33:42.255Z',
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
+    id: '1e69b2a9-15dd-4d59-872a-b6830d0a2f92',
   },
   {
     title: 'Personal Goals',
     content: 'Exercise for 30 minutes daily. Read a book every week.',
     createdAt: '2024-02-05T23:33:42.256Z',
     updatedAt: '2024-02-05T23:33:42.256Z',
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
+    id: 'dd05d471-3f71-4616-8372-a399f496cb39',
   },
   {
     title: "Fête d'anniversaire",
     content: "Préparer une surprise pour la fête d'anniversaire.",
     createdAt: '2024-02-05T23:33:42.257Z',
     updatedAt: '2024-02-05T23:33:42.257Z',
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
+    id: '13ee0bfc-5510-43d7-b58b-d714a1f26aea',
   },
   {
     title: '日本旅行',
     content: '計画: 東京、京都、大阪を訪れる。',
     createdAt: '2024-02-05T23:33:42.258Z',
     updatedAt: '2024-02-05T23:33:42.258Z',
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
+    id: '75e5e48d-4ea8-4609-8b57-732eea9b628e',
   },
   {
     title: 'Семейный ужин',
     content: 'Приготовить вкусный ужин для всей семьи.',
     createdAt: '2024-02-05T23:33:42.259Z',
     updatedAt: '2024-02-05T23:33:42.259Z',
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
+    id: 'a9392144-54c0-44a4-8f51-1dd06ebfe5d5',
   },
   {
     title: 'Coding Project',
     content: 'Implement new features using React and Express.',
     createdAt: '2024-02-05T23:33:42.260Z',
     updatedAt: '2024-02-05T23:33:42.260Z',
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
+    id: 'dcbdc92f-f04c-4a84-8631-57e1943acfc7',
   },
 ];
 

backend/src/index.ts

@@ -27,7 +27,7 @@ app.get('/health', (req, res) => {
   res.json({ status: 'ok' });
 });
 
-/* istanbul ignore next */
+/* istanbul ignore if */
 if (process.env.NODE_ENV !== 'test') {
   app.listen(PORT, () => {
     console.log('server running on localhost', PORT);

backend/src/routes/noteRoutes.ts

@@ -37,16 +37,12 @@ router.post('/api/notes', authenticateToken, async (req, res) => {
 
 router.put('/api/notes/:id', authenticateToken, async (req, res) => {
   const { title, content } = req.body;
-  const id = parseInt(req.params.id);
+  const id = req.params.id;
 
   if (!title || !content) {
     return res.status(400).send({ error: 'title and content fields required' });
   }
 
-  if (!id || isNaN(id)) {
-    return res.status(400).send({ error: 'ID must be a valid number' });
-  }
-
   try {
     const updatedNote = await prisma.note.update({
       where: { id },
@@ -59,11 +55,7 @@ router.put('/api/notes/:id', authenticateToken, async (req, res) => {
 });
 
 router.delete('/api/notes/:id', authenticateToken, async (req, res) => {
-  const id = parseInt(req.params.id);
-
-  if (!id || isNaN(id)) {
-    return res.status(400).send({ error: 'ID field required' });
-  }
+  const id = req.params.id;
 
   try {
     await prisma.note.delete({

backend/tests/contract/notes.pact.spec.ts

@@ -18,7 +18,6 @@ describe('Pact Verification', () => {
       ],
       log: 'INFO', // Set to "DEBUG" to see output
     };
-
     return new Verifier(opts).verifyProvider().then((output) => {
       console.log(output);
     });

backend/tests/service/notes.spec.ts

@@ -66,7 +66,7 @@ describe('Authenticated Flows', () => {
       {
         content: 'Discussed project timelines and goals.',
         createdAt: '2024-02-05T23:33:42.252Z',
-        id: 1,
+        id: '328baf25-3cb5-46a8-a66e-d86ac9bd46d5',
         title: 'Meeting Notes',
         updatedAt: '2024-02-05T23:33:42.252Z',
         userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
@@ -147,7 +147,7 @@ describe('Authenticated Flows', () => {
     const deleteRes = await request(NOTES_URL)
       .delete(`/invalid-id`)
       .set('Authorization', `Bearer ${token}`);
-    expect(deleteRes.status).toBe(400);
-    expect(deleteRes.body.error).toBe('ID field required');
+    expect(deleteRes.status).toBe(500);
+    expect(deleteRes.body.error).toBe('Oops, something went wrong');
   });
 });

backend/tests/unit/mocks/notes.mock.ts

@@ -1,70 +1,70 @@
 export const noteSeed = [
   {
-    id: 1,
+    id: 'a1b2c3d4-1234-5678-9abc-abcdef123456',
     title: 'Meeting Notes',
     content: 'Discussed project timelines and goals.',
     updatedAt: new Date('2024-02-05T23:33:42.252Z'),
     createdAt: new Date('2024-02-05T23:43:42.252Z'),
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
   },
   {
-    id: 2,
+    id: 'e5f6g7h8-5678-1234-abcd-efghijklmnop',
     title: 'Shopping List',
     content: 'Milk, eggs, bread, and fruits.',
     updatedAt: new Date('2024-02-05T23:33:42.252Z'),
     createdAt: new Date('2024-02-05T23:43:42.252Z'),
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
   },
   {
-    id: 3,
+    id: 'i9j0k1l2-9012-3456-cdef-ghijklmnopqr',
     title: 'Recipe',
     content: 'Ingredients: Chicken, tomatoes, onions, garlic.',
     updatedAt: new Date('2024-02-05T23:33:42.252Z'),
     createdAt: new Date('2024-02-05T23:43:42.252Z'),
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
   },
   {
-    id: 4,
+    id: 's3t4u5v6-3456-7890-ijkl-mnopqrstuvwx',
     title: 'Ideas',
     content: 'Brainstorming ideas for the next feature release. 🚀',
     updatedAt: new Date('2024-02-05T23:33:42.252Z'),
     createdAt: new Date('2024-02-05T23:43:42.252Z'),
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
   },
   {
-    id: 5,
+    id: 'y7z8a9b0-7890-1234-qrst-uvwxyz123456',
     title: 'Personal Goals',
     content: 'Exercise for 30 minutes daily. Read a book every week.',
     updatedAt: new Date('2024-02-05T23:33:42.252Z'),
     createdAt: new Date('2024-02-05T23:43:42.252Z'),
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
   },
   {
-    id: 6,
+    id: 'c1d2e3f4-2345-6789-uvwx-yz0123456789',
     title: "Fête d'anniversaire",
     content: "Préparer une surprise pour la fête d'anniversaire.",
     updatedAt: new Date('2024-02-05T23:33:42.252Z'),
     createdAt: new Date('2024-02-05T23:43:42.252Z'),
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
   },
   {
-    id: 7,
+    id: 'f5g6h7i8-4567-8901-2345-6789abcdefghij',
     title: '日本旅行',
     content: '計画: 東京、京都、大阪を訪れる。',
     updatedAt: new Date('2024-02-05T23:33:42.252Z'),
     createdAt: new Date('2024-02-05T23:43:42.252Z'),
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
   },
   {
-    id: 8,
+    id: 'j9k0l1m2-5678-9012-3456-7890abcdefghij',
     title: 'Семейный ужин',
     content: 'Приготовить вкусный ужин для всей семьи.',
     updatedAt: new Date('2024-02-05T23:33:42.252Z'),
     createdAt: new Date('2024-02-05T23:43:42.252Z'),
     userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
   },
   {
-    id: 9,
+    id: 'n3o4p5q6-7890-1234-5678-90abcdefghij',
     title: 'Coding Project',
     content: 'Implement new features using React and Express.',
     updatedAt: new Date('2024-02-05T23:33:42.252Z'),

backend/tests/unit/notes.spec.ts

@@ -33,7 +33,7 @@ describe('View notes', () => {
     expect(response.status).toBe(200);
     expect(response.body).toEqual([
       {
-        id: 1,
+        id: 'a1b2c3d4-1234-5678-9abc-abcdef123456',
         title: 'Meeting Notes',
         content: 'Discussed project timelines and goals.',
         createdAt: '2024-02-05T23:43:42.252Z',
@@ -70,7 +70,7 @@ describe('Create a note', () => {
     prisma.note.create.mockResolvedValue({
       content: 'Test',
       title: 'Test',
-      id: 1,
+      id: 'a1b2c3d4-1234-5678-9abc-abcdef123456',
       updatedAt: new Date('2024-02-05T23:33:42.252Z'),
       createdAt: new Date('2024-02-05T23:33:42.252Z'),
       userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
@@ -120,55 +120,48 @@ describe('Update a note', () => {
     prisma.note.update.mockResolvedValue({
       title: 'Test update',
       content: 'Test',
-      id: 1,
+      id: 'a1b2c3d4-1234-5678-9abc-abcdef123457',
       updatedAt: new Date('2024-02-05T23:33:42.252Z'),
       createdAt: new Date('2024-02-05T23:33:42.252Z'),
       userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
     });
     const response = await request(app)
-      .put('/api/notes/1')
+      .put('/api/notes/a1b2c3d4-1234-5678-9abc-abcdef123457')
       .send({ title: 'Test update', content: 'Test', id: 1 });
     expect(response.status).toBe(200);
     expect(response.body).toStrictEqual({
       title: 'Test update',
       content: 'Test',
       createdAt: '2024-02-05T23:33:42.252Z',
-      id: 1,
+      id: 'a1b2c3d4-1234-5678-9abc-abcdef123457',
       updatedAt: '2024-02-05T23:33:42.252Z',
       userID: 'ccf89a7e-b941-4f17-bbe0-4e0c8b2cd272',
     });
   });
   test('PUT without title - failure', async ({}) => {
     const response = await request(app)
-      .put('/api/notes/1')
+      .put('/api/notes/a1b2c3d4-1234-5678-9abc-abcdef123457')
       .send({ content: 'Test', id: 1 });
     expect(response.status).toBe(400);
   });
   test('PUT without content - failure', async ({}) => {
     const response = await request(app)
-      .put('/api/notes/1')
+      .put('/api/notes/a1b2c3d4-1234-5678-9abc-abcdef123457')
       .send({ title: 'Test' });
     expect(response.status).toBe(400);
   });
   test('PUT without id in url - failure', async ({}) => {
     const response = await request(app)
       .put('/api/notes/')
-      .send({ title: 'Test' });
-    expect(response.status).toBe(404);
-  });
-  test('PUT with not string in url - failure', async ({}) => {
-    const response = await request(app)
-      .put('/api/notes/blah')
       .send({ title: 'Test', content: 'Test', id: 1 });
-    expect(response.status).toBe(400);
-    expect(response.body).toStrictEqual({ error: 'ID must be a valid number' });
+    expect(response.status).toBe(404);
   });
   test('PUT with a 500 error - failure', async ({}) => {
     prisma.note.update.mockImplementation(() => {
       throw new Error('Test error');
     });
     const response = await request(app)
-      .put('/api/notes/1')
+      .put('/api/notes/a1b2c3d4-1234-5678-9abc-abcdef123457')
       .send({ title: 'Test update', content: 'Test', id: 1 });
     expect(response.status).toBe(500);
     expect(response.body).toStrictEqual({
@@ -199,15 +192,6 @@ describe('Delete a note', () => {
       error: 'Oops, something went wrong',
     });
   });
-  test('DELETE with id error', async ({}) => {
-    prisma.note.delete.mockImplementation(() => {
-      throw new Error('Test error');
-    });
-    const response = await request(app).delete('/api/notes/string');
-
-    expect(response.status).toBe(400);
-    expect(response.body).toStrictEqual({ error: 'ID field required' });
-  });
 });
 
 describe('Health check', () => {