🐛 Fix(zod): Fixed bug with property errors being swallowed

[roninjin10]

Description

Concise description of proposed changes

Testing

Explain the quality checks that have been done on the code changes

Additional Information

• I read the contributing docs (if this is your first contribution)

Your ENS/address:

Summary by CodeRabbit

• Bug Fixes
  • Fixed an issue with validation where errors for missing to parameters were not being reported correctly.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
evmts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 11, 2024 5:18am

[changeset-bot]

🦋 Changeset detected

Latest commit: d43355e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages

Name	Type
@tevm/zod	Patch
@tevm/procedures	Patch
@tevm/server	Patch
@tevm/vm	Patch
@tevm/viem	Patch
@tevm/client	Patch
tevm	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Walkthrough

The recent patch addresses a critical issue in the @tevm/zod package, where errors for missing to parameters were not being reported due to a bug in the zod validator. A conditional check has been implemented to ensure that these errors are now captured and communicated properly, improving the reliability of parameter validation.

Changes

File Path	Change Summary
.vm/zod/src/validators/.../validateContractParams.js	Added check for formattedErrors.to to catch and report missing to parameter errors.

Poem

In the code's burrow, deep and tight,
A bug was lurking, out of sight.
With a hop and a code patch cheer,
🐇 CodeRabbit made the bug disappear!

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[roninjin10]

Current dependencies on/for this PR:

• main
  • PR 🐛 Fix(zod): Fix nonoptional param in zContractParams #806
    • PR 🐛 Fix(zod): Fixed bug with property errors being swallowed #807 👈
      • PR 🐛 Fix(api): Fix broken type not handling error and data correctly #808
        • PR 🐛 Docs: Add jsdoc to createHttpHandler #809
          • PR ✅ Test: Add missing handlers test coverage #810

This stack of pull requests is managed by Graphite.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between aec294b and d43355e.

Files selected for processing (2)

• .changeset/afraid-crabs-exist.md (1 hunks)
• vm/zod/src/validators/validateContractParams.js (1 hunks)

Additional comments: 3

.changeset/afraid-crabs-exist.md (2)

• 1-3: The changeset metadata correctly specifies the package and the type of change as a patch.

• 5-5: The description clearly explains the bug fix related to the to parameter in the zod validator.

vm/zod/src/validators/validateContractParams.js (1)

• 43-47: The added conditional check for formattedErrors.to correctly captures and reports errors related to the to parameter. Ensure that the createError function is robust and handles all possible error inputs correctly.

Verification successful

---

The createError function is implemented to construct an error object with a flexible structure that can handle various error inputs, including the case in the PR where it is used to report InvalidAddressError. The function is robust and aligns with the usage seen across the codebase.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that createError function handles all possible error inputs correctly.
rg --type js 'function createError' -- 'src/common/index.js'

Length of output: 120

---

---

Script:

#!/bin/bash
# Search for the createError function definition in the JavaScript files without assuming its location.
rg --type js 'function createError'

Length of output: 37

---

---

Script:

#!/bin/bash
# Search for any occurrence of the createError function or method in the entire codebase.
rg 'createError'

Length of output: 4388

---

---

Script:

#!/bin/bash
# Retrieve the full implementation of the createError function to verify its robustness.
cat vm/zod/src/common/createError.js

Length of output: 299