Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/marxan 1560 legacy project import batch failed saga #1097

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { QueueBuilder } from '@marxan-api/modules/queue';
import {
FailedLegacyProjectImportDbCleanupJobInput,
FailedLegacyProjectImportDbCleanupJobOutput,
failedLegacyProjectImportDbCleanupQueueName,
} from '@marxan/legacy-project-import';
import { FactoryProvider } from '@nestjs/common';
import { Queue } from 'bullmq';

export const failedLegacyProjectImportDbCleanupQueueToken = Symbol(
'failed legacy project import db cleanup queue token',
);

export const failedLegacyProjectImportDbCleanupQueueProvider: FactoryProvider<
Queue<
FailedLegacyProjectImportDbCleanupJobInput,
FailedLegacyProjectImportDbCleanupJobOutput
>
> = {
provide: failedLegacyProjectImportDbCleanupQueueToken,
useFactory: (
queueBuilder: QueueBuilder<
FailedLegacyProjectImportDbCleanupJobInput,
FailedLegacyProjectImportDbCleanupJobOutput
>,
) => {
return queueBuilder.buildQueue(failedLegacyProjectImportDbCleanupQueueName);
},
inject: [QueueBuilder],
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Injectable } from '@nestjs/common';
import { ICommand, ofType, Saga } from '@nestjs/cqrs';
import { Observable, of } from 'rxjs';
import { mergeMap } from 'rxjs/operators';
import { MarkLegacyProjectImportAsFailed } from '../application/mark-legacy-project-import-as-failed.command';
import { LegacyProjectImportBatchFailed } from '../domain/events/legacy-project-import-batch-failed.event';
import { ScheduleDbCleanupForFailedLegacyProjectImport } from './schedule-db-cleanup-for-failed-legacy-project-import.command';

@Injectable()
export class LegacyProjectImportBatchFailedSaga {
@Saga()
saga = (events$: Observable<any>): Observable<ICommand> =>
events$.pipe(
ofType(LegacyProjectImportBatchFailed),
mergeMap((event) =>
of(
new MarkLegacyProjectImportAsFailed(
event.projectId,
`${event.batchNumber} batch contains failed pieces`,
),
new ScheduleDbCleanupForFailedLegacyProjectImport(event.projectId),
),
),
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,24 @@ import { ApiEventsModule } from '@marxan-api/modules/api-events';
import { QueueApiEventsModule } from '@marxan-api/modules/queue-api-events';
import { Logger, Module, Scope } from '@nestjs/common';
import { CqrsModule } from '@nestjs/cqrs';
import { failedLegacyProjectImportDbCleanupQueueProvider } from './failed-legacy-project-import-db-cleanup-queue.provider';
import { LegacyProjectImportBatchFailedSaga } from './legacy-project-import-batch-failed.saga';
import {
importLegacyProjectPieceQueueProvider,
importLegacyProjectPiecenQueueEventsProvider,
importLegacyProjectPieceEventsFactoryProvider,
importLegacyProjectPiecenQueueEventsProvider,
importLegacyProjectPieceQueueProvider,
} from './legacy-project-import-queue.provider';
import { ScheduleDbCleanupForFailedLegacyProjectImportHandler } from './schedule-db-cleanup-for-failed-legacy-project-import.handler';

@Module({
imports: [ApiEventsModule, QueueApiEventsModule, CqrsModule],
providers: [
importLegacyProjectPieceQueueProvider,
importLegacyProjectPiecenQueueEventsProvider,
importLegacyProjectPieceEventsFactoryProvider,
failedLegacyProjectImportDbCleanupQueueProvider,
LegacyProjectImportBatchFailedSaga,
ScheduleDbCleanupForFailedLegacyProjectImportHandler,
{
provide: Logger,
useClass: Logger,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { ResourceId } from '@marxan/cloning/domain';
import { Command } from '@nestjs-architects/typed-cqrs';

export class ScheduleDbCleanupForFailedLegacyProjectImport extends Command<void> {
constructor(public readonly projectId: ResourceId) {
super();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { FailedLegacyProjectImportDbCleanupJobInput } from '@marxan/legacy-project-import';
import { Inject, Logger } from '@nestjs/common';
import { CommandHandler, IInferredCommandHandler } from '@nestjs/cqrs';
import { Queue } from 'bullmq';
import { failedLegacyProjectImportDbCleanupQueueToken } from './failed-legacy-project-import-db-cleanup-queue.provider';
import { ScheduleDbCleanupForFailedLegacyProjectImport } from './schedule-db-cleanup-for-failed-legacy-project-import.command';

@CommandHandler(ScheduleDbCleanupForFailedLegacyProjectImport)
export class ScheduleDbCleanupForFailedLegacyProjectImportHandler
implements
IInferredCommandHandler<ScheduleDbCleanupForFailedLegacyProjectImport> {
constructor(
@Inject(failedLegacyProjectImportDbCleanupQueueToken)
private readonly queue: Queue<FailedLegacyProjectImportDbCleanupJobInput>,
private readonly logger: Logger,
) {
this.logger.setContext(
ScheduleDbCleanupForFailedLegacyProjectImportHandler.name,
);
}

async execute({
projectId,
}: ScheduleDbCleanupForFailedLegacyProjectImport): Promise<void> {
const job = await this.queue.add(
`failed-legacy-project-import-db-cleanup`,
{
projectId: projectId.value,
},
);

if (!job) {
this.logger.error(
`failed-legacy-project-import-db-cleanup job couldn't be added to queue`,
);
return;
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export const failedLegacyProjectImportDbCleanupQueueName =
'failed-legacy-project-import-db-cleanup';
11 changes: 9 additions & 2 deletions api/libs/legacy-project-import/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
export * from './domain';
export * from './infra';
export { LegacyProjectImportJobInput } from './job-input';
export { LegacyProjectImportJobOutput } from './job-output';
export {
LegacyProjectImportJobInput,
FailedLegacyProjectImportDbCleanupJobInput,
} from './job-input';
export {
LegacyProjectImportJobOutput,
FailedLegacyProjectImportDbCleanupJobOutput,
} from './job-output';
export { LegacyProjectImportPieceProcessor } from './legacy-project-import-piece-processor.port';
export { legacyProjectImportQueueName } from './legacy-project-import-queue-name';
export { failedLegacyProjectImportDbCleanupQueueName } from './failed-legacy-project-import-db-cleanup-queue-name';
4 changes: 4 additions & 0 deletions api/libs/legacy-project-import/src/job-input.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ export interface LegacyProjectImportJobInput {
readonly scenarioId: string;
readonly piece: LegacyProjectImportPiece;
}

export interface FailedLegacyProjectImportDbCleanupJobInput {
readonly projectId: string;
}
4 changes: 4 additions & 0 deletions api/libs/legacy-project-import/src/job-output.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ export interface LegacyProjectImportJobOutput {
readonly piece: LegacyProjectImportPiece;
readonly warnings?: string[];
}

export interface FailedLegacyProjectImportDbCleanupJobOutput {
readonly projectId: string;
}