[O2B-1452] Add filter option by creation date interval for retrieving environments (#1931)

* Add API tests for expected filtering on created

* Add tests for usecase on get all environments

* Add functionality on filtering environments by creation date

* Remove unwanted comment

* Add tests for empty result case

* Use convention for missing values

Author: graduta

lib/domain/dtos/GetAllEnvironmentsDto.js

@@ -13,6 +13,7 @@
 
 const Joi = require('joi');
 const PaginationDto = require('./PaginationDto');
+const { FromToFilterDto } = require('./filters/FromToFilterDto');
 
 /**
  * Separate filter DTO for get all environments, because EnvironmentsFilterDto
@@ -23,6 +24,7 @@ const FilterDto = Joi.object({
     currentStatus: Joi.string().trim().optional(),
     statusHistory: Joi.string().trim().optional(),
     runNumbers: Joi.string().trim().optional(),
+    created: FromToFilterDto,
 });
 
 const QueryDto = Joi.object({

lib/usecases/environment/GetAllEnvironmentsUseCase.js

@@ -85,10 +85,17 @@ class GetAllEnvironmentsUseCase {
                 currentStatus: currentStatusExpression,
                 statusHistory,
                 runNumbers: runNumbersExpression,
+                created,
             } = filter;
 
             const filterQueryBuilder = prepareQueryBuilder();
 
+            if (created) {
+                const from = created.from !== undefined ? created.from : 0;
+                const to = created.to !== undefined ? created.to : Date.now();
+                filterQueryBuilder.where('createdAt').between(from, to);
+            }
+
             if (idsExpression) {
                 const filters = idsExpression.split(',').map((id) => id.trim());
 
@@ -167,12 +174,18 @@ class GetAllEnvironmentsUseCase {
             }
 
             const filteredEnvironmentsIds = (await EnvironmentRepository.findAll(filterQueryBuilder)).map(({ id }) => id);
+            // If no environments match the filter, return an empty result
+            if (filteredEnvironmentsIds.length === 0) {
+                return {
+                    count: 0,
+                    environments: [],
+                };
+            }
             fetchQueryBuilder.where('id').oneOf(filteredEnvironmentsIds);
         }
 
         fetchQueryBuilder.include({ association: 'runs' });
         fetchQueryBuilder.include({ association: 'historyItems' });
-
         const { count, rows } = await EnvironmentRepository.findAndCountAll(fetchQueryBuilder);
         return {
             count,

test/api/environments.test.js

@@ -36,6 +36,56 @@ module.exports = () => {
             expect(environments[0].id).to.equal('CmCvjNbg');
         });
 
+        it('should successfully return environments that were created between two provided dates', async () => {
+            const from = new Date('2019-08-09 15:50:00').getTime();
+            const to = new Date('2019-08-09 19:00:00').getTime();
+            const response = await request(server).get(`/api/environments?filter[created][from]=${from}&filter[created][to]=${to}`);
+
+            expect(response.status).to.equal(200);
+            const environments = response.body.data;
+            expect(environments).to.lengthOf(2);
+            expect(environments[0].id).to.equal('TDI59So3d');
+            expect(environments[1].id).to.equal('EIDO13i3D');
+        });
+
+        it('should successfully return environments that were created from provided date', async () => {
+            const from = new Date('2019-08-09 15:50:00').getTime();
+            const response = await request(server).get(`/api/environments?filter[created][from]=${from}`);
+
+            expect(response.status).to.equal(200);
+            const environments = response.body.data;
+            expect(environments).to.lengthOf(3);
+            expect(environments[0].id).to.equal('CmCvjNbg');
+            expect(environments[1].id).to.equal('TDI59So3d');
+            expect(environments[2].id).to.equal('EIDO13i3D');
+        });
+
+        it('should successfully return environments that were created to provided date', async () => {
+            const to = new Date('2019-08-09 19:00:00').getTime();
+            const response = await request(server).get(`/api/environments?filter[created][to]=${to}`);
+
+            expect(response.status).to.equal(200);
+            const environments = response.body.data;
+            expect(environments).to.lengthOf(8);
+            expect(environments[0].id).to.equal('TDI59So3d');
+            expect(environments[1].id).to.equal('EIDO13i3D');
+            expect(environments[2].id).to.equal('KGIS12DS');
+            expect(environments[3].id).to.equal('VODdsO12d');
+            expect(environments[4].id).to.equal('GIDO1jdkD');
+            expect(environments[5].id).to.equal('8E4aZTjY');
+            expect(environments[6].id).to.equal('Dxi029djX');
+            expect(environments[7].id).to.equal('eZF99lH6');
+        });
+
+        it('should successfully return no environments for filter not matching', async () => {
+            const from = Date.now();
+            const response = await request(server).get(`/api/environments?filter[created][from]=${from}`);
+
+            expect(response.status).to.equal(200);
+            const environments = response.body.data;
+            expect(environments).to.lengthOf(0);
+        });
+
         it('should successfully apply filter for environments ids', async () => {
             const response = await request(server).get('/api/environments?filter[ids]=8E4aZTjY');
 

test/lib/usecases/environment/GetAllEnvironmentsUseCase.test.js

@@ -161,4 +161,41 @@ module.exports = () => {
         // Should include all environments with run numbers containing the substring 10
         expect(environments.map(({ id }) => id)).to.have.members(['TDI59So3d', 'Dxi029djX']);
     });
+
+    it('should successfully filter environments on created from and to', async () => {
+        const from = Date.now() - 24 * 60 * 60 * 1000; // environment from 24h ago which was created by CreateEnvironmentUseCase.test.js
+        const to = Date.now() - 10;
+        getAllEnvsDto.query = { filter: { created: { from, to } } };
+        const { environments } = await new GetAllEnvironmentsUseCase().execute(getAllEnvsDto);
+        expect(environments).to.be.an('array');
+        expect(environments.length).to.be.equal(2);
+        expect(environments[0].id).to.be.equal('newId');
+        expect(environments[1].id).to.be.equal('SomeId');
+    });
+
+    it('should successfully filter environments on created from', async () => {
+        const from = Date.now() - 24 * 60 * 60 * 1000; // environment from 24h ago which was created by CreateEnvironmentUseCase.test.js
+        getAllEnvsDto.query = { filter: { created: { from } } };
+        const { environments } = await new GetAllEnvironmentsUseCase().execute(getAllEnvsDto);
+        expect(environments).to.be.an('array');
+        expect(environments.length).to.be.equal(2);
+        expect(environments[0].id).to.be.equal('newId');
+        expect(environments[1].id).to.be.equal('SomeId');
+    });
+
+    it('should successfully filter environments on created to', async () => {
+        const to = Date.now() - 24 * 60 * 60 * 1000; // environment until 24h are created by seeders
+        getAllEnvsDto.query = { filter: { created: { to } } };
+        const { environments } = await new GetAllEnvironmentsUseCase().execute(getAllEnvsDto);
+        expect(environments).to.be.an('array');
+        expect(environments.length).to.be.equal(9); // Environments from seeders
+    });
+
+    it('should successfully return empty environment array if filter does not match', async () => {
+        const from = Date.now() - 10; 
+        getAllEnvsDto.query = { filter: { created: { from } } };
+        const { environments } = await new GetAllEnvironmentsUseCase().execute(getAllEnvsDto);
+        expect(environments).to.be.an('array');
+        expect(environments.length).to.be.equal(0); // Environments from seeders
+    });
 };