From db94f169fcd03983fc78a3b4c5e11543610825bf Mon Sep 17 00:00:00 2001
From: Charlie Kolb <charlie@n8n.io>
Date: Thu, 7 Nov 2024 16:22:13 +0100
Subject: [PATCH] fix(editor): Prevent NodeCreator from swallowing AskAssistant
 enter event (#11532)

---
 cypress/e2e/45-ai-assistant.cy.ts                | 16 ++++++++++++++++
 .../AskAssistantChat/AskAssistantChat.vue        |  1 +
 .../__snapshots__/AskAssistantChat.test.ts.snap  |  7 +++++++
 .../composables/useKeyboardNavigation.ts         | 10 ++++++++++
 .../editor-ui/src/components/ParameterInput.vue  |  7 +++++--
 packages/editor-ui/src/components/RunData.vue    |  2 +-
 packages/editor-ui/src/components/TextEdit.vue   |  2 +-
 .../components/WorkflowLMChat/WorkflowLMChat.vue |  2 +-
 .../src/components/WorkflowSettings.vue          | 16 ++++++++--------
 .../editor-ui/src/composables/useClipboard.ts    |  2 +-
 .../editor-ui/src/composables/useKeybindings.ts  |  2 +-
 packages/editor-ui/src/views/NodeView.vue        |  2 +-
 12 files changed, 53 insertions(+), 16 deletions(-)

diff --git a/cypress/e2e/45-ai-assistant.cy.ts b/cypress/e2e/45-ai-assistant.cy.ts
index 3b4f61f660..9c69269b33 100644
--- a/cypress/e2e/45-ai-assistant.cy.ts
+++ b/cypress/e2e/45-ai-assistant.cy.ts
@@ -4,6 +4,7 @@ import { clickCreateNewCredential, openCredentialSelect } from '../composables/n
 import { GMAIL_NODE_NAME, SCHEDULE_TRIGGER_NODE_NAME } from '../constants';
 import { CredentialsModal, CredentialsPage, NDV, WorkflowPage } from '../pages';
 import { AIAssistant } from '../pages/features/ai-assistant';
+import { NodeCreator } from '../pages/features/node-creator';
 import { getVisibleSelect } from '../utils';
 
 const wf = new WorkflowPage();
@@ -11,6 +12,7 @@ const ndv = new NDV();
 const aiAssistant = new AIAssistant();
 const credentialsPage = new CredentialsPage();
 const credentialsModal = new CredentialsModal();
+const nodeCreatorFeature = new NodeCreator();
 
 describe('AI Assistant::disabled', () => {
 	beforeEach(() => {
@@ -280,6 +282,20 @@ describe('AI Assistant::enabled', () => {
 		wf.getters.isWorkflowSaved();
 		aiAssistant.getters.placeholderMessage().should('not.exist');
 	});
+
+	it('should send message via enter even with global NodeCreator panel opened', () => {
+		cy.intercept('POST', '/rest/ai/chat', {
+			statusCode: 200,
+			fixture: 'aiAssistant/responses/simple_message_response.json',
+		}).as('chatRequest');
+
+		wf.actions.addInitialNodeToCanvas(SCHEDULE_TRIGGER_NODE_NAME);
+		aiAssistant.actions.openChat();
+		nodeCreatorFeature.actions.openNodeCreator();
+		aiAssistant.getters.chatInput().type('Hello{Enter}');
+
+		aiAssistant.getters.placeholderMessage().should('not.exist');
+	});
 });
 
 describe('AI Assistant Credential Help', () => {
diff --git a/packages/design-system/src/components/AskAssistantChat/AskAssistantChat.vue b/packages/design-system/src/components/AskAssistantChat/AskAssistantChat.vue
index 78b4ccbf51..3cd62205f6 100644
--- a/packages/design-system/src/components/AskAssistantChat/AskAssistantChat.vue
+++ b/packages/design-system/src/components/AskAssistantChat/AskAssistantChat.vue
@@ -317,6 +317,7 @@ async function onCopyButtonClick(content: string, e: MouseEvent) {
 			<textarea
 				ref="chatInput"
 				v-model="textInputValue"
+				class="ignore-key-press-node-creator ignore-key-press-canvas"
 				:disabled="sessionEnded"
 				:placeholder="t('assistantChat.inputPlaceholder')"
 				rows="1"
diff --git a/packages/design-system/src/components/AskAssistantChat/__snapshots__/AskAssistantChat.test.ts.snap b/packages/design-system/src/components/AskAssistantChat/__snapshots__/AskAssistantChat.test.ts.snap
index c26913e405..358b174503 100644
--- a/packages/design-system/src/components/AskAssistantChat/__snapshots__/AskAssistantChat.test.ts.snap
+++ b/packages/design-system/src/components/AskAssistantChat/__snapshots__/AskAssistantChat.test.ts.snap
@@ -156,6 +156,7 @@ exports[`AskAssistantChat > does not render retry button if no error is present
       data-test-id="chat-input-wrapper"
     >
       <textarea
+        class="ignore-key-press-node-creator ignore-key-press-canvas"
         data-test-id="chat-input"
         placeholder="Enter your response..."
         rows="1"
@@ -903,6 +904,7 @@ Testing more code
       data-test-id="chat-input-wrapper"
     >
       <textarea
+        class="ignore-key-press-node-creator ignore-key-press-canvas"
         data-test-id="chat-input"
         placeholder="Enter your response..."
         rows="1"
@@ -1078,6 +1080,7 @@ exports[`AskAssistantChat > renders default placeholder chat correctly 1`] = `
       data-test-id="chat-input-wrapper"
     >
       <textarea
+        class="ignore-key-press-node-creator ignore-key-press-canvas"
         data-test-id="chat-input"
         placeholder="Enter your response..."
         rows="1"
@@ -1323,6 +1326,7 @@ exports[`AskAssistantChat > renders end of session chat correctly 1`] = `
       data-test-id="chat-input-wrapper"
     >
       <textarea
+        class="ignore-key-press-node-creator ignore-key-press-canvas"
         data-test-id="chat-input"
         disabled=""
         placeholder="Enter your response..."
@@ -1493,6 +1497,7 @@ exports[`AskAssistantChat > renders error message correctly with retry button 1`
       data-test-id="chat-input-wrapper"
     >
       <textarea
+        class="ignore-key-press-node-creator ignore-key-press-canvas"
         data-test-id="chat-input"
         placeholder="Enter your response..."
         rows="1"
@@ -1737,6 +1742,7 @@ catch(e) {
       data-test-id="chat-input-wrapper"
     >
       <textarea
+        class="ignore-key-press-node-creator ignore-key-press-canvas"
         data-test-id="chat-input"
         placeholder="Enter your response..."
         rows="1"
@@ -1913,6 +1919,7 @@ exports[`AskAssistantChat > renders streaming chat correctly 1`] = `
       data-test-id="chat-input-wrapper"
     >
       <textarea
+        class="ignore-key-press-node-creator ignore-key-press-canvas"
         data-test-id="chat-input"
         placeholder="Enter your response..."
         rows="1"
diff --git a/packages/editor-ui/src/components/Node/NodeCreator/composables/useKeyboardNavigation.ts b/packages/editor-ui/src/components/Node/NodeCreator/composables/useKeyboardNavigation.ts
index 7026287946..6ffe169871 100644
--- a/packages/editor-ui/src/components/Node/NodeCreator/composables/useKeyboardNavigation.ts
+++ b/packages/editor-ui/src/components/Node/NodeCreator/composables/useKeyboardNavigation.ts
@@ -62,6 +62,16 @@ export const useKeyboardNavigation = defineStore('nodeCreatorKeyboardNavigation'
 	}
 
 	async function onKeyDown(e: KeyboardEvent) {
+		// We generally want a global listener across the app
+		// But specific components may overrule this by adopting
+		// the 'ignore-key-press-node-creator' class
+		if (
+			e.target instanceof Element &&
+			e.target.classList.contains('ignore-key-press-node-creator')
+		) {
+			return;
+		}
+
 		const pressedKey = e.key;
 		if (!WATCHED_KEYS.includes(pressedKey)) return;
 		e.preventDefault();
diff --git a/packages/editor-ui/src/components/ParameterInput.vue b/packages/editor-ui/src/components/ParameterInput.vue
index 1f2057307c..8162e854a2 100644
--- a/packages/editor-ui/src/components/ParameterInput.vue
+++ b/packages/editor-ui/src/components/ParameterInput.vue
@@ -1023,7 +1023,7 @@ onUpdated(async () => {
 			@update:model-value="expressionUpdated"
 		></ExpressionEditModal>
 
-		<div class="parameter-input ignore-key-press" :style="parameterInputWrapperStyle">
+		<div class="parameter-input ignore-key-press-canvas" :style="parameterInputWrapperStyle">
 			<ResourceLocator
 				v-if="parameter.type === 'resourceLocator'"
 				ref="resourceLocator"
@@ -1098,7 +1098,10 @@ onUpdated(async () => {
 					:before-close="closeCodeEditDialog"
 					data-test-id="code-editor-fullscreen"
 				>
-					<div :key="codeEditDialogVisible.toString()" class="ignore-key-press code-edit-dialog">
+					<div
+						:key="codeEditDialogVisible.toString()"
+						class="ignore-key-press-canvas code-edit-dialog"
+					>
 						<CodeNodeEditor
 							v-if="editorType === 'codeNodeEditor'"
 							:mode="codeEditorMode"
diff --git a/packages/editor-ui/src/components/RunData.vue b/packages/editor-ui/src/components/RunData.vue
index 6a197d35e9..d0baa2d0c3 100644
--- a/packages/editor-ui/src/components/RunData.vue
+++ b/packages/editor-ui/src/components/RunData.vue
@@ -1409,7 +1409,7 @@ defineExpose({ enterEditMode });
 			</div>
 
 			<div v-else-if="editMode.enabled" :class="$style.editMode">
-				<div :class="[$style.editModeBody, 'ignore-key-press']">
+				<div :class="[$style.editModeBody, 'ignore-key-press-canvas']">
 					<JsonEditor
 						:model-value="editMode.value"
 						:fill-parent="true"
diff --git a/packages/editor-ui/src/components/TextEdit.vue b/packages/editor-ui/src/components/TextEdit.vue
index e884a0d7d6..95b2c3bb9a 100644
--- a/packages/editor-ui/src/components/TextEdit.vue
+++ b/packages/editor-ui/src/components/TextEdit.vue
@@ -68,7 +68,7 @@ const closeDialog = () => {
 				.inputLabelDisplayName(parameter, path)}`"
 			:before-close="closeDialog"
 		>
-			<div class="ignore-key-press">
+			<div class="ignore-key-press-canvas">
 				<n8n-input-label :label="$locale.nodeText().inputLabelDisplayName(parameter, path)">
 					<div @keydown.stop @keydown.esc="onKeyDownEsc">
 						<n8n-input
diff --git a/packages/editor-ui/src/components/WorkflowLMChat/WorkflowLMChat.vue b/packages/editor-ui/src/components/WorkflowLMChat/WorkflowLMChat.vue
index e76ab8241a..72fcd3012d 100644
--- a/packages/editor-ui/src/components/WorkflowLMChat/WorkflowLMChat.vue
+++ b/packages/editor-ui/src/components/WorkflowLMChat/WorkflowLMChat.vue
@@ -536,7 +536,7 @@ onMounted(() => {
 				data-test-id="workflow-lm-chat-dialog"
 				:style="messageVars"
 			>
-				<MessagesList :messages="messages" :class="[$style.messages, 'ignore-key-press']">
+				<MessagesList :messages="messages" :class="[$style.messages, 'ignore-key-press-canvas']">
 					<template #beforeMessage="{ message }">
 						<MessageOptionTooltip
 							v-if="message.sender === 'bot' && !message.id.includes('preload')"
diff --git a/packages/editor-ui/src/components/WorkflowSettings.vue b/packages/editor-ui/src/components/WorkflowSettings.vue
index c552e8327c..3146e9a7e6 100644
--- a/packages/editor-ui/src/components/WorkflowSettings.vue
+++ b/packages/editor-ui/src/components/WorkflowSettings.vue
@@ -486,7 +486,7 @@ onMounted(async () => {
 					<el-col :span="10" class="setting-name">
 						{{ $locale.baseText('workflowSettings.executionOrder') + ':' }}
 					</el-col>
-					<el-col :span="14" class="ignore-key-press">
+					<el-col :span="14" class="ignore-key-press-canvas">
 						<n8n-select
 							v-model="workflowSettings.executionOrder"
 							placeholder="Select Execution Order"
@@ -517,7 +517,7 @@ onMounted(async () => {
 							<font-awesome-icon icon="question-circle" />
 						</n8n-tooltip>
 					</el-col>
-					<el-col :span="14" class="ignore-key-press">
+					<el-col :span="14" class="ignore-key-press-canvas">
 						<n8n-select
 							v-model="workflowSettings.errorWorkflow"
 							placeholder="Select Workflow"
@@ -548,7 +548,7 @@ onMounted(async () => {
 							</n8n-tooltip>
 						</el-col>
 
-						<el-col :span="14" class="ignore-key-press">
+						<el-col :span="14" class="ignore-key-press-canvas">
 							<n8n-select
 								v-model="workflowSettings.callerPolicy"
 								:disabled="readOnlyEnv || !workflowPermissions.update"
@@ -598,7 +598,7 @@ onMounted(async () => {
 							<font-awesome-icon icon="question-circle" />
 						</n8n-tooltip>
 					</el-col>
-					<el-col :span="14" class="ignore-key-press">
+					<el-col :span="14" class="ignore-key-press-canvas">
 						<n8n-select
 							v-model="workflowSettings.timezone"
 							placeholder="Select Timezone"
@@ -627,7 +627,7 @@ onMounted(async () => {
 							<font-awesome-icon icon="question-circle" />
 						</n8n-tooltip>
 					</el-col>
-					<el-col :span="14" class="ignore-key-press">
+					<el-col :span="14" class="ignore-key-press-canvas">
 						<n8n-select
 							v-model="workflowSettings.saveDataErrorExecution"
 							:placeholder="$locale.baseText('workflowSettings.selectOption')"
@@ -656,7 +656,7 @@ onMounted(async () => {
 							<font-awesome-icon icon="question-circle" />
 						</n8n-tooltip>
 					</el-col>
-					<el-col :span="14" class="ignore-key-press">
+					<el-col :span="14" class="ignore-key-press-canvas">
 						<n8n-select
 							v-model="workflowSettings.saveDataSuccessExecution"
 							:placeholder="$locale.baseText('workflowSettings.selectOption')"
@@ -685,7 +685,7 @@ onMounted(async () => {
 							<font-awesome-icon icon="question-circle" />
 						</n8n-tooltip>
 					</el-col>
-					<el-col :span="14" class="ignore-key-press">
+					<el-col :span="14" class="ignore-key-press-canvas">
 						<n8n-select
 							v-model="workflowSettings.saveManualExecutions"
 							:placeholder="$locale.baseText('workflowSettings.selectOption')"
@@ -714,7 +714,7 @@ onMounted(async () => {
 							<font-awesome-icon icon="question-circle" />
 						</n8n-tooltip>
 					</el-col>
-					<el-col :span="14" class="ignore-key-press">
+					<el-col :span="14" class="ignore-key-press-canvas">
 						<n8n-select
 							v-model="workflowSettings.saveExecutionProgress"
 							:placeholder="$locale.baseText('workflowSettings.selectOption')"
diff --git a/packages/editor-ui/src/composables/useClipboard.ts b/packages/editor-ui/src/composables/useClipboard.ts
index 1cd4c9ef70..6716494f94 100644
--- a/packages/editor-ui/src/composables/useClipboard.ts
+++ b/packages/editor-ui/src/composables/useClipboard.ts
@@ -14,7 +14,7 @@ export function useClipboard(
 	const { debounce } = useDebounce();
 	const { copy, copied, isSupported, text } = useClipboardCore({ legacy: true });
 
-	const ignoreClasses = ['el-messsage-box', 'ignore-key-press'];
+	const ignoreClasses = ['el-messsage-box', 'ignore-key-press-canvas'];
 	const initialized = ref(false);
 
 	const onPasteCallback = ref<ClipboardEventFn | null>(options.onPaste || null);
diff --git a/packages/editor-ui/src/composables/useKeybindings.ts b/packages/editor-ui/src/composables/useKeybindings.ts
index 4aa460c562..5abcb58efb 100644
--- a/packages/editor-ui/src/composables/useKeybindings.ts
+++ b/packages/editor-ui/src/composables/useKeybindings.ts
@@ -22,7 +22,7 @@ export const useKeybindings = (
 		const active = activeElement.value;
 		const isInput = ['INPUT', 'TEXTAREA'].includes(active.tagName);
 		const isContentEditable = active.closest('[contenteditable]') !== null;
-		const isIgnoreClass = active.closest('.ignore-key-press') !== null;
+		const isIgnoreClass = active.closest('.ignore-key-press-canvas') !== null;
 
 		return isInput || isContentEditable || isIgnoreClass;
 	});
diff --git a/packages/editor-ui/src/views/NodeView.vue b/packages/editor-ui/src/views/NodeView.vue
index e55dd859e3..9c1b1f3be6 100644
--- a/packages/editor-ui/src/views/NodeView.vue
+++ b/packages/editor-ui/src/views/NodeView.vue
@@ -1268,7 +1268,7 @@ export default defineComponent({
 					element instanceof HTMLElement &&
 					element.className &&
 					typeof element.className === 'string' &&
-					element.className.includes('ignore-key-press')
+					element.className.includes('ignore-key-press-canvas')
 				) {
 					return;
 				}