feat: allow filtering by root log id

Author: mvegter

lib/domain/dtos/GetAllLogsDto.js

@@ -19,6 +19,7 @@ const FilterDto = Joi.object({
     origin: Joi.string()
         .valid('human', 'process'),
     parentLog: EntityIdDto,
+    rootLog: EntityIdDto,
 });
 
 const SortDto = Joi.object({

lib/usecases/log/GetAllLogsUseCase.js

@@ -37,14 +37,18 @@ class GetAllLogsUseCase {
         const { filter, page = {}, sort = { id: 'desc' } } = query;
 
         if (filter) {
-            const { origin, parentLog } = filter;
+            const { origin, parentLog, rootLog } = filter;
             if (origin) {
                 queryBuilder.where('origin', origin);
             }
 
             if (parentLog) {
                 queryBuilder.where('parentLogId', parentLog);
             }
+
+            if (rootLog) {
+                queryBuilder.where('rootLogId', rootLog);
+            }
         }
 
         const { limit = 100, offset = 0 } = page;

spec/openapi.yaml

@@ -440,6 +440,8 @@ components:
           $ref: '#/components/schemas/LogOrigin'
         parentLog:
           $ref: '#/components/schemas/EntityId'
+        rootLog:
+          $ref: '#/components/schemas/EntityId'
       additionalProperties: false
     Log:
       description: Describes an intervention or an event that happened.

test/e2e/logs.test.js

@@ -83,6 +83,46 @@ module.exports = () => {
                 });
         });
 
+        it('should support filtering by root log', (done) => {
+            request(server)
+                .get('/api/logs?filter[rootLog]=1')
+                .expect(200)
+                .end((err, res) => {
+                    if (err) {
+                        done(err);
+                        return;
+                    }
+
+                    // Response must satisfy the OpenAPI specification
+                    expect(res).to.satisfyApiSpec;
+
+                    expect(res.body.data).to.be.an('array');
+                    expect(res.body.data).to.have.lengthOf(3);
+
+                    done();
+                });
+        });
+
+        it('should return 400 for an invalid root log', (done) => {
+            request(server)
+                .get('/api/logs?filter[rootLog]=-1')
+                .expect(400)
+                .end((err, res) => {
+                    if (err) {
+                        done(err);
+                        return;
+                    }
+
+                    // Response must satisfy the OpenAPI specification
+                    expect(res).to.satisfyApiSpec;
+
+                    const { errors } = res.body;
+                    expect(errors[0].detail).to.equal('"query.filter.rootLog" must be a positive number');
+
+                    done();
+                });
+        });
+
         it('should support filtering by origin (process)', (done) => {
             request(server)
                 .get('/api/logs?filter[origin]=process')