rez_core 4.0.184 → 4.0.187

package/src/module/workflow-schedule/dto/update-schedule.dto.ts

@@ -0,0 +1,96 @@
+import {
+  IsNotEmpty,
+  IsString,
+  IsNumber,
+  IsOptional,
+  IsBoolean,
+  IsObject,
+  IsArray,
+  ValidateNested,
+  IsDateString,
+  Matches,
+  Min,
+} from 'class-validator';
+import { Type } from 'class-transformer';
+import { RetryConfigDto, WorkflowActionDto } from './create-schedule.dto';
+
+/**
+ * DTO for updating a scheduled workflow
+ * All fields are optional as partial updates should be supported
+ */
+export class UpdateScheduleDto {
+  @IsNumber()
+  @IsNotEmpty()
+  id: number;
+
+  @IsNumber()
+  @IsOptional()
+  workflow_id?: number;
+
+  @IsString()
+  @IsOptional()
+  workflow_name?: string;
+
+  @IsString()
+  @IsOptional()
+  name?: string;
+
+  @IsString()
+  @IsOptional()
+  description?: string;
+
+  @IsString()
+  @IsOptional()
+  @Matches(
+    /^(\*|([0-5]?\d)) (\*|([01]?\d|2[0-3])) (\*|([01]?\d|2\d|3[01])) (\*|([1-9]|1[0-2])) (\*|([0-6]))$/,
+    {
+      message:
+        'Invalid cron expression format. Expected format: "minute hour day month weekday"',
+    },
+  )
+  cron_expression?: string;
+
+  @IsString()
+  @IsOptional()
+  timezone?: string;
+
+  @IsDateString()
+  @IsOptional()
+  start_date?: string;
+
+  @IsDateString()
+  @IsOptional()
+  end_date?: string;
+
+  @IsNumber()
+  @IsOptional()
+  @Min(1)
+  max_executions?: number;
+
+  @IsString()
+  @IsOptional()
+  schedule_status?: string;
+
+  @ValidateNested()
+  @Type(() => RetryConfigDto)
+  @IsOptional()
+  retry_config?: RetryConfigDto;
+
+  @IsArray()
+  @ValidateNested({ each: true })
+  @Type(() => WorkflowActionDto)
+  @IsOptional()
+  actions?: WorkflowActionDto[];
+
+  @IsObject()
+  @IsOptional()
+  metadata?: Record<string, any>;
+
+  @IsBoolean()
+  @IsOptional()
+  is_enabled?: boolean;
+
+  @IsString()
+  @IsOptional()
+  status?: string;
+}

package/src/module/workflow-schedule/entities/scheduled-workflow.entity.ts

@@ -0,0 +1,148 @@
+import { Entity, Column } from 'typeorm';
+import { Expose } from 'class-transformer';
+import { BaseEntity } from '../../meta/entity/base-entity.entity';
+import { SCHEDULED_WORKFLOW } from '../constants/schedule.constants';
+
+/**
+ * ScheduledWorkflow Entity
+ * Represents a workflow that is scheduled to run at specific times
+ */
+@Entity({ name: 'frm_wf_scheduled_workflow' })
+export class ScheduledWorkflow extends BaseEntity {
+  constructor() {
+    super();
+    this.entity_type = SCHEDULED_WORKFLOW;
+  }
+
+  /**
+   * Reference to the workflow that will be executed
+   */
+  @Column({ type: 'bigint', nullable: false })
+  @Expose()
+  workflow_id: number;
+
+  /**
+   * Workflow name for quick reference
+   */
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  @Expose()
+  workflow_name: string;
+
+  /**
+   * Description of the scheduled workflow
+   */
+  @Column({ type: 'text', nullable: true })
+  @Expose()
+  description: string;
+
+  /**
+   * Cron expression defining the schedule
+   * Example: "0 9 * * 1-5" (Every weekday at 9 AM)
+   */
+  @Column({ type: 'varchar', length: 255, nullable: false })
+  @Expose()
+  cron_expression: string;
+
+  /**
+   * Timezone for the schedule (IANA timezone format)
+   * Example: "Asia/Kolkata", "America/New_York"
+   */
+  @Column({ type: 'varchar', length: 100, nullable: false, default: 'Asia/Kolkata' })
+  @Expose()
+  timezone: string;
+
+  /**
+   * Schedule start date (optional)
+   */
+  @Column({ type: 'timestamp', nullable: true })
+  @Expose()
+  start_date: Date | null;
+
+  /**
+   * Schedule end date (optional)
+   */
+  @Column({ type: 'timestamp', nullable: true })
+  @Expose()
+  end_date: Date | null;
+
+  /**
+   * Maximum number of executions allowed (optional)
+   */
+  @Column({ type: 'int', nullable: true })
+  @Expose()
+  max_executions: number;
+
+  /**
+   * Current execution count
+   */
+  @Column({ type: 'int', nullable: false, default: 0 })
+  @Expose()
+  execution_count: number;
+
+  /**
+   * Last execution timestamp
+   */
+  @Column({ type: 'timestamp', nullable: true })
+  @Expose()
+  last_execution_at: Date | null;
+
+  /**
+   * Next scheduled execution timestamp
+   */
+  @Column({ type: 'timestamp', nullable: true })
+  @Expose()
+  next_execution_at: Date | null;
+
+  /**
+   * Schedule status: ACTIVE, PAUSED, INACTIVE, EXPIRED
+   */
+  @Column({ type: 'varchar', length: 50, nullable: false, default: 'ACTIVE' })
+  @Expose()
+  schedule_status: string;
+
+  /**
+   * Bull job ID for tracking
+   */
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  @Expose()
+  job_id: string | null;
+
+  /**
+   * Retry configuration in JSON format
+   * Example: {"maxRetries": 3, "retryDelay": 5000, "backoffMultiplier": 2}
+   */
+  @Column({ type: 'json', nullable: true })
+  @Expose()
+  retry_config: {
+    maxRetries: number;
+    retryDelay: number;
+    backoffMultiplier: number;
+  };
+
+  /**
+   * Actions to be performed when workflow executes
+   * Array of action configurations
+   */
+  @Column({ type: 'json', nullable: true })
+  @Expose()
+  actions: Array<{
+    actionType: string;
+    actionConfig: Record<string, any>;
+    targetEntityType?: string;
+    filterCriteria?: Record<string, any>;
+  }>;
+
+  /**
+   * Additional metadata for the schedule
+   */
+  @Column({ type: 'json', nullable: true })
+  @Expose()
+  metadata: Record<string, any>;
+
+  /**
+   * Whether this schedule is enabled
+   */
+  @Column({ type: 'boolean', nullable: false, default: true })
+  @Expose()
+  is_enabled: boolean;
+}

package/src/module/workflow-schedule/entities/workflow-execution-log.entity.ts

@@ -0,0 +1,154 @@
+import { Entity, Column } from 'typeorm';
+import { Expose } from 'class-transformer';
+import { BaseEntity } from '../../meta/entity/base-entity.entity';
+import { WORKFLOW_EXECUTION_LOG } from '../constants/schedule.constants';
+
+/**
+ * WorkflowExecutionLog Entity
+ * Tracks every execution of a scheduled workflow
+ */
+@Entity({ name: 'frm_wf_execution_log' })
+export class WorkflowExecutionLog extends BaseEntity {
+  constructor() {
+    super();
+    this.entity_type = WORKFLOW_EXECUTION_LOG;
+  }
+
+  /**
+   * Reference to the scheduled workflow
+   */
+  @Column({ type: 'bigint', nullable: false })
+  @Expose()
+  schedule_id: number;
+
+  /**
+   * Reference to the workflow being executed
+   */
+  @Column({ type: 'bigint', nullable: false })
+  @Expose()
+  workflow_id: number;
+
+  /**
+   * Bull job ID for this execution
+   */
+  @Column({ type: 'varchar', length: 255, nullable: true })
+  @Expose()
+  job_id: string;
+
+  /**
+   * Execution status: PENDING, RUNNING, COMPLETED, FAILED, PARTIAL
+   */
+  @Column({ type: 'varchar', length: 50, nullable: false, default: 'PENDING' })
+  @Expose()
+  execution_status: string;
+
+  /**
+   * When the execution started
+   */
+  @Column({ type: 'timestamp', nullable: true })
+  @Expose()
+  started_at: Date;
+
+  /**
+   * When the execution completed
+   */
+  @Column({ type: 'timestamp', nullable: true })
+  @Expose()
+  completed_at: Date;
+
+  /**
+   * Duration of execution in milliseconds
+   */
+  @Column({ type: 'int', nullable: true })
+  @Expose()
+  duration_ms: number;
+
+  /**
+   * How the execution was triggered: SCHEDULE or MANUAL
+   */
+  @Column({ type: 'varchar', length: 50, nullable: false, default: 'SCHEDULE' })
+  @Expose()
+  triggered_by: string;
+
+  /**
+   * User ID who triggered manual execution (if applicable)
+   */
+  @Column({ type: 'bigint', nullable: true })
+  @Expose()
+  triggered_by_user_id: number | null;
+
+  /**
+   * Total number of records processed
+   */
+  @Column({ type: 'int', nullable: false, default: 0 })
+  @Expose()
+  total_records: number;
+
+  /**
+   * Number of successfully processed records
+   */
+  @Column({ type: 'int', nullable: false, default: 0 })
+  @Expose()
+  successful_records: number;
+
+  /**
+   * Number of failed records
+   */
+  @Column({ type: 'int', nullable: false, default: 0 })
+  @Expose()
+  failed_records: number;
+
+  /**
+   * Current retry attempt number
+   */
+  @Column({ type: 'int', nullable: false, default: 0 })
+  @Expose()
+  retry_count: number;
+
+  /**
+   * Maximum retry attempts allowed
+   */
+  @Column({ type: 'int', nullable: false, default: 3 })
+  @Expose()
+  max_retries: number;
+
+  /**
+   * Error message if execution failed
+   */
+  @Column({ type: 'text', nullable: true })
+  @Expose()
+  error_message: string;
+
+  /**
+   * Detailed error stack trace
+   */
+  @Column({ type: 'text', nullable: true })
+  @Expose()
+  error_stack: string;
+
+  /**
+   * Execution results and details in JSON format
+   */
+  @Column({ type: 'json', nullable: true })
+  @Expose()
+  execution_details: {
+    batchesProcessed?: number;
+    actionsExecuted?: Array<{
+      actionType: string;
+      success: boolean;
+      recordsAffected?: number;
+      error?: string;
+    }>;
+    errors?: Array<{
+      recordId?: number;
+      error: string;
+    }>;
+  };
+
+  /**
+   * Additional metadata for this execution
+   */
+  @Column({ type: 'json', nullable: true })
+  @Expose()
+  metadata: Record<string, any>;
+}

package/src/module/workflow-schedule/interfaces/schedule-job-data.interface.ts

@@ -0,0 +1,53 @@
+/**
+ * Interface for Bull job data
+ */
+
+import { UserData } from "src/module/user/entity/user.entity";
+
+export interface ScheduleJobData {
+  scheduleId: number;
+  workflowId: number;
+  workflowName: string;
+  organizationId: number;
+  enterpriseId: number;
+  levelId?: string;
+  levelType?: string;
+  appcode?: string;
+  createdBy: number;
+  triggeredBy: 'SCHEDULE' | 'MANUAL';
+  triggeredAt: Date;
+  metadata?: Record<string, any>;
+  loggedInUser?: UserData;
+}
+
+export interface WorkflowActionData {
+  actionType: string;
+  actionConfig: Record<string, any>;
+  targetEntityType?: string;
+  filterCriteria?: Record<string, any>;
+}
+
+export interface BatchProcessingResult {
+  totalRecords: number;
+  processedRecords: number;
+  successfulRecords: number;
+  failedRecords: number;
+  errors: Array<{
+    recordId?: number;
+    error: string;
+  }>;
+}
+
+export interface RetryConfig {
+  maxRetries: number;
+  retryDelay: number;
+  backoffMultiplier: number;
+}
+
+export interface ScheduleConfig {
+  cronExpression: string;
+  timezone: string;
+  startDate?: Date;
+  endDate?: Date;
+  maxExecutions?: number;
+}

package/src/module/workflow-schedule/interfaces/workflow-schedule-options.interface.ts

@@ -0,0 +1,12 @@
+/**
+ * Options for WorkflowScheduleModule configuration
+ */
+export interface WorkflowScheduleModuleOptions {
+  /**
+   * Flag to control whether this server should run the workflow scheduler
+   * Set to true only on the dedicated scheduler server
+   * Set to false on API/worker servers that should not execute cron jobs
+   * @default false (safe default - scheduler disabled unless explicitly enabled)
+   */
+  is_workflow?: boolean;
+}