Added hint when using function as procedure and vice versa #322
+139
−11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: f1883b4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
ncordon
reviewed
Jan 10, 2025
| parsedProcedure.rawText, | ||
| parsedProcedure, | ||
| DiagnosticSeverity.Error, | ||
| `Procedure ${parsedProcedure.name} is not present in the database. Did you mean to call the function ${parsedProcedure.name}? Only procedures can be called inside a CALL clause.`, |
There was a problem hiding this comment.
It would be better if the error was actionable IMHO:
${parsedProcedure.name} is a function, not a procedure. Did you mean to use the function ${parsedProcedure.name} with a RETURN instead of a CALL clause?
ncordon
reviewed
Jan 10, 2025
Comment on lines
+92
to
+95
| let existsAsProcedure = false; | ||
| if (procedureSchema) { | ||
| existsAsProcedure = Boolean(procedureSchema[parsedFunction.name]); | ||
| } |
There was a problem hiding this comment.
This can be rewritten as:
const existsAsProcedure = procedureSchema && Boolean(procedureSchema[parsedFunction.name]);
ncordon
reviewed
Jan 10, 2025
Comment on lines
118
to
126
| if ( | ||
| caseInsensitiveFunctionInDatabase && | ||
| caseInsensitiveFunctionInDatabase.isBuiltIn | ||
| functionExistsWithExactName || | ||
| (caseInsensitiveFunctionInDatabase && | ||
| caseInsensitiveFunctionInDatabase.isBuiltIn) | ||
| ) { | ||
| return undefined; | ||
| return true; | ||
| } else { | ||
| return false; | ||
| } |
There was a problem hiding this comment.
You don't need the if:
return functionExistsWithExactName ||
(caseInsensitiveFunctionInDatabase &&
caseInsensitiveFunctionInDatabase.isBuiltIn)
ncordon
reviewed
Jan 10, 2025
| @@ -74,6 +74,42 @@ describe('Functions semantic validation spec', () => { | |||
| ]); | |||
| }); | |||
|
|
|||
| test('Syntax validation error on function used as procedure returns helpful message', () => { | |||
| const query = `CALL abs(-50) YIELD *`; | |||
There was a problem hiding this comment.
It'd be good to add a test to check we are matching case insensitive functions:
CALL ABS(-1)
ncordon
reviewed
Jan 10, 2025
| @@ -59,6 +59,42 @@ meaning that it expects at least 3 arguments of types NODE, STRING, ANY | |||
| ]); | |||
| }); | |||
|
|
|||
| test('Syntax validation error on procedure used as function returns helpful message', () => { | |||
| const query = `RETURN apoc.create.uuids(50)`; | |||
There was a problem hiding this comment.
Conversely, we should add a test to check
RETURN APOC.create.uuids(50)
would just say the function is not in the database, but not that the procedure is (because procedures are case sensitive)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Will yield errors like:
CALL abs(-50) YIELD *-> Procedure abs is not present in the database. Did you mean to call the function abs? Only procedures can be called inside a CALL clause.and
RETURN apoc.create.uuids(50)-> Function apoc.create.uuids is not present in the database. Did you mean to call the procedure apoc.create.uuids? Procedures must be called inside a CALL clause.Instead of the regular "Procedure/Function is not present in the database"-messages.