n8n/packages/cli/src/errors/subworkflow-policy-denial.error.ts

68 lines
2.2 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import type { Project } from '@n8n/db';
import { WorkflowOperationError } from 'n8n-workflow';
import type { INode } from 'n8n-workflow';
type Options = {
/** ID of the subworkflow whose execution was denied. */
subworkflowId: string;
/** Project that owns the subworkflow whose execution was denied. */
subworkflowProject: Project;
/** Whether the user has read access to the subworkflow based on their project and scope. */
hasReadAccess: boolean;
/** URL of the n8n instance. */
instanceUrl: string;
/** Full name of the user who owns the personal project that owns the subworkflow. Absent if team project. */
ownerName?: string;
/** Node that triggered the execution of the subworkflow whose execution was denied. */
node?: INode;
};
export const SUBWORKFLOW_DENIAL_BASE_DESCRIPTION =
'The sub-workflow youre trying to execute limits which workflows it can be called by.';
export class SubworkflowPolicyDenialError extends WorkflowOperationError {
constructor({
subworkflowId,
subworkflowProject,
instanceUrl,
hasReadAccess,
ownerName,
node,
}: Options) {
const descriptions = {
default: SUBWORKFLOW_DENIAL_BASE_DESCRIPTION,
accessible: [
SUBWORKFLOW_DENIAL_BASE_DESCRIPTION,
`<a href="${instanceUrl}/workflow/${subworkflowId}" target="_blank">Update sub-workflow settings</a> to allow other workflows to call it.`,
].join(' '),
inaccessiblePersonalProject: [
SUBWORKFLOW_DENIAL_BASE_DESCRIPTION,
`You will need ${ownerName} to update the sub-workflow (${subworkflowId}) settings to allow this workflow to call it.`,
].join(' '),
inaccesibleTeamProject: [
SUBWORKFLOW_DENIAL_BASE_DESCRIPTION,
`You will need an admin from the ${subworkflowProject.name} project to update the sub-workflow (${subworkflowId}) settings to allow this workflow to call it.`,
].join(' '),
};
const description = () => {
if (hasReadAccess) return descriptions.accessible;
if (subworkflowProject.type === 'personal') return descriptions.inaccessiblePersonalProject;
if (subworkflowProject.type === 'team') return descriptions.inaccesibleTeamProject;
return descriptions.default;
};
super(
`The sub-workflow (${subworkflowId}) cannot be called by this workflow`,
node,
description(),
);
}
}