[O2B-1107] Filter on environment id (#1326)

* feat: add like filtering for ids

* feat: add exact filter for environment ids

* fix: fix lint problems

* refactor: implement comment on PR

* test: add tests for feature

* test: add test for filtering in API

* test: add more tests for environment API

Author: CollinPoetoehena

lib/domain/dtos/GetAllEnvironmentsDto.js

@@ -14,7 +14,16 @@
 const Joi = require('joi');
 const PaginationDto = require('./PaginationDto');
 
+/**
+ * Separate filter DTO for get all environments, because EnvironmentsFilterDto
+ * is used for logs and requires different information
+ */
+const FilterDto = Joi.object({
+    ids: Joi.string().trim().optional(),
+});
+
 const QueryDto = Joi.object({
+    filter: FilterDto,
     page: PaginationDto,
     token: Joi.string(),
 });

lib/usecases/environment/GetAllEnvironmentsUseCase.js

@@ -22,6 +22,7 @@ const {
 } = require('../../database');
 const { environmentAdapter } = require('../../database/adapters/index.js');
 const { ApiConfig } = require('../../config/index.js');
+const { Op } = require('sequelize');
 
 /**
  * GetAllEnvironmentsUseCase
@@ -35,11 +36,29 @@ class GetAllEnvironmentsUseCase {
      */
     async execute(dto = {}) {
         const { query = {} } = dto;
-        const { page = {} } = query;
+        const { filter, page = {} } = query;
         const { limit = ApiConfig.pagination.limit, offset = 0 } = page;
 
+        const queryBuilder = new QueryBuilder();
+
+        if (filter) {
+            const { ids } = filter;
+            if (ids) {
+                const filters = ids.split(',').map((id) => id.trim());
+
+                // Filter should be like with only one filter
+                if (filters.length === 1) {
+                    queryBuilder.where('id').substring(filters[0]);
+                }
+
+                // Filters should be exact with more than one filter
+                if (filters.length > 1) {
+                    queryBuilder.andWhere({ id: { [Op.in]: filters } });
+                }
+            }
+        }
+
         const { count, rows } = await TransactionHelper.provide(async () => {
-            const queryBuilder = new QueryBuilder();
             queryBuilder.orderBy('updatedAt', 'desc');
             queryBuilder.limit(limit);
             queryBuilder.offset(offset);

test/api/environments.test.js

@@ -35,6 +35,36 @@ module.exports = () => {
                     done();
                 });
         });
+
+        it('should successfully show all environments without filter', async () => {
+            const response = await request(server).get('/api/environments');
+
+            expect(response.status).to.equal(200);
+            const environments = response.body.data;
+            expect(environments).to.lengthOf(9);
+            // Check if the environment list is valid by checking the first one only
+            expect(environments[0].id).to.equal('CmCvjNbg');
+        });
+
+        it('should successfully apply filter for environments ids', async () => {
+            const response = await request(server).get('/api/environments?filter[ids]=8E4aZTjY');
+
+            expect(response.status).to.equal(200);
+            const environments = response.body.data;
+            expect(environments).to.lengthOf(1);
+            expect(environments[0].id).to.equal('8E4aZTjY');
+        });
+
+        it('should successfully filter environments on a list of ids', async () => {
+            const response = await request(server).get('/api/environments?filter[ids]=CmCvjNbg, TDI59So3d, EIDO13i3D');
+
+            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');
+        });
     });
     describe('POST /api/environments', () => {
         it('should return 201 if valid data is provided', (done) => {

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

@@ -28,4 +28,34 @@ module.exports = () => {
             .execute(getAllEnvsDto);
         expect(result.environments).to.be.an('array');
     });
+
+    it('should successfully filter environments on one id', async () => {
+        getAllEnvsDto.query = { filter: { ids: 'SomeId' } };
+        const { environments } = await new GetAllEnvironmentsUseCase().execute(getAllEnvsDto);
+
+        expect(environments).to.be.an('array');
+        expect(environments.length).to.be.equal(1);
+        expect(environments[0].id).to.be.equal('SomeId');
+    });
+
+    it('should successfully filter environments on a list of ids', async () => {
+        getAllEnvsDto.query = { filter: { ids: 'SomeId, newId, CmCvjNbg' } };
+        const { environments } = await new GetAllEnvironmentsUseCase().execute(getAllEnvsDto);
+
+        expect(environments).to.be.an('array');
+        expect(environments.length).to.be.equal(3);
+        expect(environments[0].id).to.be.equal('SomeId');
+        expect(environments[1].id).to.be.equal('newId');
+        expect(environments[2].id).to.be.equal('CmCvjNbg');
+    });
+
+    it('should successfully filter environments on a list of ids with a non existing id', async () => {
+        getAllEnvsDto.query = { filter: { ids: 'SomeId, nonExistingIdEnv, newId' } };
+        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('SomeId');
+        expect(environments[1].id).to.be.equal('newId');
+    });
 };