refactor(projects): move additional request info to single dto

api/apps/api/src/modules/geo-features/geo-feature-property-sets.service.ts

@@ -9,6 +9,7 @@ import { GeoFeatureSetSpecification } from './dto/geo-feature-set-specification.
 import { GeoFeature } from './geo-feature.api.entity';
 import { GeoFeaturePropertySet } from './geo-feature.geo.entity';
 import { DbConnections } from '@marxan-api/ormconfig.connections';
+import { BBox } from 'geojson';
 
 @Injectable()
 export class GeoFeaturePropertySetService {
@@ -23,24 +24,24 @@ export class GeoFeaturePropertySetService {
 
   getFeaturePropertySetsForFeatures(
     geoFeatureIds: string[],
-    forProject?: Project | null | undefined,
+    withinBBox?: BBox | null,
   ): Promise<GeoFeaturePropertySet[]> {
     const query = this.geoFeaturePropertySetsRepository
       .createQueryBuilder('propertySets')
       .distinct(true)
       .where(`propertySets.featureId IN (:...ids)`, { ids: geoFeatureIds });
 
-    if (forProject) {
+    if (withinBBox) {
       query.andWhere(
         `st_intersects(
         st_makeenvelope(:xmin, :ymin, :xmax, :ymax, 4326),
         "propertySets".bbox
       )`,
         {
-          xmin: forProject.bbox[1],
-          ymin: forProject.bbox[3],
-          xmax: forProject.bbox[0],
-          ymax: forProject.bbox[2],
+          xmin: withinBBox[1],
+          ymin: withinBBox[3],
+          xmax: withinBBox[0],
+          ymax: withinBBox[2],
         },
       );
     }
@@ -111,7 +112,7 @@ export class GeoFeaturePropertySetService {
     Logger.debug(inspect(featuresInSpecification));
     const metadataForFeaturesInSpecification = await this.getFeaturePropertySetsForFeatures(
       idsOfFeaturesInSpecification,
-      project,
+      project?.bbox,
     );
     const featuresInSpecificationWithPropertiesMetadata = this.extendGeoFeaturesWithPropertiesFromPropertySets(
       featuresInSpecification,

api/apps/api/src/modules/geo-features/geo-features-request-info.ts

@@ -0,0 +1,11 @@
+import { AppInfoDTO } from '@marxan-api/dto/info.dto';
+import { BBox } from 'geojson';
+
+export interface GeoFeaturesRequestInfo extends AppInfoDTO {
+  params?: {
+    featureClassAndAliasFilter?: string;
+    projectId?: string;
+    bbox?: BBox;
+    ids?: string[];
+  };
+}

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

@@ -29,6 +29,7 @@ import { DbConnections } from '@marxan-api/ormconfig.connections';
 import { GeometrySource } from './geometry-source.enum';
 import { v4 } from 'uuid';
 import { UploadShapefileDTO } from '../projects/dto/upload-shapefile.dto';
+import { GeoFeaturesRequestInfo } from './geo-features-request-info';
 
 const geoFeatureFilterKeyNames = [
   'featureClassName',
@@ -45,16 +46,12 @@ type GeoFeatureFilterKeys = keyof Pick<
 >;
 type GeoFeatureFilters = Record<GeoFeatureFilterKeys, string[]>;
 
-type ServiceRequestInfo = AppInfoDTO & {
-  forProject?: Project;
-};
-
 @Injectable()
 export class GeoFeaturesService extends AppBaseService<
   GeoFeature,
   GeoFeatureSetSpecification,
   GeoFeatureSetSpecification,
-  ServiceRequestInfo
+  GeoFeaturesRequestInfo
 > {
   constructor(
     @InjectRepository(GeoFeatureGeometry, DbConnections.geoprocessingDB)
@@ -99,7 +96,7 @@ export class GeoFeaturesService extends AppBaseService<
   setFilters(
     query: SelectQueryBuilder<GeoFeature>,
     filters: GeoFeatureFilters,
-    info?: ServiceRequestInfo,
+    info?: GeoFeaturesRequestInfo,
   ): SelectQueryBuilder<GeoFeature> {
     this._processBaseFilters<GeoFeatureFilters>(
       query,
@@ -115,7 +112,7 @@ export class GeoFeaturesService extends AppBaseService<
   async extendFindAllQuery(
     query: SelectQueryBuilder<GeoFeature>,
     fetchSpecification: FetchSpecification,
-    info: ServiceRequestInfo,
+    info: GeoFeaturesRequestInfo,
   ): Promise<SelectQueryBuilder<GeoFeature>> {
     /**
      * We should either list only "public" features (i.e. they are not from a
@@ -210,7 +207,7 @@ export class GeoFeaturesService extends AppBaseService<
   async extendFindAllResults(
     entitiesAndCount: [any[], number],
     fetchSpecification?: DeepReadonly<FetchSpecification>,
-    info?: ServiceRequestInfo,
+    info?: GeoFeaturesRequestInfo,
   ): Promise<[any[], number]> {
     /**
      * Short-circuit if there's no result to extend, or if the API client has
@@ -239,7 +236,7 @@ export class GeoFeaturesService extends AppBaseService<
     );
 
     const entitiesWithProperties = await this.geoFeaturesPropertySet
-      .getFeaturePropertySetsForFeatures(geoFeatureIds, info?.forProject)
+      .getFeaturePropertySetsForFeatures(geoFeatureIds, info?.params?.bbox)
       .then((results) => {
         return this.geoFeaturesPropertySet.extendGeoFeaturesWithPropertiesFromPropertySets(
           entitiesAndCount[0],

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

@@ -1 +1,3 @@
 export { FeaturesCalculated } from './processing';
+export { GeoFeaturesService } from './geo-features.service';
+export { GeoFeaturesRequestInfo } from './geo-features-request-info';

api/apps/api/src/modules/projects/project-requests-info.ts

@@ -0,0 +1,11 @@
+import { AppInfoDTO } from '@marxan-api/dto/info.dto';
+import { BBox } from 'geojson';
+
+export interface ProjectsRequest extends AppInfoDTO {
+  params?: {
+    featureClassAndAliasFilter?: string;
+    projectId?: string;
+    bbox?: BBox;
+    nameSearch?: string;
+  } & AppInfoDTO['params'];
+}

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

@@ -24,10 +24,11 @@ import {
 } from './planning-areas';
 import { UsersProjectsApiEntity } from './control-level/users-projects.api.entity';
 import { Roles } from '@marxan-api/modules/users/role.api.entity';
-import { AppInfoDTO } from '@marxan-api/dto/info.dto';
 import { DbConnections } from '@marxan-api/ormconfig.connections';
 import { ProtectedArea } from '@marxan/protected-areas';
 
+import { ProjectsRequest } from './project-requests-info';
+
 const projectFilterKeyNames = [
   'name',
   'organizationId',
@@ -41,18 +42,12 @@ type ProjectFilterKeys = keyof Pick<
 >;
 type ProjectFilters = Record<ProjectFilterKeys, string[]>;
 
-export type ProjectsInfoDTO = AppInfoDTO & {
-  params?: {
-    nameSearch?: string;
-  };
-};
-
 @Injectable()
 export class ProjectsCrudService extends AppBaseService<
   Project,
   CreateProjectDTO,
   UpdateProjectDTO,
-  ProjectsInfoDTO
+  ProjectsRequest
 > {
   constructor(
     @InjectRepository(Project)
@@ -131,7 +126,7 @@ export class ProjectsCrudService extends AppBaseService<
   setFilters(
     query: SelectQueryBuilder<Project>,
     filters: ProjectFilters,
-    _info?: ProjectsInfoDTO,
+    _info?: ProjectsRequest,
   ): SelectQueryBuilder<Project> {
     this._processBaseFilters<ProjectFilters>(
       query,
@@ -143,7 +138,7 @@ export class ProjectsCrudService extends AppBaseService<
 
   async setDataCreate(
     create: CreateProjectDTO,
-    info?: ProjectsInfoDTO,
+    info?: ProjectsRequest,
   ): Promise<Project> {
     assertDefined(info?.authenticatedUser?.id);
     /**
@@ -180,7 +175,7 @@ export class ProjectsCrudService extends AppBaseService<
   async actionAfterCreate(
     model: Project,
     createModel: CreateProjectDTO,
-    _info?: ProjectsInfoDTO,
+    _info?: ProjectsRequest,
   ): Promise<void> {
     if (
       createModel.planningUnitAreakm2 &&
@@ -211,7 +206,7 @@ export class ProjectsCrudService extends AppBaseService<
   async actionAfterUpdate(
     model: Project,
     createModel: UpdateProjectDTO,
-    _info?: ProjectsInfoDTO,
+    _info?: ProjectsRequest,
   ): Promise<void> {
     /**
      * @deprecated Workers and jobs should be move to the new functionality
@@ -243,7 +238,7 @@ export class ProjectsCrudService extends AppBaseService<
   async setDataUpdate(
     model: Project,
     update: UpdateProjectDTO,
-    _?: ProjectsInfoDTO,
+    _?: ProjectsRequest,
   ): Promise<Project> {
     const bbox = await this.planningAreasService.getPlanningAreaBBox({
       ...update,
@@ -262,7 +257,7 @@ export class ProjectsCrudService extends AppBaseService<
   async extendGetByIdResult(
     entity: Project,
     _fetchSpecification?: FetchSpecification,
-    _info?: ProjectsInfoDTO,
+    _info?: ProjectsRequest,
   ): Promise<Project> {
     const ids: MultiplePlanningAreaIds = entity;
     const idAndName = await this.planningAreasService.getPlanningAreaIdAndName(
@@ -289,7 +284,7 @@ export class ProjectsCrudService extends AppBaseService<
   extendGetByIdQuery(
     query: SelectQueryBuilder<Project>,
     fetchSpecification?: FetchSpecification,
-    info?: ProjectsInfoDTO,
+    info?: ProjectsRequest,
   ): SelectQueryBuilder<Project> {
     const loggedUser = Boolean(info?.authenticatedUser);
     query.leftJoin(
@@ -316,7 +311,7 @@ export class ProjectsCrudService extends AppBaseService<
   async extendFindAllQuery(
     query: SelectQueryBuilder<Project>,
     fetchSpecification: FetchSpecification,
-    info?: ProjectsInfoDTO,
+    info?: ProjectsRequest,
   ): Promise<SelectQueryBuilder<Project>> {
     const loggedUser = Boolean(info?.authenticatedUser);
 
@@ -382,7 +377,7 @@ export class ProjectsCrudService extends AppBaseService<
   async extendFindAllResults(
     entitiesAndCount: [Project[], number],
     _fetchSpecification?: FetchSpecification,
-    _info?: ProjectsInfoDTO,
+    _info?: ProjectsRequest,
   ): Promise<[Project[], number]> {
     const extendedEntities: Promise<Project>[] = entitiesAndCount[0].map(
       (entity) => this.extendGetByIdResult(entity),

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

@@ -1,10 +1,9 @@
 import { Injectable } from '@nestjs/common';
 import { FetchSpecification } from 'nestjs-base-service';
-import { AppInfoDTO } from '@marxan-api/dto/info.dto';
 
 import { GeoFeaturesService } from '@marxan-api/modules/geo-features/geo-features.service';
 
-import { ProjectsCrudService, ProjectsInfoDTO } from './projects-crud.service';
+import { ProjectsCrudService } from './projects-crud.service';
 import { JobStatusService } from './job-status';
 import { ProtectedAreasFacade } from './protected-areas/protected-areas.facade';
 import { Project } from './project.api.entity';
@@ -14,6 +13,8 @@ import { PlanningAreasService } from './planning-areas';
 import { PlanningUnitGridService, ProjectId } from './planning-unit-grid';
 import { assertDefined } from '@marxan/utils';
 
+import { ProjectsRequest } from './project-requests-info';
+
 export { validationFailed } from './planning-areas';
 
 @Injectable()
@@ -29,24 +30,32 @@ export class ProjectsService {
 
   async findAllGeoFeatures(
     fetchSpec: FetchSpecification,
-    appInfo?: AppInfoDTO,
+    appInfo?: ProjectsRequest,
   ) {
+    const project = await this.assertProject(appInfo?.params?.projectId);
     // /ACL slot/
-    return this.geoCrud.findAllPaginated(fetchSpec, appInfo);
+    return this.geoCrud.findAllPaginated(fetchSpec, {
+      ...appInfo,
+      params: {
+        projectId: project.id,
+        bbox: project.bbox,
+        ...appInfo,
+      },
+    });
   }
 
-  async findAll(fetchSpec: FetchSpecification, info?: ProjectsInfoDTO) {
+  async findAll(fetchSpec: FetchSpecification, info?: ProjectsRequest) {
     return this.projectsCrud.findAllPaginated(fetchSpec, info);
   }
 
-  async findAllPublic(fetchSpec: FetchSpecification, info?: ProjectsInfoDTO) {
+  async findAllPublic(fetchSpec: FetchSpecification, info?: ProjectsRequest) {
     // /ACL slot/
     return this.projectsCrud.findAllPaginated(fetchSpec, info);
   }
 
   async findOne(
     id: string,
-    info?: ProjectsInfoDTO,
+    info?: ProjectsRequest,
   ): Promise<Project | undefined> {
     // /ACL slot/
     try {
@@ -58,7 +67,7 @@ export class ProjectsService {
   }
 
   // TODO debt: shouldn't use API's DTO - avoid relating service to given access layer (Rest)
-  async create(input: CreateProjectDTO, info: AppInfoDTO) {
+  async create(input: CreateProjectDTO, info: ProjectsRequest) {
     assertDefined(info.authenticatedUser);
     const project = await this.projectsCrud.create(input, info);
     await this.projectsCrud.assignCreatorRole(
@@ -81,7 +90,7 @@ export class ProjectsService {
   async addShapeFor(
     projectId: string,
     file: Express.Multer.File,
-    info: ProjectsInfoDTO,
+    info: ProjectsRequest,
   ): Promise<Error | undefined> /** Debt: move to Either<ErrorSymbol,Ok> */ {
     // /ACL slot - can?/
     try {
@@ -99,7 +108,7 @@ export class ProjectsService {
     return this.gridService.setPlanningUnitGrid(new ProjectId(projectId), file);
   }
 
-  async getJobStatusFor(projectId: string, info: ProjectsInfoDTO) {
+  async getJobStatusFor(projectId: string, info: ProjectsRequest) {
     await this.projectsCrud.getById(projectId, undefined, info);
     return await this.jobStatusService.getJobStatusFor(projectId);
   }
@@ -111,4 +120,9 @@ export class ProjectsService {
   savePlanningAreaFromShapefile = this.planningAreaService.savePlanningAreaFromShapefile.bind(
     this.planningAreaService,
   );
+
+  private async assertProject(projectId = '') {
+    /** App Base Service throws 404 */
+    return await this.projectsCrud.getById(projectId);
+  }
 }