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

ci: fix flaky aiohttp test failure [backport 2.17] #11974

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Jan 15, 2025

Backport d364f1b from #11698 to 2.17.

There is something about this test which leaks bad behavior over to other tests when run in specific order.

Using --randomly-seed=4013706280 will simulate the same test execution order as an example failing job to reproduce the behavior consistently.

I do not really understand the root cause of this issue, but removing the extra patch/unpatch calls does resolve the issue and keeps the original test as passing.

The failing behavior on the test_distributed_tracing test was that the passed in distributed tracing headers were not honored. I think this is because the test expects an unpatched aiohttp client, but we are actually getting a patched one, so it is creating a span and injecting it's distributed headers into the request.

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

Co-authored-by: erikayasuda <153395705+erikayasuda@users.noreply.github.com>
(cherry picked from commit d364f1b)
@github-actions github-actions bot added changelog/no-changelog A changelog entry is not required for this PR. mergequeue-status: done labels Jan 15, 2025
@github-actions github-actions bot requested review from a team as code owners January 15, 2025 20:50
@erikayasuda erikayasuda reopened this Jan 15, 2025
@erikayasuda erikayasuda enabled auto-merge (squash) January 15, 2025 20:50
Copy link
Contributor Author

CODEOWNERS have been resolved as:

tests/contrib/aiohttp/test_request.py                                   @DataDog/apm-core-python @DataDog/apm-idm-python

@pr-commenter
Copy link

pr-commenter bot commented Jan 15, 2025

Benchmarks

Benchmark execution time: 2025-01-15 21:32:28

Comparing candidate commit 61f18c4 in PR branch backport-11698-to-2.17 with baseline commit a419d97 in branch 2.17.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 388 metrics, 2 unstable metrics.

@erikayasuda erikayasuda merged commit aa59f38 into 2.17 Jan 15, 2025
621 checks passed
@erikayasuda erikayasuda deleted the backport-11698-to-2.17 branch January 15, 2025 21:33
erikayasuda pushed a commit that referenced this pull request Jan 16, 2025
Backport d364f1b from #11698 to 2.17.

There is something about this test which leaks bad behavior over to
other tests when run in specific order.

Using `--randomly-seed=4013706280` will simulate the same test execution
order as an example failing job to reproduce the behavior consistently.

I do not really understand the root cause of this issue, but removing
the extra patch/unpatch calls does resolve the issue and keeps the
original test as passing.

The failing behavior on the `test_distributed_tracing` test was that the
passed in distributed tracing headers were not honored. I _think_ this
is because the test expects an unpatched aiohttp client, but we are
actually getting a patched one, so it is creating a span and injecting
it's distributed headers into the request.

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

Co-authored-by: Brett Langdon <brett.langdon@datadoghq.com>
(cherry picked from commit aa59f38)
@DataDog DataDog deleted a comment from github-actions bot Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR. mergequeue-status: done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants