fix: improve error message in rpc input validation

khanti42 commented 2 months ago

PR Description: Improved Error Messages for Union Struct Validation

Before:

When testing a union struct with multiple levels, such as:

const multiLevelStruct = union([
  object({
    field1: string(),
  }),
  object({
    field3: boolean(),
  }),
]);

If the input was incorrect, for example:

{
  "field1": true
}

The error message provided was not clear and didn't offer much guidance:

"Expected the value to satisfy a union of `object | object`, but received: [object Object]"

This generic message made it difficult to diagnose the specific issue within the nested structure, particularly when working with complex schemas.

Now:

The error handling has been improved to provide much clearer and more informative messages. With the same incorrect input:

{
  "field1": true
}

The new error message provides detailed information about where the validation failed:

At path: field1 --
    Expected a string, but received: true
    Expected a value of type `never`, but received: `true`

At path: field3 -- 
    Expected a value of type `boolean`, but received: `undefined`

Benefits:

Enhanced Clarity: The error messages now pinpoint the exact field and expected type, making it easier to debug and correct invalid input.
Detailed Feedback: By providing detailed feedback at each level of the validation, developers can quickly identify and resolve issues with their input data.
Better Support for Complex Schemas: This improvement is especially valuable when dealing with nested or complex data structures, where understanding the root cause of validation failures is crucial.

This PR improves the developer experience and reduce time in debugging.