feat: bulk CSV background jobs setup

api/prisma/migrations/63_add_background_jobs_table/migration.sql

@@ -0,0 +1,25 @@
+-- CreateEnum
+CREATE TYPE "BackgroundJobStatusEnum" AS ENUM ('processing', 'completed', 'failed');
+
+-- CreateTable
+CREATE TABLE "background_job" (
+    "id" UUID NOT NULL DEFAULT uuid_generate_v4(),
+    "listing_id" UUID NOT NULL,
+    "requested_by_user_id" UUID NOT NULL,
+    "status" "BackgroundJobStatusEnum" NOT NULL,
+    "total_records" INTEGER,
+    "input_s3_key" TEXT NOT NULL,
+    "error_message" TEXT,
+    "error_row" INTEGER,
+    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(3) NOT NULL,
+    "completed_at" TIMESTAMP(3),
+
+    CONSTRAINT "background_job_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE INDEX "background_job_listing_id_status_idx" ON "background_job"("listing_id", "status");
+
+-- AddForeignKey
+ALTER TABLE "background_job" ADD CONSTRAINT "background_job_requested_by_user_id_fkey" FOREIGN KEY ("requested_by_user_id") REFERENCES "user_accounts"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;

api/src/controllers/background-jobs.controller.ts

@@ -0,0 +1,100 @@
+import {
+  Body,
+  Controller,
+  Get,
+  Param,
+  ParseUUIDPipe,
+  Post,
+  Query,
+  Request,
+  UseGuards,
+  UsePipes,
+  ValidationPipe,
+} from '@nestjs/common';
+import {
+  ApiExtraModels,
+  ApiOkResponse,
+  ApiOperation,
+  ApiTags,
+} from '@nestjs/swagger';
+import { Request as ExpressRequest } from 'express';
+import { ApiKeyGuard } from '../guards/api-key.guard';
+import { BackgroundJobsService } from '../services/background-jobs.service';
+import { BackgroundJobCreate } from '../dtos/background-jobs/background-job-create.dto';
+import { mapTo } from '../utilities/mapTo';
+import { User } from '../dtos/users/user.dto';
+import { BackgroundJob } from '../dtos/background-jobs/background-job.dto';
+import { PermissionTypeDecorator } from '../decorators/permission-type.decorator';
+import { JwtAuthGuard } from '../guards/jwt.guard';
+import { defaultValidationPipeOptions } from '../utilities/default-validation-pipe-options';
+import { SuccessDTO } from '../dtos/shared/success.dto';
+
+@Controller('jobs')
+@ApiTags('jobs')
+@ApiExtraModels(BackgroundJob, BackgroundJobCreate)
+@PermissionTypeDecorator('jobs')
+@UseGuards(ApiKeyGuard, JwtAuthGuard)
+export class BackgroundJobsController {
+  constructor(private readonly backgroundJobsService: BackgroundJobsService) {}
+
+  @Post()
+  @ApiOperation({
+    summary: 'Creates a new background job record in the database',
+    operationId: 'createBackgroundJob',
+  })
+  @UsePipes(new ValidationPipe(defaultValidationPipeOptions))
+  @UseGuards(ApiKeyGuard)
+  @ApiOkResponse({ type: BackgroundJob })
+  public async createBackgroundJob(
+    @Request() req: ExpressRequest,
+    @Body() dto: BackgroundJobCreate,
+  ): Promise<BackgroundJob> {
+    return await this.backgroundJobsService.create(
+      dto,
+      mapTo(User, req['user']),
+    );
+  }
+  @Get('active')
+  @ApiOperation({
+    summary: 'Get info if any jobs are currently running',
+    operationId: 'activeJobStatus',
+  })
+  @ApiOkResponse({ type: SuccessDTO })
+  public async activeJobStatus(
+    @Request() req: ExpressRequest,
+  ): Promise<SuccessDTO> {
+    return this.backgroundJobsService.findActiveJob(mapTo(User, req['user']));
+  }
+
+  @Get(':jobId')
+  @ApiOperation({
+    summary: 'Get a background job data by its ID',
+    operationId: 'getBackgroundJob',
+  })
+  @ApiOkResponse({ type: BackgroundJob })
+  public async getJobById(
+    @Request() req: ExpressRequest,
+    @Param('jobId', new ParseUUIDPipe({ version: '4' })) jobId: string,
+  ): Promise<BackgroundJob> {
+    return await this.backgroundJobsService.getById(
+      jobId,
+      mapTo(User, req['user']),
+    );
+  }
+
+  @Get()
+  @ApiOperation({
+    summary: 'Get an active background job for a listing',
+    operationId: 'findActiveJobForListing',
+  })
+  @ApiOkResponse({ type: Array<BackgroundJob> })
+  public async getListingActiveJob(
+    @Request() req: ExpressRequest,
+    @Query('listingId', new ParseUUIDPipe({ version: '4' })) listingId: string,
+  ): Promise<BackgroundJob[]> {
+    return await this.backgroundJobsService.findActiveForListing(
+      listingId,
+      mapTo(User, req['user']),
+    );
+  }
+}

api/src/dtos/background-jobs/background-job-create.dto.ts

@@ -0,0 +1,19 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Expose } from 'class-transformer';
+import { IsDefined, IsString, IsUUID } from 'class-validator';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
+
+export class BackgroundJobCreate {
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @IsUUID(4, { groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  listingId: string;
+
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  inputS3Key: string;
+}

api/src/dtos/background-jobs/background-job.dto.ts

@@ -0,0 +1,70 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { Expose, Type } from 'class-transformer';
+import {
+  IsDefined,
+  IsDate,
+  IsEnum,
+  IsInt,
+  IsOptional,
+  IsString,
+  IsUUID,
+} from 'class-validator';
+import { BackgroundJobStatusEnum } from '@prisma/client';
+import { ValidationsGroupsEnum } from '../../enums/shared/validation-groups-enum';
+import { AbstractDTO } from '../shared/abstract.dto';
+
+export class BackgroundJob extends AbstractDTO {
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @IsUUID(4, { groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  listingId: string;
+
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @IsUUID(4, { groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  requestedByUserId: string;
+
+  @Expose()
+  @IsEnum(BackgroundJobStatusEnum, { groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty({
+    enum: BackgroundJobStatusEnum,
+    enumName: 'BackgroundJobStatusEnum',
+  })
+  status: BackgroundJobStatusEnum;
+
+  @Expose()
+  @IsOptional({ groups: [ValidationsGroupsEnum.default] })
+  @IsInt({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  totalRecords?: number;
+
+  @Expose()
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ApiProperty()
+  inputS3Key: string;
+
+  @Expose()
+  @IsOptional({ groups: [ValidationsGroupsEnum.default] })
+  @IsString({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  errorMessage?: string;
+
+  @Expose()
+  @IsOptional({ groups: [ValidationsGroupsEnum.default] })
+  @IsInt({ groups: [ValidationsGroupsEnum.default] })
+  @ApiPropertyOptional()
+  errorRow?: number;
+
+  @Expose()
+  @IsOptional({ groups: [ValidationsGroupsEnum.default] })
+  @IsDate({ groups: [ValidationsGroupsEnum.default] })
+  @Type(() => Date)
+  @ApiPropertyOptional()
+  completedAt?: Date;
+}

api/src/modules/app.module.ts

@@ -27,6 +27,7 @@ import { ThrottlerModule } from '@nestjs/throttler';
 import { UnitRentTypeModule } from './unit-rent-type.module';
 import { UnitTypeModule } from './unit-type.module';
 import { UserModule } from './user.module';
+import { BackgroundJobsModule } from './background-jobs.module';
 
 @Module({
   imports: [
@@ -42,6 +43,7 @@ import { UserModule } from './user.module';
     UserModule,
     PrismaModule,
     AuthModule,
+    BackgroundJobsModule,
     ApplicationFlaggedSetModule,
     MapLayerModule,
     ScriptRunnerModule,
@@ -84,6 +86,7 @@ import { UserModule } from './user.module';
     UserModule,
     PrismaModule,
     AuthModule,
+    BackgroundJobsModule,
     ApplicationFlaggedSetModule,
     MapLayerModule,
     ScriptRunnerModule,

api/src/modules/background-jobs.module.ts

@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { PrismaModule } from './prisma.module';
+import { S3Module } from './s3.module';
+import { PermissionModule } from './permission.module';
+import { BackgroundJobsController } from '../controllers/background-jobs.controller';
+import { BackgroundJobsService } from '../services/background-jobs.service';
+
+@Module({
+  imports: [PrismaModule, S3Module, PermissionModule],
+  providers: [BackgroundJobsService],
+  controllers: [BackgroundJobsController],
+  exports: [BackgroundJobsService],
+})
+export class BackgroundJobsModule {}

api/src/permission-configs/permission_policy.csv

@@ -95,6 +95,11 @@ p, jurisdictionAdmin, unitRentType, true, read
 p, limitedJurisdictionAdmin, unitRentType, true, read
 p, partner, unitRentType, true, read
 
+p, admin, jobs, true, .*
+p, supportAdmin, jobs, true, .*
+p, jurisdictionAdmin, jobs, true, .*
+p, limitedJurisdictionAdmin, jobs, true, .*
+p, partner, jobs, true, .*
 
 p, admin, applicationMethod, true, .*
 p, supportAdmin, applicationMethod, true, .*