[TM-1398] Merge tree species epic

.env.local.sample

@@ -2,6 +2,7 @@ USER_SERVICE_PORT=4010
 JOB_SERVICE_PORT=4020
 RESEARCH_SERVICE_PORT=4030
 UNIFIED_DATABASE_SERVICE_PORT=4040
+ENTITY_SERVICE_PORT=4050
 
 DB_HOST=localhost
 DB_PORT=3360

.github/workflows/deploy-service.yml

@@ -18,8 +18,9 @@ on:
         required: true
         options:
           - job-service
-          - research-service
           - user-service
+          - entity-service
+          - research-service
           - unified-database-service
       env:
         description: 'Deployment target environment'
@@ -70,7 +71,7 @@ jobs:
           : # Don't build the base image with NODE_ENV because it'll limit the packages that are installed
           docker build -t terramatch-microservices-base:nx-base .
           SERVICE_IMAGE=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
-          docker build --build-arg NODE_ENV=production --build-arg BUILD_FLAG=--prod -f apps/${{ inputs.service }}/Dockerfile -t $SERVICE_IMAGE .
+          docker build --build-arg NODE_ENV=production --build-arg BUILD_FLAG='--prod --verbose' -f apps/${{ inputs.service }}/Dockerfile -t $SERVICE_IMAGE .
           docker push $SERVICE_IMAGE
           echo "image=$SERVICE_IMAGE"
 

.github/workflows/deploy-services.yml

@@ -25,13 +25,15 @@ jobs:
     outputs:
       job-service-enabled: ${{ steps.check-services.outputs.job }}
       user-service-enabled: ${{ steps.check-services.outputs.user }}
+      entity-service-enabled: ${{ steps.check-services.outputs.entity }}
       research-service-enabled: ${{ steps.check-services.outputs.research }}
       unified-database-service-enabled: ${{ steps.check-services.outputs.unified-database }}
     steps:
       - id: check-services
         run: |
           echo "job=${{ vars.ENABLED_SERVICES == '' || contains(vars.ENABLED_SERVICES, 'job-service') }}" >> "$GITHUB_OUTPUT"
           echo "user=${{ vars.ENABLED_SERVICES == '' || contains(vars.ENABLED_SERVICES, 'user-service') }}" >> "$GITHUB_OUTPUT"
+          echo "entity=${{ vars.ENABLED_SERVICES == '' || contains(vars.ENABLED_SERVICES, 'entity-service') }}" >> "$GITHUB_OUTPUT"
           echo "research=${{ vars.ENABLED_SERVICES == '' || contains(vars.ENABLED_SERVICES, 'research-service') }}" >> "$GITHUB_OUTPUT"
           echo "unified-database=${{ vars.ENABLED_SERVICES == '' || contains(vars.ENABLED_SERVICES, 'unified-database-service') }}" >> "$GITHUB_OUTPUT"
 
@@ -44,7 +46,6 @@ jobs:
       service: job-service
     secrets: inherit
 
-
   user-service:
     needs: check-services
     if: needs.check-services.outputs.user-service-enabled == 'true'
@@ -54,6 +55,15 @@ jobs:
       service: user-service
     secrets: inherit
 
+  entity-service:
+    needs: check-services
+    if: needs.check-services.outputs.entity-service-enabled == 'true'
+    uses: ./.github/workflows/deploy-service.yml
+    with:
+      env: ${{ inputs.env }}
+      service: entity-service
+    secrets: inherit
+
   research-service:
     needs: check-services
     if: needs.check-services.outputs.research-service-enabled == 'true'

apps/entity-service-e2e/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/entity-service-e2e/jest.config.ts

@@ -0,0 +1,19 @@
+/* eslint-disable */
+export default {
+  displayName: "entity-service-e2e",
+  preset: "../../jest.preset.js",
+  globalSetup: "<rootDir>/src/support/global-setup.ts",
+  globalTeardown: "<rootDir>/src/support/global-teardown.ts",
+  setupFiles: ["<rootDir>/src/support/test-setup.ts"],
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.[tj]s$": [
+      "ts-jest",
+      {
+        tsconfig: "<rootDir>/tsconfig.spec.json"
+      }
+    ]
+  },
+  moduleFileExtensions: ["ts", "js", "html"],
+  coverageDirectory: "../../coverage/entity-service-e2e"
+};

apps/entity-service-e2e/project.json

@@ -0,0 +1,17 @@
+{
+  "name": "entity-service-e2e",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "application",
+  "implicitDependencies": ["entity-service"],
+  "targets": {
+    "e2e": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{e2eProjectRoot}"],
+      "options": {
+        "jestConfig": "apps/entity-service-e2e/jest.config.ts",
+        "passWithNoTests": true
+      },
+      "dependsOn": ["entity-service:build"]
+    }
+  }
+}

apps/entity-service-e2e/src/entity-service/entity-service.spec.ts

@@ -0,0 +1,10 @@
+import axios from "axios";
+
+describe("GET /api", () => {
+  it("should return a message", async () => {
+    const res = await axios.get(`/api`);
+
+    expect(res.status).toBe(200);
+    expect(res.data).toEqual({ message: "Hello API" });
+  });
+});

apps/entity-service-e2e/src/support/global-setup.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+var __TEARDOWN_MESSAGE__: string;
+
+module.exports = async function () {
+  // Start services that that the app needs to run (e.g. database, docker-compose, etc.).
+  console.log("\nSetting up...\n");
+
+  // Hint: Use `globalThis` to pass variables to global teardown.
+  globalThis.__TEARDOWN_MESSAGE__ = "\nTearing down...\n";
+};

apps/entity-service-e2e/src/support/global-teardown.ts

@@ -0,0 +1,7 @@
+/* eslint-disable */
+
+module.exports = async function () {
+  // Put clean up logic here (e.g. stopping services, docker-compose, etc.).
+  // Hint: `globalThis` is shared between setup and teardown.
+  console.log(globalThis.__TEARDOWN_MESSAGE__);
+};

apps/entity-service-e2e/src/support/test-setup.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+
+import axios from "axios";
+
+module.exports = async function () {
+  // Configure axios for tests to use.
+  const host = process.env.HOST ?? "localhost";
+  const port = process.env.PORT ?? "3000";
+  axios.defaults.baseURL = `http://${host}:${port}`;
+};

apps/entity-service-e2e/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "compilerOptions": {
+    "esModuleInterop": true
+  }
+}

apps/entity-service-e2e/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.ts"]
+}

apps/entity-service/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/entity-service/Dockerfile

@@ -0,0 +1,15 @@
+FROM terramatch-microservices-base:nx-base AS builder
+
+ARG BUILD_FLAG
+WORKDIR /app/builder
+COPY . .
+RUN npx nx build entity-service ${BUILD_FLAG}
+
+FROM terramatch-microservices-base:nx-base
+
+ARG NODE_ENV
+WORKDIR /app
+COPY --from=builder /app/builder ./
+ENV NODE_ENV=${NODE_ENV}
+
+CMD ["node", "./dist/apps/entity-service/main.js"]

apps/entity-service/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: "entity-service",
+  preset: "../../jest.preset.js",
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.[tj]s$": ["ts-jest", { tsconfig: "<rootDir>/tsconfig.spec.json" }]
+  },
+  moduleFileExtensions: ["ts", "js", "html"],
+  coverageDirectory: "../../coverage/apps/entity-service"
+};

apps/entity-service/project.json

@@ -0,0 +1,26 @@
+{
+  "name": "entity-service",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/entity-service/src",
+  "projectType": "application",
+  "tags": [],
+  "targets": {
+    "serve": {
+      "executor": "@nx/js:node",
+      "defaultConfiguration": "development",
+      "dependsOn": ["build"],
+      "options": {
+        "buildTarget": "entity-service:build",
+        "runBuildTargetDependencies": false
+      },
+      "configurations": {
+        "development": {
+          "buildTarget": "entity-service:build:development"
+        },
+        "production": {
+          "buildTarget": "entity-service:build:production"
+        }
+      }
+    }
+  }
+}

apps/entity-service/src/app.module.ts

@@ -0,0 +1,13 @@
+import { Module } from "@nestjs/common";
+import { DatabaseModule } from "@terramatch-microservices/database";
+import { CommonModule } from "@terramatch-microservices/common";
+import { HealthModule } from "./health/health.module";
+import { TreesController } from "./trees/trees.controller";
+import { TreeService } from "./trees/tree.service";
+
+@Module({
+  imports: [DatabaseModule, CommonModule, HealthModule],
+  controllers: [TreesController],
+  providers: [TreeService]
+})
+export class AppModule {}

apps/entity-service/src/health/health.controller.ts

@@ -0,0 +1,28 @@
+import { Controller, Get } from '@nestjs/common';
+import { HealthCheck, HealthCheckService, SequelizeHealthIndicator } from '@nestjs/terminus';
+import { NoBearerAuth } from '@terramatch-microservices/common/guards';
+import { ApiExcludeController } from '@nestjs/swagger';
+import { User } from '@terramatch-microservices/database/entities';
+
+@Controller('health')
+@ApiExcludeController()
+export class HealthController {
+  constructor(
+    private readonly health: HealthCheckService,
+    private readonly db: SequelizeHealthIndicator
+  ) {}
+
+  @Get()
+  @HealthCheck()
+  @NoBearerAuth
+  async check() {
+    const connection = await User.sequelize.connectionManager.getConnection({ type: 'read' });
+    try {
+      return this.health.check([
+        () => this.db.pingCheck('database', { connection })
+      ]);
+    } finally {
+      User.sequelize.connectionManager.releaseConnection(connection);
+    }
+  }
+}

apps/entity-service/src/health/health.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { TerminusModule } from '@nestjs/terminus';
+import { HealthController } from './health.controller';
+
+@Module({
+  imports: [TerminusModule],
+  controllers: [HealthController],
+})
+export class HealthModule {}

apps/entity-service/src/main.ts

@@ -0,0 +1,33 @@
+import { Logger, ValidationPipe } from "@nestjs/common";
+import { NestFactory } from "@nestjs/core";
+import { AppModule } from "./app.module";
+import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
+import { TMLogService } from "@terramatch-microservices/common/util/tm-log.service";
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+
+  if (process.env.NODE_ENV === "development") {
+    // CORS is handled by the Api Gateway in AWS
+    app.enableCors();
+  }
+
+  const config = new DocumentBuilder()
+    .setTitle("TerraMatch Entity Service")
+    .setDescription("APIs related to entities")
+    .setVersion("1.0")
+    .addTag("entity-service")
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup("entity-service/documentation/api", app, document);
+
+  app.useGlobalPipes(new ValidationPipe({ transform: true, transformOptions: { enableImplicitConversion: true } }));
+  app.useLogger(app.get(TMLogService));
+
+  const port = process.env.NODE_ENV === "production" ? 80 : process.env.ENTITY_SERVICE_PORT ?? 4050;
+  await app.listen(port);
+
+  Logger.log(`TerraMatch Entity Service is running on: http://localhost:${port}`);
+}
+
+bootstrap();

apps/entity-service/src/trees/dto/establishment-trees.dto.ts

@@ -0,0 +1,23 @@
+import { JsonApiAttributes } from "@terramatch-microservices/common/dto/json-api-attributes";
+import { JsonApiDto } from "@terramatch-microservices/common/decorators";
+import { ApiProperty } from "@nestjs/swagger";
+
+// The ID for this DTO is formed of "entityType|entityUuid". This is a virtual resource, not directly
+// backed by a single DB table.
+@JsonApiDto({ type: "establishmentTrees", id: "string" })
+export class EstablishmentsTreesDto extends JsonApiAttributes<EstablishmentsTreesDto> {
+  @ApiProperty({
+    type: [String],
+    description: "The species that were specified at the establishment of the parent entity."
+  })
+  establishmentTrees: string[];
+
+  @ApiProperty({
+    type: "object",
+    additionalProperties: { type: "number" },
+    nullable: true,
+    description: "If the entity in this request is a report, the sum totals of previous planting by species.",
+    example: { "Aster persaliens": 256, "Cirsium carniolicum": 1024 }
+  })
+  previousPlantingCounts?: Record<string, number>;
+}

apps/entity-service/src/trees/dto/establishments-trees-params.dto.ts

@@ -0,0 +1,17 @@
+// The entities that are able to ask for what their establishment tree data was.
+import { ApiProperty } from "@nestjs/swagger";
+import { IsIn, IsUUID } from "class-validator";
+import { ESTABLISHMENT_ENTITIES, EstablishmentEntity } from "../tree.service";
+
+export class EstablishmentsTreesParamsDto {
+  @IsIn(ESTABLISHMENT_ENTITIES)
+  @ApiProperty({
+    enum: ESTABLISHMENT_ENTITIES,
+    description: "Entity type for which to retrieve the establishment tree data."
+  })
+  entity: EstablishmentEntity;
+
+  @IsUUID()
+  @ApiProperty({ description: "Entity UUID for which to retrieve the establishment tree data." })
+  uuid: string;
+}