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

Skip 1.10.0+ bidi/stream GRPC server tests #4095

Closed
wants to merge 1 commit into from

Conversation

jbertran
Copy link
Contributor

@jbertran jbertran commented Feb 23, 2024

What does this PR do?

  • Skip bidi and stream tests grpc server tests in >=1.10.0.

Motivation

The NodeJS GRPC implementation @grpc/grpc-js introduced in 1.10.0 server interceptors and removed/changed the previous events. Since then, bidi and stream requests experience unexpected cancellations which break tests for these.

We skip these in >1.10.0 to avoid polluting test results, pending correct instrumentation for this version.

Plugin Checklist

  • Unit tests.

Additional Notes

Security

Datadog employees:

  • If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from @DataDog/security-design-and-guidance.
  • This PR doesn't touch any of that.

@jbertran jbertran requested review from a team as code owners February 23, 2024 14:06
Copy link

github-actions bot commented Feb 23, 2024

Overall package size

Self size: 6.11 MB
Deduped: 61.99 MB
No deduping: 62.75 MB

Dependency sizes

name version self size total size
@datadog/native-iast-taint-tracking 1.7.0 16.71 MB 16.72 MB
@datadog/native-appsec 7.0.0 14.51 MB 14.52 MB
@datadog/pprof 5.0.0 9.59 MB 10.44 MB
protobufjs 7.2.5 2.77 MB 6.56 MB
@datadog/native-iast-rewriter 2.2.3 2.19 MB 2.28 MB
@opentelemetry/core 1.14.0 872.87 kB 1.47 MB
@datadog/native-metrics 2.0.0 898.77 kB 1.3 MB
@opentelemetry/api 1.4.1 780.32 kB 780.32 kB
import-in-the-middle 1.7.3 67.62 kB 731.01 kB
pprof-format 2.0.7 588.12 kB 588.12 kB
msgpack-lite 0.1.26 201.16 kB 281.59 kB
opentracing 0.14.7 194.81 kB 194.81 kB
semver 7.5.4 93.4 kB 123.8 kB
@datadog/sketches-js 2.1.0 109.9 kB 109.9 kB
lodash.sortby 4.7.0 75.76 kB 75.76 kB
lru-cache 7.14.0 74.95 kB 74.95 kB
ipaddr.js 2.1.0 60.23 kB 60.23 kB
ignore 5.2.4 51.22 kB 51.22 kB
int64-buffer 0.1.10 49.18 kB 49.18 kB
shell-quote 1.8.1 44.96 kB 44.96 kB
istanbul-lib-coverage 3.2.0 29.34 kB 29.34 kB
tlhunter-sorted-set 0.1.0 24.94 kB 24.94 kB
limiter 1.1.5 23.17 kB 23.17 kB
dc-polyfill 0.1.4 23.1 kB 23.1 kB
retry 0.13.1 18.85 kB 18.85 kB
node-abort-controller 3.1.1 16.89 kB 16.89 kB
jest-docblock 29.7.0 8.99 kB 12.76 kB
crypto-randomuuid 1.0.0 11.18 kB 11.18 kB
path-to-regexp 0.1.7 6.78 kB 6.78 kB
koalas 1.0.2 6.47 kB 6.47 kB
methods 1.1.2 5.29 kB 5.29 kB
module-details-from-path 1.0.3 4.47 kB 4.47 kB

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

Copy link

codecov bot commented Feb 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.97%. Comparing base (0dee799) to head (cd74d17).
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4095      +/-   ##
==========================================
- Coverage   88.65%   84.97%   -3.68%     
==========================================
  Files         245      247       +2     
  Lines       10285    10730     +445     
  Branches       33       33              
==========================================
  Hits         9118     9118              
- Misses       1167     1612     +445     

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

return server
})

addHook({ name: '@grpc/grpc-js', versions: ['>=1.10.0'], file: 'build/src/server.js' }, server => {
Copy link
Contributor

Choose a reason for hiding this comment

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

We probably shouldn't be considering these versions supported at all until we have tests working to prove it actually works. 🤔

Copy link
Member

Choose a reason for hiding this comment

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

It's unclear from the PR description if it's just the tests that are broken or the functionality. In any case, since this is a supported module, we need to make sure that it's working properly for new versions, otherwise tracing will stop working for users when they upgrade the module.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We probably shouldn't be considering these versions supported at all until we have tests working to prove it actually works. 🤔

That's fair. Since it makes package installs behave strangely for whatever reason, I've removed the new boundary anyway.

return server
})

addHook({ name: '@grpc/grpc-js', versions: ['>=1.10.0'], file: 'build/src/server.js' }, server => {
Copy link
Member

Choose a reason for hiding this comment

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

It's unclear from the PR description if it's just the tests that are broken or the functionality. In any case, since this is a supported module, we need to make sure that it's working properly for new versions, otherwise tracing will stop working for users when they upgrade the module.

@jbertran jbertran force-pushed the jbertran/grpc-skip-1.10.0+ branch from c384d7d to cd74d17 Compare February 26, 2024 10:07
@jbertran
Copy link
Contributor Author

jbertran commented Feb 26, 2024

It's unclear from the PR description if it's just the tests that are broken or the functionality. In any case, since this is a supported module, we need to make sure that it's working properly for new versions, otherwise tracing will stop working for users when they upgrade the module.

@rochdev as far as I can tell functionality is broken. This PR just skips these specific broken tests (bidi and stream calls) in >=1.10.0 so we don't miss other errors, but we do need to make them work with server interceptors.

@jbertran jbertran requested review from rochdev and Qard February 26, 2024 10:14
@pr-commenter
Copy link

pr-commenter bot commented Feb 26, 2024

Benchmarks

Benchmark execution time: 2024-02-26 10:15:04

Comparing candidate commit cd74d17 in PR branch jbertran/grpc-skip-1.10.0+ with baseline commit 0dee799 in branch master.

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

@jbertran
Copy link
Contributor Author

jbertran commented Mar 8, 2024

Closed by #4133

@jbertran jbertran closed this Mar 8, 2024
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.

3 participants