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 a number of CodeQL warnings #14882

Merged
merged 1 commit into from
Jan 4, 2024

Conversation

dbussink
Copy link
Contributor

@dbussink dbussink commented Jan 3, 2024

This addresses a number of CodeQL warnings. We have a concurrency field which is using inconsistent types across different fields, which means we end up casting and triggering warnings around overflows. We can use the smallest type here, namely int32 since that is for sure sufficient for real concurrency values. It avoids warnings like:

https://github.com/vitessio/vitess/security/code-scanning/267

Also fixes the parsing bug identified in
https://github.com/vitessio/vitess/security/code-scanning/266 where we parse with ParseUint instead of ParseInt.

Last one is
https://github.com/vitessio/vitess/security/code-scanning/268 which is fixed by making sure we parse it as the type MySQL sends down and to keep using that consistently.

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Copy link
Contributor

vitess-bot bot commented Jan 3, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jan 3, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 3, 2024
uses: actions/setup-go@v4
with:
go-version: 1.21.5

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dbussink dbussink removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jan 3, 2024
@dbussink dbussink force-pushed the dbussink/fix-codeql-warnings branch from dee3d90 to 4f77d60 Compare January 3, 2024 21:15
This addresses a number of CodeQL warnings. We have a concurrency field
which is using inconsistent types across different fields, which means
we end up casting and triggering warnings around overflows. We can use
the smallest type here, namely int32 since that is for sure sufficient
for real concurrency values. It avoids warnings like:

https://github.com/vitessio/vitess/security/code-scanning/267

Also fixes the parsing bug identified in
https://github.com/vitessio/vitess/security/code-scanning/266 where we
parse with `ParseUint` instead of `ParseInt`.

Last one is
https://github.com/vitessio/vitess/security/code-scanning/268 which is
fixed by making sure we parse it as the type MySQL sends down and to
keep using that consistently.

Signed-off-by: Dirkjan Bussink <[email protected]>
@dbussink dbussink force-pushed the dbussink/fix-codeql-warnings branch from 4f77d60 to 560496b Compare January 3, 2024 21:27
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Thank you for fixing those @dbussink 🙏🏻

// name into a uint32 value. If the parameter is not set, the provided default
// value is returned.
func (r Request) ParseQueryParamAsInt32(name string, defaultVal int32) (int32, error) {
if param := r.URL.Query().Get(name); param != "" {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Styling-wise, I'd prefer to first handle the case where param == "" and do an early return, then unindent the rest of the function. But it's insignificant and not worth the rebuild time.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shlomi-noach Copy-pasted this mostly from another function for uint32, so it's not "new" in that sense.

@dbussink dbussink merged commit 7e1afc3 into vitessio:main Jan 4, 2024
102 checks passed
@dbussink dbussink deleted the dbussink/fix-codeql-warnings branch January 4, 2024 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: General Changes throughout the code base Type: Internal Cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants