Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(core): Introduce import service (no-changelog) (#8001)
Consolidate import logic into import service. Also fixes: - https://linear.app/n8n/issue/PAY-1086 - #7881 - https://community.n8n.io/t/cli-workflow-imports-failing-after-upgrade-to-v1-18-0/33780 - https://linear.app/n8n/issue/PAY-221 - #5477 - https://community.n8n.io/t/export-workflows-with-tags-got-created/6161
- Loading branch information
Showing
4 changed files
with
356 additions
and
206 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| import { Service } from 'typedi'; | ||
| import { v4 as uuid } from 'uuid'; | ||
| import { type INode, type INodeCredentialsDetails } from 'n8n-workflow'; | ||
| import type { EntityManager } from 'typeorm'; | ||
|
|
||
| import { Logger } from '@/Logger'; | ||
| import * as Db from '@/Db'; | ||
| import { CredentialsRepository } from '@/databases/repositories/credentials.repository'; | ||
| import { TagRepository } from '@/databases/repositories/tag.repository'; | ||
| import { SharedWorkflow } from '@/databases/entities/SharedWorkflow'; | ||
| import { RoleService } from '@/services/role.service'; | ||
| import { replaceInvalidCredentials } from '@/WorkflowHelpers'; | ||
| import { WorkflowEntity } from '@/databases/entities/WorkflowEntity'; | ||
| import { WorkflowTagMapping } from '@/databases/entities/WorkflowTagMapping'; | ||
|
|
||
| import type { TagEntity } from '@/databases/entities/TagEntity'; | ||
| import type { Role } from '@/databases/entities/Role'; | ||
| import type { ICredentialsDb } from '@/Interfaces'; | ||
|
|
||
| @Service() | ||
| export class ImportService { | ||
| private dbCredentials: ICredentialsDb[] = []; | ||
|
|
||
| private dbTags: TagEntity[] = []; | ||
|
|
||
| private workflowOwnerRole: Role; | ||
|
|
||
| constructor( | ||
| private readonly logger: Logger, | ||
| private readonly credentialsRepository: CredentialsRepository, | ||
| private readonly tagRepository: TagRepository, | ||
| private readonly roleService: RoleService, | ||
| ) {} | ||
|
|
||
| async initRecords() { | ||
| this.dbCredentials = await this.credentialsRepository.find(); | ||
| this.dbTags = await this.tagRepository.find(); | ||
| this.workflowOwnerRole = await this.roleService.findWorkflowOwnerRole(); | ||
| } | ||
|
|
||
| async importWorkflows(workflows: WorkflowEntity[], userId: string) { | ||
| await this.initRecords(); | ||
|
|
||
| for (const workflow of workflows) { | ||
| workflow.nodes.forEach((node) => { | ||
| this.toNewCredentialFormat(node); | ||
|
|
||
| if (!node.id) node.id = uuid(); | ||
| }); | ||
|
|
||
| const hasInvalidCreds = workflow.nodes.some((node) => !node.credentials?.id); | ||
|
|
||
| if (hasInvalidCreds) await this.replaceInvalidCreds(workflow); | ||
| } | ||
|
|
||
| await Db.transaction(async (tx) => { | ||
| for (const workflow of workflows) { | ||
| if (workflow.active) { | ||
| workflow.active = false; | ||
|
|
||
| this.logger.info(`Deactivating workflow "${workflow.name}". Remember to activate later.`); | ||
| } | ||
|
|
||
| const upsertResult = await tx.upsert(WorkflowEntity, workflow, ['id']); | ||
|
|
||
| const workflowId = upsertResult.identifiers.at(0)?.id as string; | ||
|
|
||
| await tx.upsert(SharedWorkflow, { workflowId, userId, roleId: this.workflowOwnerRole.id }, [ | ||
| 'workflowId', | ||
| 'userId', | ||
| ]); | ||
|
|
||
| if (!workflow.tags?.length) continue; | ||
|
|
||
| await this.setTags(tx, workflow); | ||
|
|
||
| for (const tag of workflow.tags) { | ||
| await tx.upsert(WorkflowTagMapping, { tagId: tag.id, workflowId }, [ | ||
| 'tagId', | ||
| 'workflowId', | ||
| ]); | ||
| } | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| async replaceInvalidCreds(workflow: WorkflowEntity) { | ||
| try { | ||
| await replaceInvalidCredentials(workflow); | ||
| } catch (e) { | ||
| const error = e instanceof Error ? e : new Error(`${e}`); | ||
| this.logger.error('Failed to replace invalid credential', error); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Convert a node's credentials from old format `{ <nodeType>: <credentialName> }` | ||
| * to new format: `{ <nodeType>: { id: string | null, name: <credentialName> } }` | ||
| */ | ||
| private toNewCredentialFormat(node: INode) { | ||
| if (!node.credentials) return; | ||
|
|
||
| for (const [type, name] of Object.entries(node.credentials)) { | ||
| if (typeof name !== 'string') continue; | ||
|
|
||
| const nodeCredential: INodeCredentialsDetails = { id: null, name }; | ||
|
|
||
| const match = this.dbCredentials.find((c) => c.name === name && c.type === type); | ||
|
|
||
| if (match) nodeCredential.id = match.id; | ||
|
|
||
| node.credentials[type] = nodeCredential; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Set tags on workflow to import while ensuring all tags exist in the database, | ||
| * either by matching incoming to existing tags or by creating them first. | ||
| */ | ||
| private async setTags(tx: EntityManager, workflow: WorkflowEntity) { | ||
| if (!workflow?.tags?.length) return; | ||
|
|
||
| for (let i = 0; i < workflow.tags.length; i++) { | ||
| const importTag = workflow.tags[i]; | ||
|
|
||
| if (!importTag.name) continue; | ||
|
|
||
| const identicalMatch = this.dbTags.find( | ||
| (dbTag) => | ||
| dbTag.id === importTag.id && | ||
| dbTag.createdAt && | ||
| importTag.createdAt && | ||
| dbTag.createdAt.getTime() === new Date(importTag.createdAt).getTime(), | ||
| ); | ||
|
|
||
| if (identicalMatch) { | ||
| workflow.tags[i] = identicalMatch; | ||
| continue; | ||
| } | ||
|
|
||
| const nameMatch = this.dbTags.find((dbTag) => dbTag.name === importTag.name); | ||
|
|
||
| if (nameMatch) { | ||
| workflow.tags[i] = nameMatch; | ||
| continue; | ||
| } | ||
|
|
||
| const tagEntity = this.tagRepository.create(importTag); | ||
|
|
||
| workflow.tags[i] = await tx.save<TagEntity>(tagEntity); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.