[api] Add range of amounts (min, max) for feature per PU [MRXN23-444]

api/apps/api/src/migrations/api/1645026803969-AddTokenIdColumnToLocks.ts

@@ -1,3 +1,4 @@
+
 import { MigrationInterface, QueryRunner } from 'typeorm';
 
 export class AddTokenIdColumnToLocks1645026803969

api/apps/api/src/migrations/api/1697210673344-AddMinMaxAmountColumnsToFeatures.ts

@@ -0,0 +1,21 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+
+export class AddMinMaxAmountColumnsToFeatures1697210673344 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+      await queryRunner.query(`
+        ALTER TABLE features
+            ADD COLUMN amount_min float8,
+            ADD COLUMN amount_max float8;
+    `);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+      await queryRunner.query(`
+        ALTER TABLE features
+            DROP COLUMN amount_min float8,
+            DROP COLUMN amount_max float8;
+    `);
+    }
+
+}

api/apps/api/src/modules/geo-features/geo-feature.api.entity.ts

@@ -27,6 +27,11 @@ export interface GeoFeatureProperty {
   distinctValues: Array<string | number>;
 }
 
+export type FeatureAmountRange = {
+  min: number | null;
+  max: number | null;
+};
+
 @Entity('features')
 export class GeoFeature extends BaseEntity {
   @ApiProperty()
@@ -95,6 +100,12 @@ export class GeoFeature extends BaseEntity {
   @Column('boolean', { name: 'is_custom' })
   isCustom?: boolean;
 
+  @Column('float8', { name: 'amount_min' })
+  amountMin?: number;
+
+  @Column('float8', { name: 'amount_max' })
+  amountMax?: number;
+
   @Column('boolean', { name: 'is_legacy' })
   isLegacy!: boolean;
 
@@ -109,6 +120,9 @@ export class GeoFeature extends BaseEntity {
 
   @ApiPropertyOptional()
   scenarioUsageCount?: number;
+
+  @ApiPropertyOptional()
+  amountRange?: FeatureAmountRange;
 }
 
 export class JSONAPIGeoFeaturesData {

api/apps/api/src/modules/geo-features/geo-features.controller.ts

@@ -56,7 +56,6 @@ import { mapAclDomainToHttpError } from '@marxan-api/utils/acl.utils';
 )
 export class GeoFeaturesController {
   constructor(
-    public readonly service: GeoFeaturesService,
     private readonly geoFeatureService: GeoFeaturesService,
     public readonly geoFeaturesTagService: GeoFeatureTagsService,
     private readonly proxyService: ProxyService,
@@ -75,8 +74,10 @@ export class GeoFeaturesController {
   async findAll(
     @ProcessFetchSpecification() fetchSpecification: FetchSpecification,
   ): Promise<GeoFeatureResult> {
-    const results = await this.service.findAllPaginated(fetchSpecification);
-    return this.service.serialize(results.data, results.metadata);
+    const results = await this.geoFeatureService.findAllPaginated(
+      fetchSpecification,
+    );
+    return this.geoFeatureService.serialize(results.data, results.metadata);
   }
 
   @ImplementsAcl()

api/apps/api/src/modules/geo-features/geo-features.service.ts

@@ -41,7 +41,6 @@ import { ScenarioFeaturesService } from '@marxan-api/modules/scenarios-features'
 import { GeoFeatureTag } from '@marxan-api/modules/geo-feature-tags/geo-feature-tag.api.entity';
 import { GeoFeatureTagsService } from '@marxan-api/modules/geo-feature-tags/geo-feature-tags.service';
 import { FeatureAmountUploadService } from '@marxan-api/modules/geo-features/import/features-amounts-upload.service';
-import { isLeft } from 'fp-ts/Either';
 import { isNil } from 'lodash';
 
 const geoFeatureFilterKeyNames = [
@@ -138,6 +137,7 @@ export class GeoFeaturesService extends AppBaseService<
         'isCustom',
         'tag',
         'scenarioUsageCount',
+        'amountRange',
       ],
       keyForAttribute: 'camelCase',
     };
@@ -834,4 +834,24 @@ export class GeoFeaturesService extends AppBaseService<
       scenarioUsageCount: usage ? Number(usage.count) : 0,
     } as GeoFeature;
   }
+
+  async saveAmountRangeForFeatures(featureIds: string[]) {
+    for (const featureId of featureIds) {
+      const minAndMaxAmount = await this.geoEntityManager
+        .createQueryBuilder()
+        .select('MIN(amount)', 'min')
+        .addSelect('MAX(amount)', 'max')
+        .from('puvspr_calculations', 'puvspr')
+        .where('puvspr.feature_id = :featureId', { featureId })
+        .getOne();
+
+      await this.geoFeaturesRepository.update(
+        { id: featureId },
+        {
+          amountMin: minAndMaxAmount?.min ?? null,
+          amountMax: minAndMaxAmount?.max ?? null,
+        },
+      );
+    }
+  }
 }

api/apps/api/src/modules/geo-features/import/features-amounts-upload.service.ts

@@ -1,11 +1,18 @@
-import { BadRequestException, Injectable, Logger } from '@nestjs/common';
+import {
+  BadRequestException,
+  forwardRef,
+  Inject,
+  Injectable,
+  Logger,
+} from '@nestjs/common';
 import { DbConnections } from '@marxan-api/ormconfig.connections';
 import { DataSource, EntityManager, QueryRunner } from 'typeorm';
 import { InjectDataSource, InjectEntityManager } from '@nestjs/typeorm';
 import { featureAmountCsvParser } from '@marxan-api/modules/geo-features/import/csv.parser';
 import { FeatureAmountCSVDto } from '@marxan-api/modules/geo-features/dto/feature-amount-csv.dto';
 import { FeatureAmountUploadRegistry } from '@marxan-api/modules/geo-features/import/features-amounts-upload-registry.api.entity';
 import {
+  GeoFeaturesService,
   importedFeatureNameAlreadyExist,
   unknownPuidsInFeatureAmountCsvUpload,
 } from '@marxan-api/modules/geo-features/geo-features.service';
@@ -19,6 +26,7 @@ import { CHUNK_SIZE_FOR_BATCH_APIDB_OPERATIONS } from '@marxan-api/utils/chunk-s
 import { UploadedFeatureAmount } from '@marxan-api/modules/geo-features/import/features-amounts-data.api.entity';
 import { Project } from '@marxan-api/modules/projects/project.api.entity';
 import { ProjectSourcesEnum } from '@marxan/projects';
+import { ScenariosService } from '@marxan-api/modules/scenarios/scenarios.service';
 
 @Injectable()
 export class FeatureAmountUploadService {
@@ -33,6 +41,8 @@ export class FeatureAmountUploadService {
     @InjectEntityManager(DbConnections.default)
     private readonly apiEntityManager: EntityManager,
     private readonly events: FeatureImportEventsService,
+    @Inject(forwardRef(() => GeoFeaturesService))
+    private readonly geoFeaturesService: GeoFeaturesService,
   ) {}
 
   async uploadFeatureFromCsv(data: {
@@ -107,6 +117,12 @@ export class FeatureAmountUploadService {
         apiQueryRunner.manager,
       );
 
+      this.logger.log(`Saving min and max amounts for new features...`);
+
+      await this.geoFeaturesService.saveAmountRangeForFeatures(
+        newFeaturesFromCsvUpload.map((feature) => feature.id),
+      );
+
       this.logger.log(`Csv file upload process finished successfully`);
       // Committing transaction
 
@@ -211,7 +227,7 @@ export class FeatureAmountUploadService {
     queryRunner: QueryRunner,
     uploadId: string,
     projectId: string,
-  ) {
+  ): Promise<GeoFeature[]> {
     const newFeaturesToCreate = (
       await queryRunner.manager
         .createQueryBuilder()

api/apps/api/src/modules/projects/projects.service.ts

@@ -178,16 +178,29 @@ export class ProjectsService {
       return project;
     }
 
-    return right(
-      await this.geoCrud.findAllPaginated(fetchSpec, {
-        ...appInfo,
-        params: {
-          ...appInfo.params,
-          projectId: project.right.id,
-          bbox: project.right.bbox,
-        },
+    const result = await this.geoCrud.findAllPaginated(fetchSpec, {
+      ...appInfo,
+      params: {
+        ...appInfo.params,
+        projectId: project.right.id,
+        bbox: project.right.bbox,
+      },
+    });
+
+    const resultWithMappedAmountRange = {
+      data: result.data.map((feature) => {
+        return {
+          ...feature,
+          amountRange: {
+            min: feature?.amountMin ?? null,
+            max: feature?.amountMax ?? null,
+          },
+        };
       }),
-    );
+      metadata: result.metadata,
+    };
+
+    return right(resultWithMappedAmountRange);
   }
 
   async findAll(fetchSpec: FetchSpecification, info: ProjectsServiceRequest) {

api/apps/api/test/geo-features.e2e-spec.ts

@@ -9,7 +9,7 @@ import {
 import { bootstrapApplication } from './utils/api-application';
 import { GivenUserIsLoggedIn } from './steps/given-user-is-logged-in';
 
-import { createWorld } from './project/projects-world';
+import { createWorld } from './projects/projects-world';
 import { Repository } from 'typeorm';
 import { ScenarioFeaturesData } from '@marxan/features';
 import { v4 } from 'uuid';
@@ -65,6 +65,10 @@ describe('GeoFeaturesModule (e2e)', () => {
     const geoFeaturesForProject: GeoFeature[] = response.body.data;
     expect(geoFeaturesForProject.length).toBeGreaterThan(0);
     expect(response.body.data[0].type).toBe(geoFeatureResource.name.plural);
+    expect(response.body.data[0].attributes.amountRange).toEqual({
+      min: null,
+      max: null,
+    });
   });
 
   test('should include correct scenarioUsageCounts for the given project', async () => {

api/apps/api/test/upload-feature/upload-feature.fixtures.ts

@@ -271,6 +271,8 @@ export const getFixtures = async () => {
           featureClassName: name,
           description,
           alias: null,
+          amountMax: null,
+          amountMin: null,
           propertyName: null,
           intersection: null,
           creationStatus: `done`,

api/apps/geoprocessing/src/export/pieces-exporters/project-custom-features.piece-exporter.ts

@@ -32,6 +32,8 @@ type ProjectCustomFeaturesSelectResult = {
   list_property_keys: string[];
   is_legacy: boolean;
   tag: string;
+  amount_min: number | null;
+  amount_max: number | null;
 };
 
 type FeaturesDataSelectResult = {
@@ -81,6 +83,8 @@ export class ProjectCustomFeaturesPieceExporter
           'f.creation_status',
           'f.list_property_keys',
           'f.is_legacy',
+          'f.amount_min',
+          'f.amount_max',
           'pft.tag',
         ])
         .from('features', 'f')