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(langgraph): fix flaky test #12024

Merged
merged 3 commits into from
Jan 22, 2025
Merged

ci(langgraph): fix flaky test #12024

merged 3 commits into from
Jan 22, 2025

Conversation

sabrenner
Copy link
Contributor

@sabrenner sabrenner commented Jan 22, 2025

What does this PR do

Tests like test_fanning_graph_async would fail because it may be possible for the two children being called from a common node (ie node a calling nodes b and c) to execute in any order. Although this is probably only particular to async fanning tests, this PR changes the logic such that:

  • for LLMObs tests, we find spans by name and assert LLMObs properties after. This might be tricky if we have duplicate span names (ie two LangGraph spans), but for now this isn't the case
  • for APM tests, we assert that all span resource names appear an expected number of times. We can probably make these tests more robust with snapshots but this can be done in a later PR

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

@sabrenner sabrenner added the changelog/no-changelog A changelog entry is not required for this PR. label Jan 22, 2025
Copy link
Contributor

CODEOWNERS have been resolved as:

tests/contrib/langgraph/test_langgraph.py                               @DataDog/ml-observability
tests/contrib/langgraph/test_langgraph_llmobs.py                        @DataDog/ml-observability

@sabrenner sabrenner marked this pull request as ready for review January 22, 2025 14:59
@sabrenner sabrenner requested a review from a team as a code owner January 22, 2025 14:59
@sabrenner sabrenner enabled auto-merge (squash) January 22, 2025 15:10
@pr-commenter
Copy link

pr-commenter bot commented Jan 22, 2025

Benchmarks

Benchmark execution time: 2025-01-22 15:27:15

Comparing candidate commit bff15d2 in PR branch sabrenner/flaky-langgraph with baseline commit cd6422a in branch main.

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

scenario:iast_aspects-ospathsplitext_aspect

  • 🟥 execution_time [+259.921ns; +319.396ns] or [+7.246%; +8.904%]

@sabrenner sabrenner merged commit 2f52abb into main Jan 22, 2025
158 of 161 checks passed
@sabrenner sabrenner deleted the sabrenner/flaky-langgraph branch January 22, 2025 15:28
github-actions bot pushed a commit that referenced this pull request Jan 22, 2025
## What does this PR do
Tests like `test_fanning_graph_async` would fail because it may be
possible for the two children being called from a common node (ie node
`a` calling nodes `b` and `c`) to execute in any order. Although this is
probably only particular to async fanning tests, this PR changes the
logic such that:
- for LLMObs tests, we find spans by name and assert LLMObs properties
after. This might be tricky if we have duplicate span names (ie two
`LangGraph` spans), but for now this isn't the case
- for APM tests, we assert that all span resource names appear an
expected number of times. We can probably make these tests more robust
with snapshots but this can be done in a later PR

## 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)

(cherry picked from commit 2f52abb)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.20 changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants