cannon: Make jsonutil error when loading json payload with extra data

[mbaxter]

Description

Make jsonutil.LoadJSON error rather than accept a malformed file with extra data appended after a valid JSON payload.
This addresses the json.Decoder.Decode anti-pattern described here.

Tests

Add some unit tests to validate the behavior of LoadJSON when extra data is appended to the file being processed.

Additional context

This is part of the work to address the Coinbase security audit of Cannon.

Metadata

Part of: https://github.com/ethereum-optimism/client-pod/issues/761 (L-06)

[coderabbitai]

Walkthrough

Walkthrough

The primary change involves enhancing the JSON loading functionality in the jsonutil package by adding a check for unexpected trailing data after the main JSON object. This ensures that only one JSON object is present in the file. Additionally, tests have been added to verify this new functionality, including scenarios with extra data and trailing whitespace.

Changes

File	Summary
.../jsonutil/json.go	Updated LoadJSON function to include a check for unexpected trailing data in the JSON file.
.../jsonutil/json_test.go	Added tests for loading JSON with extra data and trailing whitespace, and utility function to append data.

---

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c79248e and a19a045.

Files selected for processing (2)

• op-service/jsonutil/json.go (1 hunks)
• op-service/jsonutil/json_test.go (2 hunks)

Additional comments not posted (4)

op-service/jsonutil/json.go (1)

24-31: The added check for unexpected trailing data after the main JSON object is decoded is a good practice. This ensures that only one JSON object is present in the file, addressing the json.Decoder.Decode anti-pattern.

op-service/jsonutil/json_test.go (3)

51-101: The test function TestLoadJSONWithExtraDataAppended effectively covers various scenarios of extra data appended to the JSON file. This ensures that the LoadJSON function correctly identifies and errors out on unexpected trailing data.

---

103-144: The test function TestLoadJSONWithTrailingWhitespace effectively covers various scenarios of trailing whitespace. This ensures that the LoadJSON function correctly handles and ignores trailing whitespace.

---

151-160: The helper function appendDataToFile is straightforward and correctly appends data to a file.

---

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 testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.