Entity dummy response and assertions (getodk#820)

Wrote basic integration tests for the APIs

Author: sadiqkhoja

lib/http/service.js

@@ -73,6 +73,7 @@ module.exports = (container) => {
   require('../resources/comments')(service, endpoint);
   require('../resources/analytics')(service, endpoint);
   require('../resources/datasets')(service, endpoint);
+  require('../resources/entities')(service, endpoint);
 
   ////////////////////////////////////////////////////////////////////////////////
   // POSTRESOURCE HANDLERS

lib/resources/entities.js

@@ -0,0 +1,369 @@
+// Copyright 2023 ODK Central Developers
+// See the NOTICE file at the top-level directory of this distribution and at
+// https://github.com/getodk/central-backend/blob/master/NOTICE.
+// This file is part of ODK Central. It is subject to the license terms in
+// the LICENSE file found in the top-level directory of this distribution and at
+// https://www.apache.org/licenses/LICENSE-2.0. No part of ODK Central,
+// including this file, may be copied, modified, propagated, or distributed
+// except according to the terms contained in the LICENSE file.
+
+const { getOrNotFound } = require('../util/promise');
+const { mergeLeft } = require('ramda');
+const { success } = require('../util/http');
+
+const getActor = () => ({
+  id: 1,
+  displayName: 'John Doe',
+  type: 'user',
+  createdAt: new Date(),
+  updatedAt: null,
+  deletedAt: null
+});
+const getEntityDef = () => ({
+  versionNumber: 1,
+  label: '',
+  current: true,
+  createdAt: '2023-01-01T09:00:00.000Z',
+  creatorId: 1,
+  userAgent: 'Postman'
+});
+
+const getEntity = (i) => ({
+  uuid: `00000000-0000-0000-0000-00000000000${i}`,
+  createdAt: '2023-01-01T09:00:00.000Z',
+  updatedAt: null,
+  deletedAt: null,
+  creatorId: 1
+});
+
+const populateEntities = () => {
+  const entities = [];
+  for (let i = 1; i <= 5; i+=1) {
+    entities.push({
+      ...getEntity(i),
+      currentVersion: getEntityDef()
+    });
+  }
+  return entities;
+};
+
+module.exports = (service, endpoint) => {
+
+  service.get('/projects/:id/datasets/:name/entities', endpoint(async ({ Projects }, { params, queryOptions, query }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+    const entities = populateEntities();
+
+    if (queryOptions.extended) {
+      for (let i = 0; i < 5; i+=1) {
+        entities[i].currentVersion.creator = getActor();
+        entities[i].creator = getActor();
+      }
+    }
+
+    if (query.deleted) {
+      entities[4].deletedAt = new Date();
+      return [entities[4]];
+    }
+
+    return entities;
+  }));
+
+  service.get('/projects/:id/datasets/:name/entities/:uuid', endpoint(async ({ Projects }, { params, queryOptions }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+    const entity = getEntity(1);
+    entity.updatedAt = '2023-01-02T09:00:00.000Z';
+    entity.currentVersion = {
+      ...getEntityDef(),
+      source: {
+        type: 'api',
+        details: null
+      },
+      data: {
+        firstName: 'Jane',
+        lastName: 'Roe',
+        city: 'Toronto'
+      },
+      versionNumber: 2,
+      label: 'Jane Roe',
+      createdAt: '2023-01-02T09:00:00.000Z'
+    };
+    return entity;
+  }));
+
+  service.get('/projects/:id/datasets/:name/entities/:uuid/versions', endpoint(async ({ Projects }, { params, queryOptions }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+
+    const versions = ['John Doe', 'Jane Doe', 'Richard Roe', 'Janie Doe', 'Baby Roe'].map((name, i) => ({
+      ...getEntityDef(),
+      current: i === 4,
+      source: {
+        type: 'api',
+        details: null
+      },
+      data: {
+        firstName: name.split(' ')[0],
+        lastName: name.split(' ')[1],
+        city: 'Toronto'
+      },
+      versionNumber: i+1,
+      label: name,
+      createdAt: new Date()
+    }));
+
+    return versions;
+  }));
+
+  // May not be needed for now
+  service.get('/projects/:id/datasets/:name/entities/:uuid/versions/:versionNumber', endpoint(async ({ Projects }, { params, queryOptions }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+
+    return {
+      ...getEntityDef(),
+      current: false,
+      source: {
+        type: 'api',
+        details: null
+      },
+      data: {
+        firstName: 'Janie',
+        lastName: 'Doe',
+        city: 'Toronto'
+      },
+      versionNumber: params.versionNumber,
+      label: 'Janie Doe',
+      createdAt: new Date()
+    };
+
+  }));
+
+  service.get('/projects/:id/datasets/:name/entities/:uuid/diffs', endpoint(async ({ Projects }, { params, queryOptions }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+
+    return {
+      2: [ // 2 is version number
+        { old: 'John', new: 'Jane', propertyName: 'firstName' },
+        { old: 'Doe', new: 'Roe', propertyName: 'lastName' },
+        { old: 'John Doe', new: 'Jane Roe', propertyName: 'label' }
+      ]
+    };
+  }));
+
+  service.get('/projects/:id/datasets/:name/entities/:uuid/audits', endpoint(async ({ Projects }, { params, queryOptions }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+
+    return [
+      {
+        actorId: 1,
+        action: 'entity.update.version',
+        acteeId: '11111111-1111-1111-11111111111111111',
+        details: {
+          entityId: '00000000-0000-0000-0000-000000000001',
+          label: 'Jane Roe',
+          versionNumber: 2,
+          source: {
+            type: 'api',
+            details: null
+          }
+        },
+        loggedAt: '2023-01-02T09:00:00.000Z',
+        notes: null,
+        actor: getActor()
+      },
+      {
+        actorId: 1,
+        action: 'entity.create',
+        acteeId: '11111111-1111-1111-11111111111111111',
+        details: {
+          entityId: '00000000-0000-0000-0000-000000000001',
+          label: 'John Doe',
+          versionNumber: 1,
+          source: {
+            type: 'submission',
+            details: {
+              instanceId: '11111111-1111-1111-11111111111111111',
+              instanceName: 'first instance',
+              xmlFormId: 'submission'
+            }
+          },
+          // This nesting needs to be discussed
+          relatedEvents: [
+            {
+              actorId: 1,
+              action: 'submission.update',
+              acteeId: '11111111-1111-1111-511c9466b12c',
+              details: {
+                instanceId: 'uuid:f9636668-814c-4450-859e-e651f3d81fd5',
+                submissionId: 359983,
+                reviewState: 'approved'
+              },
+              loggedAt: '2023-01-01T09:00:00.000Z',
+              notes: null,
+              actor: getActor()
+            },
+            {
+              actorId: 1,
+              action: 'submission.create',
+              acteeId: '11111111-1111-1111-511c9466b12c',
+              details: {
+                instanceId: 'uuid:f9636668-814c-4450-859e-e651f3d81fd5',
+                submissionId: 359983,
+                instanceName: 'Lorem ipsum'
+              },
+              loggedAt: '2023-01-01T09:00:00.000Z',
+              notes: null,
+              actor: getActor()
+            }
+          ]
+        },
+        loggedAt: '2023-01-01T09:00:00.000Z',
+        notes: null,
+        actor: getActor()
+      }
+    ];
+  }));
+
+  service.post('/projects/:id/datasets/:name/entities', endpoint(async ({ Projects }, { params, queryOptions, body, headers }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+
+    const { uuid, label, ...data } = body;
+
+    const date = new Date();
+
+    const userAgent = headers['user-agent'];
+
+    const entity = {
+      ...getEntity(1),
+      uuid,
+      createdAt: date,
+      currentVersion: {
+        ...getEntityDef(),
+        sourceId: userAgent,
+        source: {
+          type: 'api',
+          details: null
+        },
+        label,
+        createdAt: date,
+        data
+      }
+    };
+
+    return entity;
+
+  }));
+
+  service.put('/projects/:id/datasets/:name/entities/:uuid', endpoint(async ({ Projects }, { params, queryOptions, body, headers }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+
+    const { uuid, label, ...data } = body;
+
+    const updatedAt = new Date();
+
+    const userAgent = headers['user-agent'];
+
+    const entity = {
+      ...getEntity(1),
+      uuid,
+      createdAt: '2023-01-01T09:00:00.000Z',
+      updatedAt,
+      currentVersion: {
+        ...getEntityDef(),
+        userAgent,
+        versionNumber: 2,
+        source: {
+          type: 'api',
+          details: null
+        },
+        label,
+        createdAt: updatedAt,
+        data
+      }
+    };
+
+    return entity;
+
+  }));
+
+  service.patch('/projects/:id/datasets/:name/entities/:uuid', endpoint(async ({ Projects }, { params, queryOptions, body, headers }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+
+    const originalData = {
+      uuid: '10000000-0000-0000-0000-000000000001',
+      label: 'Johnny Doe',
+      firstName: 'Johnny',
+      lastName: 'Doe',
+      city: 'Toronto'
+    };
+
+    const { uuid, label, ...data } = mergeLeft(body, originalData);
+
+    const updatedAt = new Date();
+
+    const userAgent = headers['user-agent'];
+
+    const entity = {
+      ...getEntity(1),
+      uuid,
+      createdAt: '2023-01-01T09:00:00.000Z',
+      updatedAt,
+      currentVersion: {
+        ...getEntityDef(),
+        userAgent,
+        versionNumber: 2,
+        source: {
+          type: 'api',
+          details: null
+        },
+        label,
+        createdAt: updatedAt,
+        data
+      }
+    };
+
+    return entity;
+
+  }));
+
+  service.delete('/projects/:id/datasets/:name/entities/:uuid', endpoint(async ({ Projects }, { params, queryOptions }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+
+    return success();
+
+  }));
+
+  // Lowest priority
+  service.post('/projects/:id/datasets/:name/entities/:uuid/restore', endpoint(async ({ Projects }, { params, queryOptions }) => {
+
+    await Projects.getById(params.id, queryOptions).then(getOrNotFound);
+
+    const entity = getEntity(1);
+    entity.updatedAt = '2023-01-02T09:00:00.000Z';
+    entity.currentVersion = {
+      ...getEntityDef(),
+      source: {
+        type: 'api',
+        details: null
+      },
+      data: {
+        firstName: 'Jane',
+        lastName: 'Roe',
+        city: 'Toronto'
+      },
+      versionNumber: 1,
+      label: 'Jane Roe',
+      createdAt: '2023-01-03T09:00:00.000Z'
+    };
+    return entity;
+
+  }));
+};