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

connpool: fix racy test #14731

Merged
merged 1 commit into from
Dec 8, 2023
Merged

Conversation

vmg
Copy link
Collaborator

@vmg vmg commented Dec 8, 2023

Description

--- FAIL: TestOpen (0.05s)
    pool_test.go:174: 
        	Error Trace:	/home/runner/work/vitess/vitess/go/pools/smartconnpool/pool_test.go:174
        	Error:      	Not equal: 
        	            	expected: int(5)
        	            	actual  : int64(4)
        	Test:       	TestOpen
    pool_test.go:175: 
        	Error Trace:	/home/runner/work/vitess/vitess/go/pools/smartconnpool/pool_test.go:175
        	Error:      	Not equal: 
        	            	expected: 5
        	            	actual  : 4
        	Test:       	TestOpen
FAIL
FAIL	vitess.io/vitess/go/pools/smartconnpool	15.407s

Spotted by @harshit-gangal. A sleep is not always enough to synchronize the wait. We can make the synchronization explicit by waiting until a client is in the wait queue, then offering a connection to them.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

Signed-off-by: Vicent Marti <[email protected]>
Copy link
Contributor

vitess-bot bot commented Dec 8, 2023

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 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 Dec 8, 2023
@vmg vmg added Component: Query Serving Type: CI/Build and 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 labels Dec 8, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 8, 2023
@vmg vmg added the Component: General Changes throughout the code base label Dec 8, 2023
Comment on lines +169 to +172
// block until we have a client wait for a connection, then offer it
for p.wait.waiting() == 0 {
time.Sleep(time.Millisecond)
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like we should use a context here to break out of this if needed... but this is a unit test so the test itself should time out relatively quickly.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In theory this code cannot deadlock, because the goroutine is constantly trying to add itself to the waitgroup, but you're right that the test timeout will catch this if down the road we break the implementation.

@vmg vmg merged commit 87b047b into vitessio:main Dec 8, 2023
120 of 121 checks passed
@vmg vmg deleted the vmg/connpool-wait-race branch December 8, 2023 12:13
ejortegau referenced this pull request in slackhq/vitess Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants