Flakes: De-flake TestGatewayBufferingWhenPrimarySwitchesServingState

[mattlord]

Description

The TestGatewayBufferingWhenPrimarySwitchesServingState unit test has been somewhat flaky in all unit test workflows due to timing issues. For whatever reasons, it was even more flaky in the new code coverage workflow and it was failing there upwards of 50% of the time.

The changes in this PR appear to have removed the flakiness as this unit test — for whatever related timing issues — was causing the code coverage workflow to fail upwards of 50% off the time and now in this PR it passed 10 times in a row (there were other unit test failures, but not for this test):

• https://github.com/vitessio/vitess/actions/runs/7546084268?pr=14968
• https://github.com/vitessio/vitess/actions/runs/7547205459/job/20546652849?pr=14968

Related Issue(s)

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

[vitess-bot]

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c1f9c80) 47.26% compared to head (f33ed92) 47.28%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #14968      +/-   ##
==========================================
+ Coverage   47.26%   47.28%   +0.01%     
==========================================
  Files        1138     1138              
  Lines      238842   238842              
==========================================
+ Hits       112880   112927      +47     
+ Misses     117368   117318      -50     
- Partials     8594     8597       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.