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

release-23.1: linter: loopvarcapture should check interface methods #103088

Merged
merged 1 commit into from
May 11, 2023

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented May 11, 2023

Backport 1/1 commits from #102679 on behalf of @srosenberg.

/cc @cockroachdb/release


The loopvarcapture linter is part of roachvet. It flags incorrect uses of loop variables captured by reference in Go routines or defer statements--a common source of data races.

In addition to checking Go routines created via the go keyword, the linter also checks against other (internal) APIs, which are known to create Go routines; this is specified via GoRoutineFunctions.

An existing bug prevented the linter from checking inside Monitor.Go, which are commonly used inside roachtests.
This PR fixes the linter bug as well as the pre-existing bug inside a roachtest, which this linter now detects.

This PR also removes the uncessary hack, i.e., RunDespiteErrors, introduced in [1]. By allowing the type checker to swallow errors, the test was susceptible to silent errors, e.g., buggy testdata. Instead, we work around by disabling CGO.

Epic: none
Fixes: #102678
Release note: None
Release justification: CI only change

[1] #84867 (comment)


Release justification:

The `loopvarcapture` linter is part of `roachvet`.
It flags incorrect uses of loop variables captured by reference
in Go routines or defer statements--a common source of data races.

In addition to checking Go routines created via the `go` keyword,
the linter also checks against other (internal) APIs, which are known
to create Go routines; this is specified via `GoRoutineFunctions`.

An existing bug prevented the linter from checking inside `Monitor.Go`,
which are commonly used inside roachtests.
This PR fixes the linter bug as well as the pre-existing bug inside
a roachtest, which this linter now detects.

This PR also removes the uncessary hack, i.e., `RunDespiteErrors`, introduced
in [1]. By allowing the type checker to swallow errors, the test was susceptible
to silent errors, e.g., buggy testdata. Instead, we work around by disabling CGO.

Epic: none
Fixes: #102678
Release note: None

[1] #84867 (comment)
@blathers-crl blathers-crl bot requested a review from a team as a code owner May 11, 2023 03:03
@blathers-crl blathers-crl bot requested review from herkolategan and smg260 and removed request for a team May 11, 2023 03:03
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-102679 branch from dd85943 to 3c54037 Compare May 11, 2023 03:03
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels May 11, 2023
@blathers-crl
Copy link
Author

blathers-crl bot commented May 11, 2023

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@srosenberg srosenberg merged commit a551206 into release-23.1 May 11, 2023
@srosenberg srosenberg deleted the blathers/backport-release-23.1-102679 branch May 11, 2023 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants