fix: handle missing package.json file when checking for version #2450
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Flarna
reviewed
Sep 3, 2021
| // eslint-disable-next-line @typescript-eslint/no-var-requires | ||
| const version = require(path.join(baseDir, 'package.json')).version; | ||
| const version = existsSync(packageJsonPath) ? require(packageJsonPath).version : undefined; |
There was a problem hiding this comment.
even if a file exists it may be not readable (e.g. access rights). What about using a try/catch block instead?
vmarchaud
approved these changes
Sep 4, 2021
Codecov Report
@@ Coverage Diff @@
## main #2450 +/- ##
==========================================
+ Coverage 92.71% 93.20% +0.48%
==========================================
Files 137 137
Lines 4996 5002 +6
Branches 1057 1057
==========================================
+ Hits 4632 4662 +30
+ Misses 364 340 -24
|
rauno56
approved these changes
Sep 6, 2021
There was a problem hiding this comment.
I guess it's quite obvious for most people, but I'd add a comment somewhere that we are dealing with packages here for which we haven't detected a version at all. The describe kinda point in that direction, but the setup doesn't make that clear.
Something like
describe('_onRequire - module version is not available', () => {
// For all of these cases, there is no indication of the actual module version,
// so we require there to be a wildcard supported version.
|
@rauno56 👍 |
|
@nozik You'll need to rebase the PR (or give us access to your fork so we can do it for you) |
|
@vmarchaud done |
Flarna
approved these changes
Sep 6, 2021
obecny
reviewed
Sep 7, 2021
packages/opentelemetry-instrumentation/test/node/InstrumentationBase.test.ts
Outdated
Show resolved
Hide resolved
packages/opentelemetry-instrumentation/test/node/InstrumentationBase.test.ts
Outdated
Show resolved
Hide resolved
packages/opentelemetry-instrumentation/test/node/InstrumentationBase.test.ts
Outdated
Show resolved
Hide resolved
packages/opentelemetry-instrumentation/test/node/InstrumentationBase.test.ts
Outdated
Show resolved
Hide resolved
|
@obecny Done |
ghost
mentioned this pull request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
package.jsonfile may be missing at runtime for a certain module. Currently OTEL crashes in this case, unnecessarily.Short description of the changes
package.jsonfile), we patch the module/file if and only if the supported versions contain a wildcard (*). Until now, an exception was thrown, crashing the app.