import { Container } from 'typedi'; import { Flags } from '@oclif/core'; import { ApplicationError, jsonParse } from 'n8n-workflow'; import fs from 'fs'; import glob from 'fast-glob'; import { UM_FIX_INSTRUCTION } from '@/constants'; import { WorkflowEntity } from '@db/entities/WorkflowEntity'; import { disableAutoGeneratedIds } from '@db/utils/commandHelpers'; import { generateNanoId } from '@db/utils/generators'; import { UserRepository } from '@db/repositories/user.repository'; import { WorkflowRepository } from '@db/repositories/workflow.repository'; import type { IWorkflowToImport } from '@/Interfaces'; import { ImportService } from '@/services/import.service'; import { BaseCommand } from '../BaseCommand'; import { SharedWorkflowRepository } from '@db/repositories/sharedWorkflow.repository'; import { ProjectRepository } from '@/databases/repositories/project.repository'; function assertHasWorkflowsToImport(workflows: unknown): asserts workflows is IWorkflowToImport[] { if (!Array.isArray(workflows)) { throw new ApplicationError( 'File does not seem to contain workflows. Make sure the workflows are contained in an array.', ); } for (const workflow of workflows) { if ( typeof workflow !== 'object' || !Object.prototype.hasOwnProperty.call(workflow, 'nodes') || !Object.prototype.hasOwnProperty.call(workflow, 'connections') ) { throw new ApplicationError('File does not seem to contain valid workflows.'); } } } export class ImportWorkflowsCommand extends BaseCommand { static description = 'Import workflows'; static examples = [ '$ n8n import:workflow --input=file.json', '$ n8n import:workflow --separate --input=backups/latest/', '$ n8n import:workflow --input=file.json --userId=1d64c3d2-85fe-4a83-a649-e446b07b3aae', '$ n8n import:workflow --input=file.json --projectId=Ox8O54VQrmBrb4qL', '$ n8n import:workflow --separate --input=backups/latest/ --userId=1d64c3d2-85fe-4a83-a649-e446b07b3aae', ]; static flags = { help: Flags.help({ char: 'h' }), input: Flags.string({ char: 'i', description: 'Input file name or directory if --separate is used', }), separate: Flags.boolean({ description: 'Imports *.json files from directory provided by --input', }), userId: Flags.string({ description: 'The ID of the user to assign the imported workflows to', }), projectId: Flags.string({ description: 'The ID of the project to assign the imported workflows to', }), }; async init() { disableAutoGeneratedIds(WorkflowEntity); await super.init(); } async run(): Promise { const { flags } = await this.parse(ImportWorkflowsCommand); if (!flags.input) { this.logger.info('An input file or directory with --input must be provided'); return; } if (flags.separate) { if (fs.existsSync(flags.input)) { if (!fs.lstatSync(flags.input).isDirectory()) { this.logger.info('The argument to --input must be a directory'); return; } } } if (flags.projectId && flags.userId) { throw new ApplicationError( 'You cannot use `--userId` and `--projectId` together. Use one or the other.', ); } const project = await this.getProject(flags.userId, flags.projectId); const workflows = await this.readWorkflows(flags.input, flags.separate); const result = await this.checkRelations(workflows, flags.projectId, flags.userId); if (!result.success) { throw new ApplicationError(result.message); } this.logger.info(`Importing ${workflows.length} workflows...`); await Container.get(ImportService).importWorkflows(workflows, project.id); this.reportSuccess(workflows.length); } private async checkRelations(workflows: WorkflowEntity[], projectId?: string, userId?: string) { // The credential is not supposed to be re-owned. if (!userId && !projectId) { return { success: true as const, message: undefined, }; } for (const workflow of workflows) { if (!(await this.workflowExists(workflow))) { continue; } const { user, project: ownerProject } = await this.getWorkflowOwner(workflow); if (!ownerProject) { continue; } if (ownerProject.id !== projectId) { const currentOwner = ownerProject.type === 'personal' ? `the user with the ID "${user.id}"` : `the project with the ID "${ownerProject.id}"`; const newOwner = userId ? // The user passed in `--userId`, so let's use the user ID in the error // message as opposed to the project ID. `the user with the ID "${userId}"` : `the project with the ID "${projectId}"`; return { success: false as const, message: `The credential with ID "${workflow.id}" is already owned by ${currentOwner}. It can't be re-owned by ${newOwner}.`, }; } } return { success: true as const, message: undefined, }; } async catch(error: Error) { this.logger.error('An error occurred while importing workflows. See log messages for details.'); this.logger.error(error.message); } private reportSuccess(total: number) { this.logger.info(`Successfully imported ${total} ${total === 1 ? 'workflow.' : 'workflows.'}`); } private async getOwnerProject() { const owner = await Container.get(UserRepository).findOneBy({ role: 'global:owner' }); if (!owner) { throw new ApplicationError(`Failed to find owner. ${UM_FIX_INSTRUCTION}`); } const project = await Container.get(ProjectRepository).getPersonalProjectForUserOrFail( owner.id, ); return project; } private async getWorkflowOwner(workflow: WorkflowEntity) { const sharing = await Container.get(SharedWorkflowRepository).findOne({ where: { workflowId: workflow.id, role: 'workflow:owner' }, relations: { project: true }, }); if (sharing && sharing.project.type === 'personal') { const user = await Container.get(UserRepository).findOneByOrFail({ projectRelations: { role: 'project:personalOwner', projectId: sharing.projectId, }, }); return { user, project: sharing.project }; } return {}; } private async workflowExists(workflow: WorkflowEntity) { return await Container.get(WorkflowRepository).existsBy({ id: workflow.id }); } private async readWorkflows(path: string, separate: boolean): Promise { if (process.platform === 'win32') { path = path.replace(/\\/g, '/'); } if (separate) { const files = await glob('*.json', { cwd: path, absolute: true, }); const workflowInstances = files.map((file) => { const workflow = jsonParse(fs.readFileSync(file, { encoding: 'utf8' })); if (!workflow.id) { workflow.id = generateNanoId(); } const workflowInstance = Container.get(WorkflowRepository).create(workflow); return workflowInstance; }); return workflowInstances; } else { const workflows = jsonParse(fs.readFileSync(path, { encoding: 'utf8' })); const workflowInstances = workflows.map((w) => Container.get(WorkflowRepository).create(w)); assertHasWorkflowsToImport(workflows); return workflowInstances; } } private async getProject(userId?: string, projectId?: string) { if (projectId) { return await Container.get(ProjectRepository).findOneByOrFail({ id: projectId }); } if (userId) { return await Container.get(ProjectRepository).getPersonalProjectForUserOrFail(userId); } return await this.getOwnerProject(); } }