Merge pull request #55 from PhilanthropyDataCommons/30-add-get-canonical-fields

Add GET /canonicalFields endpoint

Author: slifty

package-lock.json

@@ -59,6 +59,8 @@
     "typescript": "^4.7.3"
   },
   "dependencies": {
+    "ajv": "^8.11.0",
+    "ajv-keywords": "^5.1.0",
     "dotenv": "^16.0.1",
     "express": "^4.18.1",
     "pino": "^8.1.0",

package.json

@@ -1,14 +1,65 @@
 import request from 'supertest';
 import { app } from '../app';
+import { db } from '../database';
+import type { Result } from 'tinypg';
 
 const agent = request.agent(app);
 
 describe('/canonicalFields', () => {
   describe('/', () => {
-    it('should return HTTP Status Code 200 OK', async () => {
+    it('returns an empty array when no data is present', async () => {
       await agent
         .get('/canonicalFields')
-        .expect(200);
+        .expect(200, []);
+    });
+
+    it('returns all canonical fields present in the database', async () => {
+      await db.query(`
+        INSERT INTO canonical_fields (
+          label,
+          short_code,
+          data_type,
+          created_at
+        )
+        VALUES
+          ( 'First Name', 'firstName', 'string', '2022-07-20 12:00:00+0000' ),
+          ( 'Last Name', 'lastName', 'string', '2022-07-20 12:00:00+0000' );
+      `);
+      await agent
+        .get('/canonicalFields')
+        .expect(
+          200,
+          [
+            {
+              createdAt: '2022-07-20T12:00:00.000Z',
+              dataType: 'string',
+              id: 1,
+              label: 'First Name',
+              shortCode: 'firstName',
+            },
+            {
+              createdAt: '2022-07-20T12:00:00.000Z',
+              dataType: 'string',
+              id: 2,
+              label: 'Last Name',
+              shortCode: 'lastName',
+            },
+          ],
+        );
+    });
+
+    it('should error if the database returns an unexpected data structure', async () => {
+      jest.spyOn(db, 'sql')
+        .mockImplementationOnce(async () => ({
+          rows: [{ foo: 'not a valid result' }],
+        }) as Result<object>);
+      const result = await agent
+        .get('/canonicalFields')
+        .expect(500);
+      expect(result.body).toMatchObject({
+        name: 'ValidationError',
+        errors: expect.any(Array) as unknown[],
+      });
     });
   });
 });

src/__tests__/canonicalFields.int.test.ts

@@ -0,0 +1,5 @@
+import Ajv from 'ajv';
+import ajvKeywords from 'ajv-keywords';
+
+export const ajv = new Ajv();
+ajvKeywords(ajv, 'instanceof');