Skip to content

test: clean up usage of agent.assertTelemetryReceived #5883

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

Merged
merged 3 commits into from
Jun 13, 2025

Conversation

watson
Copy link
Collaborator

@watson watson commented Jun 12, 2025

What does this PR do?

Ensure that:

  • We always await calls to agent.assertTelemetryReceived (instead of either ignoring the promise, or chaining a .then() call)
  • We always use a reasonable timeout.

Addionally, agent.assertTelemetryReceived is updated to allow the function to be optional.

A bug in assertObjectContains is also fixed to allow arrays to be checked.

Motivation

This is essentially a follow up PR to: #5374

In the cases where the promise was ignored, the test would time out if the content of the function ever threw, instead of actually showing the thrown error.

I also wanted a chance to fix the bug in assertObjectContains.

Plugin Checklist

Additional Notes

@watson watson self-assigned this Jun 12, 2025
Copy link
Collaborator Author

watson commented Jun 12, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link

github-actions bot commented Jun 12, 2025

Overall package size

Self size: 9.66 MB
Deduped: 101.61 MB
No deduping: 102.13 MB

Dependency sizes | name | version | self size | total size | |------|---------|-----------|------------| | @datadog/libdatadog | 0.6.0 | 30.47 MB | 30.47 MB | | @datadog/native-appsec | 8.5.2 | 19.33 MB | 19.34 MB | | @datadog/native-iast-taint-tracking | 4.0.0 | 11.72 MB | 11.73 MB | | @datadog/pprof | 5.8.2 | 9.56 MB | 9.93 MB | | @opentelemetry/core | 1.30.1 | 908.66 kB | 7.16 MB | | protobufjs | 7.5.3 | 2.95 MB | 5.6 MB | | @datadog/wasm-js-rewriter | 4.0.1 | 2.85 MB | 3.58 MB | | @datadog/native-metrics | 3.1.1 | 1.02 MB | 1.43 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | import-in-the-middle | 1.14.0 | 120.58 kB | 841.68 kB | | source-map | 0.7.4 | 226 kB | 226 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | lru-cache | 7.18.3 | 133.92 kB | 133.92 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.1 | 109.9 kB | 109.9 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 5.3.2 | 53.63 kB | 53.63 kB | | istanbul-lib-coverage | 3.2.2 | 34.37 kB | 34.37 kB | | rfdc | 1.4.1 | 27.15 kB | 27.15 kB | | @isaacs/ttlcache | 1.4.1 | 25.2 kB | 25.2 kB | | dc-polyfill | 0.1.9 | 25.11 kB | 25.11 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | shell-quote | 1.8.2 | 23.54 kB | 23.54 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | semifies | 1.0.0 | 15.84 kB | 15.84 kB | | jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB | | crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB | | ttl-set | 1.0.0 | 4.61 kB | 9.69 kB | | mutexify | 1.4.0 | 5.71 kB | 8.74 kB | | path-to-regexp | 0.1.12 | 6.6 kB | 6.6 kB | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | module-details-from-path | 1.0.4 | 3.96 kB | 3.96 kB |

🤖 This report was automatically generated by heaviest-objects-in-the-universe

Copy link

codecov bot commented Jun 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.74%. Comparing base (b9e0157) to head (76ce8d0).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5883   +/-   ##
=======================================
  Coverage   80.74%   80.74%           
=======================================
  Files         462      462           
  Lines       19905    19905           
=======================================
  Hits        16073    16073           
  Misses       3832     3832           

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

🚀 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.

@watson watson force-pushed the watson/clean-up-assertTelemetryReceived-usage branch from 3c01f75 to cb78aba Compare June 12, 2025 05:44
@pr-commenter
Copy link

pr-commenter bot commented Jun 12, 2025

Benchmarks

Benchmark execution time: 2025-06-13 08:41:46

Comparing candidate commit 76ce8d0 in PR branch watson/clean-up-assertTelemetryReceived-usage with baseline commit b9e0157 in branch master.

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

scenario:shimmer-runtime-declared-wrap-20

  • 🟩 cpu_user_time [-5.342ms; -2.214ms] or [-14.250%; -5.906%]

@datadog-datadog-prod-us1
Copy link

datadog-datadog-prod-us1 bot commented Jun 12, 2025

Datadog Report

Branch report: watson/clean-up-assertTelemetryReceived-usage
Commit report: 1c94ee2
Test service: dd-trace-js-integration-tests

✅ 0 Failed, 1256 Passed, 0 Skipped, 21m 55.97s Total Time

@watson watson marked this pull request as ready for review June 12, 2025 06:23
@watson watson requested review from a team as code owners June 12, 2025 06:23
@watson watson force-pushed the watson/clean-up-assertTelemetryReceived-usage branch from f81c6d6 to 7c86640 Compare June 12, 2025 17:00
watson added 2 commits June 12, 2025 19:37
Ensure that:
- We always await calls to `agent.assertTelemetryReceived` (instead of
  either ignoring the promise, or chaining a `.then()` call)
- We always use a reasonable timeout.

Addionally, `agent.assertTelemetryReceived` is updated to allow the
function to be optional.

A bug in `assertObjectContains` is also fixed to allow arrays to be
checked.
@watson watson force-pushed the watson/clean-up-assertTelemetryReceived-usage branch from 7c86640 to 90e1615 Compare June 12, 2025 17:37
@watson watson requested a review from BridgeAR June 12, 2025 17:38
Copy link
Collaborator

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

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

LGTM

@watson watson enabled auto-merge (squash) June 13, 2025 08:35
@watson watson merged commit 7e95984 into master Jun 13, 2025
412 of 534 checks passed
@watson watson deleted the watson/clean-up-assertTelemetryReceived-usage branch June 13, 2025 08:41
dd-trace-js bot pushed a commit that referenced this pull request Jun 14, 2025
Ensure that:
- We always await calls to `agent.assertTelemetryReceived` (instead of
  either ignoring the promise, or chaining a `.then()` call)
- We always use a reasonable timeout.

Additionally, `agent.assertTelemetryReceived` is updated to allow the
function to be optional.

A bug in `assertObjectContains` is also fixed to allow arrays to be
checked.

* Address review comments
@dd-trace-js dd-trace-js bot mentioned this pull request Jun 14, 2025
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.

2 participants