github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[ES|QL] Improve arguments error copy (#177418)

Browse source 
## Summary

Improve error copy based on @leemthompo suggestions.

### Checklist

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

---------

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
This commit is contained in:
Marco Liberati 2024-02-21 15:56:21 +01:00 • committed by GitHub
parent 6a2bc20b82
commit 2b86cceff7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

6
packages/kbn-monaco/src/esql/lib/ast/validation/errors.ts
View file

@ -59,7 +59,7 @@ function getMessageAndTypeFromId<K extends ErrorTypes>({
return {
message: i18n.translate('monaco.esql.validation.wrongArgumentExactNumber', {
defaultMessage:
'Error building [{fn}]: expects exactly {numArgs, plural, one {one argument} other {{numArgs} arguments}}, passed {passedArgs} instead.',
'Error: [{fn}] function expects exactly {numArgs, plural, one {one argument} other {{numArgs} arguments}}, got {passedArgs}.',
values: {
fn: out.fn,
numArgs: out.numArgs,
@ -71,7 +71,7 @@ function getMessageAndTypeFromId<K extends ErrorTypes>({
return {
message: i18n.translate('monaco.esql.validation.wrongArgumentTooManyNumber', {
defaultMessage:
'Error building [{fn}]: expects {extraArgs, plural, =0 {} other {no more than }}{numArgs, plural, one {one argument} other {{numArgs} arguments}}, passed {passedArgs} instead.',
'Error: [{fn}] function expects {extraArgs, plural, =0 {} other {no more than }}{numArgs, plural, one {one argument} other {{numArgs} arguments}}, got {passedArgs}.',
values: {
fn: out.fn,
numArgs: out.numArgs,
@ -84,7 +84,7 @@ function getMessageAndTypeFromId<K extends ErrorTypes>({
return {
message: i18n.translate('monaco.esql.validation.wrongArgumentTooFewNumber', {
defaultMessage:
'Error building [{fn}]: expects {missingArgs, plural, =0 {} other {at least }}{numArgs, plural, one {one argument} other {{numArgs} arguments}}, passed {passedArgs} instead.',
'Error: [{fn}] function expects {missingArgs, plural, =0 {} other {at least }}{numArgs, plural, one {one argument} other {{numArgs} arguments}}, got {passedArgs}.',
values: {
fn: out.fn,
numArgs: out.numArgs,

12
packages/kbn-monaco/src/esql/lib/ast/validation/validation.test.ts
View file

@ -466,7 +466,7 @@ describe('validation logic', () => {
testErrorsAndWarnings('row var = 1 in ', ['SyntaxError: expected {LP} but found "<EOF>"']);
testErrorsAndWarnings('row var = 1 in (', [
'SyntaxError: expected {STRING, INTEGER_LITERAL, DECIMAL_LITERAL, FALSE, LP, NULL, PARAM, TRUE, PLUS, MINUS, OPENING_BRACKET, UNQUOTED_IDENTIFIER, QUOTED_IDENTIFIER} but found "<EOF>"',
'Error building [in]: expects exactly 2 arguments, passed 1 instead.',
'Error: [in] function expects exactly 2 arguments, got 1.',
]);
testErrorsAndWarnings('row var = 1 not in ', ['SyntaxError: expected {LP} but found "<EOF>"']);
testErrorsAndWarnings('row var = 1 in (1, 2, 3)', []);
@ -1028,7 +1028,7 @@ describe('validation logic', () => {
}
testErrorsAndWarnings(`from a_index | where cidr_match(ipField)`, [
`Error building [cidr_match]: expects at least 2 arguments, passed 1 instead.`,
`Error: [cidr_match] function expects at least 2 arguments, got 1.`,
]);
testErrorsAndWarnings(
`from a_index | eval cidr = "172.0.0.1/30" | where cidr_match(ipField, "172.0.0.1/30", cidr)`,
@ -1330,13 +1330,13 @@ describe('validation logic', () => {
)[0].declaration
}`,
[
`Error building [${name}]: expects ${messageQuantifier}${
`Error: [${name}] function expects ${messageQuantifier}${
fullNumberOfArgs === 1
? 'one argument'
: fullNumberOfArgs === 0
? '0 arguments'
: `${fullNumberOfArgs} arguments`
}, passed ${fieldMappingWithOneExtraArg.length} instead.`,
}, got ${fieldMappingWithOneExtraArg.length}.`,
]
);
}
@ -1476,7 +1476,7 @@ describe('validation logic', () => {
);
testErrorsAndWarnings('from a_index | eval not', [
'SyntaxError: expected {STRING, INTEGER_LITERAL, DECIMAL_LITERAL, FALSE, LP, NOT, NULL, PARAM, TRUE, PLUS, MINUS, OPENING_BRACKET, UNQUOTED_IDENTIFIER, QUOTED_IDENTIFIER} but found "<EOF>"',
'Error building [not]: expects exactly one argument, passed 0 instead.',
'Error: [not] function expects exactly one argument, got 0.',
]);
testErrorsAndWarnings('from a_index | eval in', [
'SyntaxError: expected {STRING, INTEGER_LITERAL, DECIMAL_LITERAL, FALSE, LP, NOT, NULL, PARAM, TRUE, PLUS, MINUS, OPENING_BRACKET, UNQUOTED_IDENTIFIER, QUOTED_IDENTIFIER} but found "in"',
@ -1489,7 +1489,7 @@ describe('validation logic', () => {
testErrorsAndWarnings('from a_index | eval stringField in stringField)', [
"SyntaxError: missing '(' at 'stringField'",
'Error building [in]: expects exactly 2 arguments, passed 1 instead.',
'Error: [in] function expects exactly 2 arguments, got 1.',
]);
testErrorsAndWarnings('from a_index | eval stringField not in stringField', [
"SyntaxError: missing '(' at 'stringField'",