refactor: replaced `fmt.Sprintf` with `strconv.FormatBool` for boolean conversions by MukulKolpe · Pull Request #6516 · cosmos/ibc-go

MukulKolpe · 2024-06-05T21:31:54Z

Description

Replaced fmt.Sprintf with strconv.FormatBool for all instances of boolean conversion.
For reference - #6442 (comment).

closes: #6449

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Summary by CodeRabbit

Refactor
- Improved boolean-to-string conversion for event attributes across multiple modules for better performance and consistency.

coderabbitai · 2024-06-05T21:32:39Z

Walkthrough

The changes focus on improving the conversion of boolean values to strings within the codebase. Specifically, the fmt.Sprintf method has been replaced with strconv.FormatBool for better performance and readability. This update affects several functions responsible for event emission in the interchain accounts and transfer modules.

Changes

Files/Modules	Change Summary
`.../27-interchain-accounts/controller/ibc_middleware_test.go`	Updated boolean formatting from `fmt.Sprintf("%t", false)` to `strconv.FormatBool(false)` in `TestOnRecvPacket`.
`.../27-interchain-accounts/controller/keeper/events.go`	Replaced `fmt.Sprintf` with `strconv.FormatBool` for `ack.Success()` in `EmitAcknowledgementEvent`.
`.../27-interchain-accounts/host/ibc_module_test.go`	Changed `fmt.Sprintf("%t", ack.Success())` to `strconv.FormatBool(ack.Success())` in `TestOnRecvPacket`.
`.../27-interchain-accounts/host/keeper/events.go`	Updated boolean conversion method in `EmitAcknowledgementEvent`.
`.../transfer/internal/events/events.go`	Replaced `fmt.Sprintf("%t", ack.Success())` with `strconv.FormatBool(ack.Success())` in `EmitOnRecvPacketEvent`.

Assessment against linked issues

Objective (Issue #6449)	Addressed	Explanation
Replace `fmt.Sprintf` with `strconv.FormatBool`	✅

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

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.
- @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@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.

coderabbitai

Actionable comments posted: 4

Outside diff range and nitpick comments (3)

modules/apps/27-interchain-accounts/controller/keeper/events.go (1)
Line range hint 4-4: Remove unused import to clean up the code.
- import (
-	"fmt"
Tools

GitHub Check: tests (03)

[failure] 19-19:
undefined: strconv

GitHub Check: tests (02)

[failure] 19-19:
undefined: strconv

[failure] 19-19:
undefined: strconv

GitHub Check: tests (01)

[failure] 19-19:
undefined: strconv

GitHub Check: tests (00)

[failure] 19-19:
undefined: strconv

[failure] 19-19:
undefined: strconv

GitHub Check: build (arm64)

[failure] 19-19:
undefined: strconv

GitHub Check: build (amd64)

[failure] 19-19:
undefined: strconv

GitHub Check: lint

[failure] 19-19:
undefined: strconv) (typecheck)
modules/apps/27-interchain-accounts/host/keeper/events.go (1)
Line range hint 4-4: Remove unused import to clean up the code.
- import (
-	"fmt"
Tools

GitHub Check: tests (03)

[failure] 20-20:
undefined: strconv

GitHub Check: tests (02)

[failure] 20-20:
undefined: strconv

[failure] 20-20:
undefined: strconv

GitHub Check: tests (01)

[failure] 20-20:
undefined: strconv

GitHub Check: tests (00)

[failure] 20-20:
undefined: strconv

[failure] 20-20:
undefined: strconv

GitHub Check: build (arm64)

[failure] 20-20:
undefined: strconv

GitHub Check: build (amd64)

[failure] 20-20:
undefined: strconv

GitHub Check: lint

[failure] 20-20:
undefined: strconv) (typecheck)

[failure] 20-20:
undefined: strconv) (typecheck)
modules/apps/transfer/internal/events/events.go (1)
Line range hint 5-5: Remove unused import to clean up the code.
- import (
-	"fmt"
Tools

GitHub Check: tests (03)

[failure] 41-41:
undefined: strconv

GitHub Check: tests (02)

[failure] 41-41:
undefined: strconv

GitHub Check: tests (01)

[failure] 41-41:
undefined: strconv

[failure] 41-41:
undefined: strconv

GitHub Check: tests (00)

[failure] 41-41:
undefined: strconv

GitHub Check: build (arm64)

[failure] 41-41:
undefined: strconv

GitHub Check: build (amd64)

[failure] 41-41:
undefined: strconv

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 01eb3cb and aec5951.

Files selected for processing (5)

modules/apps/27-interchain-accounts/controller/ibc_middleware_test.go (1 hunks)
modules/apps/27-interchain-accounts/controller/keeper/events.go (1 hunks)
modules/apps/27-interchain-accounts/host/ibc_module_test.go (1 hunks)
modules/apps/27-interchain-accounts/host/keeper/events.go (1 hunks)
modules/apps/transfer/internal/events/events.go (1 hunks)

Additional context used

Path-based instructions (5)

modules/apps/27-interchain-accounts/controller/keeper/events.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

modules/apps/27-interchain-accounts/host/keeper/events.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

modules/apps/transfer/internal/events/events.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

modules/apps/27-interchain-accounts/host/ibc_module_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

modules/apps/27-interchain-accounts/controller/ibc_middleware_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

GitHub Check: tests (03)

modules/apps/27-interchain-accounts/controller/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 19-19:
undefined: strconv

modules/apps/27-interchain-accounts/host/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv

modules/apps/transfer/internal/events/events.go

[failure] 5-5:
"fmt" imported and not used

[failure] 41-41:
undefined: strconv

GitHub Check: tests (02)

modules/apps/27-interchain-accounts/controller/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 19-19:
undefined: strconv

[failure] 4-4:
"fmt" imported and not used

[failure] 19-19:
undefined: strconv

modules/apps/27-interchain-accounts/host/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv

modules/apps/transfer/internal/events/events.go

[failure] 5-5:
"fmt" imported and not used

[failure] 41-41:
undefined: strconv

GitHub Check: tests (01)

modules/apps/27-interchain-accounts/controller/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 19-19:
undefined: strconv

modules/apps/27-interchain-accounts/host/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv

modules/apps/transfer/internal/events/events.go

[failure] 5-5:
"fmt" imported and not used

[failure] 41-41:
undefined: strconv

[failure] 5-5:
"fmt" imported and not used

[failure] 41-41:
undefined: strconv

GitHub Check: tests (00)

modules/apps/27-interchain-accounts/controller/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 19-19:
undefined: strconv

[failure] 4-4:
"fmt" imported and not used

[failure] 19-19:
undefined: strconv

modules/apps/27-interchain-accounts/host/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv

modules/apps/transfer/internal/events/events.go

[failure] 5-5:
"fmt" imported and not used

[failure] 41-41:
undefined: strconv

GitHub Check: build (arm64)

modules/apps/27-interchain-accounts/controller/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 19-19:
undefined: strconv

modules/apps/27-interchain-accounts/host/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv

modules/apps/transfer/internal/events/events.go

[failure] 5-5:
"fmt" imported and not used

[failure] 41-41:
undefined: strconv

GitHub Check: build (amd64)

modules/apps/27-interchain-accounts/controller/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 19-19:
undefined: strconv

modules/apps/27-interchain-accounts/host/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv

modules/apps/transfer/internal/events/events.go

[failure] 5-5:
"fmt" imported and not used

[failure] 41-41:
undefined: strconv

GitHub Check: lint

modules/apps/27-interchain-accounts/controller/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 19-19:
undefined: strconv) (typecheck)

modules/apps/27-interchain-accounts/host/keeper/events.go

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv) (typecheck)

[failure] 4-4:
"fmt" imported and not used

[failure] 20-20:
undefined: strconv) (typecheck)

coderabbitai · 2024-06-05T21:41:46Z

 						sdk.NewAttribute(sdk.AttributeKeyModule, icatypes.ModuleName),
 						sdk.NewAttribute(icatypes.AttributeKeyControllerChannelID, packet.GetDestChannel()),
-						sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, fmt.Sprintf("%t", false)),
+						sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, strconv.FormatBool(false)),


Replace fmt.Sprintf with strconv.FormatBool for boolean conversion.

- sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, fmt.Sprintf("%t", ack.Success())) + sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, strconv.FormatBool(ack.Success()))

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, strconv.FormatBool(false)),

sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, strconv.FormatBool(false)),

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between aec5951 and bf3fdfd.

Files selected for processing (5)

modules/apps/27-interchain-accounts/controller/ibc_middleware_test.go (2 hunks)
modules/apps/27-interchain-accounts/controller/keeper/events.go (2 hunks)
modules/apps/27-interchain-accounts/host/ibc_module_test.go (2 hunks)
modules/apps/27-interchain-accounts/host/keeper/events.go (2 hunks)
modules/apps/transfer/internal/events/events.go (2 hunks)

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

modules/apps/27-interchain-accounts/controller/ibc_middleware_test.go
modules/apps/27-interchain-accounts/controller/keeper/events.go
modules/apps/27-interchain-accounts/host/ibc_module_test.go
modules/apps/27-interchain-accounts/host/keeper/events.go
modules/apps/transfer/internal/events/events.go

DimitrisJim

lgtm! thanks!

crodriguezvega

Thank you, @MukulKolpe!

MukulKolpe · 2024-06-06T08:20:09Z

Thanks @DimitrisJim, @crodriguezvega!

MukulKolpe requested review from AdityaSripal, chatton, colin-axner and damiannolan as code owners June 5, 2024 21:31

coderabbitai Bot reviewed Jun 5, 2024

View reviewed changes

refactor: replaced fmt.Sprintf with strconv.FormatBool

f229fb8

MukulKolpe force-pushed the formatBool branch from bf3fdfd to f229fb8 Compare June 5, 2024 22:15

Merge branch 'main' into formatBool

c3403f4

DimitrisJim approved these changes Jun 6, 2024

View reviewed changes

crodriguezvega approved these changes Jun 6, 2024

View reviewed changes

crodriguezvega merged commit 87dfd76 into cosmos:main Jun 6, 2024

MukulKolpe deleted the formatBool branch June 6, 2024 08:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: replaced `fmt.Sprintf` with `strconv.FormatBool` for boolean conversions#6516

refactor: replaced `fmt.Sprintf` with `strconv.FormatBool` for boolean conversions#6516
crodriguezvega merged 2 commits into
cosmos:mainfrom
MukulKolpe:formatBool

MukulKolpe commented Jun 5, 2024 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 5, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jun 5, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

DimitrisJim left a comment

Uh oh!

crodriguezvega left a comment

Uh oh!

MukulKolpe commented Jun 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, strconv.FormatBool(false)),
	sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, strconv.FormatBool(false)),

Conversation

MukulKolpe commented Jun 5, 2024 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

DimitrisJim left a comment

Choose a reason for hiding this comment

Uh oh!

crodriguezvega left a comment

Choose a reason for hiding this comment

Uh oh!

MukulKolpe commented Jun 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MukulKolpe commented Jun 5, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 5, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)