fix(instrumentation-mongodb): update mongodb to version without missing types #1036
Conversation
dyladan
changed the title
Codecov Report
@@ Coverage Diff @@
## main #1036 +/- ##
=======================================
Coverage 95.91% 95.91%
=======================================
Files 13 13
Lines 856 856
Branches 178 178
=======================================
Hits 821 821
Misses 35 35 |
| @@ -58,7 +58,7 @@ | |||
| "@types/node": "16.11.21", | |||
| "gts": "3.1.0", | |||
| "mocha": "7.2.0", | |||
| "mongodb": "3.6.11", | |||
| "mongodb": "4.6.0", | |||
There was a problem hiding this comment.
Having mongodb in dev deps only will result in missing types for consumers.
Adding a specific mongodb version as dependency seems not good.
There was a problem hiding this comment.
I agree. thats why this is a draft. i'm trying to figure out other options. Unfortunately, I think we're going to have to stop trying to type check modules we're patching. causing too many dependency troubles.
There was a problem hiding this comment.
For the patching part it's quite simple as the instrumentation base classes don't need/use the types at all.
The problem are the hooks offered by some instrumentations as they are APIs to end users. We could use unknown/any there and just document what is provided and user as to cast. This would even cover differences between versions.
| @@ -58,7 +58,7 @@ | |||
| "@types/node": "16.11.21", | |||
| "gts": "3.1.0", | |||
| "mocha": "7.2.0", | |||
| "mongodb": "3.6.11", | |||
| "mongodb": "4.6.0", | |||
There was a problem hiding this comment.
This is deliberately set to version 3 as it is what we run in CI when invoking npm run test:
"test": "nyc ts-mocha -p tsconfig.json --require '@opentelemetry/contrib-test-utils' 'test/**/mongodb-v3.test.ts'",
Since we can only run a single version, version 3 was choosen as it is more common
|
This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days. |
Fixes #1031