feat(project): upload user feature

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

@@ -327,8 +327,6 @@ export class GeoFeaturesService extends AppBaseService<
         'An error occurred creating features for shapefile (changes have been rolled back)',
         String(err),
       );
-
-      console.log(err);
     } finally {
       // you need to release a queryRunner which was manually instantiated
       await apiQueryRunner.release();

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

@@ -52,10 +52,10 @@ import { JobStatusSerializer } from './dto/job-status.serializer';
 import { PlanningAreaResponseDto } from './dto/planning-area-response.dto';
 import { isLeft } from 'fp-ts/Either';
 import { ShapefileUploadResponse } from './dto/project-upload-shapefile.dto';
-import { ShapefileService } from '@marxan-geoprocessing/modules/shapefiles/shapefiles.service';
 import { UploadShapefileDTO } from './dto/upload-shapefile.dto';
 import { GeoFeaturesService } from '../geo-features/geo-features.service';
 import { AppConfig } from '@marxan-api/utils/config.utils';
+import { ShapefileService } from '@marxan/shapefile-converter';
 
 @UseGuards(JwtAuthGuard)
 @ApiBearerAuth()
@@ -216,7 +216,7 @@ export class ProjectsController {
   @ApiOkResponse({ type: ShapefileUploadResponse })
   @Post(`:id/features/shapefile`)
   @UseInterceptors(
-    FileInterceptor('shapefile', {
+    FileInterceptor('file', {
       ...uploadOptions,
       limits: {
         fileSize: (() =>

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

@@ -11,7 +11,6 @@ import { CountriesModule } from '@marxan-api/modules/countries/countries.module'
 import { PlanningUnitsModule } from '@marxan-api/modules/planning-units/planning-units.module';
 import { GeoFeaturesModule } from '@marxan-api/modules/geo-features/geo-features.module';
 import { ApiEventsModule } from '@marxan-api/modules/api-events/api-events.module';
-import { ShapefilesModule } from '@marxan-geoprocessing/modules/shapefiles/shapefiles.module';
 import { ProtectedAreasModule } from './protected-areas/protected-areas.module';
 import { ProjectsService } from './projects.service';
 import { GeoFeatureSerializer } from './dto/geo-feature.serializer';
@@ -23,6 +22,7 @@ import { PlanningAreasModule } from './planning-areas';
 import { UsersProjectsApiEntity } from './control-level/users-projects.api.entity';
 import { ProjectsListingController } from './projects-listing.controller';
 import { ProjectDetailsController } from './project-details.controller';
+import { ShapefilesModule } from '@marxan/shapefile-converter';
 
 @Module({
   imports: [

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

@@ -64,6 +64,8 @@
     "@marxan/geofeature-calculations/(.*)": "<rootDir>/../../../libs/geofeature-calculations/src/$1",
     "@marxan/geofeature-calculations": "<rootDir>/../../../libs/geofeature-calculations/src",
     "@marxan/iucn/(.*)": "<rootDir>/../../../libs/iucn/src/$1",
-    "@marxan/iucn": "<rootDir>/../../../libs/iucn/src"
+    "@marxan/iucn": "<rootDir>/../../../libs/iucn/src",
+    "@marxan/shapefile-converter/(.*)": "<rootDir>/../../../libs/shapefile-converter/src/$1",
+    "@marxan/shapefile-converter": "<rootDir>/../../../libs/shapefile-converter/src"
   }
 }

api/apps/api/test/upload-feature/upload-feature.e2e-spec.ts

@@ -0,0 +1,17 @@
+import { FixtureType } from '@marxan/utils/tests/fixture-type';
+import { getFixtures } from './upload-feature.fixtures';
+
+let fixtures: FixtureType<typeof getFixtures>;
+
+beforeEach(async () => {
+  fixtures = await getFixtures();
+});
+
+afterEach(async () => {
+  await fixtures?.cleanup();
+});
+
+test(`custom feature upload`, async () => {
+  const result = await fixtures.WhenUploadingCustomFeature();
+  await fixtures.ThenGeoFeaturesAreCreated(result);
+});

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

@@ -0,0 +1,75 @@
+import { bootstrapApplication } from '../utils/api-application';
+import { GivenUserIsLoggedIn } from '../steps/given-user-is-logged-in';
+import { GivenProjectExists } from '../steps/given-project';
+
+import { GeoFeature } from '@marxan-api/modules/geo-features/geo-feature.api.entity';
+import { getRepositoryToken } from '@nestjs/typeorm';
+import { Repository } from 'typeorm';
+import * as request from 'supertest';
+
+export const getFixtures = async () => {
+  const app = await bootstrapApplication();
+  const token = await GivenUserIsLoggedIn(app);
+  const { projectId, cleanup } = await GivenProjectExists(
+    app,
+    token,
+    {
+      name: `Project ${Date.now()}`,
+      countryCode: undefined!,
+    },
+    {
+      name: `Organization ${Date.now()}`,
+    },
+  );
+  const customFeatureName = `User custom feature ${Date.now()}`;
+  const customFeatureTag = `bioregional`;
+  const customFeatureDesc = `User custom feature desc`;
+
+  const geoFeaturesApiRepo: Repository<GeoFeature> = app.get(
+    getRepositoryToken(GeoFeature),
+  );
+
+  return {
+    cleanup: async () => {
+      await geoFeaturesApiRepo.delete({
+        projectId,
+      });
+      await cleanup();
+      await app.close();
+    },
+    WhenUploadingCustomFeature: async () =>
+      request(app.getHttpServer())
+        .post(`/api/v1/projects/${projectId}/features/shapefile`)
+        .set('Authorization', `Bearer ${token}`)
+        .attach(`file`, __dirname + `/wetlands.zip`)
+        .field({
+          name: customFeatureName,
+          type: customFeatureTag,
+          description: customFeatureDesc,
+        }),
+    ThenGeoFeaturesAreCreated: async (result: request.Response) => {
+      expect(result.body).toEqual({
+        success: true,
+      });
+      expect(
+        await geoFeaturesApiRepo.find({
+          where: {
+            projectId,
+          },
+        }),
+      ).toEqual([
+        {
+          id: expect.any(String),
+          featureClassName: customFeatureName,
+          description: customFeatureDesc,
+          alias: null,
+          propertyName: null,
+          intersection: null,
+          tag: customFeatureTag,
+          creationStatus: `done`,
+          projectId,
+        },
+      ]);
+    },
+  };
+};

api/apps/geoprocessing/src/decoratos/shapefile.decorator.ts

@@ -5,7 +5,7 @@ import {
   ApiOkResponse,
   ApiOperation,
 } from '@nestjs/swagger';
-import { ShapefileGeoJSONResponseDTO } from '../modules/shapefiles/dto/shapefile.geojson.response.dto';
+import { ShapefileGeoJSONResponseDTO } from '../types/shapefile.geojson.response.dto';
 
 export function ApiConsumesShapefile() {
   return applyDecorators(

api/apps/geoprocessing/src/modules/planning-area/planning-area.module.ts

@@ -1,6 +1,6 @@
 import { Module } from '@nestjs/common';
 import { PlanningAreaRepositoryModule } from '@marxan/planning-area-repository';
-import { ShapefilesModule } from '@marxan-geoprocessing/modules/shapefiles/shapefiles.module';
+import { ShapefilesModule } from '@marxan/shapefile-converter';
 import { geoprocessingConnections } from '@marxan-geoprocessing/ormconfig';
 import { PlanningAreaService } from './planning-area.service';
 import { PlanningAreaController } from './planning-area.controller';

api/apps/geoprocessing/src/modules/planning-area/planning-area.service.ts

@@ -2,7 +2,7 @@ import { Injectable, Logger } from '@nestjs/common';
 import { GeoJSON } from 'geojson';
 import * as uuid from 'uuid';
 import { CustomPlanningAreaRepository } from '@marxan/planning-area-repository';
-import { ShapefileService } from '@marxan-geoprocessing/modules/shapefiles/shapefiles.service';
+import { ShapefileService } from '@marxan/shapefile-converter';
 import { GarbageCollectorConfig } from '@marxan-geoprocessing/modules/planning-area/garbage-collector-config';
 import { SaveGeoJsonResult } from '@marxan/planning-area-repository/custom-planning-area.repository';
 

api/apps/geoprocessing/src/modules/planning-units/planning-units.controller.ts

@@ -17,9 +17,9 @@ import {
   tileSpecification,
 } from './planning-units.service';
 import { apiGlobalPrefixes } from '@marxan-geoprocessing/api.config';
-import { ShapefileService } from '../shapefiles/shapefiles.service';
+import { ShapefileService } from '@marxan/shapefile-converter';
 import { ApiConsumesShapefile } from '../../decoratos/shapefile.decorator';
-import { ShapefileGeoJSONResponseDTO } from '../shapefiles/dto/shapefile.geojson.response.dto';
+import { ShapefileGeoJSONResponseDTO } from '../../types/shapefile.geojson.response.dto';
 
 import {
   ApiOperation,

api/apps/geoprocessing/src/modules/planning-units/planning-units.module.ts

@@ -2,9 +2,8 @@ import { Logger, Module } from '@nestjs/common';
 import { TileModule } from '@marxan-geoprocessing/modules/tile/tile.module';
 import { PlanningUnitsProcessor } from './planning-units.worker';
 import { PlanningUnitsController } from './planning-units.controller';
-import { ShapefileService } from '../shapefiles/shapefiles.service';
+import { ShapefileService, FileService } from '@marxan/shapefile-converter';
 import { PlanningUnitsService } from './planning-units.service';
-import { FileService } from '../files/files.service';
 import { WorkerModule } from '../worker';
 
 @Module({

api/apps/geoprocessing/src/modules/protected-areas/worker/protected-area-processor.spec.ts

@@ -5,7 +5,7 @@ import { Job } from 'bullmq';
 import { FakeGeometryExtractor } from './__mocks__/geometry-extractor';
 import { createJob } from './__mocks__/job';
 
-import { ShapefileService } from '../../shapefiles/shapefiles.service';
+import { ShapefileService } from '@marxan/shapefile-converter';
 import { ProtectedAreaProcessor } from './protected-area-processor';
 import { GeometryExtractor } from './geometry-extractor';
 import { ProtectedAreasJobInput } from './worker-input';

api/apps/geoprocessing/src/modules/protected-areas/worker/protected-area-processor.ts

@@ -4,7 +4,7 @@ import { Job } from 'bullmq';
 
 import { WorkerProcessor } from '../../worker';
 import { ProtectedAreasJobInput } from './worker-input';
-import { ShapefileService } from '../../shapefiles/shapefiles.service';
+import { ShapefileService } from '@marxan/shapefile-converter';
 import { ProtectedArea } from '../protected-areas.geo.entity';
 import { GeoJSON } from 'geojson';
 import { GeometryExtractor } from './geometry-extractor';

api/apps/geoprocessing/src/modules/protected-areas/worker/protected-area-worker.module.ts

@@ -2,7 +2,7 @@ import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { CqrsModule } from '@nestjs/cqrs';
 import { WorkerModule } from '../../worker';
-import { ShapefilesModule } from '../../shapefiles/shapefiles.module';
+import { ShapefilesModule } from '@marxan/shapefile-converter';
 import { ProtectedArea } from '../protected-areas.geo.entity';
 
 import { ProtectedAreaProcessor } from './protected-area-processor';

api/apps/geoprocessing/src/modules/surface-cost/adapters/shapefile-converter.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import { GeoJSON } from 'geojson';
-import { ShapefileService } from '../../shapefiles/shapefiles.service';
+import { ShapefileService } from '@marxan/shapefile-converter';
 
 import { CostSurfaceJobInput } from '../cost-surface-job-input';
 import { ShapefileConverterPort } from '../ports/shapefile-converter/shapefile-converter.port';

api/apps/geoprocessing/src/modules/surface-cost/surface-cost.module.ts

@@ -3,7 +3,7 @@ import { TypeOrmModule } from '@nestjs/typeorm';
 import { ScenariosPlanningUnitGeoEntity } from '@marxan/scenarios-planning-unit';
 import { CqrsModule } from '@nestjs/cqrs';
 import { WorkerModule } from '@marxan-geoprocessing/modules/worker';
-import { ShapefilesModule } from '@marxan-geoprocessing/modules/shapefiles/shapefiles.module';
+import { ShapefilesModule } from '@marxan/shapefile-converter';
 
 import { SurfaceCostProcessor } from './application/surface-cost-processor';
 import { SurfaceCostWorker } from './application/surface-cost-worker';

api/apps/geoprocessing/src/utils/__mocks__/shapefile-service.ts

@@ -1,5 +1,5 @@
 import { Injectable } from '@nestjs/common';
-import { ShapefileService } from '@marxan-geoprocessing/modules/shapefiles/shapefiles.service';
+import { ShapefileService } from '@marxan/shapefile-converter';
 
 @Injectable()
 export class FakeShapefileService

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

@@ -37,6 +37,8 @@
     "@marxan/geofeature-calculations/(.*)": "<rootDir>/../../libs/geofeature-calculations/src/$1",
     "@marxan/geofeature-calculations": "<rootDir>/../../libs/geofeature-calculations/src",
     "@marxan/iucn/(.*)": "<rootDir>/../../libs/iucn/src/$1",
-    "@marxan/iucn": "<rootDir>/../../libs/iucn/src"
+    "@marxan/iucn": "<rootDir>/../../libs/iucn/src",
+    "@marxan/shapefile-converter/(.*)": "<rootDir>/../../libs/shapefile-converter/src/$1",
+    "@marxan/shapefile-converter": "<rootDir>/../../libs/shapefile-converter/src"
   }
 }

api/libs/shapefile-converter/src/index.ts

@@ -0,0 +1,4 @@
+export { FilesModule } from './files/files.module';
+export { FileService } from './files/files.service';
+export { ShapefilesModule } from './shapefiles/shapefiles.module';
+export { ShapefileService } from './shapefiles/shapefiles.service';

api/libs/shapefile-converter/tsconfig.lib.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "../../dist/libs/shapefile-converter"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}

api/nest-cli.json

@@ -160,6 +160,15 @@
       "compilerOptions": {
         "tsConfigPath": "libs/iucn/tsconfig.lib.json"
       }
+    },
+    "shapefile-converter": {
+      "type": "library",
+      "root": "libs/shapefile-converter",
+      "entryFile": "index",
+      "sourceRoot": "libs/shapefile-converter/src",
+      "compilerOptions": {
+        "tsConfigPath": "libs/shapefile-converter/tsconfig.lib.json"
+      }
     }
   }
 }

api/package.json

@@ -195,7 +195,9 @@
       "@marxan/geofeature-calculations/(.*)": "<rootDir>/libs/geofeature-calculations/src/$1",
       "@marxan/geofeature-calculations": "<rootDir>/libs/geofeature-calculations/src",
       "@marxan/iucn/(.*)": "<rootDir>/libs/iucn/src/$1",
-      "@marxan/iucn": "<rootDir>/libs/iucn/src"
+      "@marxan/iucn": "<rootDir>/libs/iucn/src",
+      "@marxan/shapefile-converter/(.*)": "<rootDir>/libs/shapefile-converter/src/$1",
+      "@marxan/shapefile-converter": "<rootDir>/libs/shapefile-converter/src"
     }
   }
-}
+}

api/tsconfig.json

@@ -108,6 +108,12 @@
       ],
       "@marxan/iucn/*": [
         "libs/iucn/src/*"
+      ],
+      "@marxan/shapefile-converter": [
+        "libs/shapefile-converter/src"
+      ],
+      "@marxan/shapefile-converter/*": [
+        "libs/shapefile-converter/src/*"
       ]
     }
   },