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
fix: handle missing package.json file when checking for version #2450
Merged
vmarchaud
merged 8 commits into
open-telemetry:main
from
helios:fix_missing_package_version
Sep 8, 2021
Merged
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
18057be
feat: handle missing version case
nozik d805221
feat: add test cases
nozik b9dfc18
fix: cr comment
nozik 0f7d68a
Merge branch 'main' into fix_missing_package_version
nozik 9253bc2
Merge branch 'main' into fix_missing_package_version
nozik 12c58fc
fix: add comment to test
nozik 1a11c85
Merge branch 'main' into fix_missing_package_version
nozik 8bc0f66
fix: tests description
nozik File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
155 changes: 155 additions & 0 deletions
155
packages/opentelemetry-instrumentation/test/node/InstrumentationBase.test.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
/* | ||
* Copyright The OpenTelemetry Authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import * as assert from 'assert'; | ||
import * as sinon from 'sinon'; | ||
import { InstrumentationBase, InstrumentationModuleDefinition } from '../../src'; | ||
|
||
const MODULE_NAME = 'test-module'; | ||
const MODULE_FILE_NAME = 'test-module-file'; | ||
const MODULE_VERSION = '0.1.0'; | ||
const WILDCARD_VERSION = '*'; | ||
const MODULE_DIR = '/random/dir'; | ||
|
||
class TestInstrumentation extends InstrumentationBase { | ||
constructor() { | ||
super(MODULE_NAME, MODULE_VERSION); | ||
} | ||
|
||
init() {} | ||
} | ||
|
||
describe('InstrumentationBase', () => { | ||
describe('_onRequire - module version is not available', () => { | ||
let instrumentation: TestInstrumentation; | ||
let modulePatchSpy: sinon.SinonSpy; | ||
|
||
beforeEach(() => { | ||
instrumentation = new TestInstrumentation(); | ||
// @ts-expect-error access internal property for testing | ||
instrumentation._enabled = true; | ||
modulePatchSpy = sinon.spy(); | ||
}); | ||
|
||
describe('when patching a module', () => { | ||
it('should not patch module when there is no wildcard supported version', () => { | ||
nozik marked this conversation as resolved.
Show resolved
Hide resolved
|
||
const moduleExports = {}; | ||
const instrumentationModule = { | ||
supportedVersions: [`^${MODULE_VERSION}`], | ||
name: MODULE_NAME, | ||
patch: modulePatchSpy as unknown, | ||
} as InstrumentationModuleDefinition<unknown>; | ||
|
||
// @ts-expect-error access internal property for testing | ||
instrumentation._onRequire<unknown>( | ||
instrumentationModule, | ||
moduleExports, | ||
MODULE_NAME, | ||
MODULE_DIR | ||
); | ||
|
||
assert.strictEqual(instrumentationModule.moduleVersion, undefined); | ||
assert.strictEqual(instrumentationModule.moduleExports, undefined); | ||
sinon.assert.notCalled(modulePatchSpy); | ||
}); | ||
|
||
it('should patch module when there is a wildcard supported version', () => { | ||
nozik marked this conversation as resolved.
Show resolved
Hide resolved
|
||
const moduleExports = {}; | ||
const instrumentationModule = { | ||
supportedVersions: [`^${MODULE_VERSION}`, WILDCARD_VERSION], | ||
name: MODULE_NAME, | ||
patch: modulePatchSpy as unknown, | ||
} as InstrumentationModuleDefinition<unknown>; | ||
|
||
// @ts-expect-error access internal property for testing | ||
instrumentation._onRequire<unknown>( | ||
instrumentationModule, | ||
moduleExports, | ||
MODULE_NAME, | ||
MODULE_DIR | ||
); | ||
|
||
assert.strictEqual(instrumentationModule.moduleVersion, undefined); | ||
assert.strictEqual(instrumentationModule.moduleExports, moduleExports); | ||
sinon.assert.calledOnceWithExactly(modulePatchSpy, moduleExports, undefined); | ||
}); | ||
}); | ||
|
||
describe('when patching module files', () => { | ||
let filePatchSpy: sinon.SinonSpy; | ||
|
||
beforeEach(() => { | ||
filePatchSpy = sinon.spy(); | ||
}) | ||
|
||
it('should not patch module file when there is no wildcard supported version', () => { | ||
nozik marked this conversation as resolved.
Show resolved
Hide resolved
|
||
const moduleExports = {}; | ||
const supportedVersions = [`^${MODULE_VERSION}`]; | ||
const instrumentationModule = { | ||
supportedVersions, | ||
name: MODULE_NAME, | ||
patch: modulePatchSpy as unknown, | ||
files: [{ | ||
name: MODULE_FILE_NAME, | ||
supportedVersions, | ||
patch: filePatchSpy as unknown | ||
}] | ||
} as InstrumentationModuleDefinition<unknown>; | ||
|
||
// @ts-expect-error access internal property for testing | ||
instrumentation._onRequire<unknown>( | ||
instrumentationModule, | ||
moduleExports, | ||
MODULE_FILE_NAME, | ||
MODULE_DIR | ||
); | ||
|
||
assert.strictEqual(instrumentationModule.moduleVersion, undefined); | ||
assert.strictEqual(instrumentationModule.moduleExports, undefined); | ||
sinon.assert.notCalled(modulePatchSpy); | ||
sinon.assert.notCalled(filePatchSpy); | ||
}); | ||
|
||
it('should patch module file when there is a wildcard supported version', () => { | ||
nozik marked this conversation as resolved.
Show resolved
Hide resolved
|
||
const moduleExports = {}; | ||
const supportedVersions = [`^${MODULE_VERSION}`, WILDCARD_VERSION]; | ||
const instrumentationModule = { | ||
supportedVersions, | ||
name: MODULE_NAME, | ||
patch: modulePatchSpy as unknown, | ||
files: [{ | ||
name: MODULE_FILE_NAME, | ||
supportedVersions, | ||
patch: filePatchSpy as unknown | ||
}] | ||
} as InstrumentationModuleDefinition<unknown>; | ||
|
||
// @ts-expect-error access internal property for testing | ||
instrumentation._onRequire<unknown>( | ||
instrumentationModule, | ||
moduleExports, | ||
MODULE_FILE_NAME, | ||
MODULE_DIR | ||
); | ||
|
||
assert.strictEqual(instrumentationModule.moduleVersion, undefined); | ||
assert.strictEqual(instrumentationModule.files[0].moduleExports, moduleExports); | ||
sinon.assert.notCalled(modulePatchSpy); | ||
sinon.assert.calledOnceWithExactly(filePatchSpy, moduleExports, undefined); | ||
}); | ||
}); | ||
}); | ||
}); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
even if a file exists it may be not readable (e.g. access rights). What about using a try/catch block instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done 👍