n8n
Version:
n8n Workflow Automation Tool
300 lines • 14.4 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __metadata = (this && this.__metadata) || function (k, v) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.SourceControlExportService = void 0;
const typedi_1 = __importStar(require("typedi"));
const path_1 = __importDefault(require("path"));
const constants_1 = require("./constants");
const n8n_workflow_1 = require("n8n-workflow");
const promises_1 = require("fs/promises");
const fs_1 = require("fs");
const n8n_core_1 = require("n8n-core");
const sourceControlHelper_ee_1 = require("./sourceControlHelper.ee");
const variables_service_ee_1 = require("../variables/variables.service.ee");
const tag_repository_1 = require("../../databases/repositories/tag.repository");
const workflow_repository_1 = require("../../databases/repositories/workflow.repository");
const Logger_1 = require("../../Logger");
const sharedCredentials_repository_1 = require("../../databases/repositories/sharedCredentials.repository");
const sharedWorkflow_repository_1 = require("../../databases/repositories/sharedWorkflow.repository");
const workflowTagMapping_repository_1 = require("../../databases/repositories/workflowTagMapping.repository");
let SourceControlExportService = class SourceControlExportService {
constructor(logger, variablesService, tagRepository, instanceSettings) {
this.logger = logger;
this.variablesService = variablesService;
this.tagRepository = tagRepository;
this.replaceCredentialData = (data) => {
for (const [key] of Object.entries(data)) {
try {
if (data[key] === null) {
delete data[key];
}
else if (typeof data[key] === 'object') {
data[key] = this.replaceCredentialData(data[key]);
}
else if (typeof data[key] === 'string') {
data[key] = (0, sourceControlHelper_ee_1.stringContainsExpression)(data[key]) ? data[key] : '';
}
else if (typeof data[key] === 'number') {
continue;
}
}
catch (error) {
this.logger.error(`Failed to sanitize credential data: ${error.message}`);
throw error;
}
}
return data;
};
this.gitFolder = path_1.default.join(instanceSettings.n8nFolder, constants_1.SOURCE_CONTROL_GIT_FOLDER);
this.workflowExportFolder = path_1.default.join(this.gitFolder, constants_1.SOURCE_CONTROL_WORKFLOW_EXPORT_FOLDER);
this.credentialExportFolder = path_1.default.join(this.gitFolder, constants_1.SOURCE_CONTROL_CREDENTIAL_EXPORT_FOLDER);
}
getWorkflowPath(workflowId) {
return (0, sourceControlHelper_ee_1.getWorkflowExportPath)(workflowId, this.workflowExportFolder);
}
getCredentialsPath(credentialsId) {
return (0, sourceControlHelper_ee_1.getCredentialExportPath)(credentialsId, this.credentialExportFolder);
}
async deleteRepositoryFolder() {
try {
await (0, promises_1.rm)(this.gitFolder, { recursive: true });
}
catch (error) {
this.logger.error(`Failed to delete work folder: ${error.message}`);
}
}
rmFilesFromExportFolder(filesToBeDeleted) {
try {
filesToBeDeleted.forEach((e) => (0, fs_1.rmSync)(e));
}
catch (error) {
this.logger.error(`Failed to delete workflows from work folder: ${error.message}`);
}
return filesToBeDeleted;
}
async writeExportableWorkflowsToExportFolder(workflowsToBeExported, owners) {
await Promise.all(workflowsToBeExported.map(async (e) => {
const fileName = this.getWorkflowPath(e.id);
const sanitizedWorkflow = {
id: e.id,
name: e.name,
nodes: e.nodes,
connections: e.connections,
settings: e.settings,
triggerCount: e.triggerCount,
versionId: e.versionId,
owner: owners[e.id],
};
this.logger.debug(`Writing workflow ${e.id} to ${fileName}`);
return await (0, promises_1.writeFile)(fileName, JSON.stringify(sanitizedWorkflow, null, 2));
}));
}
async exportWorkflowsToWorkFolder(candidates) {
try {
(0, sourceControlHelper_ee_1.sourceControlFoldersExistCheck)([this.workflowExportFolder]);
const workflowIds = candidates.map((e) => e.id);
const sharedWorkflows = await typedi_1.default.get(sharedWorkflow_repository_1.SharedWorkflowRepository).findByWorkflowIds(workflowIds);
const workflows = await typedi_1.default.get(workflow_repository_1.WorkflowRepository).findByIds(workflowIds);
const owners = {};
sharedWorkflows.forEach((e) => {
const project = e.project;
if (!project) {
throw new n8n_workflow_1.ApplicationError(`Workflow ${e.workflow.display()} has no owner`);
}
if (project.type === 'personal') {
const ownerRelation = project.projectRelations.find((pr) => pr.role === 'project:personalOwner');
if (!ownerRelation) {
throw new n8n_workflow_1.ApplicationError(`Workflow ${e.workflow.display()} has no owner`);
}
owners[e.workflowId] = {
type: 'personal',
personalEmail: ownerRelation.user.email,
};
}
else if (project.type === 'team') {
owners[e.workflowId] = {
type: 'team',
teamId: project.id,
teamName: project.name,
};
}
else {
throw new n8n_workflow_1.ApplicationError(`Workflow belongs to unknown project type: ${project.type}`);
}
});
await this.writeExportableWorkflowsToExportFolder(workflows, owners);
return {
count: sharedWorkflows.length,
folder: this.workflowExportFolder,
files: workflows.map((e) => ({
id: e === null || e === void 0 ? void 0 : e.id,
name: this.getWorkflowPath(e === null || e === void 0 ? void 0 : e.name),
})),
};
}
catch (error) {
throw new n8n_workflow_1.ApplicationError('Failed to export workflows to work folder', { cause: error });
}
}
async exportVariablesToWorkFolder() {
try {
(0, sourceControlHelper_ee_1.sourceControlFoldersExistCheck)([this.gitFolder]);
const variables = await this.variablesService.getAllCached();
if (variables.length === 0) {
return {
count: 0,
folder: this.gitFolder,
files: [],
};
}
const fileName = (0, sourceControlHelper_ee_1.getVariablesPath)(this.gitFolder);
const sanitizedVariables = variables.map((e) => ({ ...e, value: '' }));
await (0, promises_1.writeFile)(fileName, JSON.stringify(sanitizedVariables, null, 2));
return {
count: sanitizedVariables.length,
folder: this.gitFolder,
files: [
{
id: '',
name: fileName,
},
],
};
}
catch (error) {
throw new n8n_workflow_1.ApplicationError('Failed to export variables to work folder', {
cause: error,
});
}
}
async exportTagsToWorkFolder() {
try {
(0, sourceControlHelper_ee_1.sourceControlFoldersExistCheck)([this.gitFolder]);
const tags = await this.tagRepository.find();
if (tags.length === 0) {
return {
count: 0,
folder: this.gitFolder,
files: [],
};
}
const mappings = await typedi_1.default.get(workflowTagMapping_repository_1.WorkflowTagMappingRepository).find();
const fileName = path_1.default.join(this.gitFolder, constants_1.SOURCE_CONTROL_TAGS_EXPORT_FILE);
await (0, promises_1.writeFile)(fileName, JSON.stringify({
tags: tags.map((tag) => ({ id: tag.id, name: tag.name })),
mappings,
}, null, 2));
return {
count: tags.length,
folder: this.gitFolder,
files: [
{
id: '',
name: fileName,
},
],
};
}
catch (error) {
throw new n8n_workflow_1.ApplicationError('Failed to export variables to work folder', { cause: error });
}
}
async exportCredentialsToWorkFolder(candidates) {
try {
(0, sourceControlHelper_ee_1.sourceControlFoldersExistCheck)([this.credentialExportFolder]);
const credentialIds = candidates.map((e) => e.id);
const credentialsToBeExported = await typedi_1.default.get(sharedCredentials_repository_1.SharedCredentialsRepository).findByCredentialIds(credentialIds, 'credential:owner');
let missingIds = [];
if (credentialsToBeExported.length !== credentialIds.length) {
const foundCredentialIds = credentialsToBeExported.map((e) => e.credentialsId);
missingIds = credentialIds.filter((remote) => foundCredentialIds.findIndex((local) => local === remote) === -1);
}
await Promise.all(credentialsToBeExported.map(async (sharing) => {
const { name, type, data, id } = sharing.credentials;
const credentials = new n8n_core_1.Credentials({ id, name }, type, data);
let owner = null;
if (sharing.project.type === 'personal') {
const ownerRelation = sharing.project.projectRelations.find((pr) => pr.role === 'project:personalOwner');
if (ownerRelation) {
owner = {
type: 'personal',
personalEmail: ownerRelation.user.email,
};
}
}
else if (sharing.project.type === 'team') {
owner = {
type: 'team',
teamId: sharing.project.id,
teamName: sharing.project.name,
};
}
const stub = {
id,
name,
type,
data: this.replaceCredentialData(credentials.getData()),
ownedBy: owner,
};
const filePath = this.getCredentialsPath(id);
this.logger.debug(`Writing credentials stub "${name}" (ID ${id}) to: ${filePath}`);
return await (0, promises_1.writeFile)(filePath, JSON.stringify(stub, null, 2));
}));
return {
count: credentialsToBeExported.length,
folder: this.credentialExportFolder,
files: credentialsToBeExported.map((e) => ({
id: e.credentials.id,
name: path_1.default.join(this.credentialExportFolder, `${e.credentials.name}.json`),
})),
missingIds,
};
}
catch (error) {
throw new n8n_workflow_1.ApplicationError('Failed to export credentials to work folder', { cause: error });
}
}
};
exports.SourceControlExportService = SourceControlExportService;
exports.SourceControlExportService = SourceControlExportService = __decorate([
(0, typedi_1.Service)(),
__metadata("design:paramtypes", [Logger_1.Logger,
variables_service_ee_1.VariablesService,
tag_repository_1.TagRepository,
n8n_core_1.InstanceSettings])
], SourceControlExportService);
//# sourceMappingURL=sourceControlExport.service.ee.js.map