mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-18 10:31:15 +00:00
refactor(core): Introduce import service (no-changelog) (#8001)
Consolidate import logic into import service. Also fixes: - https://linear.app/n8n/issue/PAY-1086 - https://github.com/n8n-io/n8n/issues/7881 - https://community.n8n.io/t/cli-workflow-imports-failing-after-upgrade-to-v1-18-0/33780 - https://linear.app/n8n/issue/PAY-221 - https://github.com/n8n-io/n8n/issues/5477 - https://community.n8n.io/t/export-workflows-with-tags-got-created/6161
This commit is contained in:
@@ -1,26 +1,18 @@
|
||||
import { flags } from '@oclif/command';
|
||||
import type { INode, INodeCredentialsDetails } from 'n8n-workflow';
|
||||
import { ApplicationError, jsonParse } from 'n8n-workflow';
|
||||
import fs from 'fs';
|
||||
import glob from 'fast-glob';
|
||||
import { Container } from 'typedi';
|
||||
import type { EntityManager } from 'typeorm';
|
||||
import { v4 as uuid } from 'uuid';
|
||||
import * as Db from '@/Db';
|
||||
import { SharedWorkflow } from '@db/entities/SharedWorkflow';
|
||||
import { WorkflowEntity } from '@db/entities/WorkflowEntity';
|
||||
import type { Role } from '@db/entities/Role';
|
||||
import type { User } from '@db/entities/User';
|
||||
import { disableAutoGeneratedIds } from '@db/utils/commandHelpers';
|
||||
import type { ICredentialsDb, IWorkflowToImport } from '@/Interfaces';
|
||||
import { replaceInvalidCredentials } from '@/WorkflowHelpers';
|
||||
import type { IWorkflowToImport } from '@/Interfaces';
|
||||
import { BaseCommand } from '../BaseCommand';
|
||||
import { generateNanoId } from '@db/utils/generators';
|
||||
import { RoleService } from '@/services/role.service';
|
||||
import { TagService } from '@/services/tag.service';
|
||||
import { UM_FIX_INSTRUCTION } from '@/constants';
|
||||
import { UserRepository } from '@db/repositories/user.repository';
|
||||
import { CredentialsRepository } from '@db/repositories/credentials.repository';
|
||||
import { ImportService } from '@/services/import.service';
|
||||
import { WorkflowRepository } from '@/databases/repositories/workflow.repository';
|
||||
|
||||
function assertHasWorkflowsToImport(workflows: unknown): asserts workflows is IWorkflowToImport[] {
|
||||
if (!Array.isArray(workflows)) {
|
||||
@@ -64,16 +56,9 @@ export class ImportWorkflowsCommand extends BaseCommand {
|
||||
}),
|
||||
};
|
||||
|
||||
private ownerWorkflowRole: Role;
|
||||
|
||||
private transactionManager: EntityManager;
|
||||
|
||||
private tagService: TagService;
|
||||
|
||||
async init() {
|
||||
disableAutoGeneratedIds(WorkflowEntity);
|
||||
await super.init();
|
||||
this.tagService = Container.get(TagService);
|
||||
}
|
||||
|
||||
async run(): Promise<void> {
|
||||
@@ -94,12 +79,8 @@ export class ImportWorkflowsCommand extends BaseCommand {
|
||||
}
|
||||
}
|
||||
|
||||
await this.initOwnerWorkflowRole();
|
||||
const user = flags.userId ? await this.getAssignee(flags.userId) : await this.getOwner();
|
||||
|
||||
const credentials = await Container.get(CredentialsRepository).find();
|
||||
const tags = await this.tagService.getAll();
|
||||
|
||||
let totalImported = 0;
|
||||
|
||||
if (flags.separate) {
|
||||
@@ -116,41 +97,17 @@ export class ImportWorkflowsCommand extends BaseCommand {
|
||||
|
||||
totalImported = files.length;
|
||||
this.logger.info(`Importing ${totalImported} workflows...`);
|
||||
await Db.getConnection().transaction(async (transactionManager) => {
|
||||
this.transactionManager = transactionManager;
|
||||
|
||||
for (const file of files) {
|
||||
const workflow = jsonParse<IWorkflowToImport>(
|
||||
fs.readFileSync(file, { encoding: 'utf8' }),
|
||||
);
|
||||
if (!workflow.id) {
|
||||
workflow.id = generateNanoId();
|
||||
}
|
||||
|
||||
if (credentials.length > 0) {
|
||||
workflow.nodes.forEach((node: INode) => {
|
||||
this.transformCredentials(node, credentials);
|
||||
|
||||
if (!node.id) {
|
||||
node.id = uuid();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
if (Object.prototype.hasOwnProperty.call(workflow, 'tags')) {
|
||||
await this.tagService.setTagsForImport(transactionManager, workflow, tags);
|
||||
}
|
||||
|
||||
if (workflow.active) {
|
||||
this.logger.info(
|
||||
`Deactivating workflow "${workflow.name}" during import, remember to activate it later.`,
|
||||
);
|
||||
workflow.active = false;
|
||||
}
|
||||
|
||||
await this.storeWorkflow(workflow, user);
|
||||
for (const file of files) {
|
||||
const workflow = jsonParse<IWorkflowToImport>(fs.readFileSync(file, { encoding: 'utf8' }));
|
||||
if (!workflow.id) {
|
||||
workflow.id = generateNanoId();
|
||||
}
|
||||
});
|
||||
|
||||
const _workflow = Container.get(WorkflowRepository).create(workflow);
|
||||
|
||||
await Container.get(ImportService).importWorkflows([_workflow], user.id);
|
||||
}
|
||||
|
||||
this.reportSuccess(totalImported);
|
||||
process.exit();
|
||||
@@ -160,46 +117,13 @@ export class ImportWorkflowsCommand extends BaseCommand {
|
||||
fs.readFileSync(flags.input, { encoding: 'utf8' }),
|
||||
);
|
||||
|
||||
const _workflows = workflows.map((w) => Container.get(WorkflowRepository).create(w));
|
||||
|
||||
assertHasWorkflowsToImport(workflows);
|
||||
|
||||
totalImported = workflows.length;
|
||||
|
||||
await Db.getConnection().transaction(async (transactionManager) => {
|
||||
this.transactionManager = transactionManager;
|
||||
|
||||
for (const workflow of workflows) {
|
||||
let oldCredentialFormat = false;
|
||||
if (credentials.length > 0) {
|
||||
workflow.nodes.forEach((node: INode) => {
|
||||
this.transformCredentials(node, credentials);
|
||||
if (!node.id) {
|
||||
node.id = uuid();
|
||||
}
|
||||
if (!node.credentials?.id) {
|
||||
oldCredentialFormat = true;
|
||||
}
|
||||
});
|
||||
}
|
||||
if (oldCredentialFormat) {
|
||||
try {
|
||||
await replaceInvalidCredentials(workflow as unknown as WorkflowEntity);
|
||||
} catch (error) {
|
||||
this.logger.error('Failed to replace invalid credential', error as Error);
|
||||
}
|
||||
}
|
||||
if (Object.prototype.hasOwnProperty.call(workflow, 'tags')) {
|
||||
await this.tagService.setTagsForImport(transactionManager, workflow, tags);
|
||||
}
|
||||
if (workflow.active) {
|
||||
this.logger.info(
|
||||
`Deactivating workflow "${workflow.name}" during import, remember to activate it later.`,
|
||||
);
|
||||
workflow.active = false;
|
||||
}
|
||||
|
||||
await this.storeWorkflow(workflow, user);
|
||||
}
|
||||
});
|
||||
await Container.get(ImportService).importWorkflows(_workflows, user.id);
|
||||
|
||||
this.reportSuccess(totalImported);
|
||||
}
|
||||
@@ -213,29 +137,6 @@ export class ImportWorkflowsCommand extends BaseCommand {
|
||||
this.logger.info(`Successfully imported ${total} ${total === 1 ? 'workflow.' : 'workflows.'}`);
|
||||
}
|
||||
|
||||
private async initOwnerWorkflowRole() {
|
||||
const ownerWorkflowRole = await Container.get(RoleService).findWorkflowOwnerRole();
|
||||
|
||||
if (!ownerWorkflowRole) {
|
||||
throw new ApplicationError(`Failed to find owner workflow role. ${UM_FIX_INSTRUCTION}`);
|
||||
}
|
||||
|
||||
this.ownerWorkflowRole = ownerWorkflowRole;
|
||||
}
|
||||
|
||||
private async storeWorkflow(workflow: object, user: User) {
|
||||
const result = await this.transactionManager.upsert(WorkflowEntity, workflow, ['id']);
|
||||
await this.transactionManager.upsert(
|
||||
SharedWorkflow,
|
||||
{
|
||||
workflowId: result.identifiers[0].id as string,
|
||||
userId: user.id,
|
||||
roleId: this.ownerWorkflowRole.id,
|
||||
},
|
||||
['workflowId', 'userId'],
|
||||
);
|
||||
}
|
||||
|
||||
private async getOwner() {
|
||||
const ownerGlobalRole = await Container.get(RoleService).findGlobalOwnerRole();
|
||||
|
||||
@@ -259,28 +160,4 @@ export class ImportWorkflowsCommand extends BaseCommand {
|
||||
|
||||
return user;
|
||||
}
|
||||
|
||||
private transformCredentials(node: INode, credentialsEntities: ICredentialsDb[]) {
|
||||
if (node.credentials) {
|
||||
const allNodeCredentials = Object.entries(node.credentials);
|
||||
for (const [type, name] of allNodeCredentials) {
|
||||
if (typeof name === 'string') {
|
||||
const nodeCredentials: INodeCredentialsDetails = {
|
||||
id: null,
|
||||
name,
|
||||
};
|
||||
|
||||
const matchingCredentials = credentialsEntities.filter(
|
||||
(credentials) => credentials.name === name && credentials.type === type,
|
||||
);
|
||||
|
||||
if (matchingCredentials.length === 1) {
|
||||
nodeCredentials.id = matchingCredentials[0].id;
|
||||
}
|
||||
|
||||
node.credentials[type] = nodeCredentials;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user