Error with empty array

[jcollum-nutrien]

Error:

{\"errorType\":\"TypeError\",\"errorMessage\":\"Cannot read properties of undefined (reading 'length')\",

My code:

export function throwZodError(message: string) {
  getLogger().error('throwZodError', {
    error: new ZodError([
      <ZodIssue>{
        message,
      },
    ]),
  });
  throw new ZodError([<ZodIssue>{ message }]);
}

the logs:

"error": {
            "name": "ZodError",
            "location": "/packages/schemas/src/zod/index.ts:20",
            "message": "[\n  {\n    \"message\": \"Schema validation error(s): body REDACTED",
            "stack": "ZodError: [\n  {\n    \"message\": \"Schema validation error(s): body REDACTED]\"\n  }\n]\n    at throwZodError (/packages/schemas/src/zod/index.ts:20:12)\n    at maybeThrowValidationError (/packages/redacted/util.ts:14:5)\n    at Object._or (/packages/redacted/redacted.ts:81:5)\n    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n    at async R2n (/var/src/redacted.ts:38:22)\n    at async <anonymous> (/var/src/redacted.ts:74:14)\n    at async kTe (/node_modules/redacted/src/track-event.ts:61:20)\n    at async TLt (/var/src/redacted.ts:68:10)\n    at async FLt (/var/src/handler.ts:79:10)\n    at async runRequest (/opt/nodejs/node_modules/@middy/core/index.cjs:130:32)",
            "issues": [
                {
                    "message": "Schema validation error(s): body REDACTED"
                }
            ]
        }

the stack trace:

at isNonEmptyArray (/opt/nodejs/node_modules/zod-validation-error/lib/utils/NonEmptyArray.ts:4:16)\",\"   
at getMessageFromZodIssue (/opt/nodejs/node_modules/zod-validation-error/lib/MessageBuilder.ts:115:22)\",\"   
at <anonymous> (/opt/nodejs/node_modules/zod-validation-error/lib/MessageBuilder.ts:42:9)\",\"   
at Array.map (<anonymous>)\",\"   
at <anonymous> (/opt/nodejs/node_modules/zod-validation-error/lib/MessageBuilder.ts:41:8)\",\"   
at fromZodErrorWithoutRuntimeCheck (/opt/nodejs/node_modules/zod-validation-error/lib/fromZodError.ts:45:15)\",\"   
at fromZodError (/opt/nodejs/node_modules/zod-validation-error/lib/fromZodError.ts:33:10)\",\"   

Looks to me like it's hitting

// lib/utils/NonEmptyArray.ts
function isNonEmptyArray(value) {
  return value.length !== 0;
}

and not checking if value is present before checking the length.

My other code that calls this looks like:

    if (request.error instanceof z.ZodError) {
      // we might have a Zod validation error here, so return a formatted validation message
      error = new RedactedError( 
        `${fromZodError(request.error as ZodError)}`
      );
    }

is that incorrect usage?

[jcollum-nutrien]

fixed it, function needs to be

export function throwZodError(message: string) {
  throw new ZodError([
    { fatal: false, message, code: 'custom', path: ['(none)'] },
  ]);
}

but zod-validation-error should be doing a better job of defensive coding.

[thanoskrg]

Hi @jcollum-nutrien , thanks for reporting this.

May I ask what would be the expected behaviour in this case? It looks like the exception is coming from this place:

zod-validation-error/lib/MessageBuilder.ts

Line 115 in 315d9ad

if (includePath && isNonEmptyArray(issue.path)) {

I understand that the issue stems from the fact that in the first variation of the throwZodError there is no definition of path prop. According to the docs, under fromZodError definition there is an extra prop includePath which by default is true. Did you try turning this off and see what it happens?

For example:

if (request.error instanceof z.ZodError) {
  // we might have a Zod validation error here, so return a formatted validation message
  error = new RedactedError( 
    `${fromZodError(request.error as ZodError, { includePath: false })}`
  );
}

Also as a rule of thumb, I would suggest that you try avoid casting values if possible because it can lead to tricky outcomes.

Instead, we could rewrite the above snippet as:

const { error } = request;

if (isZodErrorLike(error)) {
  // we might have a Zod validation error here, so return a formatted validation message
  error = new RedactedError( 
    `${fromZodError(error, { includePath: false })}` // no casting needed
  );
}

More on isZodErrorLike can be found here.

[The-LukeZ]

Hey, I got the same issue. If anything else than stated in the zod schema is provided (like an empty object e.g.) then it throws me this.

Error:

Code:

• Validator logic: https://github.com/supportmailapp/dashboard/blob/master/src/lib/server/validators/index.ts

const mySchema = z.object({
  value: z.boolean(),
  date: z.iso.datetime().nullable(),
});

new MyValidator(mySchema).validate({})

---

Update 3 minutes later:

A workaround is this:

// Before
error: fromError(err)

// Workaround
error: fromZodError(err as ZodError) as ValidationError

So basically not use the fromError function

[jmike]

Is this issue still relevant? @thanoskrg pinging you because you worked on this previously.

[The-LukeZ]

Yes.

[thanoskrg]

Is this issue still relevant? @thanoskrg pinging you because you worked on this previously.

@jmike based on my original investigation which goes several months back, this issue might stem from the fact that in the original reported issue the code snippet is type-casting what we pass into fromZodError, i.e request.error as ZodError which I think it shouldn't be the case and is not compliant with the guidelines of zod-validation-error usage. I'm happy to investigate further if needed.

On top of that @The-LukeZ did you try to use the isZodErrorLike function here to see whether it addresses the issue?

[The-LukeZ]

Will try when I got the time.

[jmike]

I've read this issue 3 times (followed the links and everything) and still don't understand what the problem is.

• fromError is designed to accept any type of error;
• fromZodError is designed to only accept zod errors. Otherwise it throws.

I've verified the aforementioned behaviour by adding thorough tests to the codebase.

Looking at the error logs, pasted in the previous message (#459 (comment)), I noticed that The-LukeZ is using v.3.5.3 of zod-validation-error which is suspicious. Maybe there's something wrong with v.3.5.3.