Added conflict property in Entity Odata (#1024)

getodk · Oct 12, 2023 · 5833dc2 · 5833dc2
1 parent 8bcbbea
commit 5833dc2
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 11 deletions.
diff --git a/docs/api.yaml b/docs/api.yaml
@@ -12609,6 +12609,7 @@ paths:
         | Entity Creator Actor ID | `__system/creatorId` |
         | Entity Timestamp        | `__system/createdAt` |
         | Entity Update Timestamp | `__system/updatedAt` |
+        | Entity Conflict         | `__system/conflict`  |
 
         Note that `createdAt` and `updatedAt` are time components. This means that any comparisons you make need to account for the full time of the entity. It might seem like `$filter=__system/createdAt le 2020-01-31` would return all results on or before 31 Jan 2020, but in fact only entities made before midnight of that day would be accepted. To include all of the month of January, you need to filter by either `$filter=__system/createdAt le 2020-01-31T23:59:59.999Z` or `$filter=__system/createdAt lt 2020-02-01`. Remember also that you can [query by a specific timezone](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).
 
@@ -12691,6 +12692,7 @@ paths:
                     updates: 1,
                     updatedAt: '2023-04-31T19:41:16.478Z'
                     version: 1
+                    conflict: null
                 - __id: aeebd746-3b1e-4a24-ba9d-ed6547bd5ff1
                   label: 345cm mora
                   __system:
@@ -12700,6 +12702,7 @@ paths:
                     updates: 1,
                     updatedAt: '2023-04-31T19:41:16.478Z'
                     version: 2
+                    conflict: null
                   geometry: 47.722581 18.562111 0 0,
                   species: mora,
                   circumference_cm: 345            

diff --git a/lib/data/entity.js b/lib/data/entity.js
@@ -23,7 +23,8 @@ const { sanitizeOdataIdentifier } = require('../util/util');
 const odataToColumnMap = new Map([
   ['__system/createdAt', 'entities.createdAt'],
   ['__system/updatedAt', 'entities.updatedAt'],
-  ['__system/creatorId', 'entities.creatorId']
+  ['__system/creatorId', 'entities.creatorId'],
+  ['__system/conflict', 'entities.conflict']
 ]);
 
 ////////////////////////////////////////////////////////////////////////////
@@ -231,7 +232,8 @@ const selectFields = (entity, properties, selectedProperties) => {
     creatorName: entity.aux.creator.displayName,
     updates: entity.aux.stats.updates,
     updatedAt: entity.updatedAt,
-    version: entity.def.version
+    version: entity.def.version,
+    conflict: entity.conflict
   };
 
   if (!selectedProperties || selectedProperties.has('__system')) {

diff --git a/test/integration/api/odata-entities.js b/test/integration/api/odata-entities.js
@@ -27,16 +27,37 @@ describe('api: /datasets/:name.svc', () => {
             .replace('uuid:12345678-1234-4123-8234-123456789abc', uuid()))
           .set('Content-Type', 'application/xml')
           .expect(200);
-
-        await user.patch(`/v1/projects/1/forms/simpleEntity/submissions/submission${i+skip}`)
-          .send({ reviewState: 'approved' })
-          .expect(200);
-
       }
       await exhaust(container);
     };
     /* eslint-enable no-await-in-loop*/
 
+    const createConflict = async (user, container) => {
+      await user.post('/v1/projects/1/forms/simpleEntity/submissions')
+        .send(testData.instances.simpleEntity.one)
+        .set('Content-Type', 'application/xml')
+        .expect(200);
+
+      await exhaust(container);
+
+      await user.patch('/v1/projects/1/datasets/people/entities/12345678-1234-4123-8234-123456789abc?force=true')
+        .send({ data: { age: '99' } })
+        .expect(200);
+
+      await user.post('/v1/projects/1/forms?publish=true')
+        .send(testData.forms.updateEntity)
+        .set('Content-Type', 'application/xml')
+        .expect(200);
+
+      // all properties changed
+      await user.post('/v1/projects/1/forms/updateEntity/submissions')
+        .send(testData.instances.updateEntity.one)
+        .set('Content-Type', 'application/xml')
+        .expect(200);
+
+      await exhaust(container);
+    };
+
     it('should return all entities', testService(async (service, container) => {
       const asAlice = await service.login('alice');
 
@@ -239,6 +260,27 @@ describe('api: /datasets/:name.svc', () => {
         });
     }));
 
+    it('should filter by conflict status', testService(async (service, container) => {
+      const asAlice = await service.login('alice');
+
+      await asAlice.post('/v1/projects/1/forms?publish=true')
+        .set('Content-Type', 'application/xml')
+        .send(testData.forms.simpleEntity)
+        .expect(200);
+
+      await createSubmissions(asAlice, container, 2);
+
+      await createConflict(asAlice, container);
+
+      await asAlice.get('/v1/projects/1/datasets/people.svc/Entities?$filter=__system/conflict eq \'hard\'')
+        .expect(200)
+        .then(({ body }) => {
+          body.value.length.should.be.eql(1);
+
+          body.value[0].__system.conflict.should.be.eql('hard');
+        });
+    }));
+
     it('should return filtered entities with pagination', testService(async (service, container) => {
       const asAlice = await service.login('alice');
       const asBob = await service.login('bob');

diff --git a/test/unit/data/entity.js b/test/unit/data/entity.js
@@ -471,6 +471,7 @@ describe('extracting and validating entities', () => {
       uuid: 'uuid',
       createdAt: 'createdAt',
       updatedAt: 'updatedAt',
+      conflict: 'hard',
       def: {
         label: 'label',
         version: 1,
@@ -503,7 +504,8 @@ describe('extracting and validating entities', () => {
           creatorName: 'displayName',
           updatedAt: 'updatedAt',
           updates: 0,
-          version: 1
+          version: 1,
+          conflict: 'hard'
         },
         firstName: entity.def.data.firstName,
         lastName: entity.def.data.lastName
@@ -544,7 +546,8 @@ describe('extracting and validating entities', () => {
           creatorName: 'displayName',
           updatedAt: 'updatedAt',
           updates: 0,
-          version: 1
+          version: 1,
+          conflict: 'hard'
         }
       });
     });
@@ -554,6 +557,7 @@ describe('extracting and validating entities', () => {
         uuid: 'uuid',
         createdAt: 'createdAt',
         updatedAt: 'updatedAt',
+        conflict: 'hard',
         def: {
           label: 'label',
           version: 1,
@@ -580,7 +584,8 @@ describe('extracting and validating entities', () => {
           creatorName: 'displayName',
           updatedAt: 'updatedAt',
           updates: 0,
-          version: 1
+          version: 1,
+          conflict: 'hard'
         },
         firstName: '',
         lastName: ''
@@ -601,7 +606,8 @@ describe('extracting and validating entities', () => {
           creatorName: 'displayName',
           updatedAt: 'updatedAt',
           updates: 0,
-          version: 1
+          version: 1,
+          conflict: 'hard'
         },
         firstName: entity.def.data.firstName,
         lastName: entity.def.data.lastName,