Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix staticcheck warning SA1029: inappropriate key in call to context.WithValue #693

Merged
merged 2 commits into from
Oct 25, 2024

Conversation

gzliudan
Copy link
Collaborator

@gzliudan gzliudan commented Oct 25, 2024

Proposed changes

This PR fixes the staticcheck warning SA1029: Inappropriate key in call to context.WithValue by:

The provided key must be comparable and should not be of type string or any other built-in type to avoid collisions between packages using context. Users of WithValue should define their own types for keys.

To avoid allocating when assigning to an interface{}, context keys often have concrete type struct{}. Alternatively, exported context key variables’ static type should be a pointer or interface.

Types of changes

What types of changes does your code introduce to XDC network?
Put an in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)
  • Regular KTLO or any of the maintaince work. e.g code style
  • CICD Improvement

Impacted Components

Which part of the codebase this PR will touch base on,

Put an in the boxes that apply

  • Consensus
  • Account
  • Network
  • Geth
  • Smart Contract
  • External components
  • Not sure (Please specify below)

Checklist

Put an in the boxes once you have confirmed below actions (or provide reasons on not doing so) that

  • This PR has sufficient test coverage (unit/integration test) OR I have provided reason in the PR description for not having test coverage
  • Provide an end-to-end test plan in the PR description on how to manually test it on the devnet/testnet.
  • Tested the backwards compatibility.
  • Tested with XDC nodes running this version co-exist with those running the previous version.
  • Relevant documentation has been updated as part of this PR
  • N/A

@gzliudan gzliudan changed the title rpc: add PeerInfo fix staticcheck warning SA1029: Inappropriate key in call to context.WithValue Oct 25, 2024
@gzliudan gzliudan changed the title fix staticcheck warning SA1029: Inappropriate key in call to context.WithValue fix staticcheck warning SA1029: inappropriate key in call to context.WithValue Oct 25, 2024
@gzliudan gzliudan merged commit e9df8a1 into XinFinOrg:dev-upgrade Oct 25, 2024
17 checks passed
@gzliudan gzliudan deleted the rpc-peerinfo branch October 25, 2024 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants