fix(x/authz): non utf-8 characters in logs #19923

EmilGeorgiev · 2024-04-03T04:04:18Z

Description

Closes: #19874

For consistency with other methods in the keeper, in the logs are printed granter address, grantee address and the msg type instead of grant key which is not valid UTF-8.

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

Refactor
- Enhanced error message details in the authorization deletion process to improve debugging.
Bug Fixes
- Ensured that transaction event queries return responses with only UTF-8 characters.

coderabbitai · 2024-04-03T04:04:23Z

Walkthrough

The recent updates aim to improve error message clarity in the DeleteGrant function by providing detailed information about the grantee, granter, and message type. Additionally, a bug related to parsing errors caused by non-UTF-8 characters in transaction logs on the mainnet has been resolved. These changes enhance debugging capabilities and ensure compliance with UTF-8 encoding standards in string representations.

Changes

File	Change Summary
`x/authz/keeper/keeper.go`	Updated error message in `DeleteGrant` to include detailed info about grantee, granter, and message type.

Assessment against linked issues

Objective	Addressed	Explanation
Enhance error message clarity in `DeleteGrant` for debugging purposes (#19874)	✅
Address parsing error caused by non-UTF-8 characters in transaction logs (#19874)	❌	The change summary does not mention a fix for handling non-UTF-8 characters in transaction logs.

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.

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/coderabbit-overrides.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.

… grantee address and the msg type

coderabbitai

Actionable comments posted: 1

Review Status

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 319e6e4 and a9b1bc5.

Files selected for processing (1)

x/authz/keeper/keeper.go (1 hunks)

Additional Context Used

Path-based Instructions (1)

x/authz/keeper/keeper.go (1)

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

coderabbitai · 2024-04-03T04:13:46Z

x/authz/keeper/keeper.go

+		return errorsmod.Wrapf(authz.ErrNoAuthorizationFound,
+			"failed to delete grant with key %s given granter: %s, grantee: %s & msgType: %s ", granter.String(), grantee.String(), msgType)


Consider using fmt.Errorf instead of errorsmod.Wrapf for consistency with the rest of the Cosmos SDK codebase and to improve readability.

- return errorsmod.Wrapf(authz.ErrNoAuthorizationFound, + return fmt.Errorf("failed to delete grant with key %s given granter: %s, grantee: %s & msgType: %s: %w", granter.String(), grantee.String(), msgType, authz.ErrNoAuthorizationFound)

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

return errorsmod.Wrapf(authz.ErrNoAuthorizationFound,

"failed to delete grant with key %s given granter: %s, grantee: %s & msgType: %s ", granter.String(), grantee.String(), msgType)

return fmt.Errorf("failed to delete grant with key %s given granter: %s, grantee: %s & msgType: %s: %w", granter.String(), grantee.String(), msgType, authz.ErrNoAuthorizationFound)

x/authz/keeper/keeper.go

coderabbitai

Actionable comments posted: 0

Review Status

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between a9b1bc5 and ebd7df1.

Files selected for processing (1)

x/authz/keeper/keeper.go (1 hunks)

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

x/authz/keeper/keeper.go

julienrbrt

Can we get a changelog in x/authx/changelog.md

EmilGeorgiev · 2024-04-05T02:27:29Z

Can we get a changelog in x/authx/changelog.md

Done

coderabbitai

Actionable comments posted: 1

Review Status

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between ebd7df1 and 8b393f0.

Files selected for processing (1)

x/authz/CHANGELOG.md (1 hunks)

Additional Context Used

Path-based Instructions (1)

x/authz/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

coderabbitai · 2024-04-05T02:31:23Z

x/authz/CHANGELOG.md

+
+### Bug Fixes
+
+* [#19874](https://github.com/cosmos/cosmos-sdk/pull/19923) Now when querying transaction events (cosmos.tx.v1beta1.Service/GetTxsEvent) the response will contains only UTF-8 characters


Clarify the bug fix entry to specify the method or functionality that was modified.

- * [#19874](https://github.com/cosmos/cosmos-sdk/pull/19923) Now when querying transaction events (cosmos.tx.v1beta1.Service/GetTxsEvent) the response will contains only UTF-8 characters + * [#19874](https://github.com/cosmos/cosmos-sdk/pull/19923) Fixed an issue in the `DeleteGrant` function where non-UTF-8 characters in logs could cause parsing errors when querying transaction events (cosmos.tx.v1beta1.Service/GetTxsEvent). Now, the response contains only UTF-8 characters.

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

* [#19874](https://github.com/cosmos/cosmos-sdk/pull/19923) Now when querying transaction events (cosmos.tx.v1beta1.Service/GetTxsEvent) the response will contains only UTF-8 characters

* [#19874](https://github.com/cosmos/cosmos-sdk/pull/19923) Fixed an issue in the `DeleteGrant` function where non-UTF-8 characters in logs could cause parsing errors when querying transaction events (cosmos.tx.v1beta1.Service/GetTxsEvent). Now, the response contains only UTF-8 characters.

…-19874

* main: (45 commits) build(deps): Bump github.com/decred/dcrd/dcrec/secp256k1/v4 from 4.2.0 to 4.3.0 (cosmos#19913) build(deps): Bump google.golang.org/grpc from 1.62.1 to 1.63.0 (cosmos#19929) test(types/address): add additional unit tests for address.LengthPrefix and a… (cosmos#19964) refactor(x/bank)!: remove Address.String() (cosmos#19954) build(deps): Bump github.com/prometheus/common from 0.51.1 to 0.52.2 (cosmos#19930) fix(x/epochs): Fix init genesis (cosmos#19958) feat(core,runtime): transaction service (exec mode) (cosmos#19953) fix(x/authz): non utf-8 characters in logs (cosmos#19923) build(deps): Bump golang.org/x/crypto from 0.21.0 to 0.22.0 (cosmos#19960) chore: fix spelling errors (cosmos#19957) fix(x/tx): don't shadow Amino marshalling error messages (cosmos#19955) refactor(types): loosen module.AppModule interface (cosmos#19951) feat(core): add `TxValidator` interface (cosmos#19950) build(deps): Bump cosmossdk.io/store from 1.0.2 to 1.1.0 in /x/epochs (cosmos#19947) feat(x/epochs): upstream osmosis epoch module (cosmos#19697) build(deps): Bump bufbuild/buf-setup-action from 1.30.0 to 1.30.1 (cosmos#19928) refactor(x/genutil)!: remove Address.String() (cosmos#19926) docs(x/mint): Fix inconsistency in mint docs (cosmos#19915) build(deps): Bump github.com/regen-network/gocuke from 1.1.0 to 1.1.1 in /orm (cosmos#19920) feat: Integrate grpc configuration into client.toml (cosmos#19905) ...

EmilGeorgiev added 5 commits April 2, 2024 21:36

write unit test first

ab6cc27

implement parsing function that convert grant key to UTF-8 valid string

fdbe314

remove unnecessary debug fmt.Println

c61670e

refactor the function for parsing grsnt key to valid utf-8 string

5b5e64b

add comments

a1d24a0

github-actions bot added the C:x/authz label Apr 3, 2024

for consistency woth other methods print in the logs grenter address,…

a9b1bc5

… grantee address and the msg type

EmilGeorgiev force-pushed the fix-authz-non-utf-8-characters-in-event-logs-19874 branch from 90510d7 to a9b1bc5 Compare April 3, 2024 04:08

EmilGeorgiev marked this pull request as ready for review April 3, 2024 04:09

EmilGeorgiev requested a review from a team as a code owner April 3, 2024 04:09

coderabbitai bot reviewed Apr 3, 2024

View reviewed changes

sontrinh16 reviewed Apr 3, 2024

View reviewed changes

x/authz/keeper/keeper.go Show resolved Hide resolved

remove unnecessary '%s' in the format string

ebd7df1

sontrinh16 approved these changes Apr 3, 2024

View reviewed changes

coderabbitai bot reviewed Apr 3, 2024

View reviewed changes

julienrbrt changed the title ~~fix(authz): non utf 8 characters in logs 19874~~ fix(x/authz): non utf-8 characters in logs Apr 3, 2024

julienrbrt reviewed Apr 3, 2024

View reviewed changes

likhita-809 approved these changes Apr 4, 2024

View reviewed changes

update the changelog.md file

8b393f0

coderabbitai bot reviewed Apr 5, 2024

View reviewed changes

Merge branch 'main' into fix-authz-non-utf-8-characters-in-event-logs…

bb306f2

…-19874

facundomedica enabled auto-merge April 5, 2024 09:49

facundomedica added this pull request to the merge queue Apr 5, 2024

Merged via the queue into cosmos:main with commit ab45a85 Apr 5, 2024
55 of 58 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(x/authz): non utf-8 characters in logs #19923

fix(x/authz): non utf-8 characters in logs #19923

EmilGeorgiev commented Apr 3, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 3, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Apr 3, 2024

coderabbitai bot left a comment

julienrbrt left a comment

EmilGeorgiev commented Apr 5, 2024

coderabbitai bot left a comment

coderabbitai bot Apr 5, 2024

		return errorsmod.Wrapf(authz.ErrNoAuthorizationFound,
		"failed to delete grant with key %s given granter: %s, grantee: %s & msgType: %s ", granter.String(), grantee.String(), msgType)

	return errorsmod.Wrapf(authz.ErrNoAuthorizationFound,
	"failed to delete grant with key %s given granter: %s, grantee: %s & msgType: %s ", granter.String(), grantee.String(), msgType)
	return fmt.Errorf("failed to delete grant with key %s given granter: %s, grantee: %s & msgType: %s: %w", granter.String(), grantee.String(), msgType, authz.ErrNoAuthorizationFound)


		### Bug Fixes

		* [#19874](https://github.com/cosmos/cosmos-sdk/pull/19923) Now when querying transaction events (cosmos.tx.v1beta1.Service/GetTxsEvent) the response will contains only UTF-8 characters

fix(x/authz): non utf-8 characters in logs #19923

fix(x/authz): non utf-8 characters in logs #19923

Conversation

EmilGeorgiev commented Apr 3, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Apr 3, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 3, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

EmilGeorgiev commented Apr 5, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 5, 2024

Choose a reason for hiding this comment

EmilGeorgiev commented Apr 3, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 3, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)