[TM-2332] site validation

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

@@ -9,10 +9,30 @@ import { BoundingBoxController } from "./bounding-boxes/bounding-box.controller"
 import { BoundingBoxService } from "./bounding-boxes/bounding-box.service";
 import { ValidationController } from "./validations/validation.controller";
 import { ValidationService } from "./validations/validation.service";
+import { ValidationProcessor } from "./validations/validation.processor";
 import { DataApiModule } from "@terramatch-microservices/data-api";
+import { BullModule } from "@nestjs/bullmq";
+import { ConfigModule, ConfigService } from "@nestjs/config";
 
 @Module({
-  imports: [SentryModule.forRoot(), CommonModule, HealthModule, DataApiModule],
+  imports: [
+    SentryModule.forRoot(),
+    CommonModule,
+    HealthModule,
+    DataApiModule,
+    ConfigModule.forRoot({ isGlobal: true }),
+    BullModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (configService: ConfigService) => ({
+        connection: {
+          host: configService.get("REDIS_HOST"),
+          port: configService.get("REDIS_PORT")
+        }
+      })
+    }),
+    BullModule.registerQueue({ name: "validation" })
+  ],
   controllers: [SitePolygonsController, BoundingBoxController, ValidationController],
   providers: [
     {
@@ -21,7 +41,8 @@ import { DataApiModule } from "@terramatch-microservices/data-api";
     },
     SitePolygonsService,
     BoundingBoxService,
-    ValidationService
+    ValidationService,
+    ValidationProcessor
   ]
 })
 export class AppModule {}

apps/research-service/src/validations/dto/site-validation-request.dto.ts

@@ -0,0 +1,22 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { IsArray, IsIn, IsOptional } from "class-validator";
+import { VALIDATION_TYPES, ValidationType } from "@terramatch-microservices/database/constants";
+import { CreateDataDto, JsonApiBodyDto } from "@terramatch-microservices/common/util/json-api-update-dto";
+
+export class SiteValidationRequestAttributes {
+  @ApiProperty({
+    enum: VALIDATION_TYPES,
+    isArray: true,
+    required: false,
+    description:
+      "Array of validation types to run on all polygons in the site. If not provided or empty, all validation types will be run."
+  })
+  @IsOptional()
+  @IsArray()
+  @IsIn(VALIDATION_TYPES, { each: true })
+  validationTypes?: ValidationType[];
+}
+
+export class SiteValidationRequestBody extends JsonApiBodyDto(
+  class SiteValidationRequestData extends CreateDataDto("validations", SiteValidationRequestAttributes) {}
+) {}

apps/research-service/src/validations/dto/validation-criteria.dto.ts

@@ -4,12 +4,6 @@ import { VALIDATION_CRITERIA_IDS, CriteriaId } from "@terramatch-microservices/d
 
 @JsonApiDto({ type: "validationCriterias" })
 export class ValidationCriteriaDto {
-  @ApiProperty({
-    description: "The polygon UUID that was validated (optional for historic data)",
-    required: false
-  })
-  polygonUuid?: string;
-
   @ApiProperty({
     description: "The validation criteria ID",
     enum: VALIDATION_CRITERIA_IDS

apps/research-service/src/validations/dto/validation-request.dto.ts

@@ -1,27 +1,31 @@
 import { ApiProperty } from "@nestjs/swagger";
-import { IsArray, IsString, ArrayMinSize, IsIn } from "class-validator";
+import { IsArray, ArrayMinSize, IsIn, IsOptional } from "class-validator";
 import { VALIDATION_TYPES, ValidationType } from "@terramatch-microservices/database/constants";
+import { CreateDataDto, JsonApiBodyDto } from "@terramatch-microservices/common/util/json-api-update-dto";
 
-export class ValidationRequestDto {
+export class ValidationRequestAttributes {
   @ApiProperty({
     description: "Array of polygon UUIDs to validate",
     example: ["7631be34-bbe0-4e1e-b4fe-592677dc4b50", "d6502d4c-dfd6-461e-af62-21a0ec2f3e65"],
-    type: [String],
-    isArray: true
+    isArray: true,
+    type: String
   })
   @IsArray()
   @ArrayMinSize(1)
-  @IsString({ each: true })
   polygonUuids: string[];
 
   @ApiProperty({
     enum: VALIDATION_TYPES,
-    name: "validationTypes[]",
     isArray: true,
-    required: true,
-    description: "Array of validation types to run"
+    required: false,
+    description: "Array of validation types to run. If not provided or empty, all validation types will be run."
   })
+  @IsOptional()
   @IsArray()
   @IsIn(VALIDATION_TYPES, { each: true })
-  validationTypes: ValidationType[];
+  validationTypes?: ValidationType[];
 }
+
+export class ValidationRequestBody extends JsonApiBodyDto(
+  class ValidationRequestData extends CreateDataDto("validations", ValidationRequestAttributes) {}
+) {}

apps/research-service/src/validations/dto/validation-summary.dto.ts

@@ -0,0 +1,52 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { JsonApiDto } from "@terramatch-microservices/common/decorators";
+import { ValidationType } from "@terramatch-microservices/database/constants";
+
+export class ValidationTypeSummary {
+  @ApiProperty({
+    description: "Number of polygons that passed this validation"
+  })
+  valid: number;
+
+  @ApiProperty({
+    description: "Number of polygons that failed this validation"
+  })
+  invalid: number;
+}
+
+@JsonApiDto({ type: "validationSummaries" })
+export class ValidationSummaryDto {
+  @ApiProperty({
+    description: "The UUID of the site that was validated",
+    example: "7631be34-bbe0-4e1e-b4fe-592677dc4b50"
+  })
+  siteUuid: string;
+
+  @ApiProperty({
+    description: "Total number of polygons in the site"
+  })
+  totalPolygons: number;
+
+  @ApiProperty({
+    description: "Number of polygons that were validated"
+  })
+  validatedPolygons: number;
+
+  @ApiProperty({
+    description: "Summary of validation results by validation type",
+    type: "object",
+    additionalProperties: {
+      type: "object",
+      properties: {
+        valid: { type: "number" },
+        invalid: { type: "number" }
+      }
+    }
+  })
+  validationSummary: Record<ValidationType, ValidationTypeSummary>;
+
+  @ApiProperty({
+    description: "When the validation was completed"
+  })
+  completedAt: Date;
+}

apps/research-service/src/validations/dto/validation.dto.ts

@@ -8,7 +8,7 @@ export class ValidationDto {
     description: "The UUID of the polygon that was validated",
     example: "d6502d4c-dfd6-461e-af62-21a0ec2f3e65"
   })
-  polygonId: string;
+  polygonUuid: string;
 
   @ApiProperty({
     description: "List of validation criteria results for this polygon",