@friggframework/core 2.0.0-next.6 → 2.0.0-next.60

package/integrations/use-cases/get-integrations-for-user.js

@@ -0,0 +1,88 @@
+// Removed Integration wrapper - using IntegrationBase directly
+const {
+    mapIntegrationClassToIntegrationDTO,
+} = require('../utils/map-integration-dto');
+
+/**
+ * Use case for retrieving all integrations for a specific user.
+ * @class GetIntegrationsForUser
+ */
+class GetIntegrationsForUser {
+    /**
+     * Creates a new GetIntegrationsForUser instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../repositories/integration-repository-interface').IntegrationRepositoryInterface} params.integrationRepository - Repository for integration data operations.
+     * @param {Array<import('../integration').Integration>} params.integrationClasses - Array of available integration classes.
+     * @param {import('../../modules/module-factory').ModuleFactory} params.moduleFactory - Service for module instantiation and management.
+     * @param {import('../../modules/repositories/module-repository-interface').ModuleRepositoryInterface} params.moduleRepository - Repository for module and entity data operations.
+     */
+    constructor({
+        integrationRepository,
+        integrationClasses,
+        moduleFactory,
+        moduleRepository,
+    }) {
+        /**
+         * @type {import('../repositories/integration-repository-interface').IntegrationRepositoryInterface}
+         */
+        this.integrationRepository = integrationRepository;
+        this.integrationClasses = integrationClasses;
+        this.moduleFactory = moduleFactory;
+        this.moduleRepository = moduleRepository;
+    }
+
+    /**
+     * Executes the retrieval of all integrations for a user.
+     * @async
+     * @param {string} userId - ID of the user whose integrations to retrieve.
+     * @returns {Promise<Object[]>} Array of integration DTOs for the specified user.
+     */
+    async execute(userId) {
+        const integrationRecords =
+            await this.integrationRepository.findIntegrationsByUserId(userId);
+
+        const integrations = [];
+
+        for (const integrationRecord of integrationRecords) {
+            const entities = await this.moduleRepository.findEntitiesByIds(
+                integrationRecord.entitiesIds
+            );
+
+            const integrationClass = this.integrationClasses.find(
+                (integrationClass) =>
+                    integrationClass.Definition.name ===
+                    integrationRecord.config.type
+            );
+
+            const modules = [];
+            for (const entity of entities) {
+                const moduleInstance =
+                    await this.moduleFactory.getModuleInstance(
+                        entity.id,
+                        integrationRecord.userId
+                    );
+                modules.push(moduleInstance);
+            }
+
+            const integrationData = {
+                id: integrationRecord.id,
+                userId: integrationRecord.userId,
+                entities: entities,
+                config: integrationRecord.config,
+                status: integrationRecord.status,
+                version: integrationRecord.version,
+                messages: integrationRecord.messages || { errors: [], warnings: [] },
+                modules,
+                options: integrationClass.getOptionDetails(),
+            };
+
+            integrations.push(
+                mapIntegrationClassToIntegrationDTO(integrationData)
+            );
+        }
+
+        return integrations;
+    }
+}
+
+module.exports = { GetIntegrationsForUser };

package/integrations/use-cases/get-possible-integrations.js

@@ -0,0 +1,27 @@
+/**
+ * Use case for retrieving all possible integration types that can be created.
+ * @class GetPossibleIntegrations
+ */
+class GetPossibleIntegrations {
+    /**
+     * Creates a new GetPossibleIntegrations instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {Array<import('../integration').Integration>} params.integrationClasses - Array of available integration classes.
+     */
+    constructor({ integrationClasses }) {
+        this.integrationClasses = integrationClasses;
+    }
+
+    /**
+     * Executes the retrieval of all possible integration types.
+     * @async
+     * @returns {Promise<Object[]>} Array of integration option details for all available integration types.
+     */
+    async execute() {
+        return this.integrationClasses.map((integrationClass) =>
+            integrationClass.getOptionDetails()
+        );
+    }
+}
+
+module.exports = { GetPossibleIntegrations };

package/integrations/use-cases/get-process.js

@@ -0,0 +1,87 @@
+/**
+ * GetProcess Use Case
+ * 
+ * Retrieves a process by ID with proper error handling.
+ * Simple use case that delegates to repository.
+ * 
+ * Design Philosophy:
+ * - Use cases provide consistent error handling
+ * - Business logic layer between controllers and repositories
+ * - Return null for not found vs throwing error (configurable)
+ * 
+ * @example
+ * const getProcess = new GetProcess({ processRepository });
+ * const process = await getProcess.execute(processId);
+ * // or
+ * const process = await getProcess.executeOrThrow(processId);
+ */
+class GetProcess {
+    /**
+     * @param {Object} params
+     * @param {ProcessRepositoryInterface} params.processRepository - Repository for process data access
+     */
+    constructor({ processRepository }) {
+        if (!processRepository) {
+            throw new Error('processRepository is required');
+        }
+        this.processRepository = processRepository;
+    }
+
+    /**
+     * Execute the use case to get a process by ID
+     * @param {string} processId - Process ID to retrieve
+     * @returns {Promise<Object|null>} Process record or null if not found
+     * @throws {Error} If processId is invalid
+     */
+    async execute(processId) {
+        // Validate input
+        if (!processId || typeof processId !== 'string') {
+            throw new Error('processId must be a non-empty string');
+        }
+
+        // Delegate to repository
+        try {
+            const process = await this.processRepository.findById(processId);
+            return process;
+        } catch (error) {
+            throw new Error(`Failed to retrieve process: ${error.message}`);
+        }
+    }
+
+    /**
+     * Execute and throw if process not found
+     * @param {string} processId - Process ID to retrieve
+     * @returns {Promise<Object>} Process record
+     * @throws {Error} If process not found or retrieval fails
+     */
+    async executeOrThrow(processId) {
+        const process = await this.execute(processId);
+
+        if (!process) {
+            throw new Error(`Process not found: ${processId}`);
+        }
+
+        return process;
+    }
+
+    /**
+     * Get multiple processes by IDs
+     * @param {string[]} processIds - Array of process IDs
+     * @returns {Promise<Array>} Array of process records (excludes not found)
+     */
+    async executeMany(processIds) {
+        if (!Array.isArray(processIds)) {
+            throw new Error('processIds must be an array');
+        }
+
+        const processes = await Promise.all(
+            processIds.map(id => this.execute(id))
+        );
+
+        // Filter out nulls (not found)
+        return processes.filter(p => p !== null);
+    }
+}
+
+module.exports = { GetProcess };
+

package/integrations/use-cases/index.js

@@ -0,0 +1,19 @@
+const { GetIntegrationsForUser } = require('./get-integrations-for-user');
+const { DeleteIntegrationForUser } = require('./delete-integration-for-user');
+const { CreateIntegration } = require('./create-integration');
+const { GetIntegration } = require('./get-integration');
+const { CreateProcess } = require('./create-process');
+const { UpdateProcessState } = require('./update-process-state');
+const { UpdateProcessMetrics } = require('./update-process-metrics');
+const { GetProcess } = require('./get-process');
+
+module.exports = {
+    GetIntegrationsForUser,
+    DeleteIntegrationForUser,
+    CreateIntegration,
+    GetIntegration,
+    CreateProcess,
+    UpdateProcessState,
+    UpdateProcessMetrics,
+    GetProcess,
+}; 

package/integrations/use-cases/load-integration-context.js

@@ -0,0 +1,71 @@
+class LoadIntegrationContextUseCase {
+    constructor({
+        integrationRepository,
+        moduleRepository,
+        moduleFactory,
+    }) {
+        if (!integrationRepository) {
+            throw new Error('integrationRepository is required');
+        }
+        if (!moduleRepository) {
+            throw new Error('moduleRepository is required');
+        }
+        if (!moduleFactory) {
+            throw new Error('moduleFactory is required');
+        }
+
+        this.integrationRepository = integrationRepository;
+        this.moduleRepository = moduleRepository;
+        this.moduleFactory = moduleFactory;
+    }
+
+    async execute({ integrationId, integrationRecord }) {
+        const record = integrationRecord
+            ? integrationRecord
+            : await this.integrationRepository.findIntegrationById(
+                  integrationId
+              );
+
+        if (!record) {
+            const error = new Error('Integration record not found');
+            error.code = 'INTEGRATION_RECORD_NOT_FOUND';
+            throw error;
+        }
+
+        if (
+            !Array.isArray(record.entitiesIds) ||
+            record.entitiesIds.length === 0
+        ) {
+            return {
+                record: {
+                    ...record,
+                    entities: [],
+                },
+                modules: [],
+            };
+        }
+
+        const entities = await this.moduleRepository.findEntitiesByIds(
+            record.entitiesIds
+        );
+
+        const modules = [];
+        for (const entity of entities) {
+            const moduleInstance = await this.moduleFactory.getModuleInstance(
+                entity.id,
+                record.userId
+            );
+            modules.push(moduleInstance);
+        }
+
+        return {
+            record: {
+                ...record,
+                entities,
+            },
+            modules,
+        };
+    }
+}
+
+module.exports = { LoadIntegrationContextUseCase };

package/integrations/use-cases/update-integration-messages.js

@@ -0,0 +1,44 @@
+/**
+ * Use case for updating messages associated with an integration.
+ * @class UpdateIntegrationMessages
+ */
+class UpdateIntegrationMessages {
+    /**
+     * Creates a new UpdateIntegrationMessages instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../repositories/integration-repository-interface').IntegrationRepositoryInterface} params.integrationRepository - Repository for integration data operations.
+     */
+    constructor({ integrationRepository }) {
+        this.integrationRepository = integrationRepository;
+    }
+
+    /**
+     * Executes the integration messages update.
+     * @async
+     * @param {string} integrationId - ID of the integration to update.
+     * @param {string} messageType - Type of message: 'errors', 'warnings', 'info', or 'logs'.
+     * @param {string} messageTitle - Title of the message.
+     * @param {string} messageBody - Body content of the message.
+     * @param {string} messageTimestamp - Timestamp when the message was created.
+     * @returns {Promise<Object>} The updated integration record.
+     */
+    async execute(
+        integrationId,
+        messageType,
+        messageTitle,
+        messageBody,
+        messageTimestamp
+    ) {
+        const integration =
+            await this.integrationRepository.updateIntegrationMessages(
+                integrationId,
+                messageType,
+                messageTitle,
+                messageBody,
+                messageTimestamp
+            );
+        return integration;
+    }
+}
+
+module.exports = { UpdateIntegrationMessages };

package/integrations/use-cases/update-integration-status.js

@@ -0,0 +1,32 @@
+/**
+ * Use case for updating the status of an integration.
+ * @class UpdateIntegrationStatus
+ */
+class UpdateIntegrationStatus {
+    /**
+     * Creates a new UpdateIntegrationStatus instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../repositories/integration-repository-interface').IntegrationRepositoryInterface} params.integrationRepository - Repository for integration data operations.
+     */
+    constructor({ integrationRepository }) {
+        this.integrationRepository = integrationRepository;
+    }
+
+    /**
+     * Executes the integration status update.
+     * @async
+     * @param {string} integrationId - ID of the integration to update.
+     * @param {string} status - New status for the integration (e.g., 'ENABLED', 'DISABLED', 'ERROR').
+     * @returns {Promise<Object>} The updated integration record.
+     */
+    async execute(integrationId, status) {
+        const integration =
+            await this.integrationRepository.updateIntegrationStatus(
+                integrationId,
+                status
+            );
+        return integration;
+    }
+}
+
+module.exports = { UpdateIntegrationStatus };

package/integrations/use-cases/update-integration.js

@@ -0,0 +1,93 @@
+// Removed Integration wrapper - using IntegrationBase directly
+const {
+    mapIntegrationClassToIntegrationDTO,
+} = require('../utils/map-integration-dto');
+
+/**
+ * Use case for updating a single integration by ID and user.
+ * @class UpdateIntegration
+ */
+class UpdateIntegration {
+    /**
+     * Creates a new UpdateIntegration instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../repositories/integration-repository-interface').IntegrationRepositoryInterface} params.integrationRepository - Repository for integration data access
+     * @param {Array<import('../integration').Integration>} params.integrationClasses - Array of available integration classes
+     * @param {import('../../modules/module-factory').ModuleFactory} params.moduleFactory - Service for module instantiation and management
+     */
+    constructor({ integrationRepository, integrationClasses, moduleFactory }) {
+        this.integrationRepository = integrationRepository;
+        this.integrationClasses = integrationClasses;
+        this.moduleFactory = moduleFactory;
+    }
+
+    /**
+     * Executes the integration update process.
+     * @async
+     * @param {string} integrationId - ID of the integration to update.
+     * @param {string} userId - ID of the user requesting the update.
+     * @param {Object} config - New configuration object for the integration.
+     * @returns {Promise<Object>} The updated integration DTO.
+     * @throws {Error} When integration is not found, doesn't belong to user, or integration class is not found.
+     */
+    async execute(integrationId, userId, config) {
+        // 1. Get integration record from repository
+        const integrationRecord =
+            await this.integrationRepository.findIntegrationById(integrationId);
+
+        if (!integrationRecord) {
+            throw new Error(
+                `No integration found by the ID of ${integrationId}`
+            );
+        }
+
+        // 2. Get the correct Integration class by type
+        const integrationClass = this.integrationClasses.find(
+            (integrationClass) =>
+                integrationClass.Definition.name ===
+                integrationRecord.config.type
+        );
+
+        if (!integrationClass) {
+            throw new Error(
+                `No integration class found for type: ${integrationRecord.config.type}`
+            );
+        }
+
+        if (integrationRecord.userId !== userId) {
+            throw new Error(
+                `Integration ${integrationId} does not belong to User ${userId}`
+            );
+        }
+
+        // 3. Load modules based on entity references
+        const modules = [];
+        for (const entityId of integrationRecord.entitiesIds) {
+            const moduleInstance = await this.moduleFactory.getModuleInstance(
+                entityId,
+                integrationRecord.userId
+            );
+            modules.push(moduleInstance);
+        }
+
+        // 4. Create the Integration domain entity with modules and updated config
+        const integrationInstance = new integrationClass({
+            id: integrationRecord.id,
+            userId: integrationRecord.userId,
+            entities: integrationRecord.entitiesIds,
+            config: config,
+            status: integrationRecord.status,
+            version: integrationRecord.version,
+            messages: integrationRecord.messages,
+            modules,
+        });
+
+        // 6. Complete async initialization (load dynamic actions, register handlers)
+        await integrationInstance.initialize();
+        await integrationInstance.send('ON_UPDATE', { config });
+
+        return mapIntegrationClassToIntegrationDTO(integrationInstance);
+    }
+}
+
+module.exports = { UpdateIntegration };

package/integrations/use-cases/update-process-metrics.js

@@ -0,0 +1,201 @@
+/** 
+ TODO:
+ This implementation contains a race condition in the `execute` method. When multiple concurrent processes call this method on the same process record, they'll each read the current state, modify it independently, and then save - potentially overwriting each other's changes.
+
+For example:
+```
+Thread 1: reads process with totalSynced=100
+Thread 2: reads process with totalSynced=100
+Thread 1: adds 50 → writes totalSynced=150
+Thread 2: adds 30 → writes totalSynced=130 (overwrites Thread 1's update!)
+```
+
+Consider implementing one of these patterns:
+1. Database transactions with row locking
+2. Optimistic concurrency control with version numbers
+3. Atomic update operations (e.g., `$inc` in MongoDB)
+4. A FIFO queue for process updates (as described in the PROCESS_MANAGEMENT_QUEUE_SPEC.md)
+
+The current approach will lead to lost updates and inconsistent metrics during concurrent processing.
+
+ */
+
+/**
+ * UpdateProcessMetrics Use Case
+ *
+ * Updates process metrics, calculates aggregates, and computes estimated completion time.
+ * Optionally broadcasts progress via WebSocket service if provided.
+ *
+ * Design Philosophy:
+ * - Metrics are cumulative (add to existing counts)
+ * - Performance metrics calculated automatically (duration, records/sec)
+ * - ETA computed based on current progress
+ * - Error history limited to last 100 entries
+ * - WebSocket broadcasting is optional (DI pattern)
+ *
+ * @example
+ * const updateMetrics = new UpdateProcessMetrics({ processRepository, websocketService });
+ * await updateMetrics.execute(processId, {
+ *   processed: 100,
+ *   success: 95,
+ *   errors: 5,
+ *   errorDetails: [{ contactId: 'abc', error: 'Missing email', timestamp: '...' }]
+ * });
+ */
+class UpdateProcessMetrics {
+    /**
+     * @param {Object} params
+     * @param {ProcessRepositoryInterface} params.processRepository - Repository for process data access
+     * @param {Object} [params.websocketService] - Optional WebSocket service for progress broadcasting
+     */
+    constructor({ processRepository, websocketService }) {
+        if (!processRepository) {
+            throw new Error('processRepository is required');
+        }
+        this.processRepository = processRepository;
+        this.websocketService = websocketService;
+    }
+
+    /**
+     * Execute the use case to update process metrics
+     * @param {string} processId - Process ID to update
+     * @param {Object} metricsUpdate - Metrics to add/update
+     * @param {number} [metricsUpdate.processed=0] - Number of records processed in this batch
+     * @param {number} [metricsUpdate.success=0] - Number of successful records
+     * @param {number} [metricsUpdate.errors=0] - Number of failed records
+     * @param {Array} [metricsUpdate.errorDetails=[]] - Error details array
+     * @returns {Promise<Object>} Updated process record
+     * @throws {Error} If process not found or update fails
+     */
+    async execute(processId, metricsUpdate) {
+        // Validate inputs
+        if (!processId || typeof processId !== 'string') {
+            throw new Error('processId must be a non-empty string');
+        }
+        if (!metricsUpdate || typeof metricsUpdate !== 'object') {
+            throw new Error('metricsUpdate must be an object');
+        }
+
+        // Retrieve current process
+        const process = await this.processRepository.findById(processId);
+        if (!process) {
+            throw new Error(`Process not found: ${processId}`);
+        }
+
+        // Get current context and results
+        const context = process.context || {};
+        const results = process.results || { aggregateData: {} };
+
+        // Initialize nested objects if not present
+        if (!results.aggregateData) {
+            results.aggregateData = {};
+        }
+
+        // Update context counters (cumulative)
+        context.processedRecords =
+            (context.processedRecords || 0) + (metricsUpdate.processed || 0);
+
+        // Update results aggregates (cumulative)
+        results.aggregateData.totalSynced =
+            (results.aggregateData.totalSynced || 0) +
+            (metricsUpdate.success || 0);
+        results.aggregateData.totalFailed =
+            (results.aggregateData.totalFailed || 0) +
+            (metricsUpdate.errors || 0);
+
+        // Append error details (limited to last 100)
+        if (
+            metricsUpdate.errorDetails &&
+            metricsUpdate.errorDetails.length > 0
+        ) {
+            results.aggregateData.errors = [
+                ...(results.aggregateData.errors || []),
+                ...metricsUpdate.errorDetails,
+            ].slice(-100); // Keep only last 100 errors
+        }
+
+        // Calculate performance metrics
+        const startTime = new Date(context.startTime || process.createdAt);
+        const elapsed = Date.now() - startTime.getTime();
+        results.aggregateData.duration = elapsed;
+
+        if (elapsed > 0 && context.processedRecords > 0) {
+            results.aggregateData.recordsPerSecond =
+                context.processedRecords / (elapsed / 1000);
+        } else {
+            results.aggregateData.recordsPerSecond = 0;
+        }
+
+        // Calculate ETA if we know total
+        if (context.totalRecords > 0 && context.processedRecords > 0) {
+            const remaining = context.totalRecords - context.processedRecords;
+            if (results.aggregateData.recordsPerSecond > 0) {
+                const etaMs =
+                    (remaining / results.aggregateData.recordsPerSecond) * 1000;
+                const eta = new Date(Date.now() + etaMs);
+                context.estimatedCompletion = eta.toISOString();
+            }
+        }
+
+        // Prepare updates
+        const updates = {
+            context,
+            results,
+        };
+
+        // Persist updates
+        let updatedProcess;
+        try {
+            updatedProcess = await this.processRepository.update(
+                processId,
+                updates
+            );
+        } catch (error) {
+            throw new Error(
+                `Failed to update process metrics: ${error.message}`
+            );
+        }
+
+        // Broadcast progress via WebSocket (if service provided)
+        if (this.websocketService) {
+            await this._broadcastProgress(updatedProcess);
+        }
+
+        return updatedProcess;
+    }
+
+    /**
+     * Broadcast progress update via WebSocket
+     * @private
+     * @param {Object} process - Updated process record
+     */
+    async _broadcastProgress(process) {
+        try {
+            const context = process.context || {};
+            const results = process.results || { aggregateData: {} };
+            const aggregateData = results.aggregateData || {};
+
+            await this.websocketService.broadcast({
+                type: 'PROCESS_PROGRESS',
+                data: {
+                    processId: process.id,
+                    processName: process.name,
+                    processType: process.type,
+                    state: process.state,
+                    processed: context.processedRecords || 0,
+                    total: context.totalRecords || 0,
+                    successCount: aggregateData.totalSynced || 0,
+                    errorCount: aggregateData.totalFailed || 0,
+                    recordsPerSecond: aggregateData.recordsPerSecond || 0,
+                    estimatedCompletion: context.estimatedCompletion || null,
+                    timestamp: new Date().toISOString(),
+                },
+            });
+        } catch (error) {
+            // Log but don't fail the update if WebSocket broadcast fails
+            console.error('Failed to broadcast process progress:', error);
+        }
+    }
+}
+
+module.exports = { UpdateProcessMetrics };