-
Notifications
You must be signed in to change notification settings - Fork 824
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
181 additions
and
63 deletions.
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
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,50 @@ | ||
| /*! | ||
| * Copyright 2020, 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 { ContextManager } from '@opentelemetry/context-base'; | ||
| import { HttpTextPropagator } from '../context/propagation/HttpTextPropagator'; | ||
| import { MeterProvider } from '../metrics/MeterProvider'; | ||
| import { TracerProvider } from '../trace/tracer_provider'; | ||
|
|
||
| export const GLOBAL_CONTEXT_MANAGER_API_KEY = Symbol.for( | ||
| 'io.opentelemetry.js.api.context' | ||
| ); | ||
| export const GLOBAL_METRICS_API_KEY = Symbol.for( | ||
| 'io.opentelemetry.js.api.metrics' | ||
| ); | ||
| export const GLOBAL_PROPAGATION_API_KEY = Symbol.for( | ||
| 'io.opentelemetry.js.api.propagation' | ||
| ); | ||
| export const GLOBAL_TRACE_API_KEY = Symbol.for('io.opentelemetry.js.api.trace'); | ||
|
|
||
| type Get<T> = (version: number) => T; | ||
| type MyGlobals = Partial<{ | ||
| [GLOBAL_CONTEXT_MANAGER_API_KEY]: Get<ContextManager>; | ||
| [GLOBAL_METRICS_API_KEY]: Get<MeterProvider>; | ||
| [GLOBAL_PROPAGATION_API_KEY]: Get<HttpTextPropagator>; | ||
| [GLOBAL_TRACE_API_KEY]: Get<TracerProvider>; | ||
| }>; | ||
|
|
||
| export const _global = global as typeof global & MyGlobals; | ||
|
|
||
| export function makeGetter<T>( | ||
| requiredVersion: number, | ||
| instance: T, | ||
| fallback: T | ||
| ): Get<T> { | ||
| return (version: number): T => | ||
| version === requiredVersion ? instance : fallback; | ||
| } |
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
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
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
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,81 @@ | ||
| /*! | ||
| * Copyright 2020, 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 { NoopContextManager } from '@opentelemetry/context-base'; | ||
| import { | ||
| _global, | ||
| GLOBAL_CONTEXT_MANAGER_API_KEY, | ||
| } from '../../src/api/global-utils'; | ||
|
|
||
| const api1 = require('../../src') as typeof import('../../src'); | ||
|
|
||
| // clear cache and load a second instance of the api | ||
| for (const key of Object.keys(require.cache)) { | ||
| delete require.cache[key]; | ||
| } | ||
| const api2 = require('../../src') as typeof import('../../src'); | ||
|
|
||
| describe('Global Utils', () => { | ||
| // prove they are separate instances | ||
| assert.notEqual(api1, api2); | ||
| // that return separate noop instances to start | ||
| assert.notStrictEqual( | ||
| api1.context['_getContextManager'](), | ||
| api2.context['_getContextManager']() | ||
| ); | ||
|
|
||
| beforeEach(() => { | ||
| api1.context.disable(); | ||
| api1.propagation.disable(); | ||
| api1.trace.disable(); | ||
| api1.metrics.disable(); | ||
| }); | ||
|
|
||
| it('should change the global context manager', () => { | ||
| const original = api1.context['_getContextManager'](); | ||
| const newContextManager = new NoopContextManager(); | ||
| api1.context.setGlobalContextManager(newContextManager); | ||
| assert.notStrictEqual(api1.context['_getContextManager'](), original); | ||
| assert.strictEqual(api1.context['_getContextManager'](), newContextManager); | ||
| }); | ||
|
|
||
| it('should load an instance from one which was set in the other', () => { | ||
| api1.context.setGlobalContextManager(new NoopContextManager()); | ||
| assert.strictEqual( | ||
| api1.context['_getContextManager'](), | ||
| api2.context['_getContextManager']() | ||
| ); | ||
| }); | ||
|
|
||
| it('should disable both if one is disabled', () => { | ||
| const original = api1.context['_getContextManager'](); | ||
|
|
||
| api1.context.setGlobalContextManager(new NoopContextManager()); | ||
|
|
||
| assert.notStrictEqual(original, api1.context['_getContextManager']()); | ||
| api2.context.disable(); | ||
| assert.strictEqual(original, api1.context['_getContextManager']()); | ||
| }); | ||
|
|
||
| it('should return the module NoOp implementation if the version is a mismatch', () => { | ||
| const original = api1.context['_getContextManager'](); | ||
| api1.context.setGlobalContextManager(new NoopContextManager()); | ||
| const afterSet = _global[GLOBAL_CONTEXT_MANAGER_API_KEY]!(-1); | ||
|
|
||
| assert.strictEqual(original, afterSet); | ||
| }); | ||
| }); |