feat(editor): Improve how we show default Agent prompt and Memory session parameters

[OlegIvaniv]

Summary

Currently, our AI nodes default to using expressions like {{ $json.chatInput }} and {{ $json.sessionId }} for certain fields. However, this implementation causes confusion to the new users.

This PR improves the UX by:

1. Making these default expression fields visible but disabled when in automatic modes (e.g., when promptType is auto)
2. Introducing a new disabledOptions property that follows the same logic as displayOptions but disables fields instead of hiding them

Changes

• Added disabledOptions interface parallel to displayOptions for node properties
• Updated parameter input components to handle disabled state
• Modified expression editor components to support read-only mode styling
• Added version checks to ensure backward compatibility
• Applied the changes to:
  • Chain LLM node
  • Chain Retrieval QA node
  • SQL Agent node
  • Various memory nodes (Buffer Window, Motorhead, Postgres Chat, Redis Chat, Xata, Zep)
  • OpenAI Assistant node

CleanShot.2024-10-31.at.16.12.03.mp4

Review / Merge checklist

• PR title and summary are descriptive. (conventions)
• Docs updated or follow-up ticket created.
• Tests included.
• PR Labeled with release/backport (if the PR is an urgent fix that needs to be backported)

[cypress]

n8n    Run #7825

Run Properties:   Passed #7825  •  d49767b093: 🌳 🖥️ browsers:node18.12.0-chrome107 🤖 OlegIvaniv 🗃️ e2e/*

Project	n8n
Branch Review	ai-372-no-prompt-specified-text_disabled
Run status	Passed #7825
Run duration	04m 19s
Commit	d49767b093: 🌳 🖥️ browsers:node18.12.0-chrome107 🤖 OlegIvaniv 🗃️ e2e/*
Committer	Oleg Ivaniv
View all properties for this run ↗︎

---

Test results
Failures	0
Flaky	1
Pending	2
Skipped	0
Passing	466
View all changes introduced in this branch ↗︎

[CharlieKolb]

The code looks good and the feature looks even better!

I could see some users not immediately getting that/why the field is disabled, having a tooltip on hover that points calls out the controlling field or a tag next to the parameter name might be a good follow up item.
Having a visible hierarchy with indentation would also help.

Please do get another opinion as well since I'm new and mostly unfamiliar with existing best practices, as my comments will prove :D

[CharlieKolb]

Should this take from packages/@n8n/nodes-langchain/utils/descriptions.ts? That one still has Prompt rather than Prompt Source, as an aside. (Prompt Source is much better 👍 )

[OlegIvaniv]

Good point, I updated all of them to use promptTypeOptions from the shared utils file

[OlegIvaniv]

The code looks good and the feature looks even better!

I could see some users not immediately getting that/why the field is disabled, having a tooltip on hover that points calls out the controlling field or a tag next to the parameter name might be a good follow up item. Having a visible hierarchy with indentation would also help.

Please do get another opinion as well since I'm new and mostly unfamiliar with existing best practices, as my comments will prove :D

Appreciate the review, @CharlieKolb! I updated the PR to use shared textFromPreviousNode and promptTypeOptions everywhere. Could you have another look, please?
Btw, here's a workflow with all the variations/versions of applicable nodes:
Prompt___Session_Source_Nodes.json

[codecov]

Codecov Report

Attention: Patch coverage is 26.31579% with 56 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
...es/editor-ui/src/components/ParameterInputList.vue	40.00%	9 Missing ⚠️
...hain/nodes/agents/Agent/agents/SqlAgent/execute.ts	0.00%	6 Missing ⚠️
...mory/MemoryPostgresChat/MemoryPostgresChat.node.ts	0.00%	6 Missing ⚠️
...s/chains/ChainRetrievalQA/ChainRetrievalQa.node.ts	0.00%	5 Missing ⚠️
...ngchain/nodes/memory/MemoryXata/MemoryXata.node.ts	0.00%	5 Missing ⚠️
...des/memory/MemoryRedisChat/MemoryRedisChat.node.ts	0.00%	4 Missing ⚠️
...es/editor-ui/src/components/ParameterInputFull.vue	55.55%	4 Missing ⚠️
...mory/MemoryBufferWindow/MemoryBufferWindow.node.ts	0.00%	3 Missing ⚠️
...des/memory/MemoryMotorhead/MemoryMotorhead.node.ts	0.00%	3 Missing ⚠️
...des/agents/OpenAiAssistant/OpenAiAssistant.node.ts	0.00%	2 Missing ⚠️
... and 8 more

📢 Thoughts on this report? Let us know!

[CharlieKolb]

Thanks for the example workflow, that's great :D

PR looks good to go from my side 👍

[github-actions]

✅ All Cypress E2E specs passed

[elsmr]

LGTM! 🎉

Nice work, I like how you kept disabledOptions simple by reusing the displayOptions format. Maybe some of that code should be renamed in the future.

show and hide don't make much sense in disabledOptions. It's becoming a more general "Condition" object instead of something specific for hiding parameters.

[github-actions]

✅ All Cypress E2E specs passed

[OlegIvaniv]

LGTM! 🎉

Nice work, I like how you kept disabledOptions simple by reusing the displayOptions format. Maybe some of that code should be renamed in the future.

show and hide don't make much sense in disabledOptions. It's becoming a more general "Condition" object instead of something specific for hiding parameters.

Thanks!
+1 on renaming it later to something more general(conditionalParametersOptions?), I would also love to use it for specifying the default value based on condition, but that breaks all kinds of stuff right now :D

[janober]

Got released with [email protected]