fix: improve errors for configs #637
Conversation
| const paramsMessage = yamlDiffPatch("", {}, params); | ||
| return `${color.yellow(instancePath)} ${ | ||
| const prev = errors[i - 1]; |
There was a problem hiding this comment.
I think prevError would be better naming
| return ""; | ||
| } | ||
|
|
||
| return `${instancePath === "" ? "" : `${color.yellow(instancePath)} `}${ |
There was a problem hiding this comment.
Probably intancePath && color.yellow...would be simpler? Or you have other reason to use ternary here?
There was a problem hiding this comment.
Linter forbids using strings in the places where bool is expected to prevent unexpected behavior and to be more explicit about what exactly the check is checking
There was a problem hiding this comment.
Because e.g. sometimes empty string is valid and you want to get rid of only undefined case
| message ?? "" | ||
| }\n${paramsMessage}`; | ||
| }${paramsMessage === "" ? "" : `\n${paramsMessage}`}`; |
| }) | ||
| .filter((s) => { | ||
| return ( | ||
| s !== "" && |
There was a problem hiding this comment.
s && s !== "must match..."
| return ( | ||
| s !== "" && | ||
| s !== "must match exactly one schema in oneOf\npassingSchemas: null\n" | ||
| ); |
There was a problem hiding this comment.
What if error messafe in ajv changes in the next version? Probably we can specify this explicitly in ajv error message if possible and refactor this as a shared const?
There was a problem hiding this comment.
If the error changes then user will start seeing a new useless error, I am removing it here only because it's useless. I don't think moving it to const will help, but probably writing a test could, but I think writing a test for this would be too much, this bit is not so important
There was a problem hiding this comment.
Can move it to const just for little bit of documentation purpose
There was a problem hiding this comment.
But can you control this error on ajv? E.g. intercept it before error reaches the user. For example in js-client i use zod which allows me to intercept errors by filtering their codes and classes, change their message and even silence them.
Zod error API.
Because if i understand the code correctly, you want to prevent certain kind of errors from getting in user console.
There was a problem hiding this comment.
maybe possible using this https://ajv.js.org/packages/ajv-errors.html
not sure
There was a problem hiding this comment.
Maybe you can give it a try sooner or later with TODO and separate task. Dunno how hard would be to rewrite such places (if it even possible).
| @@ -277,6 +287,9 @@ export function getReadonlyConfigInitFunction< | |||
| getSchemaDirPath, | |||
| } = options; | |||
|
|
|||
| // every config schema has a version property by convention | |||
| // eslint-disable-next-line | |||
| const latestConfigVersion = latestSchema.properties.version.const as string; | |||
There was a problem hiding this comment.
Please explain this conversion a bit. Can't we extend schema type somehow with this? What is causing the need to do the conversion?
There was a problem hiding this comment.
I actually do extend schema, so it's impossible to pass pass a schema to this function that doesn't have version. But for some reason ajv types are not perfect in this sence and they don't produce correct results. I will improve comment to explains this a bit better. If you have nothing interesting to do you can to resolve as well, I wasnt' able to do it in a clean way
No description provided.