fix: Add tests

n8n-io · Sep 13, 2024 · 3d64400 · 3d64400
1 parent 8ec08a6
commit 3d64400
Show file tree

Hide file tree

Showing 7 changed files with 350 additions and 0 deletions.
diff --git a/cypress/e2e/45-ai-assistant.cy.ts b/cypress/e2e/45-ai-assistant.cy.ts
@@ -374,3 +374,58 @@ describe('AI Assistant Credential Help', () => {
 		aiAssistant.getters.credentialEditAssistantButton().should('be.disabled');
 	});
 });
+
+describe('General help', () => {
+	beforeEach(() => {
+		aiAssistant.actions.enableAssistant();
+		wf.actions.visit();
+	});
+
+	it('assistant returns code snippet', () => {
+		cy.intercept('POST', '/rest/ai-assistant/chat', {
+			statusCode: 200,
+			fixture: 'aiAssistant/code_snippet_response.json',
+		}).as('chatRequest');
+
+		aiAssistant.getters.askAssistantFloatingButton().should('be.visible');
+		aiAssistant.getters.askAssistantFloatingButton().click();
+		aiAssistant.getters.askAssistantChat().should('be.visible');
+		aiAssistant.getters.placeholderMessage().should('be.visible');
+		aiAssistant.getters.chatInput().should('be.visible');
+
+		aiAssistant.getters.chatInput().type('Show me an expression');
+		aiAssistant.getters.sendMessageButton().click();
+
+		aiAssistant.getters.chatMessagesAll().should('have.length', 3);
+		aiAssistant.getters.chatMessagesUser().eq(0).should('contain.text', 'Show me an expression');
+
+		aiAssistant.getters
+			.chatMessagesAssistant()
+			.eq(0)
+			.should('contain.text', 'To use expressions in n8n, follow these steps:');
+
+		aiAssistant.getters
+			.chatMessagesAssistant()
+			.eq(0)
+			.should(
+				'include.html',
+				`<pre><code class="language-json">[
+  {
+    "headers": {
+      "host": "n8n.instance.address",
+      ...
+    },
+    "params": {},
+    "query": {},
+    "body": {
+      "name": "Jim",
+      "age": 30,
+      "city": "New York"
+    }
+  }
+]
+</code></pre>`,
+			);
+		aiAssistant.getters.codeSnippet().should('have.text', '{{$json.body.city}}');
+	});
+});
diff --git a/cypress/fixtures/aiAssistant/code_snippet_response.json b/cypress/fixtures/aiAssistant/code_snippet_response.json
@@ -0,0 +1,28 @@
+{
+	"sessionId": "f1d19ed5-0d55-4bad-b49a-f0c56bd6f76f-705b5dbf-12d4-4805-87a3-1e5b3c716d29-W1JgVNrpfitpSNF9rAjB4",
+	"messages": [
+			{
+					"role": "assistant",
+					"type": "message",
+					"text": "To use expressions in n8n, follow these steps:\n\n1. Hover over the parameter where you want to use an expression.\n2. Select **Expressions** in the **Fixed/Expression** toggle.\n3. Write your expression in the parameter, or select **Open expression editor** to open the expressions editor. You can browse the available data in the **Variable selector**. All expressions have the format `{{ your expression here }}`.\n\n### Example: Get data from webhook body\n\nIf your webhook data looks like this:\n\n```json\n[\n  {\n    \"headers\": {\n      \"host\": \"n8n.instance.address\",\n      ...\n    },\n    \"params\": {},\n    \"query\": {},\n    \"body\": {\n      \"name\": \"Jim\",\n      \"age\": 30,\n      \"city\": \"New York\"\n    }\n  }\n]\n```\n\nYou can use the following expression to get the value of `city`:\n\n```js\n{{$json.body.city}}\n```\n\nThis expression accesses the incoming JSON-formatted data using n8n's custom `$json` variable and finds the value of `city` (in this example, \"New York\").",
+					"codeSnippet": "{{$json.body.city}}"
+			},
+			{
+					"role": "assistant",
+					"type": "message",
+					"text": "Did this answer solve your question?",
+					"quickReplies": [
+							{
+									"text": "Yes, thanks",
+									"type": "all-good",
+									"isFeedback": true
+							},
+							{
+									"text": "No, I am still stuck",
+									"type": "still-stuck",
+									"isFeedback": true
+							}
+					]
+			}
+	]
+}
diff --git a/cypress/pages/features/ai-assistant.ts b/cypress/pages/features/ai-assistant.ts
@@ -37,6 +37,7 @@ export class AIAssistant extends BasePage {
 			cy.getByTestId('node-error-view-ask-assistant-button').find('button').first(),
 		credentialEditAssistantButton: () =>
 			cy.getByTestId('credentail-edit-ask-assistant-button').find('button').first(),
+		codeSnippet: () => cy.getByTestId('assistant-code-snippet'),
 	};
 
 	actions = {

diff --git a/cypress/pages/workflow.ts b/cypress/pages/workflow.ts
@@ -366,6 +366,9 @@ export class WorkflowPage extends BasePage {
 		hitCopy: () => {
 			this.actions.hitComboShortcut(`{${META_KEY}}`, 'c');
 		},
+		hitPaste: () => {
+			this.actions.hitComboShortcut(`{${META_KEY}}`, 'p');
+		},
 		hitPinNodeShortcut: () => {
 			cy.get('body').type('p');
 		},

diff --git a/packages/design-system/src/components/AskAssistantChat/AskAssistantChat.vue b/packages/design-system/src/components/AskAssistantChat/AskAssistantChat.vue
@@ -171,6 +171,7 @@ function growInput() {
 						<div
 							v-if="message?.codeSnippet"
 							:class="$style['code-snippet']"
+							data-test-id="assistant-code-snippet"
 							v-html="renderMarkdown(message.codeSnippet).trim()"
 						></div>
 						<BlinkingCursor

diff --git a/packages/design-system/src/components/AskAssistantChat/__tests__/AskAssistantChat.spec.ts b/packages/design-system/src/components/AskAssistantChat/__tests__/AskAssistantChat.spec.ts
@@ -128,4 +128,24 @@ describe('AskAssistantChat', () => {
 		});
 		expect(container).toMatchSnapshot();
 	});
+	it('renders message with code snippet', () => {
+		const { container } = render(AskAssistantChat, {
+			props: {
+				user: { firstName: 'Kobi', lastName: 'Dog' },
+				messages: [
+					{
+						id: '1',
+						type: 'text',
+						role: 'assistant',
+						content:
+							'Hi Max! Here is my top solution to fix the error in your **Transform data** node👇',
+						codeSnippet:
+							"node.on('input', function(msg) {\n  if (msg.seed) { dummyjson.seed = msg.seed; }\n  try {\n      var value = dummyjson.parse(node.template, {mockdata: msg});\n      if (node.syntax === 'json') {\n          try { value = JSON.parse(value); }\n          catch(e) { node.error(RED._('datagen.errors.json-error')); }\n      }\n      if (node.fieldType === 'msg') {\n          RED.util.setMessageProperty(msg,node.field,value);\n      }\n      else if (node.fieldType === 'flow') {\n          node.context().flow.set(node.field,value);\n      }\n      else if (node.fieldType === 'global') {\n          node.context().global.set(node.field,value);\n      }\n      node.send(msg);\n  }\n  catch(e) {",
+						read: false,
+					},
+				],
+			},
+		});
+		expect(container).toMatchSnapshot();
+	});
 });
diff --git a/...tem/src/components/AskAssistantChat/__tests__/__snapshots__/AskAssistantChat.spec.ts.snap b/...tem/src/components/AskAssistantChat/__tests__/__snapshots__/AskAssistantChat.spec.ts.snap
@@ -1180,6 +1180,248 @@ exports[`AskAssistantChat > renders end of session chat correctly 1`] = `
 </div>
 `;
 
+exports[`AskAssistantChat > renders message with code snippet 1`] = `
+<div>
+  <div
+    class="container"
+  >
+    <div
+      class="header"
+    >
+      <div
+        class="chatTitle"
+      >
+        <div
+          class="headerText"
+        >
+          <svg
+            fill="none"
+            height="18"
+            viewBox="0 0 24 24"
+            width="18"
+            xmlns="http://www.w3.org/2000/svg"
+          >
+            <path
+              d="M19.9658 14.0171C19.9679 14.3549 19.8654 14.6851 19.6722 14.9622C19.479 15.2393 19.2046 15.4497 18.8869 15.5645L13.5109 17.5451L11.5303 22.9211C11.4137 23.2376 11.2028 23.5107 10.9261 23.7037C10.6494 23.8966 10.3202 24 9.9829 24C9.64559 24 9.3164 23.8966 9.0397 23.7037C8.76301 23.5107 8.55212 23.2376 8.43549 22.9211L6.45487 17.5451L1.07888 15.5645C0.762384 15.4479 0.489262 15.237 0.296347 14.9603C0.103431 14.6836 0 14.3544 0 14.0171C0 13.6798 0.103431 13.3506 0.296347 13.0739C0.489262 12.7972 0.762384 12.5863 1.07888 12.4697L6.45487 10.4891L8.43549 5.11309C8.55212 4.79659 8.76301 4.52347 9.0397 4.33055C9.3164 4.13764 9.64559 4.0342 9.9829 4.0342C10.3202 4.0342 10.6494 4.13764 10.9261 4.33055C11.2028 4.52347 11.4137 4.79659 11.5303 5.11309L13.5109 10.4891L18.8869 12.4697C19.2046 12.5845 19.479 12.7949 19.6722 13.072C19.8654 13.3491 19.9679 13.6793 19.9658 14.0171ZM14.1056 4.12268H15.7546V5.77175C15.7546 5.99043 15.8415 6.20015 15.9961 6.35478C16.1508 6.50941 16.3605 6.59628 16.5792 6.59628C16.7979 6.59628 17.0076 6.50941 17.1622 6.35478C17.3168 6.20015 17.4037 5.99043 17.4037 5.77175V4.12268H19.0528C19.2715 4.12268 19.4812 4.03581 19.6358 3.88118C19.7905 3.72655 19.8773 3.51682 19.8773 3.29814C19.8773 3.07946 19.7905 2.86974 19.6358 2.71511C19.4812 2.56048 19.2715 2.47361 19.0528 2.47361H17.4037V0.824535C17.4037 0.605855 17.3168 0.396131 17.1622 0.241501C17.0076 0.0868704 16.7979 0 16.5792 0C16.3605 0 16.1508 0.0868704 15.9961 0.241501C15.8415 0.396131 15.7546 0.605855 15.7546 0.824535V2.47361H14.1056C13.8869 2.47361 13.6772 2.56048 13.5225 2.71511C13.3679 2.86974 13.281 3.07946 13.281 3.29814C13.281 3.51682 13.3679 3.72655 13.5225 3.88118C13.6772 4.03581 13.8869 4.12268 14.1056 4.12268ZM23.1755 7.42082H22.3509V6.59628C22.3509 6.3776 22.2641 6.16788 22.1094 6.01325C21.9548 5.85862 21.7451 5.77175 21.5264 5.77175C21.3077 5.77175 21.098 5.85862 20.9434 6.01325C20.7887 6.16788 20.7019 6.3776 20.7019 6.59628V7.42082H19.8773C19.6586 7.42082 19.4489 7.50769 19.2943 7.66232C19.1397 7.81695 19.0528 8.02667 19.0528 8.24535C19.0528 8.46404 19.1397 8.67376 19.2943 8.82839C19.4489 8.98302 19.6586 9.06989 19.8773 9.06989H20.7019V9.89443C20.7019 10.1131 20.7887 10.3228 20.9434 10.4775C21.098 10.6321 21.3077 10.719 21.5264 10.719C21.7451 10.719 21.9548 10.6321 22.1094 10.4775C22.2641 10.3228 22.3509 10.1131 22.3509 9.89443V9.06989H23.1755C23.3941 9.06989 23.6039 8.98302 23.7585 8.82839C23.9131 8.67376 24 8.46404 24 8.24535C24 8.02667 23.9131 7.81695 23.7585 7.66232C23.6039 7.50769 23.3941 7.42082 23.1755 7.42082Z"
+              fill="url(#paint0_linear_173_12825)"
+            />
+            <defs>
+              <lineargradient
+                gradientUnits="userSpaceOnUse"
+                id="paint0_linear_173_12825"
+                x1="-3.67094e-07"
+                x2="28.8315"
+                y1="-0.000120994"
+                y2="9.82667"
+              >
+                <stop
+                  stop-color="var(--color-assistant-highlight-1)"
+                />
+                <stop
+                  offset="0.495"
+                  stop-color="var(--color-assistant-highlight-2)"
+                />
+                <stop
+                  offset="1"
+                  stop-color="var(--color-assistant-highlight-3)"
+                />
+              </lineargradient>
+            </defs>
+          </svg>
+          <span
+            class="text large"
+          >
+            AI Assistant
+          </span>
+        </div>
+        <div
+          class="beta"
+        >
+          beta
+        </div>
+      </div>
+      <div
+        class="back"
+        data-test-id="close-chat-button"
+      >
+        <n8n-icon
+          color="text-base"
+          icon="arrow-right"
+        />
+      </div>
+    </div>
+    <div
+      class="body"
+    >
+      <div
+        class="messages"
+      >
+        
+        <div
+          class="message"
+          data-test-id="chat-message-assistant"
+        >
+          <div
+            class="roleName"
+          >
+            <div
+              class="container small"
+            >
+              <svg
+                fill="none"
+                height="10"
+                viewBox="0 0 24 24"
+                width="10"
+                xmlns="http://www.w3.org/2000/svg"
+              >
+                <path
+                  d="M19.9658 14.0171C19.9679 14.3549 19.8654 14.6851 19.6722 14.9622C19.479 15.2393 19.2046 15.4497 18.8869 15.5645L13.5109 17.5451L11.5303 22.9211C11.4137 23.2376 11.2028 23.5107 10.9261 23.7037C10.6494 23.8966 10.3202 24 9.9829 24C9.64559 24 9.3164 23.8966 9.0397 23.7037C8.76301 23.5107 8.55212 23.2376 8.43549 22.9211L6.45487 17.5451L1.07888 15.5645C0.762384 15.4479 0.489262 15.237 0.296347 14.9603C0.103431 14.6836 0 14.3544 0 14.0171C0 13.6798 0.103431 13.3506 0.296347 13.0739C0.489262 12.7972 0.762384 12.5863 1.07888 12.4697L6.45487 10.4891L8.43549 5.11309C8.55212 4.79659 8.76301 4.52347 9.0397 4.33055C9.3164 4.13764 9.64559 4.0342 9.9829 4.0342C10.3202 4.0342 10.6494 4.13764 10.9261 4.33055C11.2028 4.52347 11.4137 4.79659 11.5303 5.11309L13.5109 10.4891L18.8869 12.4697C19.2046 12.5845 19.479 12.7949 19.6722 13.072C19.8654 13.3491 19.9679 13.6793 19.9658 14.0171ZM14.1056 4.12268H15.7546V5.77175C15.7546 5.99043 15.8415 6.20015 15.9961 6.35478C16.1508 6.50941 16.3605 6.59628 16.5792 6.59628C16.7979 6.59628 17.0076 6.50941 17.1622 6.35478C17.3168 6.20015 17.4037 5.99043 17.4037 5.77175V4.12268H19.0528C19.2715 4.12268 19.4812 4.03581 19.6358 3.88118C19.7905 3.72655 19.8773 3.51682 19.8773 3.29814C19.8773 3.07946 19.7905 2.86974 19.6358 2.71511C19.4812 2.56048 19.2715 2.47361 19.0528 2.47361H17.4037V0.824535C17.4037 0.605855 17.3168 0.396131 17.1622 0.241501C17.0076 0.0868704 16.7979 0 16.5792 0C16.3605 0 16.1508 0.0868704 15.9961 0.241501C15.8415 0.396131 15.7546 0.605855 15.7546 0.824535V2.47361H14.1056C13.8869 2.47361 13.6772 2.56048 13.5225 2.71511C13.3679 2.86974 13.281 3.07946 13.281 3.29814C13.281 3.51682 13.3679 3.72655 13.5225 3.88118C13.6772 4.03581 13.8869 4.12268 14.1056 4.12268ZM23.1755 7.42082H22.3509V6.59628C22.3509 6.3776 22.2641 6.16788 22.1094 6.01325C21.9548 5.85862 21.7451 5.77175 21.5264 5.77175C21.3077 5.77175 21.098 5.85862 20.9434 6.01325C20.7887 6.16788 20.7019 6.3776 20.7019 6.59628V7.42082H19.8773C19.6586 7.42082 19.4489 7.50769 19.2943 7.66232C19.1397 7.81695 19.0528 8.02667 19.0528 8.24535C19.0528 8.46404 19.1397 8.67376 19.2943 8.82839C19.4489 8.98302 19.6586 9.06989 19.8773 9.06989H20.7019V9.89443C20.7019 10.1131 20.7887 10.3228 20.9434 10.4775C21.098 10.6321 21.3077 10.719 21.5264 10.719C21.7451 10.719 21.9548 10.6321 22.1094 10.4775C22.2641 10.3228 22.3509 10.1131 22.3509 9.89443V9.06989H23.1755C23.3941 9.06989 23.6039 8.98302 23.7585 8.82839C23.9131 8.67376 24 8.46404 24 8.24535C24 8.02667 23.9131 7.81695 23.7585 7.66232C23.6039 7.50769 23.3941 7.42082 23.1755 7.42082Z"
+                  fill="white"
+                />
+                <defs>
+                  <lineargradient
+                    gradientUnits="userSpaceOnUse"
+                    id="paint0_linear_173_12825"
+                    x1="-3.67094e-07"
+                    x2="28.8315"
+                    y1="-0.000120994"
+                    y2="9.82667"
+                  >
+                    <stop
+                      stop-color="var(--color-assistant-highlight-1)"
+                    />
+                    <stop
+                      offset="0.495"
+                      stop-color="var(--color-assistant-highlight-2)"
+                    />
+                    <stop
+                      offset="1"
+                      stop-color="var(--color-assistant-highlight-3)"
+                    />
+                  </lineargradient>
+                </defs>
+              </svg>
+            </div>
+            <span>
+              Assistant
+            </span>
+          </div>
+          <div
+            class="textMessage"
+          >
+            <!-- eslint-disable-next-line vue/no-v-html -->
+            
+            <!-- eslint-disable-next-line vue/no-v-html -->
+            <div
+              class="assistantText"
+            >
+              <p>
+                Hi Max! Here is my top solution to fix the error in your 
+                <strong>
+                  Transform data
+                </strong>
+                 node👇
+              </p>
+              
+
+            </div>
+            
+            <div
+              class="code-snippet"
+              data-test-id="assistant-code-snippet"
+            >
+              <p>
+                node.on('input', function(msg) {
+                <br />
+                
+if (msg.seed) { dummyjson.seed = msg.seed; }
+                <br />
+                
+try {
+                <br />
+                
+var value = dummyjson.parse(node.template, {mockdata: msg});
+                <br />
+                
+if (node.syntax === 'json') {
+                <br />
+                
+try { value = JSON.parse(value); }
+                <br />
+                
+catch(e) { node.error(RED._('datagen.errors.json-error')); }
+                <br />
+                
+}
+                <br />
+                
+if (node.fieldType === 'msg') {
+                <br />
+                
+RED.util.setMessageProperty(msg,node.field,value);
+                <br />
+                
+}
+                <br />
+                
+else if (node.fieldType === 'flow') {
+                <br />
+                
+node.context().flow.set(node.field,value);
+                <br />
+                
+}
+                <br />
+                
+else if (node.fieldType === 'global') {
+                <br />
+                
+node.context().global.set(node.field,value);
+                <br />
+                
+}
+                <br />
+                
+node.send(msg);
+                <br />
+                
+}
+                <br />
+                
+catch(e) {
+              </p>
+            </div>
+            <!--v-if-->
+          </div>
+          <!--v-if-->
+        </div>
+        
+      </div>
+      <!--v-if-->
+    </div>
+    <div
+      class="inputWrapper"
+      data-test-id="chat-input-wrapper"
+    >
+      <textarea
+        data-test-id="chat-input"
+        placeholder="Enter your response..."
+        rows="1"
+        wrap="hard"
+      />
+      <n8n-icon-button
+        class="sendButton"
+        data-test-id="send-message-button"
+        disabled="true"
+        icon="paper-plane"
+        size="large"
+        type="text"
+      />
+    </div>
+  </div>
+</div>
+`;
+
 exports[`AskAssistantChat > renders streaming chat correctly 1`] = `
 <div>
   <div