import { testData } from '@neo4j-cypher/language-support';
import { expect, test } from '@playwright/experimental-ct-react';
import { CypherEditor } from '../CypherEditor';
import { CypherEditorPage } from './e2eUtils';
test.use({ viewport: { width: 1000, height: 500 } });
test('Prop lint set to false disables syntax validation', async ({
page,
mount,
}) => {
const query = 'METCH (n) RETURN n';
await mount();
await expect(page.locator('.cm-lintRange-error').last()).not.toBeVisible({
timeout: 10000,
});
});
test('Can turn linting back on', async ({ page, mount }) => {
const editorPage = new CypherEditorPage(page);
const query = 'METCH (n) RETURN n';
const component = await mount();
await expect(page.locator('.cm-lintRange-error').last()).not.toBeVisible({
timeout: 10000,
});
await component.update();
await editorPage.getEditor().fill('METCH (n) RETURN n');
await editorPage.checkErrorMessage(
'METCH',
`Invalid input 'METCH': expected 'ALTER', 'ORDER BY', 'CALL', 'USING PERIODIC COMMIT', 'CREATE', 'LOAD CSV', 'START DATABASE', 'STOP DATABASE', 'DEALLOCATE', 'DELETE', 'DENY', 'DETACH', 'DROP', 'DRYRUN', 'FINISH', 'FOREACH', 'GRANT', 'INSERT', 'LIMIT', 'MATCH', 'MERGE', 'NODETACH', 'OFFSET', 'OPTIONAL', 'REALLOCATE', 'REMOVE', 'RENAME', 'RETURN', 'REVOKE', 'ENABLE SERVER', 'SET', 'SHOW', 'SKIP', 'TERMINATE', 'UNWIND', 'USE' or 'WITH'`,
);
});
test('Syntactic errors are surfaced', async ({ page, mount }) => {
const editorPage = new CypherEditorPage(page);
const query = 'METCH (n) RETURN n';
await mount();
await editorPage.checkErrorMessage(
'METCH',
`Invalid input 'METCH': expected 'ALTER', 'ORDER BY', 'CALL', 'USING PERIODIC COMMIT', 'CREATE', 'LOAD CSV', 'START DATABASE', 'STOP DATABASE', 'DEALLOCATE', 'DELETE', 'DENY', 'DETACH', 'DROP', 'DRYRUN', 'FINISH', 'FOREACH', 'GRANT', 'INSERT', 'LIMIT', 'MATCH', 'MERGE', 'NODETACH', 'OFFSET', 'OPTIONAL', 'REALLOCATE', 'REMOVE', 'RENAME', 'RETURN', 'REVOKE', 'ENABLE SERVER', 'SET', 'SHOW', 'SKIP', 'TERMINATE', 'UNWIND', 'USE' or 'WITH'`,
);
});
test('Does not trigger syntax errors for backticked parameters in parameter creation', async ({
page,
mount,
}) => {
const editorPage = new CypherEditorPage(page);
const query = ':param x => "abc"';
await mount();
await editorPage.checkNoNotificationMessage('error');
});
test('Errors for undefined labels are surfaced', async ({ page, mount }) => {
const editorPage = new CypherEditorPage(page);
const query = 'MATCH (n: Person) RETURN n';
await mount(
,
);
await editorPage.checkWarningMessage(
'Person',
"Label Person is not present in the database. Make sure you didn't misspell it or that it is available when you run this statement in your application",
);
});
test('Errors for multiline undefined labels are highlighted correctly', async ({
page,
mount,
}) => {
const editorPage = new CypherEditorPage(page);
const query = `MATCH (n:\`Foo
Bar\`) RETURN n`;
const expectedMsg = `Label \`Foo
Bar\` is not present in the database. Make sure you didn't misspell it or that it is available when you run this statement in your application`;
await mount(
,
);
await editorPage.checkWarningMessage('`Foo', expectedMsg);
await editorPage.checkWarningMessage('Bar`', expectedMsg);
});
test('Semantic errors work in firefox', async ({
browserName,
page,
mount,
}) => {
test.skip(browserName !== 'firefox');
const editorPage = new CypherEditorPage(page);
const query = 'MATCH (n:OperationalPoint)--(m:OperationalPoint) RETURN s,m,n';
await mount();
await editorPage.checkErrorMessage('s,m,n', 'Variable `s` not defined');
});
test('Semantic errors are surfaced when there are no syntactic errors', async ({
page,
mount,
}) => {
const editorPage = new CypherEditorPage(page);
const query = 'MATCH (n) RETURN m';
await mount();
await editorPage.checkErrorMessage('m', 'Variable `m` not defined');
});
test('Semantic errors are correctly accumulated', async ({ page, mount }) => {
const editorPage = new CypherEditorPage(page);
const query = 'CALL { MATCH (n) } IN TRANSACTIONS OF -1 ROWS';
await mount();
await editorPage.checkErrorMessage(
'MATCH (n)',
'Query cannot conclude with MATCH (must be a RETURN clause, a FINISH clause, an update clause, a unit subquery call, or a procedure call with no YIELD).',
);
await editorPage.checkErrorMessage(
'-1',
"Invalid input. '-1' is not a valid value. Must be a positive integer.",
);
});
test('Multiline errors are correctly placed', async ({ page, mount }) => {
const editorPage = new CypherEditorPage(page);
const query = `CALL {
MATCH (n)
} IN TRANSACTIONS
OF -1 ROWS`;
await mount();
await editorPage.checkErrorMessage(
'MATCH (n)',
'Query cannot conclude with MATCH (must be a RETURN clause, a FINISH clause, an update clause, a unit subquery call, or a procedure call with no YIELD).',
);
await editorPage.checkErrorMessage(
'-1',
"Invalid input. '-1' is not a valid value. Must be a positive integer.",
);
});
test('Validation errors are correctly overlapped', async ({ page, mount }) => {
const editorPage = new CypherEditorPage(page);
const query = `CALL { MATCH (n)
RETURN n
} IN TRANSACTIONS
OF -1 ROWS`;
await mount();
await editorPage.checkErrorMessage(
'-1',
'Query cannot conclude with CALL (must be a RETURN clause, a FINISH clause, an update clause, a unit subquery call, or a procedure call with no YIELD).',
);
await editorPage.checkErrorMessage(
'-1',
"Invalid input. '-1' is not a valid value. Must be a positive integer.",
);
});
test('Syntax highlighting works as expected with multiple separate linting messages', async ( {
page,
mount
}) => {
const editorPage = new CypherEditorPage(page);
const query = `MATCH (n)--(m) CALL (n) {RETURN id(n) AS b} RETURN apoc.create.uuid(), a`;
await mount();
await expect(
editorPage.page.locator('.cm-deprecated-element').last(),
).toBeVisible({ timeout: 10000 });
await editorPage.checkWarningMessage('id', 'Function id is deprecated.');
await editorPage.checkWarningMessage('id', `The query used a deprecated function. ('id' has been replaced by 'elementId or consider using an application-generated id')`);
await editorPage.checkWarningMessage('apoc.create.uuid', 'Function apoc.create.uuid is deprecated. Alternative: Neo4j randomUUID() function');
await editorPage.checkErrorMessage('a', 'Variable `a` not defined');
})
test('Strikethroughs are shown for deprecated functions', async ({
page,
mount,
}) => {
const editorPage = new CypherEditorPage(page);
const query = `RETURN id(1)`;
await mount();
await expect(
editorPage.page.locator('.cm-deprecated-element').last(),
).toBeVisible({ timeout: 10000 });
await editorPage.checkWarningMessage('id', 'Function id is deprecated.');
});
test('Strikethroughs are shown for deprecated procedures', async ({
page,
mount,
}) => {
const editorPage = new CypherEditorPage(page);
const query = `CALL apoc.create.uuids(5)`;
await mount();
await expect(
editorPage.page.locator('.cm-deprecated-element').last(),
).toBeVisible({ timeout: 10000 });
await editorPage.checkWarningMessage(
'apoc.create.uuids',
"Procedure apoc.create.uuids is deprecated. Alternative: Neo4j's randomUUID() function can be used as a replacement, for example: `UNWIND range(0,$count) AS row RETURN row, randomUUID() AS uuid`",
);
});
test('Syntax validation depends on the Cypher version', async ({
page,
mount,
}) => {
await mount(
,
);
const editorPage = new CypherEditorPage(page);
const textField = page.getByRole('textbox');
await textField.fill('CYPHER 5 CALL apoc.create.uuids(5)');
await editorPage.checkWarningMessage(
'apoc.create.uuids',
"Procedure apoc.create.uuids is deprecated. Alternative: Neo4j's randomUUID() function can be used as a replacement, for example: `UNWIND range(0,$count) AS row RETURN row, randomUUID() AS uuid`",
);
await textField.fill('CYPHER 25 CALL apoc.create.uuids(5)');
await editorPage.checkErrorMessage(
'apoc.create.uuids',
`Procedure apoc.create.uuids is not present in the database. Make sure you didn't misspell it or that it is available when you run this statement in your application`,
);
});