Skip to content

fix(internal/civisibility): avoid tests-only race condition on CIVis reset#4744

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits into
mainfrom
dario.castane/ktlo/flakey-set-testfunc-preserves-suite-level-unskippable
May 11, 2026
Merged

fix(internal/civisibility): avoid tests-only race condition on CIVis reset#4744
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits into
mainfrom
dario.castane/ktlo/flakey-set-testfunc-preserves-suite-level-unskippable

Conversation

@darccio

@darccio darccio commented May 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

What does this PR do?

In resetCIVisibilityStateForTesting, replaces getSearchCommitsFunc = getSearchCommits (the real git function) with a stub that immediately returns (nil, nil, false) ("no commits, upload skipped").

The upload goroutine short-circuits in uploadRepositoryChangesWithHooks at the !IsOk check and exits immediately — never reading ciVisibilityClient. No concurrent reader, no race. Tests that need real commit behavior already override getSearchCommitsFunc after reset.

Motivation

Root cause: resetCIVisibilityStateForTesting resets settingsInitializationOnce to fresh, so the first call to GetImpactedTestsAnalyzer() inside SetTestFunc triggers the real settings initialization. That spawns an upload goroutine which calls getSearchCommits() → utils.GetLastLocalGitCommitShas() (git subprocess, slow) → ciVisibilityClient.GetCommits(). When the test cleanup then runs ciVisibilityClient = nil, the race detector fires.

The race is timing-dependent: fast on Mac (goroutine finishes first), caught more often in CI under load or with race-detector overhead widening the window.

Reviewer's Checklist

  • Changed code has unit tests for its functionality at or near 100% coverage.
  • New code is free of linting errors. You can check this by running make lint locally.
  • New code doesn't break existing tests. You can check this by running make test locally.
  • Add an appropriate team label so this PR gets put in the right place for the release notes.
  • All generated files are up to date. You can check this by running make generate locally.
  • Non-trivial go.mod changes, e.g. adding new modules, are reviewed by @DataDog/dd-trace-go-guild. Make sure all nested modules are up to date by running make fix-modules locally.

Unsure? Have a question? Request a review!

@darccio
darccio requested a review from a team as a code owner May 11, 2026 08:48
@codecov

codecov Bot commented May 11, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 62.41%. Comparing base (0ebb7ee) to head (7460e1f).

Additional details and impacted files

see 450 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@datadog-prod-us1-5

datadog-prod-us1-5 Bot commented May 11, 2026 •
edited by datadog-datadog-prod-us1-2 Bot
Loading

Copy link
Copy Markdown

Tests

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 61.73% (+3.88%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 7460e1f | Docs | Datadog PR Page | Give us feedback!

@pr-commenter

pr-commenter Bot commented May 11, 2026

Copy link
Copy Markdown

Benchmarks

Benchmark execution time: 2026-05-11 15:56:08

Comparing candidate commit 7460e1f in PR branch dario.castane/ktlo/flakey-set-testfunc-preserves-suite-level-unskippable with baseline commit 0ebb7ee in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 273 metrics, 2 unstable metrics, 1 flaky benchmarks without significant changes.

Explanation

This is an A/B test comparing a candidate commit's performance against that of a baseline commit. Performance changes are noted in the tables below as:

  • 🟩 = significantly better candidate vs. baseline
  • 🟥 = significantly worse candidate vs. baseline

We compute a confidence interval (CI) over the relative difference of means between metrics from the candidate and baseline commits, considering the baseline as the reference.

If the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD), the change is considered significant.

Feel free to reach out to #apm-benchmarking-platform on Slack if you have any questions.

More details about the CI and significant changes

You can imagine this CI as a range of values that is likely to contain the true difference of means between the candidate and baseline commits.

CIs of the difference of means are often centered around 0%, because often changes are not that big:

---------------------------------(------|---^--------)-------------------------------->
                              -0.6%    0%  0.3%     +1.2%
                                 |          |        |
         lower bound of the CI --'          |        |
sample mean (center of the CI) -------------'        |
         upper bound of the CI ----------------------'

As described above, a change is considered significant if the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD).

For instance, for an execution time metric, this confidence interval indicates a significantly worse performance:

----------------------------------------|---------|---(---------^---------)---------->
                                       0%        1%  1.3%      2.2%      3.1%
                                                  |   |         |         |
       significant impact threshold --------------'   |         |         |
                      lower bound of CI --------------'         |         |
       sample mean (center of the CI) --------------------------'         |
                      upper bound of CI ----------------------------------'

Known flaky benchmarks

These benchmarks are marked as flaky and will not trigger a failure. Modify FLAKY_BENCHMARKS_REGEX to control which benchmarks are marked as flaky.

Known flaky benchmarks without significant changes:

  • scenario:BenchmarkOTLPTraceWriterFlush

@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot merged commit 55c1586 into main May 11, 2026
162 of 164 checks passed
@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot deleted the dario.castane/ktlo/flakey-set-testfunc-preserves-suite-level-unskippable branch May 11, 2026 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tonyredondo tonyredondo tonyredondo approved these changes

Assignees

No one assigned

Labels

mergequeue-status: done team:apm-go

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@darccio @tonyredondo