Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(editor): Restrict when a ChatTrigger Node is added automatically #11523

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import {
AI_CATEGORY_LANGUAGE_MODELS,
BASIC_CHAIN_NODE_TYPE,
CHAT_TRIGGER_NODE_TYPE,
MANUAL_CHAT_TRIGGER_NODE_TYPE,
MANUAL_TRIGGER_NODE_TYPE,
NODE_CREATOR_OPEN_SOURCES,
NO_OP_NODE_TYPE,
Expand Down Expand Up @@ -204,8 +203,6 @@ export const useActions = () => {
);
}
function shouldPrependChatTrigger(addedNodes: AddedNode[]): boolean {
const { allNodes } = useWorkflowsStore();

const COMPATIBLE_CHAT_NODES = [
QA_CHAIN_NODE_TYPE,
AGENT_NODE_TYPE,
Expand All @@ -214,13 +211,23 @@ export const useActions = () => {
OPEN_AI_NODE_MESSAGE_ASSISTANT_TYPE,
];

const isChatTriggerMissing =
allNodes.find((node) =>
[MANUAL_CHAT_TRIGGER_NODE_TYPE, CHAT_TRIGGER_NODE_TYPE].includes(node.type),
) === undefined;
const isCompatibleNode = addedNodes.some((node) => COMPATIBLE_CHAT_NODES.includes(node.type));

return isCompatibleNode && isChatTriggerMissing;
if (!isCompatibleNode) return false;

const { allNodes, getNodeTypes } = useWorkflowsStore();
const { getByNameAndVersion } = getNodeTypes();

// We want to add a trigger if there are no triggers other than Manual Triggers
const shouldAddChatTrigger = allNodes.every((node) => {
const nodeType = getByNameAndVersion(node.type, node.typeVersion);

return (
!nodeType.description.group.includes('trigger') || node.type === MANUAL_TRIGGER_NODE_TYPE
);
});

return shouldAddChatTrigger;
}

// AI-226: Prepend LLM Chain node when adding a language model
Expand Down
100 changes: 100 additions & 0 deletions packages/editor-ui/src/components/Node/NodeCreator/useActions.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import { useNodeTypesStore } from '@/stores/nodeTypes.store';
import { useWorkflowsStore } from '@/stores/workflows.store';
import { useActions } from './composables/useActions';
import {
AGENT_NODE_TYPE,
GITHUB_TRIGGER_NODE_TYPE,
HTTP_REQUEST_NODE_TYPE,
MANUAL_TRIGGER_NODE_TYPE,
NODE_CREATOR_OPEN_SOURCES,
Expand All @@ -15,6 +17,7 @@ import {
TRIGGER_NODE_CREATOR_VIEW,
WEBHOOK_NODE_TYPE,
} from '@/constants';
import { CHAT_TRIGGER_NODE_TYPE } from 'n8n-workflow';

describe('useActions', () => {
beforeAll(() => {
Expand Down Expand Up @@ -54,6 +57,9 @@ describe('useActions', () => {
vi.spyOn(workflowsStore, 'workflowTriggerNodes', 'get').mockReturnValue([
{ type: SCHEDULE_TRIGGER_NODE_TYPE } as never,
]);
vi.spyOn(workflowsStore, 'getNodeTypes').mockReturnValue({
getByNameAndVersion: () => ({ description: { group: ['trigger'] } }),
} as never);
vi.spyOn(nodeCreatorStore, 'openSource', 'get').mockReturnValue(
NODE_CREATOR_OPEN_SOURCES.ADD_NODE_BUTTON,
);
Expand All @@ -67,6 +73,100 @@ describe('useActions', () => {
});
});

test('should insert a ChatTrigger node when an AI Agent is added without trigger', () => {
const workflowsStore = useWorkflowsStore();

vi.spyOn(workflowsStore, 'workflowTriggerNodes', 'get').mockReturnValue([]);

const { getAddedNodesAndConnections } = useActions();

expect(getAddedNodesAndConnections([{ type: AGENT_NODE_TYPE }])).toEqual({
connections: [
{
from: {
nodeIndex: 0,
},
to: {
nodeIndex: 1,
},
},
],
nodes: [
{ type: CHAT_TRIGGER_NODE_TYPE, isAutoAdd: true },
{ type: AGENT_NODE_TYPE, openDetail: true },
],
});
});

test('should insert a ChatTrigger node when an AI Agent is added with only a Manual Trigger', () => {
const workflowsStore = useWorkflowsStore();

vi.spyOn(workflowsStore, 'workflowTriggerNodes', 'get').mockReturnValue([
{ type: MANUAL_TRIGGER_NODE_TYPE } as never,
]);
vi.spyOn(workflowsStore, 'getNodeTypes').mockReturnValue({
getByNameAndVersion: () => ({ description: { group: ['trigger'] } }),
} as never);

const { getAddedNodesAndConnections } = useActions();

expect(getAddedNodesAndConnections([{ type: AGENT_NODE_TYPE }])).toEqual({
connections: [
{
from: {
nodeIndex: 0,
},
to: {
nodeIndex: 1,
},
},
],
nodes: [
{ type: CHAT_TRIGGER_NODE_TYPE, isAutoAdd: true },
{ type: AGENT_NODE_TYPE, openDetail: true },
],
});
});

test('should not insert a ChatTrigger node when an AI Agent is added with a trigger already present', () => {
const workflowsStore = useWorkflowsStore();

vi.spyOn(workflowsStore, 'allNodes', 'get').mockReturnValue([
{ type: GITHUB_TRIGGER_NODE_TYPE } as never,
]);
vi.spyOn(workflowsStore, 'getNodeTypes').mockReturnValue({
getByNameAndVersion: () => ({ description: { group: ['trigger'] } }),
} as never);

const { getAddedNodesAndConnections } = useActions();

expect(getAddedNodesAndConnections([{ type: AGENT_NODE_TYPE }])).toEqual({
connections: [],
nodes: [{ type: AGENT_NODE_TYPE, openDetail: true }],
});
});

test('should not insert a ChatTrigger node when an AI Agent is added with a Chat Trigger already present', () => {
const workflowsStore = useWorkflowsStore();

vi.spyOn(workflowsStore, 'workflowTriggerNodes', 'get').mockReturnValue([
{ type: CHAT_TRIGGER_NODE_TYPE } as never,
]);
vi.spyOn(workflowsStore, 'allNodes', 'get').mockReturnValue([
{ type: CHAT_TRIGGER_NODE_TYPE } as never,
]);
vi.spyOn(workflowsStore, 'getNodeTypes').mockReturnValue({
getByNameAndVersion: () => ({ description: { group: ['trigger'] } }),
} as never);

const { getAddedNodesAndConnections } = useActions();

expect(getAddedNodesAndConnections([{ type: AGENT_NODE_TYPE }])).toEqual({
connections: [],
nodes: [{ type: AGENT_NODE_TYPE, openDetail: true }],
});
});

test('should insert a No Op node when a Loop Over Items Node is added', () => {
const workflowsStore = useWorkflowsStore();
const nodeCreatorStore = useNodeCreatorStore();
Expand Down