feat(api): scenarios: cost-sufrace marxan data

Vizzuality · Jun 11, 2021 · 027ba86 · 027ba86
1 parent a5d5836
commit 027ba86
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 0 deletions.
diff --git a/api/apps/api/src/modules/scenarios/cost-surface-readmodel/cost-surface-view.module.ts b/api/apps/api/src/modules/scenarios/cost-surface-readmodel/cost-surface-view.module.ts
@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { CostSurfaceViewService } from './cost-surface-view.service';
+
+@Module({
+  providers: [CostSurfaceViewService],
+  exports: [CostSurfaceViewService],
+})
+export class CostSurfaceViewModule {}
diff --git a/api/apps/api/src/modules/scenarios/cost-surface-readmodel/cost-surface-view.service.ts b/api/apps/api/src/modules/scenarios/cost-surface-readmodel/cost-surface-view.service.ts
@@ -0,0 +1,13 @@
+import { Injectable } from '@nestjs/common';
+import * as stream from 'stream';
+
+@Injectable()
+export class CostSurfaceViewService {
+  read(scenarioId: string, stream: stream.Writable): void {
+    stream.write('id,cost,status');
+
+    // typeorm query runner/builder -> stream
+
+    stream.end();
+  }
+}
diff --git a/api/apps/api/src/modules/scenarios/scenarios.controller.ts b/api/apps/api/src/modules/scenarios/scenarios.controller.ts
@@ -3,11 +3,13 @@ import {
   Controller,
   Delete,
   Get,
+  Header,
   Param,
   ParseUUIDPipe,
   Patch,
   Post,
   Req,
+  Res,
   UploadedFile,
   UseGuards,
   UseInterceptors,
@@ -47,6 +49,7 @@ import { FileInterceptor } from '@nestjs/platform-express';
 import { ScenariosService } from './scenarios.service';
 import { ScenarioSerializer } from './dto/scenario.serializer';
 import { ScenarioFeatureSerializer } from './dto/scenario-feature.serializer';
+import * as express from 'express';
 
 @UseGuards(JwtAuthGuard)
 @ApiBearerAuth()
@@ -170,4 +173,22 @@ export class ScenariosController {
       await this.service.getFeatures(id),
     );
   }
+
+  @Header('Content-Type', 'text/csv')
+  @ApiOkResponse({
+    schema: {
+      type: 'string',
+    },
+  })
+  @ApiOperation({
+    description: `Uploaded cost surface data`,
+  })
+  @Get(`:id/marxan/dat/pu.dat`)
+  async getScenarioCostSurface(
+    @Param('id', ParseUUIDPipe) id: string,
+    @Res() res: express.Response,
+  ): Promise<void> {
+    await this.service.getCostSurfaceCsv(id, res);
+    return;
+  }
 }
diff --git a/api/apps/api/src/modules/scenarios/scenarios.module.ts b/api/apps/api/src/modules/scenarios/scenarios.module.ts
@@ -17,6 +17,7 @@ import { CostSurfaceModule } from './cost-surface/cost-surface.module';
 import { ScenariosService } from './scenarios.service';
 import { ScenarioSerializer } from './dto/scenario.serializer';
 import { ScenarioFeatureSerializer } from './dto/scenario-feature.serializer';
+import { CostSurfaceViewModule } from './cost-surface-readmodel/cost-surface-view.module';
 
 @Module({
   imports: [
@@ -29,6 +30,7 @@ import { ScenarioFeatureSerializer } from './dto/scenario-feature.serializer';
     AnalysisModule,
     CostSurfaceModule,
     HttpModule,
+    CostSurfaceViewModule,
   ],
   providers: [
     ScenariosService,

diff --git a/api/apps/api/src/modules/scenarios/scenarios.service.ts b/api/apps/api/src/modules/scenarios/scenarios.service.ts
@@ -1,5 +1,6 @@
 import { HttpService, Injectable } from '@nestjs/common';
 import { FetchSpecification } from 'nestjs-base-service';
+import * as stream from 'stream';
 
 import { AppInfoDTO } from '@marxan-api/dto/info.dto';
 import { AppConfig } from '@marxan-api/utils/config.utils';
@@ -13,6 +14,7 @@ import { ScenariosCrudService } from './scenarios-crud.service';
 import { CreateScenarioDTO } from './dto/create.scenario.dto';
 import { UpdateScenarioDTO } from './dto/update.scenario.dto';
 import { UpdateScenarioPlanningUnitLockStatusDto } from './dto/update-scenario-planning-unit-lock-status.dto';
+import { CostSurfaceViewService } from '@marxan-api/modules/scenarios/cost-surface-readmodel/cost-surface-view.service';
 
 @Injectable()
 export class ScenariosService {
@@ -26,6 +28,7 @@ export class ScenariosService {
     private readonly updatePlanningUnits: AdjustPlanningUnits,
     private readonly costSurface: CostSurfaceFacade,
     private readonly httpService: HttpService,
+    private readonly costSurfaceView: CostSurfaceViewService,
   ) {}
 
   async findAllPaginated(fetchSpecification: FetchSpecification) {
@@ -103,6 +106,14 @@ export class ScenariosService {
     return geoJson;
   }
 
+  async getCostSurfaceCsv(
+    scenarioId: string,
+    stream: stream.Writable,
+  ): Promise<void> {
+    await this.assertScenario(scenarioId);
+    this.costSurfaceView.read(scenarioId, stream);
+  }
+
   private async assertScenario(scenarioId: string) {
     await this.crudService.getById(scenarioId);
   }