feat(CostSurface): Adds CostSurface data to Scenario GET endpoints

Modifies the Scenarios serializer config to account the possible inclusion of costSurfaces on the GET responses (by using FetchSpecification's include in the GET request)
Vizzuality · Oct 3, 2023 · dfb0eb2 · dfb0eb2
1 parent 0282d2c
commit dfb0eb2
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 0 deletions.
diff --git a/api/apps/api/src/modules/scenarios/scenarios-crud.service.ts b/api/apps/api/src/modules/scenarios/scenarios-crud.service.ts
@@ -72,6 +72,7 @@ export class ScenariosCrudService extends AppBaseService<
         'ranAtLeastOnce',
         'solutionsAreLocked',
         'projectScenarioId',
+        'costSurface',
       ],
       keyForAttribute: 'camelCase',
       project: {
@@ -88,6 +89,10 @@ export class ScenariosCrudService extends AppBaseService<
           'lastModifiedAt',
         ],
       },
+      costSurface: {
+        ref: 'id',
+        attributes: ['name', 'isDefault'],
+      },
       users: {
         ref: 'id',
         attributes: ['fname', 'lname', 'email'],

diff --git a/api/apps/api/test/project-scenarios.e2e-spec.ts b/api/apps/api/test/project-scenarios.e2e-spec.ts
@@ -145,6 +145,18 @@ describe('ScenariosModule (e2e)', () => {
     fixtures.ThenCorrectScenariosAreReturned(response, { scenarioId, name });
   });
 
+  it('Getting scenario by id response includes cost surface name', async () => {
+    await fixtures.GivenScenarioWasCreated('test singular');
+    const response = await fixtures.WhenGettingScenarioByIdWithCostSurfaceInfo();
+    fixtures.ThenCostSurfaceNameIsIncludedInSingularResponse(response);
+  });
+  it('Getting scenarios response includes cost surface name', async () => {
+    await fixtures.GivenScenarioWasCreated('test plural');
+    await fixtures.GivenScenarioWasCreated('test plural2');
+    const response = await fixtures.WhenGettingScenariosWithCostSurfaceInfo();
+    fixtures.ThenCostSurfaceNameIsIncludedInPluralResponse(response);
+  });
+
   it('Contributor fails to delete scenario', async () => {
     const scenarioId = await fixtures.GivenScenarioWasCreated();
     await fixtures.GivenContributorWasAddedToScenario(scenarioId);
@@ -344,6 +356,14 @@ async function getFixtures() {
       return response;
     },
 
+    WhenGettingScenarioByIdWithCostSurfaceInfo: async () =>
+      await request(app.getHttpServer())
+        .get(`/api/v1/scenarios/${scenarioId}?include=costSurface`)
+        .set('Authorization', `Bearer ${ownerToken}`),
+    WhenGettingScenariosWithCostSurfaceInfo: async () =>
+      await request(app.getHttpServer())
+        .get('/api/v1/scenarios?include=costSurface')
+        .set('Authorization', `Bearer ${ownerToken}`),
     WhenGettingScenariosAsOwner: async () =>
       await request(app.getHttpServer())
         .get('/api/v1/scenarios')
@@ -499,6 +519,31 @@ async function getFixtures() {
       });
     },
 
+    ThenCostSurfaceNameIsIncludedInSingularResponse: (
+      response: request.Response,
+    ) => {
+      const resource = response.body.data;
+      const includedEntity = response.body.included;
+      expect(resource.relationships.costSurface.data.id).toBeDefined();
+      expect(includedEntity[0].type).toBe('costSurfaces');
+      expect(includedEntity[0].attributes.name).toBeDefined();
+      expect(includedEntity[0].attributes.isDefault).toBeDefined();
+    },
+    ThenCostSurfaceNameIsIncludedInPluralResponse: (
+      response: request.Response,
+    ) => {
+      const resources = response.body.data;
+      const includedEntities = response.body.included;
+      for (const resource of resources) {
+        expect(resource.relationships.costSurface.data.id).toBeDefined();
+      }
+      for (const includedEntity of includedEntities) {
+        expect(includedEntity.type).toBe('costSurfaces');
+        expect(includedEntity.attributes.name).toBeDefined();
+        expect(includedEntity.attributes.isDefault).toBeDefined();
+      }
+    },
+
     ThenAllScenariosFromContributorAreReturned: (
       response: request.Response,
     ) => {