Bug: ParseError breaking change for error cause

[agnoski]

Expected Behavior

When a ParseError is thrown by the parse function, the cause field is a ZodError.

Current Behavior

When a ParseError is thrown by the parse function, the cause field is an array of ZodIssues.

Code snippet

Pre v2.24.0:

  try {
    return schema.parse(data);
  } catch (error) {
    throw new ParseError('Failed to parse schema', { cause: error as Error });
  }

Post v2.24.0

  if (result.issues) {
    const error = new ParseError('Failed to parse schema', {
      cause: result.issues,
    });
...

Steps to Reproduce

1. Call parser pre and post v2.24.0 with an invalid schema
2. Check the error thrown has two different cause

Possible Solution

Keep backward compatibility by creating a ZodError from the issues or create a breaking change with version bump.

Powertools for AWS Lambda (TypeScript) version

latest

AWS Lambda function runtime

22.x

Packaging format used

npm

Execution logs

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: Invite link

[dreamorosi]

Hi @agnoski, thanks for opening this issue.

This behavior is expected and is part of us dropping support for Zod 3.x in favor of 4.x which happened in 2.24.0 - see release notes.

While this does not conform closely with semantic versioning, the change is in line with our versioning policy and was made after extensive discussion.

[powertools-for-aws-oss-automation]

Warning

This issue is now closed. Please be mindful that future comments are hard for our team to see.
If you need more assistance, please either reopen the issue, or open a new issue referencing this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.