Refactor to replace puvsprCalculations with featureAmountsPerPlanning…

…Units

Refactor to replace puvsprCalculations with featureAmountsPerPlanningUnits

api/apps/api/src/modules/clone/export/adapters/export-resource-pieces.adapter.spec.ts

@@ -99,7 +99,7 @@ const getFixtures = async () => {
       ClonePiece.ProjectCustomProtectedAreas,
       ClonePiece.ProjectCostSurfaces,
       ClonePiece.ProjectCustomFeatures,
-      ClonePiece.ProjectPuvsprCalculations,
+      ClonePiece.ProjectFeatureAmountsPerPlanningUnit,
     ];
   };
 

api/apps/api/src/modules/clone/export/adapters/export-resource-pieces.adapter.ts

@@ -58,7 +58,10 @@ export class ExportResourcePiecesAdapter implements ExportResourcePieces {
       ExportComponent.newOne(id, ClonePiece.ProjectCustomProtectedAreas),
       ExportComponent.newOne(id, ClonePiece.ProjectCostSurfaces),
       ExportComponent.newOne(id, ClonePiece.ProjectCustomFeatures),
-      ExportComponent.newOne(id, ClonePiece.ProjectPuvsprCalculations),
+      ExportComponent.newOne(
+        id,
+        ClonePiece.ProjectFeatureAmountsPerPlanningUnit,
+      ),
       ...scenarioPieces,
     ];
 

api/apps/api/src/modules/scenarios-features/compute-area.service.spec.ts

@@ -1,9 +1,9 @@
 import { ProjectSourcesEnum } from '@marxan/projects';
 import {
-  MemoryPuvsprCalculationsRepository,
-  PuvsprCalculationsRepository,
-  PuvsprCalculationsService,
-} from '@marxan/puvspr-calculations';
+  MemoryFeatureAmountsPerPlanningUnitRepository,
+  FeatureAmountsPerPlanningUnitRepository,
+  FeatureAmountsPerPlanningUnitService,
+} from '@marxan/feature-amounts-per-planning-unit';
 import { FixtureType } from '@marxan/utils/tests/fixture-type';
 import { Test } from '@nestjs/testing';
 import { getRepositoryToken } from '@nestjs/typeorm';
@@ -43,11 +43,11 @@ const getFixtures = async () => {
         useValue: { find: findProjectMock },
       },
       {
-        provide: PuvsprCalculationsRepository,
-        useClass: MemoryPuvsprCalculationsRepository,
+        provide: FeatureAmountsPerPlanningUnitRepository,
+        useClass: MemoryFeatureAmountsPerPlanningUnitRepository,
       },
       {
-        provide: PuvsprCalculationsService,
+        provide: FeatureAmountsPerPlanningUnitService,
         useValue: {
           computeMarxanAmountPerPlanningUnit:
             computeMarxanAmountPerPlanningUnitMock,
@@ -60,8 +60,8 @@ const getFixtures = async () => {
   await sandbox.init();
 
   const sut = sandbox.get(ComputeArea);
-  const puvsprCalculationsRepo: MemoryPuvsprCalculationsRepository =
-    sandbox.get(PuvsprCalculationsRepository);
+  const featureAmountsPerPlanningUnitRepo: MemoryFeatureAmountsPerPlanningUnitRepository =
+    sandbox.get(FeatureAmountsPerPlanningUnitRepository);
 
   const expectedPuid = v4();
   const expectedAmount = 20;
@@ -106,7 +106,7 @@ const getFixtures = async () => {
       featureId: string,
     ) => {
       const savedCalculations =
-        await puvsprCalculationsRepo.getAmountPerPlanningUnitAndFeature(
+        await featureAmountsPerPlanningUnitRepo.getAmountPerPlanningUnitAndFeature(
           projectId,
           [featureId],
         );
@@ -124,7 +124,7 @@ const getFixtures = async () => {
     ) => {
       expect(computeMarxanAmountPerPlanningUnitMock).not.toHaveBeenCalled();
       const hasBeenSaved =
-        await puvsprCalculationsRepo.areAmountPerPlanningUnitAndFeatureSaved(
+        await featureAmountsPerPlanningUnitRepo.areAmountPerPlanningUnitAndFeatureSaved(
           projectId,
           featureId,
         );

api/apps/api/src/modules/scenarios-features/compute-area.service.ts

@@ -1,8 +1,8 @@
 import { ProjectSourcesEnum } from '@marxan/projects';
 import {
-  PuvsprCalculationsRepository,
-  PuvsprCalculationsService,
-} from '@marxan/puvspr-calculations';
+  FeatureAmountsPerPlanningUnitRepository,
+  FeatureAmountsPerPlanningUnitService,
+} from '@marxan/feature-amounts-per-planning-unit';
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
@@ -11,8 +11,8 @@ import { Project } from '../projects/project.api.entity';
 @Injectable()
 export class ComputeArea {
   constructor(
-    private readonly puvsprCalculationsRepo: PuvsprCalculationsRepository,
-    private readonly puvsprCalculations: PuvsprCalculationsService,
+    private readonly featureAmountsPerPlanningUnitRepo: FeatureAmountsPerPlanningUnitRepository,
+    private readonly featureAmountsPerPlanningUnit: FeatureAmountsPerPlanningUnitService,
     @InjectRepository(Project)
     private readonly projectsRepo: Repository<Project>,
   ) {}
@@ -26,20 +26,20 @@ export class ComputeArea {
     if (isLegacyProject) return;
 
     const alreadyComputed =
-      await this.puvsprCalculationsRepo.areAmountPerPlanningUnitAndFeatureSaved(
+      await this.featureAmountsPerPlanningUnitRepo.areAmountPerPlanningUnitAndFeatureSaved(
         projectId,
         featureId,
       );
 
     if (alreadyComputed) return;
 
     const amountPerPlanningUnitOfFeature =
-      await this.puvsprCalculations.computeMarxanAmountPerPlanningUnit(
+      await this.featureAmountsPerPlanningUnit.computeMarxanAmountPerPlanningUnit(
         featureId,
         scenarioId,
       );
 
-    return this.puvsprCalculationsRepo.saveAmountPerPlanningUnitAndFeature(
+    return this.featureAmountsPerPlanningUnitRepo.saveAmountPerPlanningUnitAndFeature(
       projectId,
       amountPerPlanningUnitOfFeature.map(
         ({ featureId, projectPuId, amount }) => ({

api/apps/api/src/modules/scenarios-features/scenario-features.module.ts

@@ -28,7 +28,7 @@ import {
 import { AccessControlModule } from '@marxan-api/modules/access-control';
 import { ComputeArea } from './compute-area.service';
 import { LegacyProjectImportRepositoryModule } from '../legacy-project-import/infra/legacy-project-import.repository.module';
-import { PuvsprCalculationsModule } from '@marxan/puvspr-calculations';
+import { FeatureAmountsPerPlanningUnitModule } from '@marxan/feature-amounts-per-planning-unit';
 import { SplitFeatureConfigMapper } from '../scenarios/specification/split-feature-config.mapper';
 import { FeatureHashModule } from '../features-hash/features-hash.module';
 import { SplitCreateFeatures } from './split/split-create-features.service';
@@ -47,7 +47,7 @@ import { Project } from '../projects/project.api.entity';
       DbConnections.geoprocessingDB,
     ),
     FeatureHashModule,
-    PuvsprCalculationsModule.for(DbConnections.geoprocessingDB),
+    FeatureAmountsPerPlanningUnitModule.for(DbConnections.geoprocessingDB),
     ProjectsModule,
     ApiEventsModule,
     IntersectWithPuModule,

api/apps/api/src/modules/scenarios/input-files/puvspr.dat.processor/puvspr.dat.legacy-project.ts

@@ -1,5 +1,5 @@
 import { GeoFeature } from '@marxan-api/modules/geo-features/geo-feature.api.entity';
-import { PuvsprCalculationsService } from '@marxan/puvspr-calculations';
+import { FeatureAmountsPerPlanningUnitService } from '@marxan/feature-amounts-per-planning-unit';
 import { Injectable } from '@nestjs/common';
 import { FeatureAmountPerPlanningUnitId, PuvsprDat } from './puvsrpr.dat';
 import { InjectRepository } from '@nestjs/typeorm';
@@ -8,7 +8,7 @@ import { Repository, In } from 'typeorm';
 @Injectable()
 export class PuvsprDatLegacyProject implements PuvsprDat {
   constructor(
-    private readonly puvsprCalculations: PuvsprCalculationsService,
+    private readonly featureAmountsPerPlanningUnit: FeatureAmountsPerPlanningUnitService,
     @InjectRepository(GeoFeature)
     private readonly featuresRepo: Repository<GeoFeature>,
   ) {}
@@ -57,7 +57,7 @@ export class PuvsprDatLegacyProject implements PuvsprDat {
   ): Promise<FeatureAmountPerPlanningUnitId[]> {
     const legacyFeaturesComputations = await Promise.all(
       featureIds.map((featureId) =>
-        this.puvsprCalculations.computeLegacyAmountPerPlanningUnit(
+        this.featureAmountsPerPlanningUnit.computeLegacyAmountPerPlanningUnit(
           featureId,
           scenarioId,
         ),
@@ -76,7 +76,7 @@ export class PuvsprDatLegacyProject implements PuvsprDat {
   ): Promise<FeatureAmountPerPlanningUnitId[]> {
     const marxanFeaturesComputations = await Promise.all(
       featureIds.map((featureId) =>
-        this.puvsprCalculations.computeMarxanAmountPerPlanningUnit(
+        this.featureAmountsPerPlanningUnit.computeMarxanAmountPerPlanningUnit(
           featureId,
           scenarioId,
         ),

api/apps/api/src/modules/scenarios/input-files/puvspr.dat.processor/puvspr.dat.marxan-project.ts

@@ -1,6 +1,6 @@
 import { DbConnections } from '@marxan-api/ormconfig.connections';
 import { ProjectsPuEntity } from '@marxan-jobs/planning-unit-geometry';
-import { PuvsprCalculationsRepository } from '@marxan/puvspr-calculations';
+import { FeatureAmountsPerPlanningUnitRepository } from '@marxan/feature-amounts-per-planning-unit';
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
@@ -9,7 +9,7 @@ import { FeatureAmountPerPlanningUnitId, PuvsprDat } from './puvsrpr.dat';
 @Injectable()
 export class PuvsprDatMarxanProject implements PuvsprDat {
   constructor(
-    private readonly puvsprCalculationsRepo: PuvsprCalculationsRepository,
+    private readonly featureAmountsPerPlanningUnitRepo: FeatureAmountsPerPlanningUnitRepository,
     @InjectRepository(ProjectsPuEntity, DbConnections.geoprocessingDB)
     private readonly projectsPusRepo: Repository<ProjectsPuEntity>,
   ) {}
@@ -19,7 +19,7 @@ export class PuvsprDatMarxanProject implements PuvsprDat {
     featureIds: string[],
   ): Promise<FeatureAmountPerPlanningUnitId[]> {
     const amountPerPlanningUnitOfFeature =
-      await this.puvsprCalculationsRepo.getAmountPerPlanningUnitAndFeature(
+      await this.featureAmountsPerPlanningUnitRepo.getAmountPerPlanningUnitAndFeature(
         projectId,
         featureIds,
       );

api/apps/api/src/modules/scenarios/input-files/puvspr.dat.processor/puvspr.dat.processor.module.ts

@@ -4,7 +4,7 @@ import { SpecificationAdaptersModule } from '@marxan-api/modules/specification/a
 import { DbConnections } from '@marxan-api/ormconfig.connections';
 import { ScenarioFeaturesData } from '@marxan/features';
 import { GeoFeatureGeometry } from '@marxan/geofeatures';
-import { PuvsprCalculationsModule } from '@marxan/puvspr-calculations';
+import { FeatureAmountsPerPlanningUnitModule } from '@marxan/feature-amounts-per-planning-unit';
 import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { Scenario } from '../../scenario.api.entity';
@@ -19,7 +19,7 @@ import { ProjectsPuEntity } from '@marxan-jobs/planning-unit-geometry';
 
 @Module({
   imports: [
-    PuvsprCalculationsModule.for(DbConnections.geoprocessingDB),
+    FeatureAmountsPerPlanningUnitModule.for(DbConnections.geoprocessingDB),
     FeatureHashModule,
     TypeOrmModule.forFeature([Scenario, GeoFeature]),
     TypeOrmModule.forFeature(

api/apps/api/src/modules/scenarios/input-files/puvspr.dat.processor/puvspr.dat.processor.ts

@@ -13,7 +13,7 @@ import {
 import { SpecificationRepository } from '@marxan-api/modules/specification/application/specification.repository';
 import { Specification } from '@marxan-api/modules/specification/domain';
 import { SingleSplitConfigFeatureValue } from '@marxan/features-hash';
-import { PuvsprCalculationsService } from '@marxan/puvspr-calculations';
+import { FeatureAmountsPerPlanningUnitService } from '@marxan/feature-amounts-per-planning-unit';
 import { SpecificationOperation } from '@marxan/specification';
 import { Injectable } from '@nestjs/common';
 import { InjectEntityManager } from '@nestjs/typeorm';
@@ -38,7 +38,7 @@ export class PuvsprDatProcessor {
     private readonly scenarioSpecificationsRepo: ScenarioSpecificationRepo,
     private readonly specificationsRepo: SpecificationRepository,
     private readonly geoFeatureMapper: GeoFeatureDtoMapper,
-    private readonly puvsprCalculationsService: PuvsprCalculationsService,
+    private readonly featureAmountsPerPlanningUnitService: FeatureAmountsPerPlanningUnitService,
     private readonly splitConfigHasher: SingleConfigFeatureValueHasher,
     private readonly splitFeatureConfigMapper: SplitFeatureConfigMapper,
     private readonly puvsprDatFactory: PuvrsprDatFactory,
@@ -58,7 +58,7 @@ export class PuvsprDatProcessor {
     const featuresIds = await this.getFeaturesIds(specification);
 
     const featuresIdsWithSpeciesId =
-      await this.puvsprCalculationsService.computeSpeciesId(
+      await this.featureAmountsPerPlanningUnitService.computeSpeciesId(
         featuresIds,
         scenarioId,
       );

api/apps/api/test/jest-e2e.json

@@ -88,8 +88,8 @@
     "@marxan/planning-units-grid": "<rootDir>/../../../libs/planning-units-grid/src",
     "@marxan/protected-areas/(.*)": "<rootDir>/../../../libs/protected-areas/src/$1",
     "@marxan/protected-areas": "<rootDir>/../../../libs/protected-areas/src",
-    "@marxan/puvspr-calculations/(.*)": "<rootDir>/../../../libs/puvspr-calculations/src/$1",
-    "@marxan/puvspr-calculations": "<rootDir>/../../../libs/puvspr-calculations/src",
+    "@marxan/feature-amounts-per-planning-unit/(.*)": "<rootDir>/../../../libs/feature-amounts-per-planning-unit/src/$1",
+    "@marxan/feature-amounts-per-planning-unit": "<rootDir>/../../../libs/feature-amounts-per-planning-unit/src",
     "@marxan/specification/(.*)": "<rootDir>/../../../libs/specification/src/$1",
     "@marxan/specification": "<rootDir>/../../../libs/specification/src",
     "@marxan/tiles/(.*)": "<rootDir>/../../../libs/tiles/src/$1",

api/apps/geoprocessing/src/export/pieces-exporters/pieces-exporters.module.ts

@@ -6,7 +6,7 @@ import {
   MarxanExecutionMetadataGeoEntity,
   OutputScenariosFeaturesDataGeoEntity,
 } from '@marxan/marxan-output';
-import { PuvsprCalculationsModule } from '@marxan/puvspr-calculations';
+import { FeatureAmountsPerPlanningUnitModule } from '@marxan/feature-amounts-per-planning-unit';
 import { Logger, Module } from '@nestjs/common';
 import { HttpModule } from '@nestjs/axios';
 import { TypeOrmModule } from '@nestjs/typeorm';
@@ -21,7 +21,7 @@ import { PlanningUnitsGridPieceExporter } from './planning-units-grid.piece-expo
 import { ProjectCustomFeaturesPieceExporter } from './project-custom-features.piece-exporter';
 import { ProjectCustomProtectedAreasPieceExporter } from './project-custom-protected-areas.piece-exporter';
 import { ProjectMetadataPieceExporter } from './project-metadata.piece-exporter';
-import { ProjectPuvsprCalculationsPieceExporter } from './project-puvspr-calculations.piece-exporter';
+import { ProjectFeatureAmountsPerPlanningUnitPieceExporter } from './project-feature-amounts-per-planning-unit.piece-exporter';
 import { ScenarioFeaturesDataPieceExporter } from './scenario-features-data.piece-exporter';
 import { ScenarioFeaturesSpecificationPieceExporter } from './scenario-features-specification.piece-exporter';
 import { ScenarioInputFolderPieceExporter } from './scenario-input-folder.piece-exporter';
@@ -45,7 +45,9 @@ import { ProjectCostSurfacesPieceExporter } from '@marxan-geoprocessing/export/p
       ],
       geoprocessingConnections.default,
     ),
-    PuvsprCalculationsModule.for(geoprocessingConnections.default.name!),
+    FeatureAmountsPerPlanningUnitModule.for(
+      geoprocessingConnections.default.name!,
+    ),
     HttpModule,
   ],
   providers: [
@@ -69,7 +71,7 @@ import { ProjectCostSurfacesPieceExporter } from '@marxan-geoprocessing/export/p
     ScenarioOutputFolderPieceExporter,
     ScenarioFeaturesSpecificationPieceExporter,
     MarxanExecutionMetadataPieceExporter,
-    ProjectPuvsprCalculationsPieceExporter,
+    ProjectFeatureAmountsPerPlanningUnitPieceExporter,
     Logger,
   ],
 })

api/apps/geoprocessing/src/export/pieces-exporters/project-puvspr-calculations.piece-exporter.ts → api/apps/geoprocessing/src/export/pieces-exporters/project-feature-amounts-per-planning-unit.piece-exporter.ts

@@ -4,12 +4,12 @@ import { ClonePiece, ExportJobInput, ExportJobOutput } from '@marxan/cloning';
 import { CloningFilesRepository } from '@marxan/cloning-files-repository';
 import { ComponentLocation, ResourceKind } from '@marxan/cloning/domain';
 import { ClonePieceRelativePathResolver } from '@marxan/cloning/infrastructure/clone-piece-data';
-import { ProjectPuvsprCalculationsContent } from '@marxan/cloning/infrastructure/clone-piece-data/project-puvspr-calculations';
+import { ProjectFeatureAmountsPerPlanningUnitContent } from '@marxan/cloning/infrastructure/clone-piece-data/project-feature-amounts-per-planning-unit';
 import { SingleConfigFeatureValueStripped } from '@marxan/features-hash';
 import {
   FeatureAmountPerProjectPlanningUnit,
-  PuvsprCalculationsRepository,
-} from '@marxan/puvspr-calculations';
+  FeatureAmountsPerPlanningUnitRepository,
+} from '@marxan/feature-amounts-per-planning-unit';
 import { SpecificationOperation } from '@marxan/specification';
 import { Injectable, Logger } from '@nestjs/common';
 import { InjectEntityManager, InjectRepository } from '@nestjs/typeorm';
@@ -36,16 +36,16 @@ type FeatureByIdMap = Record<string, Omit<FeaturesSelectResult, 'id'>>;
 
 @Injectable()
 @PieceExportProvider()
-export class ProjectPuvsprCalculationsPieceExporter
+export class ProjectFeatureAmountsPerPlanningUnitPieceExporter
   implements ExportPieceProcessor
 {
   private readonly logger: Logger = new Logger(
-    ProjectPuvsprCalculationsPieceExporter.name,
+    ProjectFeatureAmountsPerPlanningUnitPieceExporter.name,
   );
 
   constructor(
     private readonly fileRepository: CloningFilesRepository,
-    private readonly puvsprCalculationsRepo: PuvsprCalculationsRepository,
+    private readonly featureAmountsPerPlanningUnitRepo: FeatureAmountsPerPlanningUnitRepository,
     @InjectRepository(ProjectsPuEntity)
     private readonly projectPusRepo: Repository<ProjectsPuEntity>,
     @InjectEntityManager(geoprocessingConnections.apiDB)
@@ -54,7 +54,7 @@ export class ProjectPuvsprCalculationsPieceExporter
 
   isSupported(piece: ClonePiece, kind: ResourceKind): boolean {
     return (
-      piece === ClonePiece.ProjectPuvsprCalculations &&
+      piece === ClonePiece.ProjectFeatureAmountsPerPlanningUnit &&
       kind === ResourceKind.Project
     );
   }
@@ -63,7 +63,7 @@ export class ProjectPuvsprCalculationsPieceExporter
     const projectId = input.resourceId;
 
     const featureAmountPerPlanningUnit =
-      await this.puvsprCalculationsRepo.getAmountPerPlanningUnitAndFeatureInProject(
+      await this.featureAmountsPerPlanningUnitRepo.getAmountPerPlanningUnitAndFeatureInProject(
         projectId,
       );
 
@@ -76,13 +76,13 @@ export class ProjectPuvsprCalculationsPieceExporter
     const projectFeaturesGeoOperations =
       await this.getProjectFeaturesGeoOperations(projectId);
 
-    const fileContent: ProjectPuvsprCalculationsContent = {
-      puvsprCalculations: featuresAmountPerPlanningUnitParsed,
+    const fileContent: ProjectFeatureAmountsPerPlanningUnitContent = {
+      featureAmountsPerPlanningUnit: featuresAmountPerPlanningUnitParsed,
       projectFeaturesGeoOperations,
     };
 
     const relativePath = ClonePieceRelativePathResolver.resolveFor(
-      ClonePiece.ProjectPuvsprCalculations,
+      ClonePiece.ProjectFeatureAmountsPerPlanningUnit,
     );
 
     const outputFile = await this.fileRepository.saveCloningFile(
@@ -92,7 +92,7 @@ export class ProjectPuvsprCalculationsPieceExporter
     );
 
     if (isLeft(outputFile)) {
-      const errorMessage = `${ProjectPuvsprCalculationsPieceExporter.name} - Project - couldn't save file - ${outputFile.left.description}`;
+      const errorMessage = `${ProjectFeatureAmountsPerPlanningUnitPieceExporter.name} - Project - couldn't save file - ${outputFile.left.description}`;
       this.logger.error(errorMessage);
       throw new Error(errorMessage);
     }