danak/dsc-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: add recurring invoice proccesor logic

Browse Source
This commit is contained in:
mahyargdz
2025-03-11 11:52:46 +03:30
parent fdf1bc908c
commit 4503721b90
17 changed files with 310 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/modules/invoices/DTO/create-invoice.dto.ts
+18 -2
View File
@@ -1,8 +1,9 @@
import { ApiProperty } from "@nestjs/swagger";
import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
import { Type } from "class-transformer";
import { ArrayMinSize, IsInt, IsNotEmpty, IsOptional, IsString, IsUUID, Length, ValidateNested } from "class-validator";
import { ArrayMinSize, IsBoolean, IsEnum, IsInt, IsNotEmpty, IsOptional, IsString, IsUUID, Length, ValidateNested } from "class-validator";
import { InvoiceMessage } from "../../../common/enums/message.enum";
import { RecurringPeriodEnum } from "../enums/invoice-recurring-period.enum";
export class InvoiceItemDto {
@IsNotEmpty({ message: InvoiceMessage.NAME_REQUIRED })
@@ -43,4 +44,19 @@ export class CreateInvoiceDto {
@ArrayMinSize(1)
@Type(() => InvoiceItemDto)
items: InvoiceItemDto[];
@IsOptional()
@IsBoolean({ message: InvoiceMessage.IS_RECURRING_MUST_BE_A_BOOLEAN })
@ApiProperty({ description: "Is this a recurring invoice", example: false, default: false })
isRecurring?: boolean;
@IsOptional()
@IsNotEmpty({ message: InvoiceMessage.RECURRING_PERIOD_REQUIRED })
@IsEnum(RecurringPeriodEnum)
@ApiPropertyOptional({
description: "Recurring period (daily, weekly, monthly, quarterly, yearly)",
example: RecurringPeriodEnum.QUARTERLY,
enum: RecurringPeriodEnum,
})
recurringPeriod?: RecurringPeriodEnum;
}
src/modules/invoices/constants/index.ts
+7
View File
@@ -1,6 +1,7 @@
export const INVOICE = Object.freeze({
INVOICE_QUEUE_NAME: "invoice",
INVOICE_REMINDER_JOB_NAME: "reminderInvoice",
INVOICE_RECURRING_JOB_NAME: "recurringInvoice",
//
INVOICE_REMINDER_JOB_PRIORITY: 1, // High priority
INVOICE_REMINDER_JOB_ATTEMPTS: 3, // Retry 3 times
@@ -8,6 +9,12 @@ export const INVOICE = Object.freeze({
INVOICE_REMINDER_JOB_TIMEOUT: 10000, // Timeout after 10 seconds
INVOICE_REMINDER_REPEAT_DELAY: 86400000, // 1 day delay in milliseconds
//
INVOICE_RECURRING_JOB_PRIORITY: 1, // High priority
INVOICE_RECURRING_JOB_ATTEMPTS: 3, // Retry 3 times
INVOICE_RECURRING_JOB_BACKOFF: 1000, // Retry after 1 second
INVOICE_RECURRING_JOB_TIMEOUT: 10000, // Timeout after 10 seconds
//
FINE_PERCENTAGE: 0.01, // 1% of the total price
MAX_DAYS_AFTER_OVERDUE: 10,
DUEDATE: 7,
src/modules/invoices/enums/invoice-recurring-period.enum.ts
+7
View File
@@ -0,0 +1,7 @@
export enum RecurringPeriodEnum {
WEEKLY = 1,
MONTHLY,
QUARTERLY,
BIANNUALLY,
ANNUALLY,
}
src/modules/invoices/enums/invoice-status.enum.ts
+1
View File
@@ -1,4 +1,5 @@
export enum InvoiceStatus {
DRAFT = "DRAFT",
PENDING = "PENDING",
WAIT_PAYMENT = "WAIT_PAYMENT",
PAID = "PAID",
src/modules/invoices/providers/invoice-creation.service.ts
View File
src/modules/invoices/providers/invoices.service.ts
+49 -7
View File
@@ -24,6 +24,7 @@ import { INVOICE } from "../constants";
import { CreateInvoiceDto } from "../DTO/create-invoice.dto";
import { InvoicesSearchQueryDto, UserInvoicesSearchQueryDto } from "../DTO/invoices-search-query.dto";
import { Invoice } from "../entities/invoice.entity";
import { RecurringPeriodEnum } from "../enums/invoice-recurring-period.enum";
import { InvoiceStatus } from "../enums/invoice-status.enum";
import { InvoicesRepository } from "../repositories/invoices.repository";
@@ -62,8 +63,7 @@ export class InvoicesService {
const totalPrice = invoiceItems.reduce((sum, item) => new Decimal(item.totalPrice).add(sum), new Decimal(0));
const tax = totalPrice.mul(0.1);
// const dueDate = dayjs().add(INVOICE.DUEDATE, "day").toDate();
const dueDate = dayjs().add(1, "minute").toDate();
const dueDate = dayjs().add(INVOICE.DUEDATE, "day").toDate();
const invoice = queryRunner.manager.create(Invoice, {
user: { id: createDto.userId },
@@ -91,17 +91,34 @@ export class InvoicesService {
},
queryRunner,
);
//add this to queue for billing reminder
await this.invoiceQueue.add(
INVOICE.INVOICE_REMINDER_JOB_NAME,
{ invoiceId: invoice.id },
{
delay: dayjs(invoice.dueDate).subtract(INVOICE.DAYS_BEFORE_OVERDUE, "day").diff(dayjs()),
// delay: 1.5 * 60 * 1000, // 5 minutes in milliseconds
attempts: INVOICE.INVOICE_REMINDER_JOB_ATTEMPTS,
backoff: INVOICE.INVOICE_REMINDER_JOB_BACKOFF,
backoff: { type: "exponential", delay: INVOICE.INVOICE_REMINDER_JOB_BACKOFF },
},
);
//add to queue for recurring invoice
if (createDto.isRecurring && createDto.recurringPeriod) {
await this.invoiceQueue.add(
INVOICE.INVOICE_RECURRING_JOB_NAME,
{
invoiceId: invoice.id,
adminCreated: true,
},
{
delay: await this.calculateRecurringDelay(createDto.recurringPeriod),
attempts: INVOICE.INVOICE_RECURRING_JOB_ATTEMPTS,
backoff: { type: "exponential", delay: INVOICE.INVOICE_REMINDER_JOB_BACKOFF },
},
);
this.logger.log(`Scheduled recurring invoice for user ${createDto.userId} with interval ${createDto.recurringPeriod}`);
}
await queryRunner.commitTransaction();
return {
@@ -264,8 +281,7 @@ export class InvoicesService {
{
delay: dayjs(invoice.dueDate).subtract(INVOICE.DAYS_BEFORE_OVERDUE, "day").diff(dayjs()),
attempts: INVOICE.INVOICE_REMINDER_JOB_ATTEMPTS,
backoff: INVOICE.INVOICE_REMINDER_JOB_BACKOFF,
repeat: { every: 300000 },
backoff: { type: "exponential", delay: INVOICE.INVOICE_REMINDER_JOB_BACKOFF },
},
);
@@ -453,7 +469,33 @@ export class InvoicesService {
return invoiceCount;
}
//*********************************** */
//********************************** */
private async calculateRecurringDelay(recurringPeriod: RecurringPeriodEnum) {
let delayMs: number;
switch (recurringPeriod) {
case RecurringPeriodEnum.WEEKLY:
delayMs = dayjs().add(1, "week").subtract(7, "days").diff(dayjs());
break;
case RecurringPeriodEnum.MONTHLY:
delayMs = dayjs().add(1, "month").subtract(7, "days").diff(dayjs());
break;
case RecurringPeriodEnum.QUARTERLY:
delayMs = dayjs().add(3, "month").subtract(7, "days").diff(dayjs());
break;
case RecurringPeriodEnum.BIANNUALLY:
delayMs = dayjs().add(6, "month").subtract(7, "days").diff(dayjs());
break;
case RecurringPeriodEnum.ANNUALLY:
delayMs = dayjs().add(1, "year").subtract(7, "days").diff(dayjs());
break;
default:
delayMs = dayjs().add(1, "month").subtract(7, "days").diff(dayjs());
}
this.logger.log(`Calculated recurring delay: ${delayMs}ms for period: ${recurringPeriod}`);
return delayMs;
}
// async applyDiscount(invoiceId: string, applyDiscountDto: ApplyDiscountDto, userId: string) {
// const invoice = await this.invoiceRepository.findOneBy({ id: invoiceId, status: InvoiceStatus.PENDING });
src/modules/invoices/queue/invoice.processor.ts
+104 -12
View File
@@ -9,9 +9,12 @@ import { DataSource, QueryRunner } from "typeorm";
import { WorkerProcessor } from "../../../common/queues/worker.processor";
import { NotificationsService } from "../../notifications/providers/notifications.service";
import { SubscriptionStatus } from "../../subscriptions/enums/subscription-status.enum";
import { User } from "../../users/entities/user.entity";
import { RoleEnum } from "../../users/enums/role.enum";
import { INVOICE } from "../constants";
import { Invoice } from "../entities/invoice.entity";
import { InvoiceStatus } from "../enums/invoice-status.enum";
import { InvoicesService } from "../providers/invoices.service";
@Processor(INVOICE.INVOICE_QUEUE_NAME)
export class InvoiceProcessor extends WorkerProcessor {
@@ -19,6 +22,7 @@ export class InvoiceProcessor extends WorkerProcessor {
constructor(
@InjectQueue(INVOICE.INVOICE_QUEUE_NAME) private readonly invoiceQueue: Queue,
private readonly invoicesService: InvoicesService,
private readonly dataSource: DataSource,
private readonly notificationService: NotificationsService,
) {
@@ -30,21 +34,84 @@ export class InvoiceProcessor extends WorkerProcessor {
switch (job.name) {
case INVOICE.INVOICE_REMINDER_JOB_NAME:
return this.sendBillInvoiceReminder(job, token);
case INVOICE.INVOICE_RECURRING_JOB_NAME:
return this.createRecurringInvoice(job, token);
default:
this.logger.error(`Unknown job name: ${job.name}`);
return;
}
}
//********************************** */
private async createRecurringInvoice(job: Job<{ invoiceId: string; adminCreated: boolean }>, token?: string): Promise<void> {
const { invoiceId, adminCreated } = job.data;
this.logger.log(`Creating recurring invoice for original invoice: ${invoiceId} ${token ? `with token: ${token}` : ""}`);
const queryRunner = this.dataSource.createQueryRunner();
try {
await queryRunner.connect();
await queryRunner.startTransaction();
const invoice = await this.fetchInvoice(invoiceId, queryRunner);
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
adminCreated
? await this.handleAdminCreatedInvoice(invoice, queryRunner)
: await this.handleSubscriptionInvoice(invoice, queryRunner);
await queryRunner.commitTransaction();
this.logger.log(`Recurring invoice for ${invoiceId} created successfully`);
} catch (error) {
this.logger.error(`Failed to create recurring invoice for ${invoiceId}:`, error);
await queryRunner.rollbackTransaction();
throw error;
} finally {
await queryRunner.release();
}
}
//********************************** */
private async handleAdminCreatedInvoice(invoice: Invoice, queryRunner: QueryRunner): Promise<Invoice> {
this.logger.verbose(`Creating admin-initiated recurring invoice in draft status`);
const newInvoice = queryRunner.manager.create(Invoice, {
user: invoice.user,
status: InvoiceStatus.DRAFT,
dueDate: dayjs().add(INVOICE.DUEDATE, "day").toDate(),
totalPrice: invoice.totalPrice,
tax: invoice.tax,
items: invoice.items,
});
await this.sendNotificationToAdmins(invoice, queryRunner);
return queryRunner.manager.save(Invoice, newInvoice);
}
//********************************** */
private async handleSubscriptionInvoice(invoice: Invoice, queryRunner: QueryRunner): Promise<Invoice> {
this.logger.verbose(`Creating subscription-based recurring invoice`);
const userSubscriptionPlan = invoice.items[0]?.subscriptionPlan;
if (!userSubscriptionPlan) {
throw new Error(`No subscription plan found for invoice ${invoice.id}`);
}
const { plan } = userSubscriptionPlan;
const dueDate = dayjs().add(INVOICE.DUEDATE, "day").toDate();
return this.invoicesService.createInvoiceForSubscription(invoice.user, plan, userSubscriptionPlan, dueDate, queryRunner);
}
//********************************** */
private async sendBillInvoiceReminder(job: Job<{ invoiceId: string }>, token?: string) {
this.logger.log(`Sending bill invoice reminder: ${job.data.invoiceId} to user. ${token}`);
const queryRunner = this.dataSource.createQueryRunner();
await queryRunner.connect();
await queryRunner.startTransaction();
try {
await queryRunner.connect();
await queryRunner.startTransaction();
const invoice = await this.fetchInvoice(job.data.invoiceId, queryRunner);
if (invoice.status === InvoiceStatus.PAID) {
@@ -78,7 +145,7 @@ export class InvoiceProcessor extends WorkerProcessor {
private async fetchInvoice(invoiceId: string, queryRunner: QueryRunner) {
const invoice = await queryRunner.manager.findOne(Invoice, {
where: { id: invoiceId },
relations: { user: true, items: { subscriptionPlan: true } },
relations: { user: true, items: { subscriptionPlan: { plan: true } } },
});
if (!invoice) throw new Error(`Invoice not found: ${invoiceId}`);
@@ -104,15 +171,16 @@ export class InvoiceProcessor extends WorkerProcessor {
await queryRunner.manager.save(userSubscription);
// await this.notificationService.createSubscriptionPlanCancelledNotification(
// invoice.user.id,
// {
// userPhone: invoice.user.phone,
// userEmail: invoice.user.email,
// subscriptionPlanId: invoice.items[0].subscriptionPlan.id,
// },
// queryRunner,
// );
await this.notificationService.createBlockServiceNotification(
invoice.user.id,
{
userPhone: invoice.user.phone,
userEmail: invoice.user.email,
planName: userSubscription.plan.name,
invoiceId: invoice.numericId.toString(),
},
queryRunner,
);
}
this.logger.log(`Invoice ${invoice.id} has been cancelled as it is more than 10 days overdue.`);
}
@@ -172,4 +240,28 @@ export class InvoiceProcessor extends WorkerProcessor {
}
//********************************** */
private async fetchAdmin(queryRunner: QueryRunner) {
return queryRunner.manager.find(User, { where: { roles: { name: RoleEnum.SUPER_ADMIN } }, relations: { roles: true } });
}
//********************************** */
private async sendNotificationToAdmins(invoice: Invoice, queryRunner: QueryRunner): Promise<void> {
this.logger.log(`Sending notification to admins for invoice ${invoice.id}`);
const admins = await this.fetchAdmin(queryRunner);
const notificationPayload = {
userPhone: invoice.user.phone,
userEmail: invoice.user.email,
invoiceId: invoice.numericId.toString(),
price: new Decimal(invoice.totalPrice).toNumber(),
dueDate: invoice.dueDate,
createDate: invoice.createdAt,
items: invoice.items.join(", "),
};
await Promise.all(
admins.map((admin) => this.notificationService.createRucurringInvoiceNotification(admin.id, notificationPayload, queryRunner)),
);
}
}