fix(x/upgrade): Stop treating inline JSON as a URL

[gibson042]

Description

Closes: #19686

Detect URLs with ParseRequestURI rather than Parse, since the former is limited to absolute URLs while the latter recognizes undesirable input such as {}.

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• Bug Fixes
  • Fixed an issue where inline JSON was not correctly treated as a URL during parsing.
  • Added a new test case to ensure empty JSON objects are parsed correctly without errors.

[coderabbitai]

Walkthrough

Walkthrough

The change addresses a bug in the URL parsing logic of the ParseInfo function within the upgrade module, specifically when handling inline JSON values. By switching from neturl.Parse to neturl.ParseRequestURI, the update ensures that only absolute URLs are considered valid, resolving an issue where inline JSON was mistakenly treated as a URL. Additionally, a new test case for parsing an empty JSON object has been introduced to verify the fix.

Changes

File(s)	Change Summary
x/upgrade/plan/info.go	Replaced neturl.Parse with neturl.ParseRequestURI
x/upgrade/plan/info_test.go	Added "empty JSON" test case in TestParseInfo()

Assessment against linked issues

Objective	Addressed	Explanation
[#19686]: Fix ParseInfo to correctly handle inline JSON as not a URL	✅

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.
  • 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 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 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.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 28801fc and cc83347.

Files selected for processing (2)

• x/upgrade/plan/info.go (1 hunks)
• x/upgrade/plan/info_test.go (1 hunks)

Additional comments: 2

x/upgrade/plan/info.go (1)

• 57-57: The change from net/url.Parse to net/url.ParseRequestURI in the ParseInfo function is a targeted fix to ensure that only absolute URLs are considered valid input for upgrade information. This adjustment effectively addresses the issue where inline JSON ({}) was mistakenly treated as a URL, aligning with the PR's objectives to enhance parsing robustness.

x/upgrade/plan/info_test.go (1)

• 79-84: The addition of the "empty JSON" test case in the TestParseInfo function is a valuable enhancement to the unit tests. It effectively verifies that an empty JSON string is correctly parsed as an empty Info{} struct, ensuring that the changes to the parsing logic in ParseInfo function behave as expected. This test case strengthens the test suite by covering a previously untested scenario, contributing to the overall robustness of the upgrade information parsing mechanism.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 28801fc and e1012f3.

Files selected for processing (3)

• CHANGELOG.md (1 hunks)
• x/upgrade/plan/info.go (1 hunks)
• x/upgrade/plan/info_test.go (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• x/upgrade/plan/info.go
• x/upgrade/plan/info_test.go

Additional comments: 1

CHANGELOG.md (1)

• 97-97: The changelog entry accurately reflects the changes made in the PR and provides a clear, concise description of the improvement to the upgrade module. The inclusion of the PR link enhances traceability. This entry adheres to the project's standards for documenting changes.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 28801fc and 60e5ae4.

Files selected for processing (3)

• x/upgrade/CHANGELOG.md (1 hunks)
• x/upgrade/plan/info.go (1 hunks)
• x/upgrade/plan/info_test.go (1 hunks)

Check Runs (27)

main completed (1)

tests (03) completed (1)

tests (02) completed (1)

tests (01) completed (1)

test-x-mint completed (1)

test-x-bank completed (1)

test-x-upgrade completed (1)

test-x-slashing completed (1)

test-x-staking completed (1)

test-x-protocolpool completed (1)

test-x-params completed (1)

test-x-group completed (1)

test-x-gov completed (1)

test-x-feegrant completed (1)

test-x-authz completed (1)

test-x-evidence completed (1)

test-x-auth completed (1)

test-x-tx completed (1)

test-x-nft completed (1)

test-x-distribution completed (1)

test-x-circuit completed (1)

test-x-accounts completed (1)

test-store completed (1)

test-simapp completed (1)

test-orm completed (1)

test-math completed (1)

test-log completed (1)

Files skipped from review as they are similar to previous changes (2)

• x/upgrade/plan/info.go
• x/upgrade/plan/info_test.go

Additional comments: 1

x/upgrade/CHANGELOG.md (1)

• 38-38: The changelog entry for PR fix(x/upgrade): Stop treating inline JSON as a URL #19706 is clear and adheres to the changelog best practices by providing a concise summary of the change and linking to the PR for more details. This entry effectively communicates the bug fix to the users.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between a569ba6 and 322479b.

Files selected for processing (3)

• x/upgrade/CHANGELOG.md (1 hunks)
• x/upgrade/plan/info.go (1 hunks)
• x/upgrade/plan/info_test.go (1 hunks)

Check Runs (27)

tests (03) completed (1)

tests (02) completed (1)

tests (01) completed (1)

main completed (1)

test-x-upgrade completed (1)

test-x-staking completed (1)

test-x-slashing completed (1)

test-x-protocolpool completed (1)

test-x-params completed (1)

test-x-nft completed (1)

test-x-mint completed (1)

test-x-group completed (1)

test-x-gov completed (1)

test-x-feegrant completed (1)

test-x-evidence completed (1)

test-x-distribution completed (1)

test-x-circuit completed (1)

test-x-bank completed (1)

test-x-authz completed (1)

test-x-auth completed (1)

test-x-tx completed (1)

test-x-accounts completed (1)

test-store completed (1)

test-log completed (1)

test-hubl completed (1)

test-confix completed (1)

test-sim-nondeterminism completed (1)

Files skipped from review as they are similar to previous changes (2)

• x/upgrade/plan/info.go
• x/upgrade/plan/info_test.go

Additional comments: 2

x/upgrade/CHANGELOG.md (2)

• 38-38: The changelog entry clearly describes the bug fix related to treating inline JSON as a URL, adhering to the guiding principles for changelog entries.
• 33-42: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-68]

While the new changelog entry is clear and follows the prescribed format, consider reviewing the entire document for typographical and grammatical consistency. For example, ensuring spaces between sentences and correcting possible spelling mistakes can improve readability and professionalism.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between a569ba6 and 0cbf9d1.

Files selected for processing (3)

• x/upgrade/CHANGELOG.md (1 hunks)
• x/upgrade/plan/info.go (1 hunks)
• x/upgrade/plan/info_test.go (1 hunks)

Check Runs (27)

tests (03) completed (1)

tests (02) completed (1)

tests (01) completed (1)

test-x-upgrade completed (1)

test-x-tx completed (1)

test-x-staking completed (1)

test-x-slashing completed (1)

test-x-protocolpool completed (1)

test-x-params completed (1)

test-x-nft completed (1)

test-x-mint completed (1)

test-x-group completed (1)

test-x-gov completed (1)

test-x-feegrant completed (1)

test-x-evidence completed (1)

test-x-distribution completed (1)

test-x-circuit completed (1)

test-x-bank completed (1)

test-x-authz completed (1)

test-x-auth completed (1)

test-store completed (1)

test-x-accounts completed (1)

test-simapp completed (1)

test-orm completed (1)

test-math completed (1)

test-log completed (1)

test-hubl completed (1)

Files skipped from review as they are similar to previous changes (2)

• x/upgrade/plan/info.go
• x/upgrade/plan/info_test.go

Additional comments: 1

x/upgrade/CHANGELOG.md (1)

• 38-38: The changelog entry for PR fix(x/upgrade): Stop treating inline JSON as a URL #19706 succinctly describes the bug fix. However, it could be enhanced by briefly explaining the impact of the change, such as "improving the accuracy of upgrade information parsing." This would provide more context to the reader about the significance of the fix.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 0cbf9d1 and 1c7741e.

Files selected for processing (1)

• x/upgrade/CHANGELOG.md (1 hunks)

Additional comments: 1

x/upgrade/CHANGELOG.md (1)

• 42-42: The changelog entry correctly documents the bug fix related to treating inline JSON as a URL. However, it could be enhanced by briefly describing the solution or the approach taken to fix the issue, providing more context for the reader.

Consider adding a brief description of the fix, such as "by refining URL parsing logic to strictly recognize absolute URLs."