@friggframework/core 2.0.0-next.42 → 2.0.0-next.44

package/integrations/repositories/process-repository-interface.js

@@ -0,0 +1,90 @@
+/**
+ * ProcessRepository Interface
+ * 
+ * Defines the contract for Process data access operations.
+ * Implementations must provide concrete methods for all operations.
+ * 
+ * This interface supports the Hexagonal Architecture pattern by:
+ * - Defining clear boundaries between domain logic and data access
+ * - Allowing multiple implementations (MongoDB, PostgreSQL, in-memory)
+ * - Enabling dependency injection and testability
+ */
+class ProcessRepositoryInterface {
+    /**
+     * Create a new process record
+     * @param {Object} processData - Process data to create
+     * @param {string} processData.userId - User ID
+     * @param {string} processData.integrationId - Integration ID
+     * @param {string} processData.name - Process name
+     * @param {string} processData.type - Process type
+     * @param {string} processData.state - Initial state
+     * @param {Object} [processData.context] - Process context
+     * @param {Object} [processData.results] - Process results
+     * @param {string[]} [processData.childProcesses] - Child process IDs
+     * @param {string} [processData.parentProcessId] - Parent process ID
+     * @returns {Promise<Object>} Created process record
+     */
+    async create(processData) {
+        throw new Error('Method create() must be implemented');
+    }
+
+    /**
+     * Find a process by ID
+     * @param {string} processId - Process ID to find
+     * @returns {Promise<Object|null>} Process record or null if not found
+     */
+    async findById(processId) {
+        throw new Error('Method findById() must be implemented');
+    }
+
+    /**
+     * Update a process record
+     * @param {string} processId - Process ID to update
+     * @param {Object} updates - Fields to update
+     * @returns {Promise<Object>} Updated process record
+     */
+    async update(processId, updates) {
+        throw new Error('Method update() must be implemented');
+    }
+
+    /**
+     * Find processes by integration and type
+     * @param {string} integrationId - Integration ID
+     * @param {string} type - Process type
+     * @returns {Promise<Array>} Array of process records
+     */
+    async findByIntegrationAndType(integrationId, type) {
+        throw new Error('Method findByIntegrationAndType() must be implemented');
+    }
+
+    /**
+     * Find active processes (not in excluded states)
+     * @param {string} integrationId - Integration ID
+     * @param {string[]} [excludeStates=['COMPLETED', 'ERROR']] - States to exclude
+     * @returns {Promise<Array>} Array of active process records
+     */
+    async findActiveProcesses(integrationId, excludeStates = ['COMPLETED', 'ERROR']) {
+        throw new Error('Method findActiveProcesses() must be implemented');
+    }
+
+    /**
+     * Find a process by name (most recent)
+     * @param {string} name - Process name
+     * @returns {Promise<Object|null>} Most recent process with given name, or null
+     */
+    async findByName(name) {
+        throw new Error('Method findByName() must be implemented');
+    }
+
+    /**
+     * Delete a process by ID
+     * @param {string} processId - Process ID to delete
+     * @returns {Promise<void>}
+     */
+    async deleteById(processId) {
+        throw new Error('Method deleteById() must be implemented');
+    }
+}
+
+module.exports = { ProcessRepositoryInterface };
+

package/integrations/repositories/process-repository-mongo.js

@@ -0,0 +1,190 @@
+const { prisma } = require('../../database/prisma');
+const { ProcessRepositoryInterface } = require('./process-repository-interface');
+
+/**
+ * MongoDB Process Repository Adapter
+ * Handles process persistence using Prisma with MongoDB
+ *
+ * MongoDB-specific characteristics:
+ * - Uses scalar fields for relations (userId, integrationId)
+ * - IDs are strings with @db.ObjectId
+ * - JSON fields for flexible context and results storage
+ * - Array field for childProcesses references
+ *
+ * Design Philosophy:
+ * - Generic Process model supports any type of long-running operation
+ * - Context and results stored as JSON for maximum flexibility
+ * - Integration-specific logic lives in use cases and services
+ */
+class ProcessRepositoryMongo extends ProcessRepositoryInterface {
+    constructor() {
+        super();
+        this.prisma = prisma;
+    }
+
+    /**
+     * Create a new process record
+     * @param {Object} processData - Process data to create
+     * @returns {Promise<Object>} Created process record
+     */
+    async create(processData) {
+        const process = await this.prisma.process.create({
+            data: {
+                userId: processData.userId,
+                integrationId: processData.integrationId,
+                name: processData.name,
+                type: processData.type,
+                state: processData.state || 'INITIALIZING',
+                context: processData.context || {},
+                results: processData.results || {},
+                childProcesses: processData.childProcesses || [],
+                parentProcessId: processData.parentProcessId || null,
+            },
+        });
+
+        return this._toPlainObject(process);
+    }
+
+    /**
+     * Find a process by ID
+     * @param {string} processId - Process ID to find
+     * @returns {Promise<Object|null>} Process record or null if not found
+     */
+    async findById(processId) {
+        const process = await this.prisma.process.findUnique({
+            where: { id: processId },
+        });
+
+        return process ? this._toPlainObject(process) : null;
+    }
+
+    /**
+     * Update a process record
+     * @param {string} processId - Process ID to update
+     * @param {Object} updates - Fields to update
+     * @returns {Promise<Object>} Updated process record
+     */
+    async update(processId, updates) {
+        // Prepare update data, excluding undefined values
+        const updateData = {};
+
+        if (updates.state !== undefined) {
+            updateData.state = updates.state;
+        }
+        if (updates.context !== undefined) {
+            updateData.context = updates.context;
+        }
+        if (updates.results !== undefined) {
+            updateData.results = updates.results;
+        }
+        if (updates.childProcesses !== undefined) {
+            updateData.childProcesses = updates.childProcesses;
+        }
+        if (updates.parentProcessId !== undefined) {
+            updateData.parentProcessId = updates.parentProcessId;
+        }
+
+        const process = await this.prisma.process.update({
+            where: { id: processId },
+            data: updateData,
+        });
+
+        return this._toPlainObject(process);
+    }
+
+    /**
+     * Find processes by integration and type
+     * @param {string} integrationId - Integration ID
+     * @param {string} type - Process type
+     * @returns {Promise<Array>} Array of process records
+     */
+    async findByIntegrationAndType(integrationId, type) {
+        const processes = await this.prisma.process.findMany({
+            where: {
+                integrationId,
+                type,
+            },
+            orderBy: {
+                createdAt: 'desc',
+            },
+        });
+
+        return processes.map((p) => this._toPlainObject(p));
+    }
+
+    /**
+     * Find active processes (not in excluded states)
+     * @param {string} integrationId - Integration ID
+     * @param {string[]} [excludeStates=['COMPLETED', 'ERROR']] - States to exclude
+     * @returns {Promise<Array>} Array of active process records
+     */
+    async findActiveProcesses(integrationId, excludeStates = ['COMPLETED', 'ERROR']) {
+        const processes = await this.prisma.process.findMany({
+            where: {
+                integrationId,
+                state: {
+                    notIn: excludeStates,
+                },
+            },
+            orderBy: {
+                createdAt: 'desc',
+            },
+        });
+
+        return processes.map((p) => this._toPlainObject(p));
+    }
+
+    /**
+     * Find a process by name (most recent)
+     * @param {string} name - Process name
+     * @returns {Promise<Object|null>} Most recent process with given name, or null
+     */
+    async findByName(name) {
+        const process = await this.prisma.process.findFirst({
+            where: { name },
+            orderBy: {
+                createdAt: 'desc',
+            },
+        });
+
+        return process ? this._toPlainObject(process) : null;
+    }
+
+    /**
+     * Delete a process by ID
+     * @param {string} processId - Process ID to delete
+     * @returns {Promise<void>}
+     */
+    async deleteById(processId) {
+        await this.prisma.process.delete({
+            where: { id: processId },
+        });
+    }
+
+    /**
+     * Convert Prisma model to plain JavaScript object
+     * Ensures consistent API across repository implementations
+     * @private
+     * @param {Object} process - Prisma process model
+     * @returns {Object} Plain process object
+     */
+    _toPlainObject(process) {
+        return {
+            id: process.id,
+            userId: process.userId,
+            integrationId: process.integrationId,
+            name: process.name,
+            type: process.type,
+            state: process.state,
+            context: process.context,
+            results: process.results,
+            childProcesses: process.childProcesses,
+            parentProcessId: process.parentProcessId,
+            createdAt: process.createdAt,
+            updatedAt: process.updatedAt,
+        };
+    }
+}
+
+module.exports = { ProcessRepositoryMongo };
+

package/integrations/repositories/process-repository-postgres.js

@@ -0,0 +1,194 @@
+const { prisma } = require('../../database/prisma');
+const { ProcessRepositoryInterface } = require('./process-repository-interface');
+
+/**
+ * PostgreSQL Process Repository Adapter
+ * Handles process persistence using Prisma with PostgreSQL
+ *
+ * PostgreSQL-specific characteristics:
+ * - Uses foreign key constraints for relations
+ * - JSONB type for context and results (efficient querying)
+ * - Array type for childProcesses references
+ * - Transactional support available if needed
+ *
+ * Design Philosophy:
+ * - Same interface as MongoDB repository
+ * - Prisma abstracts away most database-specific details
+ * - Minor differences in JSON handling internally managed by Prisma
+ */
+class ProcessRepositoryPostgres extends ProcessRepositoryInterface {
+    constructor() {
+        super();
+        this.prisma = prisma;
+    }
+
+    /**
+     * Create a new process record
+     * @param {Object} processData - Process data to create
+     * @returns {Promise<Object>} Created process record
+     */
+    async create(processData) {
+        const process = await this.prisma.process.create({
+            data: {
+                userId: processData.userId,
+                integrationId: processData.integrationId,
+                name: processData.name,
+                type: processData.type,
+                state: processData.state || 'INITIALIZING',
+                context: processData.context || {},
+                results: processData.results || {},
+                childProcesses: processData.childProcesses || [],
+                parentProcessId: processData.parentProcessId || null,
+            },
+        });
+
+        return this._toPlainObject(process);
+    }
+
+    /**
+     * Find a process by ID
+     * @param {string} processId - Process ID to find
+     * @returns {Promise<Object|null>} Process record or null if not found
+     */
+    async findById(processId) {
+        const process = await this.prisma.process.findUnique({
+            where: { id: processId },
+        });
+
+        return process ? this._toPlainObject(process) : null;
+    }
+
+    /**
+     * Update a process record
+     * @param {string} processId - Process ID to update
+     * @param {Object} updates - Fields to update
+     * @returns {Promise<Object>} Updated process record
+     */
+    async update(processId, updates) {
+        // Prepare update data, excluding undefined values
+        const updateData = {};
+
+        if (updates.state !== undefined) {
+            updateData.state = updates.state;
+        }
+        if (updates.context !== undefined) {
+            updateData.context = updates.context;
+        }
+        if (updates.results !== undefined) {
+            updateData.results = updates.results;
+        }
+        if (updates.childProcesses !== undefined) {
+            updateData.childProcesses = updates.childProcesses;
+        }
+        if (updates.parentProcessId !== undefined) {
+            updateData.parentProcessId = updates.parentProcessId;
+        }
+
+        const process = await this.prisma.process.update({
+            where: { id: processId },
+            data: updateData,
+        });
+
+        return this._toPlainObject(process);
+    }
+
+    /**
+     * Find processes by integration and type
+     * @param {string} integrationId - Integration ID
+     * @param {string} type - Process type
+     * @returns {Promise<Array>} Array of process records
+     */
+    async findByIntegrationAndType(integrationId, type) {
+        const processes = await this.prisma.process.findMany({
+            where: {
+                integrationId,
+                type,
+            },
+            orderBy: {
+                createdAt: 'desc',
+            },
+        });
+
+        return processes.map((p) => this._toPlainObject(p));
+    }
+
+    /**
+     * Find active processes (not in excluded states)
+     * @param {string} integrationId - Integration ID
+     * @param {string[]} [excludeStates=['COMPLETED', 'ERROR']] - States to exclude
+     * @returns {Promise<Array>} Array of active process records
+     */
+    async findActiveProcesses(integrationId, excludeStates = ['COMPLETED', 'ERROR']) {
+        const processes = await this.prisma.process.findMany({
+            where: {
+                integrationId,
+                state: {
+                    notIn: excludeStates,
+                },
+            },
+            orderBy: {
+                createdAt: 'desc',
+            },
+        });
+
+        return processes.map((p) => this._toPlainObject(p));
+    }
+
+    /**
+     * Find a process by name (most recent)
+     * @param {string} name - Process name
+     * @returns {Promise<Object|null>} Most recent process with given name, or null
+     */
+    async findByName(name) {
+        const process = await this.prisma.process.findFirst({
+            where: { name },
+            orderBy: {
+                createdAt: 'desc',
+            },
+        });
+
+        return process ? this._toPlainObject(process) : null;
+    }
+
+    /**
+     * Delete a process by ID
+     * @param {string} processId - Process ID to delete
+     * @returns {Promise<void>}
+     */
+    async deleteById(processId) {
+        await this.prisma.process.delete({
+            where: { id: processId },
+        });
+    }
+
+    /**
+     * Convert Prisma model to plain JavaScript object
+     * Ensures consistent API across repository implementations
+     * @private
+     * @param {Object} process - Prisma process model
+     * @returns {Object} Plain process object
+     */
+    _toPlainObject(process) {
+        return {
+            id: String(process.id),
+            userId: String(process.userId),
+            integrationId: String(process.integrationId),
+            name: process.name,
+            type: process.type,
+            state: process.state,
+            context: process.context,
+            results: process.results,
+            childProcesses: Array.isArray(process.childProcesses)
+                ? (process.childProcesses.length > 0 && typeof process.childProcesses[0] === 'object' && process.childProcesses[0] !== null
+                    ? process.childProcesses.map(child => String(child.id))
+                    : process.childProcesses)
+                : [],
+            parentProcessId: process.parentProcessId !== null ? String(process.parentProcessId) : null,
+            createdAt: process.createdAt,
+            updatedAt: process.updatedAt,
+        };
+    }
+}
+
+module.exports = { ProcessRepositoryPostgres };
+

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

@@ -0,0 +1,128 @@
+/**
+ * CreateProcess Use Case
+ * 
+ * Creates a new process record for tracking long-running operations.
+ * Validates required fields and delegates persistence to the repository.
+ * 
+ * Design Philosophy:
+ * - Use cases encapsulate business logic
+ * - Validation happens at the use case layer
+ * - Repositories handle only data access
+ * - Process model is generic and reusable
+ * 
+ * @example
+ * const createProcess = new CreateProcess({ processRepository });
+ * const process = await createProcess.execute({
+ *   userId: 'user123',
+ *   integrationId: 'integration456',
+ *   name: 'zoho-crm-contact-sync',
+ *   type: 'CRM_SYNC',
+ *   state: 'INITIALIZING',
+ *   context: { syncType: 'INITIAL', totalRecords: 0 },
+ *   results: { aggregateData: { totalSynced: 0, totalFailed: 0 } }
+ * });
+ */
+class CreateProcess {
+    /**
+     * @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 create a process
+     * @param {Object} processData - Process data to create
+     * @param {string} processData.userId - User ID (required)
+     * @param {string} processData.integrationId - Integration ID (required)
+     * @param {string} processData.name - Process name (required)
+     * @param {string} processData.type - Process type (required)
+     * @param {string} [processData.state='INITIALIZING'] - Initial state
+     * @param {Object} [processData.context={}] - Process context
+     * @param {Object} [processData.results={}] - Process results
+     * @param {string[]} [processData.childProcesses=[]] - Child process IDs
+     * @param {string} [processData.parentProcessId] - Parent process ID
+     * @returns {Promise<Object>} Created process record
+     * @throws {Error} If validation fails or creation errors
+     */
+    async execute(processData) {
+        // Validate required fields
+        this._validateProcessData(processData);
+
+        // Set defaults for optional fields
+        const processToCreate = {
+            userId: processData.userId,
+            integrationId: processData.integrationId,
+            name: processData.name,
+            type: processData.type,
+            state: processData.state || 'INITIALIZING',
+            context: processData.context || {},
+            results: processData.results || {},
+            childProcesses: processData.childProcesses || [],
+            parentProcessId: processData.parentProcessId || null,
+        };
+
+        // Delegate to repository
+        try {
+            const createdProcess = await this.processRepository.create(processToCreate);
+            return createdProcess;
+        } catch (error) {
+            throw new Error(`Failed to create process: ${error.message}`);
+        }
+    }
+
+    /**
+     * Validate process data
+     * @private
+     * @param {Object} processData - Process data to validate
+     * @throws {Error} If validation fails
+     */
+    _validateProcessData(processData) {
+        const requiredFields = ['userId', 'integrationId', 'name', 'type'];
+        const missingFields = requiredFields.filter(field => !processData[field]);
+
+        if (missingFields.length > 0) {
+            throw new Error(
+                `Missing required fields for process creation: ${missingFields.join(', ')}`
+            );
+        }
+
+        // Validate field types
+        if (typeof processData.userId !== 'string') {
+            throw new Error('userId must be a string');
+        }
+        if (typeof processData.integrationId !== 'string') {
+            throw new Error('integrationId must be a string');
+        }
+        if (typeof processData.name !== 'string') {
+            throw new Error('name must be a string');
+        }
+        if (typeof processData.type !== 'string') {
+            throw new Error('type must be a string');
+        }
+
+        // Validate optional fields if provided
+        if (processData.state && typeof processData.state !== 'string') {
+            throw new Error('state must be a string');
+        }
+        if (processData.context && typeof processData.context !== 'object') {
+            throw new Error('context must be an object');
+        }
+        if (processData.results && typeof processData.results !== 'object') {
+            throw new Error('results must be an object');
+        }
+        if (processData.childProcesses && !Array.isArray(processData.childProcesses)) {
+            throw new Error('childProcesses must be an array');
+        }
+        if (processData.parentProcessId && typeof processData.parentProcessId !== 'string') {
+            throw new Error('parentProcessId must be a string');
+        }
+    }
+}
+
+module.exports = { CreateProcess };
+