mirror of
https://github.com/n8n-io/n8n.git
synced 2026-07-28 11:35:03 +02:00
feat(editor): Deprecate $getPairedItem in the expression editor (#33549)
This commit is contained in:
parent
2be4092c4d
commit
c706cd4b96
|
|
@ -1616,6 +1616,7 @@
|
|||
"expressionEdit.expression": "Expression",
|
||||
"expressionEdit.resultOfItem1": "Result of item 1",
|
||||
"expressionEditor.uncalledFunction": "[this is a function, please add ()]",
|
||||
"expressionEditor.deprecated.getPairedItem": "$getPairedItem is deprecated and will be removed",
|
||||
"expressionModalInput.empty": "[empty]",
|
||||
"expressionModalInput.undefined": "[undefined]",
|
||||
"expressionModalInput.null": "null",
|
||||
|
|
|
|||
|
|
@ -142,6 +142,31 @@ describe('useExpressionEditor', () => {
|
|||
});
|
||||
});
|
||||
|
||||
test('surfaces deprecated $getPairedItem as an error segment', async () => {
|
||||
mockResolveExpression();
|
||||
|
||||
const {
|
||||
expressionEditor: { segments },
|
||||
} = await renderExpressionEditor({
|
||||
editorValue: '{{ $getPairedItem }}',
|
||||
extensions: [n8nLang()],
|
||||
});
|
||||
|
||||
await waitFor(() => {
|
||||
expect(toValue(segments.resolvable)).toEqual([
|
||||
{
|
||||
error: expect.any(Error),
|
||||
from: 0,
|
||||
kind: 'resolvable',
|
||||
resolvable: '{{ $getPairedItem }}',
|
||||
resolved: '[$getPairedItem is deprecated and will be removed]',
|
||||
state: 'invalid',
|
||||
to: 20,
|
||||
},
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
test('render [empty] when expression evaluates to an empty string', async () => {
|
||||
mockResolveExpression().mockReturnValueOnce('');
|
||||
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ import { closeCursorInfoBox } from '../plugins/codemirror/tooltips/InfoBoxToolti
|
|||
import type { Html, Plaintext, RawSegment, Resolvable, Segment } from '@/app/types/expressions';
|
||||
import { getExpressionErrorMessage, getResolvableState } from '@/app/utils/expressions';
|
||||
import { isCredentialsModalOpen } from '../plugins/codemirror/completions/utils';
|
||||
import { usesDeprecatedExpressionFunction } from '../plugins/codemirror/expressionDeprecations';
|
||||
import { closeCompletion, completionStatus } from '@codemirror/autocomplete';
|
||||
import {
|
||||
Compartment,
|
||||
|
|
@ -384,6 +385,12 @@ export const useExpressionEditor = ({
|
|||
};
|
||||
|
||||
try {
|
||||
// Deprecated functions still resolve on the backend, but we surface them
|
||||
// as an error in the editor preview to steer users off them.
|
||||
if (usesDeprecatedExpressionFunction(resolvable)) {
|
||||
throw new Error(i18n.baseText('expressionEditor.deprecated.getPairedItem'));
|
||||
}
|
||||
|
||||
if (expressionLocalResolveContext.value) {
|
||||
result.resolved = await workflowHelpers.resolveExpression('=' + resolvable, undefined, {
|
||||
...expressionLocalResolveContext.value,
|
||||
|
|
|
|||
|
|
@ -0,0 +1,19 @@
|
|||
import { usesDeprecatedExpressionFunction } from './expressionDeprecations';
|
||||
|
||||
describe('usesDeprecatedExpressionFunction', () => {
|
||||
it('detects $getPairedItem used as a bare reference', () => {
|
||||
expect(usesDeprecatedExpressionFunction('{{ $getPairedItem }}')).toBe(true);
|
||||
});
|
||||
|
||||
it('detects $getPairedItem used as a call', () => {
|
||||
expect(usesDeprecatedExpressionFunction('{{ $getPairedItem("Node", null, {}) }}')).toBe(true);
|
||||
});
|
||||
|
||||
it('does not flag benign expressions', () => {
|
||||
expect(usesDeprecatedExpressionFunction('{{ $json.foo }}')).toBe(false);
|
||||
});
|
||||
|
||||
it('does not flag $getPairedItem inside a string literal', () => {
|
||||
expect(usesDeprecatedExpressionFunction('{{ "$getPairedItem" }}')).toBe(false);
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
import { javascriptLanguage } from '@codemirror/lang-javascript';
|
||||
|
||||
// Expression functions deprecated in the frontend editor. Still resolve on the
|
||||
// backend at execution time — we only surface them as errors in the editor.
|
||||
export const DEPRECATED_EXPRESSION_FUNCTION = '$getPairedItem';
|
||||
|
||||
/**
|
||||
* Whether an expression body references a deprecated function. Matches
|
||||
* `VariableName` nodes so occurrences in string literals aren't flagged.
|
||||
*/
|
||||
export function usesDeprecatedExpressionFunction(expression: string): boolean {
|
||||
let found = false;
|
||||
|
||||
javascriptLanguage.parser.parse(expression).iterate({
|
||||
enter: (node) => {
|
||||
if (
|
||||
node.name === 'VariableName' &&
|
||||
expression.slice(node.from, node.to) === DEPRECATED_EXPRESSION_FUNCTION
|
||||
) {
|
||||
found = true;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
return found;
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user