From ddef687c4f5110df05edf5e7972b1a641ca6c84d Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Thu, 12 Mar 2020 15:39:25 -0400 Subject: [PATCH 1/2] refactor: rename scope to context --- .circleci/config.yml | 16 +- .../examples/document-load/index.html | 2 +- .../examples/document-load/index.js | 6 +- .../examples/user-interaction/index.js | 4 +- .../examples/xml-http-request/index.js | 6 +- examples/tracer-web/package.json | 2 +- packages/opentelemetry-api/package.json | 2 +- packages/opentelemetry-api/src/api/context.ts | 22 +-- .../opentelemetry-api/src/api/propagation.ts | 2 +- .../src/context/propagation/HttpTextFormat.ts | 2 +- .../context/propagation/HttpTextPropagator.ts | 59 ++++++ .../context/propagation/NoopHttpTextFormat.ts | 2 +- .../propagation/NoopHttpTextPropagator.ts | 32 ++++ .../src/correlation_context/EntryValue.ts | 2 +- packages/opentelemetry-api/src/index.ts | 2 +- .../opentelemetry-api/src/trace/tracer.ts | 6 +- .../noop-implementations/noop-tracer.test.ts | 2 +- .../.npmignore | 0 .../LICENSE | 0 .../README.md | 28 +-- .../package.json | 6 +- .../src/AsyncHooksContextManager.ts} | 72 +++---- .../src/index.ts | 2 +- .../src/version.ts | 0 .../test/AsyncHooksContextManager.test.ts} | 168 ++++++++-------- .../tsconfig.json | 0 .../tslint.json | 0 .../.npmignore | 0 .../LICENSE | 0 .../README.md | 28 ++- .../package.json | 4 +- .../src/NoopContextManager.ts} | 6 +- .../src/context.ts | 0 .../src/index.ts | 2 +- .../src/types.ts | 24 +-- .../src/version.ts | 0 .../test/NoopContextManager.test.ts} | 48 ++--- .../tsconfig.json | 0 .../tslint.json | 0 .../LICENSE | 0 .../README.md | 26 +-- .../karma.conf.js | 0 .../package.json | 6 +- .../src/ZoneContextManager.ts} | 88 ++++----- .../src/index.ts | 2 +- .../src/types.ts | 0 .../src/util.ts | 0 .../src/version.ts | 0 .../test/ZoneContextManager.test.ts} | 178 ++++++++--------- .../test/index-webpack.ts | 0 .../test/utils.test.ts | 2 +- .../tsconfig.json | 0 .../tslint.json | 0 .../LICENSE | 0 .../README.md | 28 +-- .../package.json | 6 +- .../src/index.ts | 2 +- .../src/version.ts | 0 .../tsconfig.json | 0 .../tslint.json | 0 packages/opentelemetry-core/package.json | 2 +- .../opentelemetry-core/src/context/context.ts | 2 +- .../test/context/B3Format.test.ts | 2 +- .../test/context/HttpTraceContext.test.ts | 2 +- .../test/context/composite.test.ts | 2 +- packages/opentelemetry-node/README.md | 2 +- packages/opentelemetry-node/package.json | 4 +- .../src/NodeTracerProvider.ts | 4 +- .../test/NodeTracerProvider.test.ts | 22 +-- .../test/registration.test.ts | 16 +- .../test/documentLoad.test.ts | 10 +- .../opentelemetry-plugin-express/package.json | 2 +- .../src/express.ts | 2 +- .../test/express.test.ts | 10 +- .../opentelemetry-plugin-grpc/package.json | 4 +- .../test/grpc.test.ts | 12 +- .../opentelemetry-plugin-http/package.json | 4 +- .../test/functionals/http-enable.test.ts | 12 +- .../opentelemetry-plugin-https/package.json | 4 +- .../test/functionals/https-enable.test.ts | 12 +- .../opentelemetry-plugin-ioredis/package.json | 2 +- .../test/ioredis.test.ts | 12 +- .../opentelemetry-plugin-mongodb/package.json | 2 +- .../test/mongodb.test.ts | 10 +- .../opentelemetry-plugin-mysql/package.json | 2 +- .../test/mysql.test.ts | 10 +- .../opentelemetry-plugin-pg-pool/package.json | 2 +- .../test/pg-pool.test.ts | 10 +- .../opentelemetry-plugin-pg/package.json | 2 +- .../opentelemetry-plugin-pg/test/pg.test.ts | 10 +- .../opentelemetry-plugin-redis/package.json | 2 +- .../test/redis.test.ts | 12 +- .../README.md | 12 +- .../package.json | 2 +- .../src/userInteraction.ts | 10 +- .../test/userInteraction.nozone.test.ts | 12 +- .../test/userInteraction.test.ts | 12 +- .../README.md | 4 +- .../package.json | 2 +- .../test/xhr.test.ts | 10 +- packages/opentelemetry-tracing/package.json | 2 +- packages/opentelemetry-tracing/src/Tracer.ts | 4 +- packages/opentelemetry-tracing/src/types.ts | 4 +- .../test/BasicTracerProvider.test.ts | 10 +- packages/opentelemetry-web/README.md | 8 +- packages/opentelemetry-web/package.json | 4 +- ...ScopeManager.ts => StackContextManager.ts} | 62 +++--- .../src/WebTracerProvider.ts | 6 +- packages/opentelemetry-web/src/index.ts | 2 +- .../test/StackContextManager.test.ts | 180 ++++++++++++++++++ .../test/StackScopeManager.test.ts | 180 ------------------ .../test/WebTracerProvider.test.ts | 18 +- .../test/registration.test.ts | 16 +- 113 files changed, 876 insertions(+), 785 deletions(-) create mode 100644 packages/opentelemetry-api/src/context/propagation/HttpTextPropagator.ts create mode 100644 packages/opentelemetry-api/src/context/propagation/NoopHttpTextPropagator.ts rename packages/{opentelemetry-scope-async-hooks => opentelemetry-context-async-hooks}/.npmignore (100%) rename packages/{opentelemetry-scope-async-hooks => opentelemetry-context-async-hooks}/LICENSE (100%) rename packages/{opentelemetry-scope-async-hooks => opentelemetry-context-async-hooks}/README.md (62%) rename packages/{opentelemetry-scope-async-hooks => opentelemetry-context-async-hooks}/package.json (90%) rename packages/{opentelemetry-scope-async-hooks/src/AsyncHooksScopeManager.ts => opentelemetry-context-async-hooks/src/AsyncHooksContextManager.ts} (76%) rename packages/{opentelemetry-scope-async-hooks => opentelemetry-context-async-hooks}/src/index.ts (93%) rename packages/{opentelemetry-scope-async-hooks => opentelemetry-context-async-hooks}/src/version.ts (100%) rename packages/{opentelemetry-scope-async-hooks/test/AsyncHooksScopeManager.test.ts => opentelemetry-context-async-hooks/test/AsyncHooksContextManager.test.ts} (50%) rename packages/{opentelemetry-scope-async-hooks => opentelemetry-context-async-hooks}/tsconfig.json (100%) rename packages/{opentelemetry-scope-async-hooks => opentelemetry-context-async-hooks}/tslint.json (100%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/.npmignore (100%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/LICENSE (100%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/README.md (54%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/package.json (93%) rename packages/{opentelemetry-scope-base/src/NoopScopeManager.ts => opentelemetry-context-base/src/NoopContextManager.ts} (87%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/src/context.ts (100%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/src/index.ts (94%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/src/types.ts (62%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/src/version.ts (100%) rename packages/{opentelemetry-scope-base/test/NoopScopeManager.test.ts => opentelemetry-context-base/test/NoopContextManager.test.ts} (65%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/tsconfig.json (100%) rename packages/{opentelemetry-scope-base => opentelemetry-context-base}/tslint.json (100%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/LICENSE (100%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/README.md (74%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/karma.conf.js (100%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/package.json (91%) rename packages/{opentelemetry-scope-zone-peer-dep/src/ZoneScopeManager.ts => opentelemetry-context-zone-peer-dep/src/ZoneContextManager.ts} (65%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/src/index.ts (94%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/src/types.ts (100%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/src/util.ts (100%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/src/version.ts (100%) rename packages/{opentelemetry-scope-zone-peer-dep/test/ZoneScopeManager.test.ts => opentelemetry-context-zone-peer-dep/test/ZoneContextManager.test.ts} (51%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/test/index-webpack.ts (100%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/test/utils.test.ts (97%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/tsconfig.json (100%) rename packages/{opentelemetry-scope-zone-peer-dep => opentelemetry-context-zone-peer-dep}/tslint.json (100%) rename packages/{opentelemetry-scope-zone => opentelemetry-context-zone}/LICENSE (100%) rename packages/{opentelemetry-scope-zone => opentelemetry-context-zone}/README.md (73%) rename packages/{opentelemetry-scope-zone => opentelemetry-context-zone}/package.json (92%) rename packages/{opentelemetry-scope-zone => opentelemetry-context-zone}/src/index.ts (92%) rename packages/{opentelemetry-scope-zone => opentelemetry-context-zone}/src/version.ts (100%) rename packages/{opentelemetry-scope-zone => opentelemetry-context-zone}/tsconfig.json (100%) rename packages/{opentelemetry-scope-zone => opentelemetry-context-zone}/tslint.json (100%) rename packages/opentelemetry-web/src/{StackScopeManager.ts => StackContextManager.ts} (52%) create mode 100644 packages/opentelemetry-web/test/StackContextManager.test.ts delete mode 100644 packages/opentelemetry-web/test/StackScopeManager.test.ts diff --git a/.circleci/config.yml b/.circleci/config.yml index b15f657faf..cfd2dc6dec 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -44,20 +44,22 @@ cache_1: &cache_1 paths: - ./node_modules - ./package-lock.json - - packages/opentelemetry-base/node_modules - - packages/opentelemetry-scope-base/node_modules - packages/opentelemetry-api/node_modules - - packages/opentelemetry-scope-async-hooks/node_modules + - packages/opentelemetry-base/node_modules + - packages/opentelemetry-context-async-hooks/node_modules + - packages/opentelemetry-context-base/node_modules + - packages/opentelemetry-context-zone/node_modules + - packages/opentelemetry-context-zone-peer-dep/node_modules - packages/opentelemetry-core/node_modules - - packages/opentelemetry-exporter-prometheus/node_modules - - packages/opentelemetry-metrics/node_modules - - packages/opentelemetry-tracing/node_modules - packages/opentelemetry-exporter-jaeger/node_modules + - packages/opentelemetry-exporter-prometheus/node_modules - packages/opentelemetry-exporter-zipkin/node_modules + - packages/opentelemetry-metrics/node_modules - packages/opentelemetry-node/node_modules + - packages/opentelemetry-plugin-dns/node_modules - packages/opentelemetry-shim-opentracing/node_modules + - packages/opentelemetry-tracing/node_modules - packages/opentelemetry-web/node_modules - - packages/opentelemetry-plugin-dns/node_modules cache_2: &cache_2 key: npm-cache-02-{{ .Environment.CIRCLE_JOB }}-{{ checksum "/tmp/checksums.txt" }}-F267A71D diff --git a/examples/tracer-web/examples/document-load/index.html b/examples/tracer-web/examples/document-load/index.html index 772a215769..8df377cc52 100644 --- a/examples/tracer-web/examples/document-load/index.html +++ b/examples/tracer-web/examples/document-load/index.html @@ -24,7 +24,7 @@ Example of using Web Tracer with document load plugin with console exporter and collector exporter
- + diff --git a/examples/tracer-web/examples/document-load/index.js b/examples/tracer-web/examples/document-load/index.js index d6f4d9d65f..87cf8bf395 100644 --- a/examples/tracer-web/examples/document-load/index.js +++ b/examples/tracer-web/examples/document-load/index.js @@ -1,7 +1,7 @@ import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; import { WebTracerProvider } from '@opentelemetry/web'; import { DocumentLoad } from '@opentelemetry/plugin-document-load'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone'; +import { ZoneContextManager } from '@opentelemetry/context-zone'; import { CollectorExporter } from '@opentelemetry/exporter-collector'; const provider = new WebTracerProvider({ @@ -12,7 +12,7 @@ const provider = new WebTracerProvider({ provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); const providerWithZone = new WebTracerProvider({ - scopeManager: new ZoneScopeManager(), + contextManager: new ZoneContextManager(), plugins: [ new DocumentLoad(), ], @@ -40,7 +40,7 @@ const getData = (url) => new Promise((resolve, reject) => { }; }); -// example of keeping track of scope between async operations +// example of keeping track of context between async operations const prepareClickEvent = () => { const url1 = 'https://raw.githubusercontent.com/open-telemetry/opentelemetry-js/master/package.json'; const url2 = 'https://raw.githubusercontent.com/open-telemetry/opentelemetry-js/master/packages/opentelemetry-web/package.json'; diff --git a/examples/tracer-web/examples/user-interaction/index.js b/examples/tracer-web/examples/user-interaction/index.js index 2e764f5cf0..ec8c1fddf2 100644 --- a/examples/tracer-web/examples/user-interaction/index.js +++ b/examples/tracer-web/examples/user-interaction/index.js @@ -2,13 +2,13 @@ import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing import { WebTracerProvider } from '@opentelemetry/web'; import { XMLHttpRequestPlugin } from '@opentelemetry/plugin-xml-http-request'; import { UserInteractionPlugin } from '@opentelemetry/plugin-user-interaction'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone'; +import { ZoneContextManager } from '@opentelemetry/context-zone'; import { CollectorExporter } from '@opentelemetry/exporter-collector'; import { B3Format } from '@opentelemetry/core'; const providerWithZone = new WebTracerProvider({ httpTextFormat: new B3Format(), - scopeManager: new ZoneScopeManager(), + contextManager: new ZoneContextManager(), plugins: [ new UserInteractionPlugin(), new XMLHttpRequestPlugin({ diff --git a/examples/tracer-web/examples/xml-http-request/index.js b/examples/tracer-web/examples/xml-http-request/index.js index 3ad74ea04c..415ab441c3 100644 --- a/examples/tracer-web/examples/xml-http-request/index.js +++ b/examples/tracer-web/examples/xml-http-request/index.js @@ -1,13 +1,13 @@ import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; import { WebTracerProvider } from '@opentelemetry/web'; import { XMLHttpRequestPlugin } from '@opentelemetry/plugin-xml-http-request'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone'; +import { ZoneContextManager } from '@opentelemetry/context-zone'; import { CollectorExporter } from '@opentelemetry/exporter-collector'; import { B3Format } from '@opentelemetry/core'; const providerWithZone = new WebTracerProvider({ httpTextFormat: new B3Format(), - scopeManager: new ZoneScopeManager(), + contextManager: new ZoneContextManager(), plugins: [ new XMLHttpRequestPlugin({ ignoreUrls: [/localhost:8090\/sockjs-node/], @@ -35,7 +35,7 @@ const getData = (url) => new Promise((resolve, _reject) => { }; }); -// example of keeping track of scope between async operations +// example of keeping track of context between async operations const prepareClickEvent = () => { const url1 = 'https://httpbin.org/get'; diff --git a/examples/tracer-web/package.json b/examples/tracer-web/package.json index 249bae0dec..fac819a20e 100644 --- a/examples/tracer-web/package.json +++ b/examples/tracer-web/package.json @@ -39,7 +39,7 @@ "@opentelemetry/plugin-document-load": "^0.4.0", "@opentelemetry/plugin-user-interaction": "^0.4.0", "@opentelemetry/plugin-xml-http-request": "^0.4.0", - "@opentelemetry/scope-zone": "^0.4.0", + "@opentelemetry/context-zone": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@opentelemetry/web": "^0.4.0" }, diff --git a/packages/opentelemetry-api/package.json b/packages/opentelemetry-api/package.json index d9a44de09a..7ed9e9b90b 100644 --- a/packages/opentelemetry-api/package.json +++ b/packages/opentelemetry-api/package.json @@ -47,7 +47,7 @@ "access": "public" }, "dependencies": { - "@opentelemetry/scope-base": "^0.4.0" + "@opentelemetry/context-base": "^0.4.0" }, "devDependencies": { "@types/mocha": "^5.2.7", diff --git a/packages/opentelemetry-api/src/api/context.ts b/packages/opentelemetry-api/src/api/context.ts index 7cc3828c4b..fc0398d7cc 100644 --- a/packages/opentelemetry-api/src/api/context.ts +++ b/packages/opentelemetry-api/src/api/context.ts @@ -15,22 +15,22 @@ */ import { - ScopeManager, - NoopScopeManager, + ContextManager, + NoopContextManager, Context, -} from '@opentelemetry/scope-base'; +} from '@opentelemetry/context-base'; /** * Singleton object which represents the entry point to the OpenTelemetry Context API */ export class ContextAPI { private static _instance?: ContextAPI; - private _scopeManager: ScopeManager = new NoopScopeManager(); + private _contextManager: ContextManager = new NoopContextManager(); /** Empty private constructor prevents end users from constructing a new instance of the API */ private constructor() {} - /** Get the singleton instance of the Scope API */ + /** Get the singleton instance of the Context API */ public static getInstance(): ContextAPI { if (!this._instance) { this._instance = new ContextAPI(); @@ -42,16 +42,16 @@ export class ContextAPI { /** * Set the current context manager. Returns the initialized context manager */ - public setGlobalContextManager(scopeManager: ScopeManager): ScopeManager { - this._scopeManager = scopeManager; - return scopeManager; + public setGlobalContextManager(contextManager: ContextManager): ContextManager { + this._contextManager = contextManager; + return contextManager; } /** * Get the currently active context */ public active(): Context { - return this._scopeManager.active(); + return this._contextManager.active(); } /** @@ -64,7 +64,7 @@ export class ContextAPI { context: Context, fn: T ): ReturnType { - return this._scopeManager.with(context, fn); + return this._contextManager.with(context, fn); } /** @@ -74,6 +74,6 @@ export class ContextAPI { * @param context context to bind to the event emitter or function. Defaults to the currently active context */ public bind(target: T, context: Context = this.active()): T { - return this._scopeManager.bind(target, context); + return this._contextManager.bind(target, context); } } diff --git a/packages/opentelemetry-api/src/api/propagation.ts b/packages/opentelemetry-api/src/api/propagation.ts index d655db4c86..5553db1cfc 100644 --- a/packages/opentelemetry-api/src/api/propagation.ts +++ b/packages/opentelemetry-api/src/api/propagation.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; import { defaultGetter, GetterFunction } from '../context/propagation/getter'; import { HttpTextFormat } from '../context/propagation/HttpTextFormat'; import { NOOP_HTTP_TEXT_FORMAT } from '../context/propagation/NoopHttpTextFormat'; diff --git a/packages/opentelemetry-api/src/context/propagation/HttpTextFormat.ts b/packages/opentelemetry-api/src/context/propagation/HttpTextFormat.ts index efd1e4efab..15e3d11e9f 100644 --- a/packages/opentelemetry-api/src/context/propagation/HttpTextFormat.ts +++ b/packages/opentelemetry-api/src/context/propagation/HttpTextFormat.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; import { SetterFunction } from './setter'; import { GetterFunction } from './getter'; diff --git a/packages/opentelemetry-api/src/context/propagation/HttpTextPropagator.ts b/packages/opentelemetry-api/src/context/propagation/HttpTextPropagator.ts new file mode 100644 index 0000000000..84c5dbd03e --- /dev/null +++ b/packages/opentelemetry-api/src/context/propagation/HttpTextPropagator.ts @@ -0,0 +1,59 @@ +/*! + * Copyright 2019, 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 { Context } from '@opentelemetry/context-base'; +import { SetterFunction } from './setter'; +import { GetterFunction } from './getter'; + +/** + * Injects {@link Context} into and extracts it from carriers that travel + * in-band across process boundaries. Encoding is expected to conform to the + * HTTP Header Field semantics. Values are often encoded as RPC/HTTP request + * headers. + * + * The carrier of propagated data on both the client (injector) and server + * (extractor) side is usually an object such as http headers. + */ +export interface HttpTextPropagator { + /** + * Injects values from a given {@link Context} into a carrier. + * + * OpenTelemetry defines a common set of format values (HttpTextPropagator), and + * each has an expected `carrier` type. + * + * @param context the Context from which to extract values to transmit over + * the wire. + * @param carrier the carrier of propagation fields, such as http request + * headers. + * @param setter a function which accepts a carrier, key, and value, which + * sets the key on the carrier to the value. + */ + inject(context: Context, carrier: unknown, setter: SetterFunction): void; + + /** + * Given a {@link Context} and a carrier, extract context values from a + * carrier and return a new context, created from the old context, with the + * extracted values. + * + * @param context the Context from which to extract values to transmit over + * the wire. + * @param carrier the carrier of propagation fields, such as http request + * headers. + * @param getter a function which accepts a carrier and a key, and returns + * the value from the carrier identified by the key. + */ + extract(context: Context, carrier: unknown, getter: GetterFunction): Context; +} diff --git a/packages/opentelemetry-api/src/context/propagation/NoopHttpTextFormat.ts b/packages/opentelemetry-api/src/context/propagation/NoopHttpTextFormat.ts index 4978cc0fbc..1d69dab182 100644 --- a/packages/opentelemetry-api/src/context/propagation/NoopHttpTextFormat.ts +++ b/packages/opentelemetry-api/src/context/propagation/NoopHttpTextFormat.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; import { HttpTextFormat } from './HttpTextFormat'; /** diff --git a/packages/opentelemetry-api/src/context/propagation/NoopHttpTextPropagator.ts b/packages/opentelemetry-api/src/context/propagation/NoopHttpTextPropagator.ts new file mode 100644 index 0000000000..654d7bc70f --- /dev/null +++ b/packages/opentelemetry-api/src/context/propagation/NoopHttpTextPropagator.ts @@ -0,0 +1,32 @@ +/*! + * Copyright 2019, 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 { Context } from '@opentelemetry/context-base'; +import { HttpTextPropagator } from './HttpTextPropagator'; + +/** + * No-op implementations of {@link HttpTextPropagator}. + */ +export class NoopHttpTextPropagator implements HttpTextPropagator { + /** Noop inject function does nothing */ + inject(context: Context, carrier: unknown, setter: Function): void {} + /** Noop extract function does nothing and returns the input context */ + extract(context: Context, carrier: unknown, getter: Function): Context { + return context; + } +} + +export const NOOP_HTTP_TEXT_FORMAT = new NoopHttpTextPropagator(); diff --git a/packages/opentelemetry-api/src/correlation_context/EntryValue.ts b/packages/opentelemetry-api/src/correlation_context/EntryValue.ts index f89575ded7..5db17aff63 100644 --- a/packages/opentelemetry-api/src/correlation_context/EntryValue.ts +++ b/packages/opentelemetry-api/src/correlation_context/EntryValue.ts @@ -35,7 +35,7 @@ export interface EntryValue { */ export enum EntryTtl { /** - * NO_PROPAGATION is considered to have local scope and is used within the + * NO_PROPAGATION is considered to have local context and is used within the * process it created. */ NO_PROPAGATION = 0, diff --git a/packages/opentelemetry-api/src/index.ts b/packages/opentelemetry-api/src/index.ts index 114bf875ff..ff36a9ab44 100644 --- a/packages/opentelemetry-api/src/index.ts +++ b/packages/opentelemetry-api/src/index.ts @@ -49,7 +49,7 @@ export * from './trace/trace_state'; export * from './trace/tracer_provider'; export * from './trace/tracer'; -export { Context } from '@opentelemetry/scope-base'; +export { Context } from '@opentelemetry/context-base'; import { ContextAPI } from './api/context'; /** Entrypoint for context API */ diff --git a/packages/opentelemetry-api/src/trace/tracer.ts b/packages/opentelemetry-api/src/trace/tracer.ts index b869036e3c..e57f2ee176 100644 --- a/packages/opentelemetry-api/src/trace/tracer.ts +++ b/packages/opentelemetry-api/src/trace/tracer.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; import { Span } from './span'; import { SpanOptions } from './SpanOptions'; @@ -58,9 +58,9 @@ export interface Tracer { ): ReturnType; /** - * Bind a span as the target's scope or propagate the current one. + * Bind a span as the target's context or propagate the current one. * - * @param target Any object to which a scope need to be set + * @param target Any object to which a context need to be set * @param [context] Optionally specify the context which you want to bind */ bind(target: T, context?: Span): T; diff --git a/packages/opentelemetry-api/test/noop-implementations/noop-tracer.test.ts b/packages/opentelemetry-api/test/noop-implementations/noop-tracer.test.ts index f1e28be91f..23fb597589 100644 --- a/packages/opentelemetry-api/test/noop-implementations/noop-tracer.test.ts +++ b/packages/opentelemetry-api/test/noop-implementations/noop-tracer.test.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; import * as assert from 'assert'; import { NoopTracer, NOOP_SPAN, SpanKind } from '../../src'; import { defaultGetter } from '../../src/context/propagation/getter'; diff --git a/packages/opentelemetry-scope-async-hooks/.npmignore b/packages/opentelemetry-context-async-hooks/.npmignore similarity index 100% rename from packages/opentelemetry-scope-async-hooks/.npmignore rename to packages/opentelemetry-context-async-hooks/.npmignore diff --git a/packages/opentelemetry-scope-async-hooks/LICENSE b/packages/opentelemetry-context-async-hooks/LICENSE similarity index 100% rename from packages/opentelemetry-scope-async-hooks/LICENSE rename to packages/opentelemetry-context-async-hooks/LICENSE diff --git a/packages/opentelemetry-scope-async-hooks/README.md b/packages/opentelemetry-context-async-hooks/README.md similarity index 62% rename from packages/opentelemetry-scope-async-hooks/README.md rename to packages/opentelemetry-context-async-hooks/README.md index 7c281030b5..4a8044a919 100644 --- a/packages/opentelemetry-scope-async-hooks/README.md +++ b/packages/opentelemetry-context-async-hooks/README.md @@ -1,26 +1,26 @@ -# OpenTelemetry AsyncHooks-based Scope Manager +# OpenTelemetry AsyncHooks-based Context Manager [![Gitter chat][gitter-image]][gitter-url] [![NPM Published Version][npm-img]][npm-url] [![dependencies][dependencies-image]][dependencies-url] [![devDependencies][devDependencies-image]][devDependencies-url] [![Apache License][license-image]][license-image] -This package provides [async-hooks][async-hooks-doc] based scope manager which is used internally by OpenTelemetry plugins to propagate specific scope between function calls and async operations. It only targets NodeJS since async-hooks is only available there. +This package provides [async-hooks][async-hooks-doc] based context manager which is used internally by OpenTelemetry plugins to propagate specific context between function calls and async operations. It only targets NodeJS since async-hooks is only available there. -## What is a ScopeManager ? +## What is a ContextManager ? -The definition and why they exist is available on [the readme of the scope-base package][def-scope-manager]. +The definition and why they exist is available on [the readme of the context-base package][def-context-manager]. ### Implementation in NodeJS -NodeJS has a specific API to track async scope: [async-hooks][async-hooks-doc], it allows to track creation of new async operation and their respective parent. +NodeJS has a specific API to track async context: [async-hooks][async-hooks-doc], it allows to track creation of new async operation and their respective parent. This package only handle storing a specific object for a given async hooks context. ### Limitations -Even if the API is native to NodeJS, it doesn't cover all possible cases of scope propagation but there is a big effort from the NodeJS team to fix those. That's why we generally advise to be on the latest LTS to benefit from performance and bug fixes. +Even if the API is native to NodeJS, it doesn't cover all possible cases of context propagation but there is a big effort from the NodeJS team to fix those. That's why we generally advise to be on the latest LTS to benefit from performance and bug fixes. -There are known modules that break scope propagation ([some of them are listed there][pkgs-that-break-ah]), so it's possible that the scope manager doesn't work with them. +There are known modules that break context propagation ([some of them are listed there][pkgs-that-break-ah]), so it's possible that the context manager doesn't work with them. ### Prior arts @@ -44,15 +44,15 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge [license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat -[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-scope-async-hooks -[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-async-hooks -[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-scope-async-hooks -[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-async-hooks&type=dev +[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-context-async-hooks +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-context-async-hooks +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-context-async-hooks +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-context-async-hooks&type=dev [async-hooks-doc]: http://nodejs.org/dist/latest/docs/api/async_hooks.html -[def-scope-manager]: https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-scope-base/README.md +[def-context-manager]: https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-context-base/README.md [dd-js-tracer-scope]: https://github.com/DataDog/dd-trace-js/tree/master/packages/dd-trace/src/scope [opentracing-scope]: https://github.com/opentracing/opentracing-javascript/pull/113 [diag-team-scope-discussion]: https://github.com/nodejs/diagnostics/issues/300 [pkgs-that-break-ah]: https://github.com/nodejs/diagnostics/blob/master/tracing/AsyncHooks/problematic-modules.md -[npm-url]: https://www.npmjs.com/package/@opentelemetry/scope-async-hooks -[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fscope-async-hooks.svg +[npm-url]: https://www.npmjs.com/package/@opentelemetry/context-async-hooks +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fcontext-async-hooks.svg diff --git a/packages/opentelemetry-scope-async-hooks/package.json b/packages/opentelemetry-context-async-hooks/package.json similarity index 90% rename from packages/opentelemetry-scope-async-hooks/package.json rename to packages/opentelemetry-context-async-hooks/package.json index 11f070718b..c0732b6f6d 100644 --- a/packages/opentelemetry-scope-async-hooks/package.json +++ b/packages/opentelemetry-context-async-hooks/package.json @@ -1,7 +1,7 @@ { - "name": "@opentelemetry/scope-async-hooks", + "name": "@opentelemetry/context-async-hooks", "version": "0.4.0", - "description": "OpenTelemetry AsyncHooks-based Scope Manager", + "description": "OpenTelemetry AsyncHooks-based Context Manager", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js", @@ -56,6 +56,6 @@ "typescript": "3.7.2" }, "dependencies": { - "@opentelemetry/scope-base": "^0.4.0" + "@opentelemetry/context-base": "^0.4.0" } } diff --git a/packages/opentelemetry-scope-async-hooks/src/AsyncHooksScopeManager.ts b/packages/opentelemetry-context-async-hooks/src/AsyncHooksContextManager.ts similarity index 76% rename from packages/opentelemetry-scope-async-hooks/src/AsyncHooksScopeManager.ts rename to packages/opentelemetry-context-async-hooks/src/AsyncHooksContextManager.ts index b0d1df0c21..e0caa3530c 100644 --- a/packages/opentelemetry-scope-async-hooks/src/AsyncHooksScopeManager.ts +++ b/packages/opentelemetry-context-async-hooks/src/AsyncHooksContextManager.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { ScopeManager, Context } from '@opentelemetry/scope-base'; +import { ContextManager, Context } from '@opentelemetry/context-base'; import * as asyncHooks from 'async_hooks'; import { EventEmitter } from 'events'; @@ -37,9 +37,9 @@ const ADD_LISTENER_METHODS = [ 'prependOnceListener' as 'prependOnceListener', ]; -export class AsyncHooksScopeManager implements ScopeManager { +export class AsyncHooksContextManager implements ContextManager { private _asyncHook: asyncHooks.AsyncHook; - private _scopes: { + private _contexts: { [uid: number]: Context | undefined | null; } = Object.create(null); @@ -52,38 +52,38 @@ export class AsyncHooksScopeManager implements ScopeManager { } active(): Context { - return this._scopes[asyncHooks.executionAsyncId()] || Context.ROOT_CONTEXT; + return this._contexts[asyncHooks.executionAsyncId()] || Context.ROOT_CONTEXT; } with ReturnType>( - scope: Context, + context: Context, fn: T ): ReturnType { const uid = asyncHooks.executionAsyncId(); - const oldScope = this._scopes[uid]; - this._scopes[uid] = scope; + const oldContext = this._contexts[uid]; + this._contexts[uid] = context; try { return fn(); } catch (err) { throw err; } finally { - if (oldScope === undefined) { + if (oldContext === undefined) { this._destroy(uid); } else { - this._scopes[uid] = oldScope; + this._contexts[uid] = oldContext; } } } - bind(target: T, scope: Context): T { - // if no specific scope to propagate is given, we use the current one - if (scope === undefined) { - scope = this.active(); + bind(target: T, context: Context): T { + // if no specific context to propagate is given, we use the current one + if (context === undefined) { + context = this.active(); } if (target instanceof EventEmitter) { - return this._bindEventEmitter(target, scope); + return this._bindEventEmitter(target, context); } else if (typeof target === 'function') { - return this._bindFunction(target, scope); + return this._bindFunction(target, context); } return target; } @@ -95,14 +95,14 @@ export class AsyncHooksScopeManager implements ScopeManager { disable(): this { this._asyncHook.disable(); - this._scopes = {}; + this._contexts = {}; return this; } - private _bindFunction(target: T, scope: Context): T { + private _bindFunction(target: T, context: Context): T { const manager = this; const contextWrapper = function(this: {}, ...args: unknown[]) { - return manager.with(scope, () => target.apply(this, args)); + return manager.with(context, () => target.apply(this, args)); }; Object.defineProperty(contextWrapper, 'length', { enumerable: false, @@ -119,24 +119,24 @@ export class AsyncHooksScopeManager implements ScopeManager { } /** - * By default, EventEmitter call their callback with their scope, which we do - * not want, instead we will bind a specific scope to all callbacks that + * By default, EventEmitter call their callback with their context, which we do + * not want, instead we will bind a specific context to all callbacks that * go through it. * @param target EventEmitter a instance of EventEmitter to patch - * @param scope the scope we want to bind + * @param context the context we want to bind */ private _bindEventEmitter( target: T, - scope: Context + context: Context ): T { const ee = (target as unknown) as PatchedEventEmitter; if (ee.__ot_listeners !== undefined) return target; ee.__ot_listeners = {}; - // patch methods that add a listener to propagate scope + // patch methods that add a listener to propagate context ADD_LISTENER_METHODS.forEach(methodName => { if (ee[methodName] === undefined) return; - ee[methodName] = this._patchAddListener(ee, ee[methodName], scope); + ee[methodName] = this._patchAddListener(ee, ee[methodName], context); }); // patch methods that remove a listener if (typeof ee.removeListener === 'function') { @@ -202,14 +202,14 @@ export class AsyncHooksScopeManager implements ScopeManager { * can force them to propagate a given context. * @param ee EventEmitter instance * @param original reference to the patched method - * @param [scope] scope to propagate when calling listeners + * @param [context] context to propagate when calling listeners */ private _patchAddListener( ee: PatchedEventEmitter, original: Function, - scope: Context + context: Context ) { - const scopeManager = this; + const contextManager = this; return function(this: {}, event: string, listener: Func) { if (ee.__ot_listeners === undefined) ee.__ot_listeners = {}; let listeners = ee.__ot_listeners[event]; @@ -217,7 +217,7 @@ export class AsyncHooksScopeManager implements ScopeManager { listeners = new WeakMap(); ee.__ot_listeners[event] = listeners; } - const patchedListener = scopeManager.bind(listener, scope); + const patchedListener = contextManager.bind(listener, context); // store a weak reference of the user listener to ours listeners.set(listener, patchedListener); return original.call(this, event, patchedListener); @@ -225,20 +225,20 @@ export class AsyncHooksScopeManager implements ScopeManager { } /** - * Init hook will be called when userland create a async scope, setting the - * scope as the current one if it exist. - * @param uid id of the async scope + * Init hook will be called when userland create a async context, setting the + * context as the current one if it exist. + * @param uid id of the async context */ private _init(uid: number) { - this._scopes[uid] = this._scopes[asyncHooks.executionAsyncId()]; + this._contexts[uid] = this._contexts[asyncHooks.executionAsyncId()]; } /** - * Destroy hook will be called when a given scope is no longer used so we can - * remove its attached scope. - * @param uid uid of the async scope + * Destroy hook will be called when a given context is no longer used so we can + * remove its attached context. + * @param uid uid of the async context */ private _destroy(uid: number) { - delete this._scopes[uid]; + delete this._contexts[uid]; } } diff --git a/packages/opentelemetry-scope-async-hooks/src/index.ts b/packages/opentelemetry-context-async-hooks/src/index.ts similarity index 93% rename from packages/opentelemetry-scope-async-hooks/src/index.ts rename to packages/opentelemetry-context-async-hooks/src/index.ts index 457513e818..e0dd94f9ea 100644 --- a/packages/opentelemetry-scope-async-hooks/src/index.ts +++ b/packages/opentelemetry-context-async-hooks/src/index.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export * from './AsyncHooksScopeManager'; +export * from './AsyncHooksContextManager'; diff --git a/packages/opentelemetry-scope-async-hooks/src/version.ts b/packages/opentelemetry-context-async-hooks/src/version.ts similarity index 100% rename from packages/opentelemetry-scope-async-hooks/src/version.ts rename to packages/opentelemetry-context-async-hooks/src/version.ts diff --git a/packages/opentelemetry-scope-async-hooks/test/AsyncHooksScopeManager.test.ts b/packages/opentelemetry-context-async-hooks/test/AsyncHooksContextManager.test.ts similarity index 50% rename from packages/opentelemetry-scope-async-hooks/test/AsyncHooksScopeManager.test.ts rename to packages/opentelemetry-context-async-hooks/test/AsyncHooksContextManager.test.ts index ea85caf6a3..91e65e99b2 100644 --- a/packages/opentelemetry-scope-async-hooks/test/AsyncHooksScopeManager.test.ts +++ b/packages/opentelemetry-context-async-hooks/test/AsyncHooksContextManager.test.ts @@ -15,28 +15,28 @@ */ import * as assert from 'assert'; -import { AsyncHooksScopeManager } from '../src'; +import { AsyncHooksContextManager } from '../src'; import { EventEmitter } from 'events'; -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; -describe('AsyncHooksScopeManager', () => { - let scopeManager: AsyncHooksScopeManager; +describe('AsyncHooksContextManager', () => { + let contextManager: AsyncHooksContextManager; const key1 = Context.createKey('test key 1'); beforeEach(() => { - scopeManager = new AsyncHooksScopeManager(); - scopeManager.enable(); + contextManager = new AsyncHooksContextManager(); + contextManager.enable(); }); afterEach(() => { - scopeManager.disable(); + contextManager.disable(); }); describe('.enable()', () => { it('should work', () => { assert.doesNotThrow(() => { - scopeManager = new AsyncHooksScopeManager(); - assert(scopeManager.enable() === scopeManager, 'should return this'); + contextManager = new AsyncHooksContextManager(); + assert(contextManager.enable() === contextManager, 'should return this'); }); }); }); @@ -44,51 +44,51 @@ describe('AsyncHooksScopeManager', () => { describe('.disable()', () => { it('should work', () => { assert.doesNotThrow(() => { - assert(scopeManager.disable() === scopeManager, 'should return this'); + assert(contextManager.disable() === contextManager, 'should return this'); }); - scopeManager.enable(); + contextManager.enable(); }); }); describe('.with()', () => { it('should run the callback (null as target)', done => { - scopeManager.with(Context.ROOT_CONTEXT, done); + contextManager.with(Context.ROOT_CONTEXT, done); }); it('should run the callback (object as target)', done => { const test = Context.ROOT_CONTEXT.setValue(key1, 1); - scopeManager.with(test, () => { - assert.strictEqual(scopeManager.active(), test, 'should have scope'); + contextManager.with(test, () => { + assert.strictEqual(contextManager.active(), test, 'should have context'); return done(); }); }); it('should run the callback (when disabled)', done => { - scopeManager.disable(); - scopeManager.with(Context.ROOT_CONTEXT, () => { - scopeManager.enable(); + contextManager.disable(); + contextManager.with(Context.ROOT_CONTEXT, () => { + contextManager.enable(); return done(); }); }); it('should rethrow errors', done => { assert.throws(() => { - scopeManager.with(Context.ROOT_CONTEXT, () => { + contextManager.with(Context.ROOT_CONTEXT, () => { throw new Error('This should be rethrown'); }); }); return done(); }); - it('should finally restore an old scope', done => { - const scope1 = Context.ROOT_CONTEXT.setValue(key1, 'scope1'); - const scope2 = Context.ROOT_CONTEXT.setValue(key1, 'scope2'); - scopeManager.with(scope1, () => { - assert.strictEqual(scopeManager.active(), scope1); - scopeManager.with(scope2, () => { - assert.strictEqual(scopeManager.active(), scope2); + it('should finally restore an old context', done => { + const ctx1 = Context.ROOT_CONTEXT.setValue(key1, 'ctx1'); + const ctx2 = Context.ROOT_CONTEXT.setValue(key1, 'ctx2'); + contextManager.with(ctx1, () => { + assert.strictEqual(contextManager.active(), ctx1); + contextManager.with(ctx2, () => { + assert.strictEqual(contextManager.active(), ctx2); }); - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); return done(); }); }); @@ -98,69 +98,69 @@ describe('AsyncHooksScopeManager', () => { it('should return the same target (when enabled)', () => { const test = { a: 1 }; assert.deepStrictEqual( - scopeManager.bind(test, Context.ROOT_CONTEXT), + contextManager.bind(test, Context.ROOT_CONTEXT), test ); }); it('should return the same target (when disabled)', () => { - scopeManager.disable(); + contextManager.disable(); const test = { a: 1 }; assert.deepStrictEqual( - scopeManager.bind(test, Context.ROOT_CONTEXT), + contextManager.bind(test, Context.ROOT_CONTEXT), test ); - scopeManager.enable(); + contextManager.enable(); }); - it('should return current scope (when enabled)', done => { - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const fn = scopeManager.bind(() => { - assert.strictEqual(scopeManager.active(), scope, 'should have scope'); + it('should return current context (when enabled)', done => { + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const fn = contextManager.bind(() => { + assert.strictEqual(contextManager.active(), context, 'should have context'); return done(); - }, scope); + }, context); fn(); }); /** - * Even if asynchooks is disabled, the scope propagation will + * Even if asynchooks is disabled, the context propagation will * still works but it might be lost after any async op. */ - it('should return current scope (when disabled)', done => { - scopeManager.disable(); - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const fn = scopeManager.bind(() => { - assert.strictEqual(scopeManager.active(), scope, 'should have scope'); + it('should return current context (when disabled)', done => { + contextManager.disable(); + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const fn = contextManager.bind(() => { + assert.strictEqual(contextManager.active(), context, 'should have context'); return done(); - }, scope); + }, context); fn(); }); - it('should fail to return current scope (when disabled + async op)', done => { - scopeManager.disable(); - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const fn = scopeManager.bind(() => { + it('should fail to return current context (when disabled + async op)', done => { + contextManager.disable(); + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const fn = contextManager.bind(() => { setTimeout(() => { assert.strictEqual( - scopeManager.active(), + contextManager.active(), Context.ROOT_CONTEXT, - 'should have no scope' + 'should have no context' ); return done(); }, 100); - }, scope); + }, context); fn(); }); - it('should return current scope (when re-enabled + async op)', done => { - scopeManager.enable(); - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const fn = scopeManager.bind(() => { + it('should return current context (when re-enabled + async op)', done => { + contextManager.enable(); + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const fn = contextManager.bind(() => { setTimeout(() => { - assert.strictEqual(scopeManager.active(), scope, 'should have scope'); + assert.strictEqual(contextManager.active(), context, 'should have context'); return done(); }, 100); - }, scope); + }, context); fn(); }); }); @@ -168,22 +168,22 @@ describe('AsyncHooksScopeManager', () => { describe('.bind(event-emitter)', () => { it('should return the same target (when enabled)', () => { const ee = new EventEmitter(); - assert.deepStrictEqual(scopeManager.bind(ee, Context.ROOT_CONTEXT), ee); + assert.deepStrictEqual(contextManager.bind(ee, Context.ROOT_CONTEXT), ee); }); it('should return the same target (when disabled)', () => { const ee = new EventEmitter(); - scopeManager.disable(); - assert.deepStrictEqual(scopeManager.bind(ee, Context.ROOT_CONTEXT), ee); - scopeManager.enable(); + contextManager.disable(); + assert.deepStrictEqual(contextManager.bind(ee, Context.ROOT_CONTEXT), ee); + contextManager.enable(); }); - it('should return current scope and removeListener (when enabled)', done => { + it('should return current context and removeListener (when enabled)', done => { const ee = new EventEmitter(); - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const patchedEe = scopeManager.bind(ee, scope); + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const patchedEe = contextManager.bind(ee, context); const handler = () => { - assert.deepStrictEqual(scopeManager.active(), scope); + assert.deepStrictEqual(contextManager.active(), context); patchedEe.removeListener('test', handler); assert.strictEqual(patchedEe.listeners('test').length, 0); return done(); @@ -193,12 +193,12 @@ describe('AsyncHooksScopeManager', () => { patchedEe.emit('test'); }); - it('should return current scope and removeAllListener (when enabled)', done => { + it('should return current context and removeAllListener (when enabled)', done => { const ee = new EventEmitter(); - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const patchedEe = scopeManager.bind(ee, scope); + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const patchedEe = contextManager.bind(ee, context); const handler = () => { - assert.deepStrictEqual(scopeManager.active(), scope); + assert.deepStrictEqual(contextManager.active(), context); patchedEe.removeAllListeners('test'); assert.strictEqual(patchedEe.listeners('test').length, 0); return done(); @@ -209,19 +209,19 @@ describe('AsyncHooksScopeManager', () => { }); /** - * Even if asynchooks is disabled, the scope propagation will + * Even if asynchooks is disabled, the context propagation will * still works but it might be lost after any async op. */ - it('should return scope (when disabled)', done => { - scopeManager.disable(); + it('should return context (when disabled)', done => { + contextManager.disable(); const ee = new EventEmitter(); - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const patchedEe = scopeManager.bind(ee, scope); + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const patchedEe = contextManager.bind(ee, context); const handler = () => { - assert.deepStrictEqual(scopeManager.active(), scope); + assert.deepStrictEqual(contextManager.active(), context); patchedEe.removeListener('test', handler); assert.strictEqual(patchedEe.listeners('test').length, 0); - scopeManager.enable(); + contextManager.enable(); return done(); }; patchedEe.on('test', handler); @@ -229,14 +229,14 @@ describe('AsyncHooksScopeManager', () => { patchedEe.emit('test'); }); - it('should not return current scope (when disabled + async op)', done => { - scopeManager.disable(); + it('should not return current context (when disabled + async op)', done => { + contextManager.disable(); const ee = new EventEmitter(); - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const patchedEe = scopeManager.bind(ee, scope); + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const patchedEe = contextManager.bind(ee, context); const handler = () => { setImmediate(() => { - assert.deepStrictEqual(scopeManager.active(), Context.ROOT_CONTEXT); + assert.deepStrictEqual(contextManager.active(), Context.ROOT_CONTEXT); patchedEe.removeAllListeners('test'); assert.strictEqual(patchedEe.listeners('test').length, 0); return done(); @@ -247,14 +247,14 @@ describe('AsyncHooksScopeManager', () => { patchedEe.emit('test'); }); - it('should return current scope (when enabled + async op)', done => { - scopeManager.enable(); + it('should return current context (when enabled + async op)', done => { + contextManager.enable(); const ee = new EventEmitter(); - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const patchedEe = scopeManager.bind(ee, scope); + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const patchedEe = contextManager.bind(ee, context); const handler = () => { setImmediate(() => { - assert.deepStrictEqual(scopeManager.active(), scope); + assert.deepStrictEqual(contextManager.active(), context); patchedEe.removeAllListeners('test'); assert.strictEqual(patchedEe.listeners('test').length, 0); return done(); diff --git a/packages/opentelemetry-scope-async-hooks/tsconfig.json b/packages/opentelemetry-context-async-hooks/tsconfig.json similarity index 100% rename from packages/opentelemetry-scope-async-hooks/tsconfig.json rename to packages/opentelemetry-context-async-hooks/tsconfig.json diff --git a/packages/opentelemetry-scope-async-hooks/tslint.json b/packages/opentelemetry-context-async-hooks/tslint.json similarity index 100% rename from packages/opentelemetry-scope-async-hooks/tslint.json rename to packages/opentelemetry-context-async-hooks/tslint.json diff --git a/packages/opentelemetry-scope-base/.npmignore b/packages/opentelemetry-context-base/.npmignore similarity index 100% rename from packages/opentelemetry-scope-base/.npmignore rename to packages/opentelemetry-context-base/.npmignore diff --git a/packages/opentelemetry-scope-base/LICENSE b/packages/opentelemetry-context-base/LICENSE similarity index 100% rename from packages/opentelemetry-scope-base/LICENSE rename to packages/opentelemetry-context-base/LICENSE diff --git a/packages/opentelemetry-scope-base/README.md b/packages/opentelemetry-context-base/README.md similarity index 54% rename from packages/opentelemetry-scope-base/README.md rename to packages/opentelemetry-context-base/README.md index f58c686a9b..efba889845 100644 --- a/packages/opentelemetry-scope-base/README.md +++ b/packages/opentelemetry-context-base/README.md @@ -1,23 +1,21 @@ -# OpenTelemetry Base Scope Manager +# OpenTelemetry Base Context Manager [![Gitter chat][gitter-image]][gitter-url] [![NPM Published Version][npm-img]][npm-url] [![dependencies][dependencies-image]][dependencies-url] [![devDependencies][devDependencies-image]][devDependencies-url] [![Apache License][license-image]][license-image] -This package provides the ScopeManager interface (which is used by concrete implementations) and a no-op implementation (which is used internally when no scope propagation is defined). It's intended for use both on the server and in the browser. +This package provides the ContextManager interface (which is used by concrete implementations) and a no-op implementation (which is used internally when no context propagation is defined). It's intended for use both on the server and in the browser. -## What is a Scope Manager ? +## What is a Context Manager ? To understand why they exists, we'll need to understand how Javascript works: when you make native function call (networks, setInterval etc) you generally call C++ code that will later callback your own code. -A common issue when tracing a request in javascript is to link the function that have made the native call to the callback that the native code called when the response is there. Imagine you want to track for which user you made the request, you need some sort of "context/scope aware storage". +A common issue when tracing a request in javascript is to link the function that have made the native call to the callback that the native code called when the response is there. Imagine you want to track for which user you made the request, you need some sort of "context/context aware storage". -ScopeManager's aim to offer exactly that, it's API offer to store an object in the current scope (`with()`) and if needed, `bind()` to a specific function call to find it back when the callback fire, which can later get retrieved using `active()`. +ContextManager's aim to offer exactly that, it's API offer to store an object in the current context (`with()`) and if needed, `bind()` to a specific function call to find it back when the callback fire, which can later get retrieved using `active()`. -This package only include the interface and a Noop implementation, for more information please see the [async-hooks based ScopeManager][ah-scope-manager] for NodeJS. - -Note: You will sometimes read about **context** management, which is sometimes also used for talking about **scope** management. However in OpenTelemetry, **context** was already heavily used as a concept in the Trace API so we named this package with **scope** to avoid confusion. +This package only include the interface and a Noop implementation, for more information please see the [async-hooks based ContextManager][ah-context-manager] for NodeJS. ## Useful links - For more information on OpenTelemetry, visit: @@ -32,10 +30,10 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge [license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat -[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-scope-base -[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-base -[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-scope-base -[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-base&type=dev -[ah-scope-manager]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-scope-async-hooks -[npm-url]: https://www.npmjs.com/package/@opentelemetry/scope-base -[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fscope-base.svg +[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-context-base +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-context-base +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-context-base +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-context-base&type=dev +[ah-context-manager]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-context-async-hooks +[npm-url]: https://www.npmjs.com/package/@opentelemetry/context-base +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fcontext-base.svg diff --git a/packages/opentelemetry-scope-base/package.json b/packages/opentelemetry-context-base/package.json similarity index 93% rename from packages/opentelemetry-scope-base/package.json rename to packages/opentelemetry-context-base/package.json index ae21640641..52926fc90b 100644 --- a/packages/opentelemetry-scope-base/package.json +++ b/packages/opentelemetry-context-base/package.json @@ -1,7 +1,7 @@ { - "name": "@opentelemetry/scope-base", + "name": "@opentelemetry/context-base", "version": "0.4.0", - "description": "OpenTelemetry Base Scope Manager", + "description": "OpenTelemetry Base Context Manager", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js", diff --git a/packages/opentelemetry-scope-base/src/NoopScopeManager.ts b/packages/opentelemetry-context-base/src/NoopContextManager.ts similarity index 87% rename from packages/opentelemetry-scope-base/src/NoopScopeManager.ts rename to packages/opentelemetry-context-base/src/NoopContextManager.ts index 027f0a2e14..62fbb88068 100644 --- a/packages/opentelemetry-scope-base/src/NoopScopeManager.ts +++ b/packages/opentelemetry-context-base/src/NoopContextManager.ts @@ -17,19 +17,19 @@ import * as types from './types'; import { Context } from './context'; -export class NoopScopeManager implements types.ScopeManager { +export class NoopContextManager implements types.ContextManager { active(): Context { return Context.ROOT_CONTEXT; } with ReturnType>( - scope: Context, + context: Context, fn: T ): ReturnType { return fn(); } - bind(target: T, scope?: Context): T { + bind(target: T, context?: Context): T { return target; } diff --git a/packages/opentelemetry-scope-base/src/context.ts b/packages/opentelemetry-context-base/src/context.ts similarity index 100% rename from packages/opentelemetry-scope-base/src/context.ts rename to packages/opentelemetry-context-base/src/context.ts diff --git a/packages/opentelemetry-scope-base/src/index.ts b/packages/opentelemetry-context-base/src/index.ts similarity index 94% rename from packages/opentelemetry-scope-base/src/index.ts rename to packages/opentelemetry-context-base/src/index.ts index 3f0c230358..25bf328c13 100644 --- a/packages/opentelemetry-scope-base/src/index.ts +++ b/packages/opentelemetry-context-base/src/index.ts @@ -16,4 +16,4 @@ export * from './types'; export * from './context'; -export * from './NoopScopeManager'; +export * from './NoopContextManager'; diff --git a/packages/opentelemetry-scope-base/src/types.ts b/packages/opentelemetry-context-base/src/types.ts similarity index 62% rename from packages/opentelemetry-scope-base/src/types.ts rename to packages/opentelemetry-context-base/src/types.ts index 9bba83b504..9624387ac7 100644 --- a/packages/opentelemetry-scope-base/src/types.ts +++ b/packages/opentelemetry-context-base/src/types.ts @@ -16,36 +16,36 @@ import { Context } from './context'; -export interface ScopeManager { +export interface ContextManager { /** - * Get the current active scope + * Get the current active context */ active(): Context; /** - * Run the fn callback with object set as the current active scope - * @param scope Any object to set as the current active scope - * @param fn A callback to be immediately run within a specific scope + * Run the fn callback with object set as the current active context + * @param context Any object to set as the current active context + * @param fn A callback to be immediately run within a specific context */ with ReturnType>( - scope: Context, + context: Context, fn: T ): ReturnType; /** - * Bind an object as the current scope (or a specific one) - * @param target Any object to which a scope need to be set - * @param [scope] Optionally specify the scope which you want to assign + * Bind an object as the current context (or a specific one) + * @param target Any object to which a context need to be set + * @param [context] Optionally specify the context which you want to assign */ - bind(target: T, scope?: Context): T; + bind(target: T, context?: Context): T; /** - * Enable scope management + * Enable context management */ enable(): this; /** - * Disable scope management + * Disable context management */ disable(): this; } diff --git a/packages/opentelemetry-scope-base/src/version.ts b/packages/opentelemetry-context-base/src/version.ts similarity index 100% rename from packages/opentelemetry-scope-base/src/version.ts rename to packages/opentelemetry-context-base/src/version.ts diff --git a/packages/opentelemetry-scope-base/test/NoopScopeManager.test.ts b/packages/opentelemetry-context-base/test/NoopContextManager.test.ts similarity index 65% rename from packages/opentelemetry-scope-base/test/NoopScopeManager.test.ts rename to packages/opentelemetry-context-base/test/NoopContextManager.test.ts index 8daf15ded0..b29541f8af 100644 --- a/packages/opentelemetry-scope-base/test/NoopScopeManager.test.ts +++ b/packages/opentelemetry-context-base/test/NoopContextManager.test.ts @@ -15,16 +15,16 @@ */ import * as assert from 'assert'; -import { NoopScopeManager, Context } from '../src'; +import { NoopContextManager, Context } from '../src'; -describe('NoopScopeManager', () => { - let scopeManager: NoopScopeManager; +describe('NoopContextManager', () => { + let contextManager: NoopContextManager; describe('.enable()', () => { it('should work', () => { assert.doesNotThrow(() => { - scopeManager = new NoopScopeManager(); - assert(scopeManager.enable() === scopeManager, 'should return this'); + contextManager = new NoopContextManager(); + assert(contextManager.enable() === contextManager, 'should return this'); }); }); }); @@ -32,34 +32,34 @@ describe('NoopScopeManager', () => { describe('.disable()', () => { it('should work', () => { assert.doesNotThrow(() => { - assert(scopeManager.disable() === scopeManager, 'should return this'); + assert(contextManager.disable() === contextManager, 'should return this'); }); - scopeManager.enable(); + contextManager.enable(); }); }); describe('.with()', () => { it('should run the callback (Context.ROOT_CONTEXT as target)', done => { - scopeManager.with(Context.ROOT_CONTEXT, done); + contextManager.with(Context.ROOT_CONTEXT, done); }); it('should run the callback (object as target)', done => { const key = Context.createKey('test key 1'); const test = Context.ROOT_CONTEXT.setValue(key, 1); - scopeManager.with(test, () => { + contextManager.with(test, () => { assert.strictEqual( - scopeManager.active(), + contextManager.active(), Context.ROOT_CONTEXT, - 'should not have scope' + 'should not have context' ); return done(); }); }); it('should run the callback (when disabled)', done => { - scopeManager.disable(); - scopeManager.with(Context.ROOT_CONTEXT, () => { - scopeManager.enable(); + contextManager.disable(); + contextManager.with(Context.ROOT_CONTEXT, () => { + contextManager.enable(); return done(); }); }); @@ -68,34 +68,34 @@ describe('NoopScopeManager', () => { describe('.active()', () => { it('should always return Context.ROOT_CONTEXT (when enabled)', () => { assert.strictEqual( - scopeManager.active(), + contextManager.active(), Context.ROOT_CONTEXT, - 'should not have scope' + 'should not have context' ); }); it('should always return Context.ROOT_CONTEXT (when disabled)', () => { - scopeManager.disable(); + contextManager.disable(); assert.strictEqual( - scopeManager.active(), + contextManager.active(), Context.ROOT_CONTEXT, - 'should not have scope' + 'should not have context' ); - scopeManager.enable(); + contextManager.enable(); }); }); describe('.bind()', () => { it('should return the same target (when enabled)', () => { const test = { a: 1 }; - assert.deepStrictEqual(scopeManager.bind(test), test); + assert.deepStrictEqual(contextManager.bind(test), test); }); it('should return the same target (when disabled)', () => { - scopeManager.disable(); + contextManager.disable(); const test = { a: 1 }; - assert.deepStrictEqual(scopeManager.bind(test), test); - scopeManager.enable(); + assert.deepStrictEqual(contextManager.bind(test), test); + contextManager.enable(); }); }); }); diff --git a/packages/opentelemetry-scope-base/tsconfig.json b/packages/opentelemetry-context-base/tsconfig.json similarity index 100% rename from packages/opentelemetry-scope-base/tsconfig.json rename to packages/opentelemetry-context-base/tsconfig.json diff --git a/packages/opentelemetry-scope-base/tslint.json b/packages/opentelemetry-context-base/tslint.json similarity index 100% rename from packages/opentelemetry-scope-base/tslint.json rename to packages/opentelemetry-context-base/tslint.json diff --git a/packages/opentelemetry-scope-zone-peer-dep/LICENSE b/packages/opentelemetry-context-zone-peer-dep/LICENSE similarity index 100% rename from packages/opentelemetry-scope-zone-peer-dep/LICENSE rename to packages/opentelemetry-context-zone-peer-dep/LICENSE diff --git a/packages/opentelemetry-scope-zone-peer-dep/README.md b/packages/opentelemetry-context-zone-peer-dep/README.md similarity index 74% rename from packages/opentelemetry-scope-zone-peer-dep/README.md rename to packages/opentelemetry-context-zone-peer-dep/README.md index 72d83ed591..4a0d2d9bd8 100644 --- a/packages/opentelemetry-scope-zone-peer-dep/README.md +++ b/packages/opentelemetry-context-zone-peer-dep/README.md @@ -1,33 +1,33 @@ -# OpenTelemetry Scope Zone Peer Dependency +# OpenTelemetry Context Zone Peer Dependency [![Gitter chat][gitter-image]][gitter-url] [![NPM Published Version][npm-img]][npm-url] [![dependencies][dependencies-image]][dependencies-url] [![devDependencies][devDependencies-image]][devDependencies-url] [![Apache License][license-image]][license-image] -This module provides *Zone Scope Manager with a peer dependency for [zone-js]* for Web applications. +This module provides *Zone Context Manager with a peer dependency for [zone-js]* for Web applications. If you use Angular you already have the [zone-js] and you should use this package. -If you don't have your own [zone-js] please use [@opentelemetry/scope-zone] +If you don't have your own [zone-js] please use [@opentelemetry/context-zone] ## Installation ```bash -npm install --save @opentelemetry/scope-zone-peer-dep +npm install --save @opentelemetry/context-zone-peer-dep ``` ## Usage ```js import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; import { WebTracer } from '@opentelemetry/web'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone-peer-dep'; +import { ZoneContextManager } from '@opentelemetry/context-zone-peer-dep'; const webTracerWithZone = new WebTracer({ - scopeManager: new ZoneScopeManager() + contextManager: new ZoneContextManager() }); webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); -// Example how the ZoneScopeManager keeps the reference to the correct scope during async operations +// Example how the ZoneContextManager keeps the reference to the correct context during async operations const span1 = webTracerWithZone.startSpan('foo1'); webTracerWithZone.withSpan(span1, () => { console.log('Current span is span1', webTracerWithZone.getCurrentSpan() === span1); @@ -61,11 +61,11 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge [license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat -[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-scope-zone-peer-dep -[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-zone-peer-dep -[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-scope-zone-peer-dep +[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-context-zone-peer-dep +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-context-zone-peer-dep +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-context-zone-peer-dep [devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-web&type=dev -[npm-url]: https://www.npmjs.com/package/@opentelemetry/scope-zone-peer-dep -[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fscope-zone-peer-dep.svg +[npm-url]: https://www.npmjs.com/package/@opentelemetry/context-zone-peer-dep +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fcontext-zone-peer-dep.svg [zone-js]: https://www.npmjs.com/package/zone.js -[@opentelemetry/scope-zone]: https://www.npmjs.com/package/@opentelemetry/scope-zone +[@opentelemetry/context-zone]: https://www.npmjs.com/package/@opentelemetry/context-zone diff --git a/packages/opentelemetry-scope-zone-peer-dep/karma.conf.js b/packages/opentelemetry-context-zone-peer-dep/karma.conf.js similarity index 100% rename from packages/opentelemetry-scope-zone-peer-dep/karma.conf.js rename to packages/opentelemetry-context-zone-peer-dep/karma.conf.js diff --git a/packages/opentelemetry-scope-zone-peer-dep/package.json b/packages/opentelemetry-context-zone-peer-dep/package.json similarity index 91% rename from packages/opentelemetry-scope-zone-peer-dep/package.json rename to packages/opentelemetry-context-zone-peer-dep/package.json index 48957cb4f0..2bc4968a52 100644 --- a/packages/opentelemetry-scope-zone-peer-dep/package.json +++ b/packages/opentelemetry-context-zone-peer-dep/package.json @@ -1,7 +1,7 @@ { - "name": "@opentelemetry/scope-zone-peer-dep", + "name": "@opentelemetry/context-zone-peer-dep", "version": "0.4.0", - "description": "OpenTelemetry Scope Zone with peer dependency for zone.js", + "description": "OpenTelemetry Context Zone with peer dependency for zone.js", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js", @@ -72,7 +72,7 @@ "zone.js": "^0.10.2" }, "dependencies": { - "@opentelemetry/scope-base": "^0.4.0" + "@opentelemetry/context-base": "^0.4.0" }, "peerDependencies": { "zone.js": "^0.10.2" diff --git a/packages/opentelemetry-scope-zone-peer-dep/src/ZoneScopeManager.ts b/packages/opentelemetry-context-zone-peer-dep/src/ZoneContextManager.ts similarity index 65% rename from packages/opentelemetry-scope-zone-peer-dep/src/ZoneScopeManager.ts rename to packages/opentelemetry-context-zone-peer-dep/src/ZoneContextManager.ts index 71b3c6be45..cd388f94b8 100644 --- a/packages/opentelemetry-scope-zone-peer-dep/src/ZoneScopeManager.ts +++ b/packages/opentelemetry-context-zone-peer-dep/src/ZoneContextManager.ts @@ -14,25 +14,25 @@ * limitations under the License. */ -import { ScopeManager, Context } from '@opentelemetry/scope-base'; +import { ContextManager, Context } from '@opentelemetry/context-base'; import { Func, TargetWithEvents } from './types'; import { isListenerObject } from './util'; -/* Key name to be used to save a scope reference in Zone */ -const ZONE_SCOPE_KEY = 'OT_ZONE_SCOPE'; +/* Key name to be used to save a context reference in Zone */ +const ZONE_CONTEXT_KEY = 'OT_ZONE_CONTEXT'; /** - * ZoneScopeManager + * ZoneContextManager * This module provides an easy functionality for tracing action between asynchronous operations in web. - * It was not possible with standard [StackScopeManager]{@link https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-web/src/StackScopeManager.ts}. + * It was not possible with standard [StackContextManager]{@link https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-web/src/StackContextManager.ts}. * It heavily depends on [zone.js]{@link https://www.npmjs.com/package/zone.js}. - * It stores the information about scope in zone. Each Scope will have always new Zone; + * It stores the information about context in zone. Each Context will have always new Zone; * It also supports binding a certain Span to a target that has "addEventListener" and "removeEventListener". * When this happens a new zone is being created and the provided Span is being assigned to this zone. */ -export class ZoneScopeManager implements ScopeManager { +export class ZoneContextManager implements ContextManager { /** - * whether the scope manager is enabled or not + * whether the context manager is enabled or not */ private _enabled = false; @@ -42,23 +42,23 @@ export class ZoneScopeManager implements ScopeManager { private _zoneCounter = 0; /** - * Returns the active scope from certain zone name + * Returns the active context from certain zone name * @param activeZone */ - private _activeScopeFromZone(activeZone: Zone | undefined): Context { + private _activeContextFromZone(activeZone: Zone | undefined): Context { return ( - (activeZone && activeZone.get(ZONE_SCOPE_KEY)) || Context.ROOT_CONTEXT + (activeZone && activeZone.get(ZONE_CONTEXT_KEY)) || Context.ROOT_CONTEXT ); } /** - * @param target Function to be executed within the scope - * @param scope A scope (span) to be executed within target function + * @param target Function to be executed within the context + * @param context A context (span) to be executed within target function */ - private _bindFunction(target: T, scope: Context): T { + private _bindFunction(target: T, context: Context): T { const manager = this; const contextWrapper = function(this: any, ...args: unknown[]) { - return manager.with(scope, () => target.apply(this, args)); + return manager.with(context, () => target.apply(this, args)); }; Object.defineProperty(contextWrapper, 'length', { enumerable: false, @@ -71,9 +71,9 @@ export class ZoneScopeManager implements ScopeManager { /** * @param obj target object on which the listeners will be patched - * @param scope A scope (span) to be bind to target + * @param context A context (span) to be bind to target */ - private _bindListener(obj: T, scope: Context): T { + private _bindListener(obj: T, context: Context): T { const target = (obj as unknown) as TargetWithEvents; if (target.__ot_listeners !== undefined) { return obj; @@ -84,7 +84,7 @@ export class ZoneScopeManager implements ScopeManager { target.addEventListener = this._patchAddEventListener( target, target.addEventListener, - scope + context ); } @@ -110,13 +110,13 @@ export class ZoneScopeManager implements ScopeManager { /** * Creates a new zone * @param zoneName zone name - * @param scope A scope (span) to be bind with Zone + * @param context A context (span) to be bind with Zone */ - private _createZone(zoneName: string, scope: unknown): Zone { + private _createZone(zoneName: string, context: unknown): Zone { return Zone.root.fork({ name: zoneName, properties: { - [ZONE_SCOPE_KEY]: scope, + [ZONE_CONTEXT_KEY]: context, }, }); } @@ -132,14 +132,14 @@ export class ZoneScopeManager implements ScopeManager { * Patches addEventListener method * @param target any target that has "addEventListener" method * @param original reference to the patched method - * @param [scope] scope to be bind to the listener + * @param [context] context to be bind to the listener */ private _patchAddEventListener( target: TargetWithEvents, original: Function, - scope: Context + context: Context ) { - const scopeManager = this; + const contextManager = this; return function(this: {}, event: string, listener: Func, opts?: any) { if (target.__ot_listeners === undefined) { @@ -150,7 +150,7 @@ export class ZoneScopeManager implements ScopeManager { listeners = new WeakMap(); target.__ot_listeners[event] = listeners; } - const patchedListener = scopeManager.bind(listener, scope); + const patchedListener = contextManager.bind(listener, context); // store a weak reference of the user listener to ours listeners.set(listener, patchedListener); return original.call(this, event, patchedListener, opts); @@ -181,7 +181,7 @@ export class ZoneScopeManager implements ScopeManager { } /** - * Returns the active scope + * Returns the active context */ active(): Context { if (!this._enabled) { @@ -189,7 +189,7 @@ export class ZoneScopeManager implements ScopeManager { } const activeZone = this._getActiveZone(); - const active = this._activeScopeFromZone(activeZone); + const active = this._activeContextFromZone(activeZone); if (active) { return active; } @@ -198,25 +198,25 @@ export class ZoneScopeManager implements ScopeManager { } /** - * Binds a the certain scope or the active one to the target function and then returns the target + * Binds a the certain context or the active one to the target function and then returns the target * @param target - * @param scope A scope (span) to be bind to target + * @param context A context (span) to be bind to target */ - bind(target: T | TargetWithEvents, scope: Context): T { - // if no specific scope to propagate is given, we use the current one - if (scope === undefined) { - scope = this.active(); + bind(target: T | TargetWithEvents, context: Context): T { + // if no specific context to propagate is given, we use the current one + if (context === undefined) { + context = this.active(); } if (typeof target === 'function') { - return this._bindFunction(target, scope); + return this._bindFunction(target, context); } else if (isListenerObject(target)) { - this._bindListener(target, scope); + this._bindListener(target, context); } return (target as unknown) as T; } /** - * Disable the scope manager (clears all the scopes) + * Disable the context manager (clears all the contexts) */ disable(): this { this._enabled = false; @@ -224,7 +224,7 @@ export class ZoneScopeManager implements ScopeManager { } /** - * Enables the scope manager and creates a default(root) scope + * Enables the context manager and creates a default(root) context */ enable(): this { this._enabled = true; @@ -232,20 +232,20 @@ export class ZoneScopeManager implements ScopeManager { } /** - * Calls the callback function [fn] with the provided [scope]. - * If [scope] is undefined then it will use the active scope. - * The scope will be set as active - * @param scope A scope (span) to be called with provided callback + * Calls the callback function [fn] with the provided [context]. + * If [context] is undefined then it will use the active context. + * The context will be set as active + * @param context A context (span) to be called with provided callback * @param fn Callback function */ with ReturnType>( - scope: Context | null, + context: Context | null, fn: () => ReturnType ): ReturnType { const zoneName = this._createZoneName(); - const newZone = this._createZone(zoneName, scope); + const newZone = this._createZone(zoneName, context); - return newZone.run(fn, scope); + return newZone.run(fn, context); } } diff --git a/packages/opentelemetry-scope-zone-peer-dep/src/index.ts b/packages/opentelemetry-context-zone-peer-dep/src/index.ts similarity index 94% rename from packages/opentelemetry-scope-zone-peer-dep/src/index.ts rename to packages/opentelemetry-context-zone-peer-dep/src/index.ts index 3360b42ee3..cee3639760 100644 --- a/packages/opentelemetry-scope-zone-peer-dep/src/index.ts +++ b/packages/opentelemetry-context-zone-peer-dep/src/index.ts @@ -14,5 +14,5 @@ * limitations under the License. */ -export * from './ZoneScopeManager'; +export * from './ZoneContextManager'; export * from './types'; diff --git a/packages/opentelemetry-scope-zone-peer-dep/src/types.ts b/packages/opentelemetry-context-zone-peer-dep/src/types.ts similarity index 100% rename from packages/opentelemetry-scope-zone-peer-dep/src/types.ts rename to packages/opentelemetry-context-zone-peer-dep/src/types.ts diff --git a/packages/opentelemetry-scope-zone-peer-dep/src/util.ts b/packages/opentelemetry-context-zone-peer-dep/src/util.ts similarity index 100% rename from packages/opentelemetry-scope-zone-peer-dep/src/util.ts rename to packages/opentelemetry-context-zone-peer-dep/src/util.ts diff --git a/packages/opentelemetry-scope-zone-peer-dep/src/version.ts b/packages/opentelemetry-context-zone-peer-dep/src/version.ts similarity index 100% rename from packages/opentelemetry-scope-zone-peer-dep/src/version.ts rename to packages/opentelemetry-context-zone-peer-dep/src/version.ts diff --git a/packages/opentelemetry-scope-zone-peer-dep/test/ZoneScopeManager.test.ts b/packages/opentelemetry-context-zone-peer-dep/test/ZoneContextManager.test.ts similarity index 51% rename from packages/opentelemetry-scope-zone-peer-dep/test/ZoneScopeManager.test.ts rename to packages/opentelemetry-context-zone-peer-dep/test/ZoneContextManager.test.ts index 33e62c29e6..325432cf50 100644 --- a/packages/opentelemetry-scope-zone-peer-dep/test/ZoneScopeManager.test.ts +++ b/packages/opentelemetry-context-zone-peer-dep/test/ZoneContextManager.test.ts @@ -17,34 +17,34 @@ import 'zone.js'; import * as sinon from 'sinon'; import * as assert from 'assert'; -import { ZoneScopeManager } from '../src'; -import { Context } from '@opentelemetry/scope-base'; +import { ZoneContextManager } from '../src'; +import { Context } from '@opentelemetry/context-base'; let clock: any; -describe('ZoneScopeManager', () => { - let scopeManager: ZoneScopeManager; +describe('ZoneContextManager', () => { + let contextManager: ZoneContextManager; const key1 = Context.createKey('test key 1'); const key2 = Context.createKey('test key 2'); beforeEach(() => { clock = sinon.useFakeTimers(); - scopeManager = new ZoneScopeManager(); - scopeManager.enable(); + contextManager = new ZoneContextManager(); + contextManager.enable(); }); afterEach(() => { clock.restore(); - scopeManager.disable(); + contextManager.disable(); }); describe('.enable()', () => { it('should work', () => { const ctx = Context.ROOT_CONTEXT.setValue(key1, 1); assert.doesNotThrow(() => { - assert(scopeManager.enable() === scopeManager, 'should return this'); - scopeManager.with(ctx, () => { - assert(scopeManager.active() === ctx, 'should have root scope'); + assert(contextManager.enable() === contextManager, 'should return this'); + contextManager.with(ctx, () => { + assert(contextManager.active() === ctx, 'should have root context'); }); }); }); @@ -54,11 +54,11 @@ describe('ZoneScopeManager', () => { it('should work', () => { const ctx = Context.ROOT_CONTEXT.setValue(key1, 1); assert.doesNotThrow(() => { - assert(scopeManager.disable() === scopeManager, 'should return this'); - scopeManager.with(ctx, () => { + assert(contextManager.disable() === contextManager, 'should return this'); + contextManager.with(ctx, () => { assert( - scopeManager.active() === Context.ROOT_CONTEXT, - 'should have root scope' + contextManager.active() === Context.ROOT_CONTEXT, + 'should have root context' ); }); }); @@ -67,85 +67,85 @@ describe('ZoneScopeManager', () => { describe('.with()', () => { it('should run the callback (null as target)', done => { - scopeManager.with(null, done); + contextManager.with(null, done); }); it('should run the callback (object as target)', done => { const test = Context.ROOT_CONTEXT.setValue(key1, 1); - scopeManager.with(test, () => { - assert.strictEqual(scopeManager.active(), test, 'should have scope'); + contextManager.with(test, () => { + assert.strictEqual(contextManager.active(), test, 'should have context'); return done(); }); }); it('should run the callback (when disabled)', done => { - scopeManager.disable(); - scopeManager.with(null, () => { - scopeManager.enable(); + contextManager.disable(); + contextManager.with(null, () => { + contextManager.enable(); return done(); }); }); it('should rethrow errors', done => { assert.throws(() => { - scopeManager.with(null, () => { + contextManager.with(null, () => { throw new Error('This should be rethrown'); }); }); return done(); }); - it('should finally restore an old scope, including the async task', done => { - const scope1 = Context.ROOT_CONTEXT.setValue(key1, 'scope1'); - const scope2 = Context.ROOT_CONTEXT.setValue(key1, 'scope2'); - const scope3 = Context.ROOT_CONTEXT.setValue(key1, 'scope3'); - - scopeManager.with(scope1, () => { - assert.strictEqual(scopeManager.active(), scope1); - scopeManager.with(scope2, () => { - assert.strictEqual(scopeManager.active(), scope2); - scopeManager.with(scope3, () => { - assert.strictEqual(scopeManager.active(), scope3); + it('should finally restore an old context, including the async task', done => { + const ctx1 = Context.ROOT_CONTEXT.setValue(key1, 'ctx1'); + const ctx2 = Context.ROOT_CONTEXT.setValue(key1, 'ctx2'); + const ctx3 = Context.ROOT_CONTEXT.setValue(key1, 'ctx3'); + + contextManager.with(ctx1, () => { + assert.strictEqual(contextManager.active(), ctx1); + contextManager.with(ctx2, () => { + assert.strictEqual(contextManager.active(), ctx2); + contextManager.with(ctx3, () => { + assert.strictEqual(contextManager.active(), ctx3); }); - assert.strictEqual(scopeManager.active(), scope2); + assert.strictEqual(contextManager.active(), ctx2); }); - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); setTimeout(() => { - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); done(); }, 500); clock.tick(500); }); - assert.strictEqual(scopeManager.active(), window); + assert.strictEqual(contextManager.active(), window); }); - it('should finally restore an old scope when scope is an object, including the async task', done => { - const scope1 = Context.ROOT_CONTEXT.setValue(key1, 1); - const scope2 = Context.ROOT_CONTEXT.setValue(key1, 2); - const scope3 = Context.ROOT_CONTEXT.setValue(key1, 3); - scopeManager.with(scope1, () => { - assert.strictEqual(scopeManager.active(), scope1); - scopeManager.with(scope2, () => { - assert.strictEqual(scopeManager.active(), scope2); - scopeManager.with(scope3, () => { - assert.strictEqual(scopeManager.active(), scope3); + it('should finally restore an old context when context is an object, including the async task', done => { + const ctx1 = Context.ROOT_CONTEXT.setValue(key1, 1); + const ctx2 = Context.ROOT_CONTEXT.setValue(key1, 2); + const ctx3 = Context.ROOT_CONTEXT.setValue(key1, 3); + contextManager.with(ctx1, () => { + assert.strictEqual(contextManager.active(), ctx1); + contextManager.with(ctx2, () => { + assert.strictEqual(contextManager.active(), ctx2); + contextManager.with(ctx3, () => { + assert.strictEqual(contextManager.active(), ctx3); }); - assert.strictEqual(scopeManager.active(), scope2); + assert.strictEqual(contextManager.active(), ctx2); }); - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); setTimeout(() => { - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); done(); }, 500); clock.tick(500); }); - assert.strictEqual(scopeManager.active(), window); + assert.strictEqual(contextManager.active(), window); }); - it('should correctly return the scopes for 3 parallel actions', () => { + it('should correctly return the contexts for 3 parallel actions', () => { const rootSpan = Context.ROOT_CONTEXT.setValue(key1, 'root'); - scopeManager.with(rootSpan, () => { + contextManager.with(rootSpan, () => { assert.ok( - scopeManager.active().getValue(key1) === 'root', + contextManager.active().getValue(key1) === 'root', 'Current span is rootSpan' ); const concurrentSpan1 = Context.ROOT_CONTEXT.setValue( @@ -161,28 +161,28 @@ describe('ZoneScopeManager', () => { 'concurrentSpan3' ); - scopeManager.with(concurrentSpan1, () => { + contextManager.with(concurrentSpan1, () => { setTimeout(() => { assert.ok( - scopeManager.active().getValue(key2) === concurrentSpan1, + contextManager.active().getValue(key2) === concurrentSpan1, 'Current span is concurrentSpan1' ); }, 10); }); - scopeManager.with(concurrentSpan2, () => { + contextManager.with(concurrentSpan2, () => { setTimeout(() => { assert.ok( - scopeManager.active().getValue(key2) === concurrentSpan2, + contextManager.active().getValue(key2) === concurrentSpan2, 'Current span is concurrentSpan2' ); }, 20); }); - scopeManager.with(concurrentSpan3, () => { + contextManager.with(concurrentSpan3, () => { setTimeout(() => { assert.ok( - scopeManager.active().getValue(key2) === concurrentSpan3, + contextManager.active().getValue(key2) === concurrentSpan3, 'Current span is concurrentSpan3' ); }, 30); @@ -192,7 +192,7 @@ describe('ZoneScopeManager', () => { }); describe('.bind(function)', () => { - it('should call the function with previously assigned scope', () => { + it('should call the function with previously assigned context', () => { class Obj { title: string; @@ -201,7 +201,7 @@ describe('ZoneScopeManager', () => { } getTitle() { - return (scopeManager.active().getValue(key1) as Obj).title; + return (contextManager.active().getValue(key1) as Obj).title; } } @@ -209,61 +209,61 @@ describe('ZoneScopeManager', () => { const ctx = Context.ROOT_CONTEXT.setValue(key1, obj1); obj1.title = 'a2'; const obj2 = new Obj('b1'); - const wrapper: any = scopeManager.bind(obj2.getTitle, ctx); + const wrapper: any = contextManager.bind(obj2.getTitle, ctx); assert.ok(wrapper(), 'a2'); }); it('should return the same target (when enabled)', () => { const test = { a: 1 }; assert.deepStrictEqual( - scopeManager.bind(test, Context.ROOT_CONTEXT), + contextManager.bind(test, Context.ROOT_CONTEXT), test ); }); it('should return the same target (when disabled)', () => { - scopeManager.disable(); + contextManager.disable(); const test = { a: 1 }; assert.deepStrictEqual( - scopeManager.bind(test, Context.ROOT_CONTEXT), + contextManager.bind(test, Context.ROOT_CONTEXT), test ); - scopeManager.enable(); + contextManager.enable(); }); - it('should return current scope (when enabled)', done => { - const scope = Context.ROOT_CONTEXT.setValue(key1, { a: 1 }); - const fn: any = scopeManager.bind(() => { - assert.strictEqual(scopeManager.active(), scope, 'should have scope'); + it('should return current context (when enabled)', done => { + const context = Context.ROOT_CONTEXT.setValue(key1, { a: 1 }); + const fn: any = contextManager.bind(() => { + assert.strictEqual(contextManager.active(), context, 'should have context'); return done(); - }, scope); + }, context); fn(); }); - it('should return root scope (when disabled)', done => { - scopeManager.disable(); - const scope = Context.ROOT_CONTEXT.setValue(key1, { a: 1 }); - const fn: any = scopeManager.bind(() => { + it('should return root context (when disabled)', done => { + contextManager.disable(); + const context = Context.ROOT_CONTEXT.setValue(key1, { a: 1 }); + const fn: any = contextManager.bind(() => { assert.strictEqual( - scopeManager.active(), + contextManager.active(), Context.ROOT_CONTEXT, - 'should have scope' + 'should have context' ); return done(); - }, scope); + }, context); fn(); }); - it('should bind the the certain scope to the target "addEventListener" function', done => { - const scope1 = Context.ROOT_CONTEXT.setValue(key1, 1); + it('should bind the the certain context to the target "addEventListener" function', done => { + const ctx1 = Context.ROOT_CONTEXT.setValue(key1, 1); const element = document.createElement('div'); - scopeManager.bind(element, scope1); + contextManager.bind(element, ctx1); element.addEventListener('click', () => { - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); setTimeout(() => { - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); done(); }, 500); clock.tick(500); @@ -279,21 +279,21 @@ describe('ZoneScopeManager', () => { }); it('should preserve zone when creating new click event inside zone', done => { - const scope1 = Context.ROOT_CONTEXT.setValue(key1, 1); + const ctx1 = Context.ROOT_CONTEXT.setValue(key1, 1); const element = document.createElement('div'); - scopeManager.bind(element, scope1); + contextManager.bind(element, ctx1); element.addEventListener('click', () => { - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); setTimeout(() => { - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); const element2 = document.createElement('div'); element2.addEventListener('click', () => { - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); setTimeout(() => { - assert.strictEqual(scopeManager.active(), scope1); + assert.strictEqual(contextManager.active(), ctx1); done(); }, 500); clock.tick(500); diff --git a/packages/opentelemetry-scope-zone-peer-dep/test/index-webpack.ts b/packages/opentelemetry-context-zone-peer-dep/test/index-webpack.ts similarity index 100% rename from packages/opentelemetry-scope-zone-peer-dep/test/index-webpack.ts rename to packages/opentelemetry-context-zone-peer-dep/test/index-webpack.ts diff --git a/packages/opentelemetry-scope-zone-peer-dep/test/utils.test.ts b/packages/opentelemetry-context-zone-peer-dep/test/utils.test.ts similarity index 97% rename from packages/opentelemetry-scope-zone-peer-dep/test/utils.test.ts rename to packages/opentelemetry-context-zone-peer-dep/test/utils.test.ts index 790bbb28fb..b0b7fab844 100644 --- a/packages/opentelemetry-scope-zone-peer-dep/test/utils.test.ts +++ b/packages/opentelemetry-context-zone-peer-dep/test/utils.test.ts @@ -17,7 +17,7 @@ import * as assert from 'assert'; import * as utils from '../src/util'; -describe('ZoneScopeManager utils', () => { +describe('ZoneContextManager utils', () => { describe('isListenerObject', () => { describe('when object contains "addEventListener" and "removeEventListener"', () => { it('should return true', () => { diff --git a/packages/opentelemetry-scope-zone-peer-dep/tsconfig.json b/packages/opentelemetry-context-zone-peer-dep/tsconfig.json similarity index 100% rename from packages/opentelemetry-scope-zone-peer-dep/tsconfig.json rename to packages/opentelemetry-context-zone-peer-dep/tsconfig.json diff --git a/packages/opentelemetry-scope-zone-peer-dep/tslint.json b/packages/opentelemetry-context-zone-peer-dep/tslint.json similarity index 100% rename from packages/opentelemetry-scope-zone-peer-dep/tslint.json rename to packages/opentelemetry-context-zone-peer-dep/tslint.json diff --git a/packages/opentelemetry-scope-zone/LICENSE b/packages/opentelemetry-context-zone/LICENSE similarity index 100% rename from packages/opentelemetry-scope-zone/LICENSE rename to packages/opentelemetry-context-zone/LICENSE diff --git a/packages/opentelemetry-scope-zone/README.md b/packages/opentelemetry-context-zone/README.md similarity index 73% rename from packages/opentelemetry-scope-zone/README.md rename to packages/opentelemetry-context-zone/README.md index 3ab2fd1f1c..0b23b884d3 100644 --- a/packages/opentelemetry-scope-zone/README.md +++ b/packages/opentelemetry-context-zone/README.md @@ -1,33 +1,33 @@ -# OpenTelemetry Scope Zone +# OpenTelemetry Context Zone [![Gitter chat][gitter-image]][gitter-url] [![NPM Published Version][npm-img]][npm-url] [![dependencies][dependencies-image]][dependencies-url] [![devDependencies][devDependencies-image]][devDependencies-url] [![Apache License][license-image]][license-image] -This module provides *Zone Scope Manager with bundled [zone-js]* for Web applications. -If you have your own [zone-js] please use [@opentelemetry/scope-zone-peer-dep] -If you use Angular it means you already have the [zone-js] and you should use [@opentelemetry/scope-zone-peer-dep] +This module provides *Zone Context Manager with bundled [zone-js]* for Web applications. +If you have your own [zone-js] please use [@opentelemetry/context-zone-peer-dep] +If you use Angular it means you already have the [zone-js] and you should use [@opentelemetry/context-zone-peer-dep] ## Installation ```bash -npm install --save @opentelemetry/scope-zone +npm install --save @opentelemetry/context-zone ``` ## Usage ```js import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; import { WebTracer } from '@opentelemetry/web'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone'; +import { ZoneContextManager } from '@opentelemetry/context-zone'; const webTracerWithZone = new WebTracer({ - scopeManager: new ZoneScopeManager() + contextManager: new ZoneContextManager() }); webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); -// Example how the ZoneScopeManager keeps the reference to the correct scope during async operations +// Example how the ZoneContextManager keeps the reference to the correct context during async operations const span1 = webTracerWithZone.startSpan('foo1'); webTracerWithZone.withSpan(span1, () => { console.log('Current span is span1', webTracerWithZone.getCurrentSpan() === span1); @@ -61,11 +61,11 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge [license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat -[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-scope-zone -[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-zone -[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-scope-zone +[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-context-zone +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-context-zone +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-context-zone [devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-web&type=dev -[npm-url]: https://www.npmjs.com/package/@opentelemetry/scope-zone -[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fscope-zone.svg +[npm-url]: https://www.npmjs.com/package/@opentelemetry/context-zone +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fcontext-zone.svg [zone-js]: https://www.npmjs.com/package/zone.js -[@opentelemetry/scope-zone-peer-dep]: https://www.npmjs.com/package/@opentelemetry/scope-zone-peer-dep +[@opentelemetry/context-zone-peer-dep]: https://www.npmjs.com/package/@opentelemetry/context-zone-peer-dep diff --git a/packages/opentelemetry-scope-zone/package.json b/packages/opentelemetry-context-zone/package.json similarity index 92% rename from packages/opentelemetry-scope-zone/package.json rename to packages/opentelemetry-context-zone/package.json index f67fb427d5..d26bc9ede0 100644 --- a/packages/opentelemetry-scope-zone/package.json +++ b/packages/opentelemetry-context-zone/package.json @@ -1,7 +1,7 @@ { - "name": "@opentelemetry/scope-zone", + "name": "@opentelemetry/context-zone", "version": "0.4.0", - "description": "OpenTelemetry Scope Zone", + "description": "OpenTelemetry Context Zone", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js", @@ -66,7 +66,7 @@ "webpack-merge": "^4.2.2" }, "dependencies": { - "@opentelemetry/scope-zone-peer-dep": "^0.4.0", + "@opentelemetry/context-zone-peer-dep": "^0.4.0", "zone.js": "^0.10.2" }, "sideEffects": true diff --git a/packages/opentelemetry-scope-zone/src/index.ts b/packages/opentelemetry-context-zone/src/index.ts similarity index 92% rename from packages/opentelemetry-scope-zone/src/index.ts rename to packages/opentelemetry-context-zone/src/index.ts index 425ddebfda..cd86de18ab 100644 --- a/packages/opentelemetry-scope-zone/src/index.ts +++ b/packages/opentelemetry-context-zone/src/index.ts @@ -14,5 +14,5 @@ * limitations under the License. */ -export * from '@opentelemetry/scope-zone-peer-dep'; +export * from '@opentelemetry/context-zone-peer-dep'; import 'zone.js'; diff --git a/packages/opentelemetry-scope-zone/src/version.ts b/packages/opentelemetry-context-zone/src/version.ts similarity index 100% rename from packages/opentelemetry-scope-zone/src/version.ts rename to packages/opentelemetry-context-zone/src/version.ts diff --git a/packages/opentelemetry-scope-zone/tsconfig.json b/packages/opentelemetry-context-zone/tsconfig.json similarity index 100% rename from packages/opentelemetry-scope-zone/tsconfig.json rename to packages/opentelemetry-context-zone/tsconfig.json diff --git a/packages/opentelemetry-scope-zone/tslint.json b/packages/opentelemetry-context-zone/tslint.json similarity index 100% rename from packages/opentelemetry-scope-zone/tslint.json rename to packages/opentelemetry-context-zone/tslint.json diff --git a/packages/opentelemetry-core/package.json b/packages/opentelemetry-core/package.json index 3d8e3f54fa..572780252d 100644 --- a/packages/opentelemetry-core/package.json +++ b/packages/opentelemetry-core/package.json @@ -79,7 +79,7 @@ }, "dependencies": { "@opentelemetry/api": "^0.4.0", - "@opentelemetry/scope-base": "^0.4.0", + "@opentelemetry/context-base": "^0.4.0", "semver": "^6.3.0" } } diff --git a/packages/opentelemetry-core/src/context/context.ts b/packages/opentelemetry-core/src/context/context.ts index 0ae080b3ed..e0a33a415c 100644 --- a/packages/opentelemetry-core/src/context/context.ts +++ b/packages/opentelemetry-core/src/context/context.ts @@ -15,7 +15,7 @@ */ import { Span, SpanContext } from '@opentelemetry/api'; -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; const ACTIVE_SPAN_KEY = Context.createKey( 'OpenTelemetry Context Key ACTIVE_SPAN' diff --git a/packages/opentelemetry-core/test/context/B3Format.test.ts b/packages/opentelemetry-core/test/context/B3Format.test.ts index df244b1f9c..90b123bdef 100644 --- a/packages/opentelemetry-core/test/context/B3Format.test.ts +++ b/packages/opentelemetry-core/test/context/B3Format.test.ts @@ -20,7 +20,7 @@ import { SpanContext, TraceFlags, } from '@opentelemetry/api'; -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; import * as assert from 'assert'; import { getExtractedSpanContext, diff --git a/packages/opentelemetry-core/test/context/HttpTraceContext.test.ts b/packages/opentelemetry-core/test/context/HttpTraceContext.test.ts index 778ea9029c..c9f524ec37 100644 --- a/packages/opentelemetry-core/test/context/HttpTraceContext.test.ts +++ b/packages/opentelemetry-core/test/context/HttpTraceContext.test.ts @@ -20,7 +20,7 @@ import { SpanContext, TraceFlags, } from '@opentelemetry/api'; -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; import * as assert from 'assert'; import { getExtractedSpanContext, diff --git a/packages/opentelemetry-core/test/context/composite.test.ts b/packages/opentelemetry-core/test/context/composite.test.ts index 396f566558..364d3e3229 100644 --- a/packages/opentelemetry-core/test/context/composite.test.ts +++ b/packages/opentelemetry-core/test/context/composite.test.ts @@ -20,7 +20,7 @@ import { HttpTextFormat, SpanContext, } from '@opentelemetry/api'; -import { Context } from '@opentelemetry/scope-base'; +import { Context } from '@opentelemetry/context-base'; import * as assert from 'assert'; import { CompositePropagator, diff --git a/packages/opentelemetry-node/README.md b/packages/opentelemetry-node/README.md index cc7ef3dae9..8836a98440 100644 --- a/packages/opentelemetry-node/README.md +++ b/packages/opentelemetry-node/README.md @@ -27,7 +27,7 @@ This is done by wrapping all tracing-relevant functions. This instrumentation code will automatically - extract a trace-context identifier from inbound requests to allow distributed tracing (if applicable) -- make sure that this current trace-context is propagated while the transaction traverses an application (see [@opentelemetry/opentelemetry-scope-base](https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-scope-base/README.md) for an in-depth explanation) +- make sure that this current trace-context is propagated while the transaction traverses an application (see [@opentelemetry/opentelemetry-context-base](https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-context-base/README.md) for an in-depth explanation) - add this trace-context identifier to outbound requests to allow continuing the distributed trace on the next hop (if applicable) - create and end spans diff --git a/packages/opentelemetry-node/package.json b/packages/opentelemetry-node/package.json index 6e3f195755..626ef9b43c 100644 --- a/packages/opentelemetry-node/package.json +++ b/packages/opentelemetry-node/package.json @@ -44,7 +44,7 @@ "@opentelemetry/resources": "^0.4.0", "@types/mocha": "^5.2.5", "@types/node": "^12.6.8", - "@opentelemetry/scope-base": "^0.4.0", + "@opentelemetry/context-base": "^0.4.0", "@types/semver": "^6.0.1", "@types/shimmer": "^1.0.1", "codecov": "^3.6.1", @@ -62,7 +62,7 @@ "dependencies": { "@opentelemetry/api": "^0.4.0", "@opentelemetry/core": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "require-in-the-middle": "^5.0.0", "semver": "^6.2.0" diff --git a/packages/opentelemetry-node/src/NodeTracerProvider.ts b/packages/opentelemetry-node/src/NodeTracerProvider.ts index 8cb200541b..11a0874e5e 100644 --- a/packages/opentelemetry-node/src/NodeTracerProvider.ts +++ b/packages/opentelemetry-node/src/NodeTracerProvider.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import { BasicTracerProvider, SDKRegistrationConfig, @@ -48,7 +48,7 @@ export class NodeTracerProvider extends BasicTracerProvider { register(config: SDKRegistrationConfig = {}) { if (config.contextManager === undefined) { - config.contextManager = new AsyncHooksScopeManager(); + config.contextManager = new AsyncHooksContextManager(); config.contextManager.enable(); } diff --git a/packages/opentelemetry-node/test/NodeTracerProvider.test.ts b/packages/opentelemetry-node/test/NodeTracerProvider.test.ts index 8a098598f6..1cd0298e62 100644 --- a/packages/opentelemetry-node/test/NodeTracerProvider.test.ts +++ b/packages/opentelemetry-node/test/NodeTracerProvider.test.ts @@ -22,12 +22,12 @@ import { NoRecordingSpan, setActiveSpan, } from '@opentelemetry/core'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import { Span } from '@opentelemetry/tracing'; import { Resource, TELEMETRY_SDK_RESOURCE } from '@opentelemetry/resources'; import * as assert from 'assert'; import * as path from 'path'; -import { ScopeManager } from '../../opentelemetry-scope-base/build/src'; +import { ContextManager } from '@opentelemetry/context-base'; import { NodeTracerProvider } from '../src/NodeTracerProvider'; const sleep = (time: number) => @@ -43,21 +43,21 @@ const INSTALLED_PLUGINS_PATH = path.join( describe('NodeTracerProvider', () => { let provider: NodeTracerProvider; - let scopeManager: ScopeManager; + let contextManager: ContextManager; before(() => { module.paths.push(INSTALLED_PLUGINS_PATH); }); beforeEach(() => { - scopeManager = new AsyncHooksScopeManager(); - context.setGlobalContextManager(scopeManager.enable()); + contextManager = new AsyncHooksContextManager(); + context.setGlobalContextManager(contextManager.enable()); }); afterEach(() => { // clear require cache Object.keys(require.cache).forEach(key => delete require.cache[key]); provider.stop(); - scopeManager.disable(); + contextManager.disable(); }); describe('constructor', () => { @@ -175,7 +175,7 @@ describe('NodeTracerProvider', () => { }); describe('.getCurrentSpan()', () => { - it('should return undefined with AsyncHooksScopeManager when no span started', () => { + it('should return undefined with AsyncHooksContextManager when no span started', () => { provider = new NodeTracerProvider({}); assert.deepStrictEqual( provider.getTracer('default').getCurrentSpan(), @@ -185,7 +185,7 @@ describe('NodeTracerProvider', () => { }); describe('.withSpan()', () => { - it('should run scope with AsyncHooksScopeManager scope manager', done => { + it('should run context with AsyncHooksContextManager context manager', done => { provider = new NodeTracerProvider({}); const span = provider.getTracer('default').startSpan('my-span'); provider.getTracer('default').withSpan(span, () => { @@ -201,7 +201,7 @@ describe('NodeTracerProvider', () => { ); }); - it('should run scope with AsyncHooksScopeManager scope manager with multiple spans', done => { + it('should run context with AsyncHooksContextManager context manager with multiple spans', done => { provider = new NodeTracerProvider({}); const span = provider.getTracer('default').startSpan('my-span'); provider.getTracer('default').withSpan(span, () => { @@ -232,7 +232,7 @@ describe('NodeTracerProvider', () => { ); }); - it('should find correct scope with promises', async () => { + it('should find correct context with promises', async () => { provider = new NodeTracerProvider(); const span = provider.getTracer('default').startSpan('my-span'); await provider.getTracer('default').withSpan(span, async () => { @@ -253,7 +253,7 @@ describe('NodeTracerProvider', () => { }); describe('.bind()', () => { - it('should bind scope with AsyncHooksScopeManager scope manager', done => { + it('should bind context with AsyncHooksContextManager context manager', done => { const provider = new NodeTracerProvider({}); const span = provider.getTracer('default').startSpan('my-span'); const fn = () => { diff --git a/packages/opentelemetry-node/test/registration.test.ts b/packages/opentelemetry-node/test/registration.test.ts index 378abf1be9..d0c5af9937 100644 --- a/packages/opentelemetry-node/test/registration.test.ts +++ b/packages/opentelemetry-node/test/registration.test.ts @@ -22,14 +22,14 @@ import { trace, } from '@opentelemetry/api'; import { HttpTraceContext } from '@opentelemetry/core'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; -import { NoopScopeManager } from '@opentelemetry/scope-base'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; +import { NoopContextManager } from '@opentelemetry/context-base'; import * as assert from 'assert'; import { NodeTracerProvider } from '../src'; describe('API registration', () => { beforeEach(() => { - context.setGlobalContextManager(new NoopScopeManager()); + context.setGlobalContextManager(new NoopContextManager()); propagation.setGlobalPropagator(new NoopHttpTextFormat()); trace.setGlobalTracerProvider(new NoopTracerProvider()); }); @@ -38,7 +38,7 @@ describe('API registration', () => { const tracerProvider = new NodeTracerProvider(); tracerProvider.register(); - assert.ok(context['_scopeManager'] instanceof AsyncHooksScopeManager); + assert.ok(context['_contextManager'] instanceof AsyncHooksContextManager); assert.ok(propagation['_propagator'] instanceof HttpTraceContext); assert.ok(trace['_tracerProvider'] === tracerProvider); }); @@ -46,7 +46,7 @@ describe('API registration', () => { it('should register configured implementations', () => { const tracerProvider = new NodeTracerProvider(); - const contextManager = new NoopScopeManager(); + const contextManager = new NoopContextManager(); const propagator = new NoopHttpTextFormat(); tracerProvider.register({ @@ -54,7 +54,7 @@ describe('API registration', () => { propagator, }); - assert.ok(context['_scopeManager'] === contextManager); + assert.ok(context['_contextManager'] === contextManager); assert.ok(propagation['_propagator'] === propagator); assert.ok(trace['_tracerProvider'] === tracerProvider); @@ -66,7 +66,7 @@ describe('API registration', () => { contextManager: null, }); - assert.ok(context['_scopeManager'] instanceof NoopScopeManager); + assert.ok(context['_contextManager'] instanceof NoopContextManager); assert.ok(propagation['_propagator'] instanceof HttpTraceContext); assert.ok(trace['_tracerProvider'] === tracerProvider); @@ -80,7 +80,7 @@ describe('API registration', () => { assert.ok(propagation['_propagator'] instanceof NoopHttpTextFormat); - assert.ok(context['_scopeManager'] instanceof AsyncHooksScopeManager); + assert.ok(context['_contextManager'] instanceof AsyncHooksContextManager); assert.ok(trace['_tracerProvider'] === tracerProvider); }); }); diff --git a/packages/opentelemetry-plugin-document-load/test/documentLoad.test.ts b/packages/opentelemetry-plugin-document-load/test/documentLoad.test.ts index 4d20f57117..2ec83f7654 100644 --- a/packages/opentelemetry-plugin-document-load/test/documentLoad.test.ts +++ b/packages/opentelemetry-plugin-document-load/test/documentLoad.test.ts @@ -38,7 +38,7 @@ import { } from '@opentelemetry/tracing'; import { PerformanceTimingNames as PTN, - StackScopeManager, + StackContextManager, } from '@opentelemetry/web'; import * as assert from 'assert'; import * as sinon from 'sinon'; @@ -209,11 +209,11 @@ describe('DocumentLoad Plugin', () => { let config: PluginConfig; let spanProcessor: SimpleSpanProcessor; let dummyExporter: DummyExporter; - let scopeManager: StackScopeManager; + let contextManager: StackContextManager; beforeEach(() => { - scopeManager = new StackScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new StackContextManager().enable(); + context.setGlobalContextManager(contextManager); Object.defineProperty(window.document, 'readyState', { writable: true, value: 'complete', @@ -229,7 +229,7 @@ describe('DocumentLoad Plugin', () => { }); afterEach(() => { - scopeManager.disable(); + contextManager.disable(); Object.defineProperty(window.document, 'readyState', { writable: true, value: 'complete', diff --git a/packages/opentelemetry-plugin-express/package.json b/packages/opentelemetry-plugin-express/package.json index 400ff9ef1f..5f4a9f0e06 100644 --- a/packages/opentelemetry-plugin-express/package.json +++ b/packages/opentelemetry-plugin-express/package.json @@ -42,7 +42,7 @@ }, "devDependencies": { "@opentelemetry/node": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/express": "^4.17.2", "@types/mocha": "^5.2.7", diff --git a/packages/opentelemetry-plugin-express/src/express.ts b/packages/opentelemetry-plugin-express/src/express.ts index 7800cf67dc..b519ad0cbc 100644 --- a/packages/opentelemetry-plugin-express/src/express.ts +++ b/packages/opentelemetry-plugin-express/src/express.ts @@ -158,7 +158,7 @@ export class ExpressPlugin extends BasePlugin { } as any; } - /** Patch each express layer to create span and propagate scope */ + /** Patch each express layer to create span and propagate context */ private _applyPatch(layer: ExpressLayer, layerPath?: string) { const plugin = this; if (layer[kLayerPatched] === true) return; diff --git a/packages/opentelemetry-plugin-express/test/express.test.ts b/packages/opentelemetry-plugin-express/test/express.test.ts index 794b9cbaf2..195381d643 100644 --- a/packages/opentelemetry-plugin-express/test/express.test.ts +++ b/packages/opentelemetry-plugin-express/test/express.test.ts @@ -17,7 +17,7 @@ import { context } from '@opentelemetry/api'; import { NoopLogger } from '@opentelemetry/core'; import { NodeTracerProvider } from '@opentelemetry/node'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import { InMemorySpanExporter, SimpleSpanProcessor, @@ -59,20 +59,20 @@ describe('Express Plugin', () => { const spanProcessor = new SimpleSpanProcessor(memoryExporter); provider.addSpanProcessor(spanProcessor); const tracer = provider.getTracer('default'); - let scopeManager: AsyncHooksScopeManager; + let contextManager: AsyncHooksContextManager; before(() => { plugin.enable(express, provider, logger); }); beforeEach(() => { - scopeManager = new AsyncHooksScopeManager(); - context.setGlobalContextManager(scopeManager.enable()); + contextManager = new AsyncHooksContextManager(); + context.setGlobalContextManager(contextManager.enable()); }); afterEach(() => { memoryExporter.reset(); - scopeManager.disable(); + contextManager.disable(); }); describe('Instrumenting normal get operations', () => { diff --git a/packages/opentelemetry-plugin-grpc/package.json b/packages/opentelemetry-plugin-grpc/package.json index 2cd07f8d1f..77b1fb9b0c 100644 --- a/packages/opentelemetry-plugin-grpc/package.json +++ b/packages/opentelemetry-plugin-grpc/package.json @@ -42,8 +42,8 @@ }, "devDependencies": { "@opentelemetry/node": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", - "@opentelemetry/scope-base": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", + "@opentelemetry/context-base": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/mocha": "^5.2.7", "@types/node": "^12.6.9", diff --git a/packages/opentelemetry-plugin-grpc/test/grpc.test.ts b/packages/opentelemetry-plugin-grpc/test/grpc.test.ts index 13883d0cbe..56ad4f09bf 100644 --- a/packages/opentelemetry-plugin-grpc/test/grpc.test.ts +++ b/packages/opentelemetry-plugin-grpc/test/grpc.test.ts @@ -22,8 +22,8 @@ import { } from '@opentelemetry/api'; import { NoopLogger, HttpTraceContext } from '@opentelemetry/core'; import { NodeTracerProvider } from '@opentelemetry/node'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; -import { ScopeManager } from '@opentelemetry/scope-base'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; +import { ContextManager } from '@opentelemetry/context-base'; import { InMemorySpanExporter, SimpleSpanProcessor, @@ -300,19 +300,19 @@ function createClient(grpc: GrpcModule, proto: any) { } describe('GrpcPlugin', () => { - let scopeManger: ScopeManager; + let contextManager: ContextManager; before(() => { propagation.setGlobalPropagator(new HttpTraceContext()); }); beforeEach(() => { - scopeManger = new AsyncHooksScopeManager().enable(); - context.setGlobalContextManager(scopeManger); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); }); afterEach(() => { - scopeManger.disable(); + contextManager.disable(); }); it('should return a plugin', () => { diff --git a/packages/opentelemetry-plugin-http/package.json b/packages/opentelemetry-plugin-http/package.json index 384f16d0ce..23bfc1f3ab 100644 --- a/packages/opentelemetry-plugin-http/package.json +++ b/packages/opentelemetry-plugin-http/package.json @@ -42,8 +42,8 @@ }, "devDependencies": { "@opentelemetry/node": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", - "@opentelemetry/scope-base": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", + "@opentelemetry/context-base": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/got": "^9.6.7", "@types/mocha": "^5.2.7", diff --git a/packages/opentelemetry-plugin-http/test/functionals/http-enable.test.ts b/packages/opentelemetry-plugin-http/test/functionals/http-enable.test.ts index 1d3cc2f7f1..94c9c410f6 100644 --- a/packages/opentelemetry-plugin-http/test/functionals/http-enable.test.ts +++ b/packages/opentelemetry-plugin-http/test/functionals/http-enable.test.ts @@ -38,8 +38,8 @@ import { OT_REQUEST_HEADER } from '../../src/utils'; import { assertSpan } from '../utils/assertSpan'; import { DummyPropagation } from '../utils/DummyPropagation'; import { httpRequest } from '../utils/httpRequest'; -import { ScopeManager } from '@opentelemetry/scope-base'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { ContextManager } from '@opentelemetry/context-base'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; const applyCustomAttributesOnSpanErrorMessage = 'bad applyCustomAttributesOnSpan function'; @@ -77,15 +77,15 @@ export const customAttributeFunction = (span: ISpan): void => { }; describe('HttpPlugin', () => { - let scopeManger: ScopeManager; + let contextManager: ContextManager; beforeEach(() => { - scopeManger = new AsyncHooksScopeManager().enable(); - context.setGlobalContextManager(scopeManger); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); }); afterEach(() => { - scopeManger.disable(); + contextManager.disable(); }); it('should return a plugin', () => { diff --git a/packages/opentelemetry-plugin-https/package.json b/packages/opentelemetry-plugin-https/package.json index 12ea4c4398..eb78dfdf8e 100644 --- a/packages/opentelemetry-plugin-https/package.json +++ b/packages/opentelemetry-plugin-https/package.json @@ -42,8 +42,8 @@ }, "devDependencies": { "@opentelemetry/node": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", - "@opentelemetry/scope-base": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", + "@opentelemetry/context-base": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/got": "^9.6.7", "@types/mocha": "^5.2.7", diff --git a/packages/opentelemetry-plugin-https/test/functionals/https-enable.test.ts b/packages/opentelemetry-plugin-https/test/functionals/https-enable.test.ts index 9a4586030e..16ed7f67e8 100644 --- a/packages/opentelemetry-plugin-https/test/functionals/https-enable.test.ts +++ b/packages/opentelemetry-plugin-https/test/functionals/https-enable.test.ts @@ -29,8 +29,8 @@ import { HttpPluginConfig, OT_REQUEST_HEADER, } from '@opentelemetry/plugin-http'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; -import { ScopeManager } from '@opentelemetry/scope-base'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; +import { ContextManager } from '@opentelemetry/context-base'; import { InMemorySpanExporter, SimpleSpanProcessor, @@ -83,15 +83,15 @@ export const customAttributeFunction = (span: ISpan): void => { }; describe('HttpsPlugin', () => { - let scopeManger: ScopeManager; + let contextManager: ContextManager; beforeEach(() => { - scopeManger = new AsyncHooksScopeManager().enable(); - context.setGlobalContextManager(scopeManger); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); }); afterEach(() => { - scopeManger.disable(); + contextManager.disable(); }); it('should return a plugin', () => { diff --git a/packages/opentelemetry-plugin-ioredis/package.json b/packages/opentelemetry-plugin-ioredis/package.json index 7e1b5d31cf..12bbd17632 100644 --- a/packages/opentelemetry-plugin-ioredis/package.json +++ b/packages/opentelemetry-plugin-ioredis/package.json @@ -45,7 +45,7 @@ }, "devDependencies": { "@opentelemetry/node": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", "@opentelemetry/test-utils": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/ioredis": "^4.14.3", diff --git a/packages/opentelemetry-plugin-ioredis/test/ioredis.test.ts b/packages/opentelemetry-plugin-ioredis/test/ioredis.test.ts index 993dcfc89d..e5054f8832 100644 --- a/packages/opentelemetry-plugin-ioredis/test/ioredis.test.ts +++ b/packages/opentelemetry-plugin-ioredis/test/ioredis.test.ts @@ -17,7 +17,7 @@ import { CanonicalCode, context, SpanKind, Status } from '@opentelemetry/api'; import { NoopLogger } from '@opentelemetry/core'; import { NodeTracerProvider } from '@opentelemetry/node'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import * as testUtils from '@opentelemetry/test-utils'; import { InMemorySpanExporter, @@ -55,18 +55,18 @@ describe('ioredis', () => { const shouldTestLocal = process.env.RUN_REDIS_TESTS_LOCAL; const shouldTest = process.env.RUN_REDIS_TESTS || shouldTestLocal; - let scopeManager: AsyncHooksScopeManager; + let contextManager: AsyncHooksContextManager; beforeEach(() => { - scopeManager = new AsyncHooksScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); }); afterEach(() => { - scopeManager.disable(); + contextManager.disable(); }); before(function() { - // needs to be "function" to have MochaContext "this" scope + // needs to be "function" to have MochaContext "this" context if (!shouldTest) { // this.skip() workaround // https://github.com/mochajs/mocha/issues/2683#issuecomment-375629901 diff --git a/packages/opentelemetry-plugin-mongodb/package.json b/packages/opentelemetry-plugin-mongodb/package.json index 800f9824d5..c92ab76a90 100644 --- a/packages/opentelemetry-plugin-mongodb/package.json +++ b/packages/opentelemetry-plugin-mongodb/package.json @@ -42,7 +42,7 @@ }, "devDependencies": { "@opentelemetry/node": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/mocha": "^5.2.7", "@types/mongodb": "^3.2.3", diff --git a/packages/opentelemetry-plugin-mongodb/test/mongodb.test.ts b/packages/opentelemetry-plugin-mongodb/test/mongodb.test.ts index 0278a5d954..606025c7e2 100644 --- a/packages/opentelemetry-plugin-mongodb/test/mongodb.test.ts +++ b/packages/opentelemetry-plugin-mongodb/test/mongodb.test.ts @@ -17,7 +17,7 @@ import { CanonicalCode, context, SpanKind } from '@opentelemetry/api'; import { NoopLogger } from '@opentelemetry/core'; import { NodeTracerProvider } from '@opentelemetry/node'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import { InMemorySpanExporter, ReadableSpan, @@ -103,7 +103,7 @@ describe('MongoDBPlugin', () => { const DB_NAME = process.env.MONGODB_DB || 'opentelemetry-tests'; const COLLECTION_NAME = 'test'; - let scopeManager: AsyncHooksScopeManager; + let contextManager: AsyncHooksContextManager; let client: mongodb.MongoClient; let collection: mongodb.Collection; const logger = new NoopLogger(); @@ -142,13 +142,13 @@ describe('MongoDBPlugin', () => { collection.insertMany(insertData, (err, result) => { done(); }); - scopeManager = new AsyncHooksScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); }); afterEach(done => { collection.deleteOne({}, done); - scopeManager.disable(); + contextManager.disable(); }); after(() => { diff --git a/packages/opentelemetry-plugin-mysql/package.json b/packages/opentelemetry-plugin-mysql/package.json index 577b84b1d6..4e3c7ce0c0 100644 --- a/packages/opentelemetry-plugin-mysql/package.json +++ b/packages/opentelemetry-plugin-mysql/package.json @@ -42,7 +42,7 @@ }, "devDependencies": { "@opentelemetry/node": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", "@opentelemetry/test-utils": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/mocha": "^5.2.7", diff --git a/packages/opentelemetry-plugin-mysql/test/mysql.test.ts b/packages/opentelemetry-plugin-mysql/test/mysql.test.ts index b0b714fb68..9e1c608cb4 100644 --- a/packages/opentelemetry-plugin-mysql/test/mysql.test.ts +++ b/packages/opentelemetry-plugin-mysql/test/mysql.test.ts @@ -17,7 +17,7 @@ import { CanonicalCode, context } from '@opentelemetry/api'; import { NoopLogger } from '@opentelemetry/core'; import { NodeTracerProvider } from '@opentelemetry/node'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import * as testUtils from '@opentelemetry/test-utils'; import { InMemorySpanExporter, @@ -36,7 +36,7 @@ const user = process.env.MYSQL_USER || 'otel'; const password = process.env.MYSQL_PASSWORD || 'secret'; describe('mysql@2.x', () => { - let scopeManager: AsyncHooksScopeManager; + let contextManager: AsyncHooksContextManager; let connection: mysql.Connection; let pool: mysql.Pool; let poolCluster: mysql.PoolCluster; @@ -73,8 +73,8 @@ describe('mysql@2.x', () => { }); beforeEach(function() { - scopeManager = new AsyncHooksScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); plugin.enable(mysql, provider, logger); connection = mysql.createConnection({ port, @@ -101,7 +101,7 @@ describe('mysql@2.x', () => { }); afterEach(done => { - scopeManager.disable(); + contextManager.disable(); memoryExporter.reset(); plugin.disable(); connection.end(() => { diff --git a/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg-pool/package.json b/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg-pool/package.json index d03e4ceeb9..6a4b6b60b3 100644 --- a/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg-pool/package.json +++ b/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg-pool/package.json @@ -47,7 +47,7 @@ }, "devDependencies": { "@opentelemetry/plugin-pg": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", "@opentelemetry/test-utils": "^0.4.0", "@types/mocha": "^5.2.7", "@types/node": "^12.6.9", diff --git a/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg-pool/test/pg-pool.test.ts b/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg-pool/test/pg-pool.test.ts index 57356ac924..9dddc3b659 100644 --- a/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg-pool/test/pg-pool.test.ts +++ b/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg-pool/test/pg-pool.test.ts @@ -26,7 +26,7 @@ import { import { NoopLogger } from '@opentelemetry/core'; import { NodeTracerProvider } from '@opentelemetry/node'; import { plugin as pgPlugin, PostgresPlugin } from '@opentelemetry/plugin-pg'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import * as testUtils from '@opentelemetry/test-utils'; import { InMemorySpanExporter, @@ -94,7 +94,7 @@ const runCallbackTest = ( describe('pg-pool@2.x', () => { let pool: pgPool; - let scopeManager: AsyncHooksScopeManager; + let contextManager: AsyncHooksContextManager; const provider = new NodeTracerProvider(); const logger = new NoopLogger(); const testPostgres = process.env.RUN_POSTGRES_TESTS; // For CI: assumes local postgres db is already available @@ -128,15 +128,15 @@ describe('pg-pool@2.x', () => { beforeEach(function() { plugin.enable(pgPool, provider, logger); pgPlugin.enable(pg, provider, logger); - scopeManager = new AsyncHooksScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); }); afterEach(() => { memoryExporter.reset(); plugin.disable(); pgPlugin.disable(); - scopeManager.disable(); + contextManager.disable(); }); it('should return a plugin', () => { diff --git a/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg/package.json b/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg/package.json index fa3b18a722..9f99870aba 100644 --- a/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg/package.json +++ b/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg/package.json @@ -46,7 +46,7 @@ }, "devDependencies": { "@opentelemetry/node": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", "@opentelemetry/test-utils": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/mocha": "^5.2.7", diff --git a/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg/test/pg.test.ts b/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg/test/pg.test.ts index 4b0865eed2..7acfa4b97a 100644 --- a/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg/test/pg.test.ts +++ b/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg/test/pg.test.ts @@ -25,7 +25,7 @@ import { } from '@opentelemetry/api'; import { NoopLogger } from '@opentelemetry/core'; import { NodeTracerProvider } from '@opentelemetry/node'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import * as testUtils from '@opentelemetry/test-utils'; import { InMemorySpanExporter, @@ -83,7 +83,7 @@ const runCallbackTest = ( describe('pg@7.x', () => { let client: pg.Client; - let scopeManager: AsyncHooksScopeManager; + let contextManager: AsyncHooksContextManager; const provider = new NodeTracerProvider(); const tracer = provider.getTracer('external'); const logger = new NoopLogger(); @@ -120,14 +120,14 @@ describe('pg@7.x', () => { beforeEach(function() { plugin.enable(pg, provider, logger); - scopeManager = new AsyncHooksScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); }); afterEach(() => { memoryExporter.reset(); plugin.disable(); - scopeManager.disable(); + contextManager.disable(); }); it('should return a plugin', () => { diff --git a/packages/opentelemetry-plugin-redis/package.json b/packages/opentelemetry-plugin-redis/package.json index 14cfe0cae4..33a7946c47 100644 --- a/packages/opentelemetry-plugin-redis/package.json +++ b/packages/opentelemetry-plugin-redis/package.json @@ -44,7 +44,7 @@ }, "devDependencies": { "@opentelemetry/node": "^0.4.0", - "@opentelemetry/scope-async-hooks": "^0.4.0", + "@opentelemetry/context-async-hooks": "^0.4.0", "@opentelemetry/test-utils": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/mocha": "^5.2.7", diff --git a/packages/opentelemetry-plugin-redis/test/redis.test.ts b/packages/opentelemetry-plugin-redis/test/redis.test.ts index 881dd3becf..6d03a14d85 100644 --- a/packages/opentelemetry-plugin-redis/test/redis.test.ts +++ b/packages/opentelemetry-plugin-redis/test/redis.test.ts @@ -17,7 +17,7 @@ import { CanonicalCode, context, SpanKind, Status } from '@opentelemetry/api'; import { NoopLogger } from '@opentelemetry/core'; import { NodeTracerProvider } from '@opentelemetry/node'; -import { AsyncHooksScopeManager } from '@opentelemetry/scope-async-hooks'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; import * as testUtils from '@opentelemetry/test-utils'; import { InMemorySpanExporter, @@ -55,18 +55,18 @@ describe('redis@2.x', () => { const shouldTestLocal = process.env.RUN_REDIS_TESTS_LOCAL; const shouldTest = process.env.RUN_REDIS_TESTS || shouldTestLocal; - let scopeManager: AsyncHooksScopeManager; + let contextManager: AsyncHooksContextManager; beforeEach(() => { - scopeManager = new AsyncHooksScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new AsyncHooksContextManager().enable(); + context.setGlobalContextManager(contextManager); }); afterEach(() => { - scopeManager.disable(); + contextManager.disable(); }); before(function() { - // needs to be "function" to have MochaContext "this" scope + // needs to be "function" to have MochaContext "this" context if (!shouldTest) { // this.skip() workaround // https://github.com/mochajs/mocha/issues/2683#issuecomment-375629901 diff --git a/packages/opentelemetry-plugin-user-interaction/README.md b/packages/opentelemetry-plugin-user-interaction/README.md index b6c12018d1..64e994eb9c 100644 --- a/packages/opentelemetry-plugin-user-interaction/README.md +++ b/packages/opentelemetry-plugin-user-interaction/README.md @@ -7,8 +7,8 @@ This module provides auto instrumentation of user interaction for web. This module can work either with [zone-js] or without it. -With [zone-js] and ZoneScopeManager it will fully support the async operations. -If you use Angular you already have the [zone-js]. It will be the same if you use [@opentelemetry/scope-zone]. +With [zone-js] and ZoneContextManager it will fully support the async operations. +If you use Angular you already have the [zone-js]. It will be the same if you use [@opentelemetry/context-zone]. Without [zone-js] it will still work but with limited support. ## Installation @@ -23,12 +23,12 @@ npm install --save @opentelemetry/plugin-user-interaction import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; import { WebTracerProvider } from '@opentelemetry/web'; import { UserInteractionPlugin } from '@opentelemetry/plugin-user-interaction'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone'; +import { ZoneContextManager } from '@opentelemetry/context-zone'; // or if you already have zone.js -// import { ZoneScopeManager } from '@opentelemetry/scope-zone-peer-dep'; +// import { ZoneContextManager } from '@opentelemetry/context-zone-peer-dep'; const provider = new WebTracerProvider({ - scopeManager: new ZoneScopeManager(), // optional + contextManager: new ZoneContextManager(), // optional plugins: [ new UserInteractionPlugin() ] @@ -101,4 +101,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [npm-url]: https://www.npmjs.com/package/@opentelemetry/plugin-user-interaction [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fplugin-user-interaction.svg [zone-js]: https://www.npmjs.com/package/zone.js -[@opentelemetry/scope-zone]: https://www.npmjs.com/package/@opentelemetry/scope-zone +[@opentelemetry/context-zone]: https://www.npmjs.com/package/@opentelemetry/context-zone diff --git a/packages/opentelemetry-plugin-user-interaction/package.json b/packages/opentelemetry-plugin-user-interaction/package.json index 48cf263775..3d8a9659d1 100644 --- a/packages/opentelemetry-plugin-user-interaction/package.json +++ b/packages/opentelemetry-plugin-user-interaction/package.json @@ -44,7 +44,7 @@ "devDependencies": { "@babel/core": "^7.6.0", "@opentelemetry/plugin-xml-http-request": "^0.4.0", - "@opentelemetry/scope-zone-peer-dep": "^0.4.0", + "@opentelemetry/context-zone-peer-dep": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/jquery": "^3.3.31", "@types/mocha": "^5.2.5", diff --git a/packages/opentelemetry-plugin-user-interaction/src/userInteraction.ts b/packages/opentelemetry-plugin-user-interaction/src/userInteraction.ts index 5e6037ad33..3be533279a 100644 --- a/packages/opentelemetry-plugin-user-interaction/src/userInteraction.ts +++ b/packages/opentelemetry-plugin-user-interaction/src/userInteraction.ts @@ -28,7 +28,7 @@ import { import { AttributeNames } from './enums/AttributeNames'; import { VERSION } from './version'; -const ZONE_SCOPE_KEY = 'OT_ZONE_SCOPE'; +const ZONE_CONTEXT_KEY = 'OT_ZONE_CONTEXT'; const EVENT_CLICK_NAME = 'event_click:'; const EVENT_NAVIGATION_NAME = 'Navigation:'; @@ -246,7 +246,7 @@ export class UserInteractionPlugin extends BasePlugin { task: AsyncTask ) { const currentZone = Zone.current; - const currentSpan = currentZone.get(ZONE_SCOPE_KEY); + const currentSpan = currentZone.get(ZONE_CONTEXT_KEY); if (currentSpan && plugin._shouldCountTask(task, currentZone)) { plugin._decrementTask(currentSpan); } @@ -269,7 +269,7 @@ export class UserInteractionPlugin extends BasePlugin { task: AsyncTask ) { const currentZone = Zone.current; - const currentSpan: types.Span = currentZone.get(ZONE_SCOPE_KEY); + const currentSpan: types.Span = currentZone.get(ZONE_CONTEXT_KEY); if (currentSpan && plugin._shouldCountTask(task, currentZone)) { plugin._incrementTask(currentSpan); plugin._checkForTimeout(task, currentSpan); @@ -310,7 +310,7 @@ export class UserInteractionPlugin extends BasePlugin { } } } else { - span = this.get(ZONE_SCOPE_KEY); + span = this.get(ZONE_CONTEXT_KEY); } try { @@ -337,7 +337,7 @@ export class UserInteractionPlugin extends BasePlugin { if (!currentZone || !task.data || task.data.isPeriodic) { return false; } - const currentSpan = currentZone.get(ZONE_SCOPE_KEY); + const currentSpan = currentZone.get(ZONE_CONTEXT_KEY); if (!currentSpan) { return false; } diff --git a/packages/opentelemetry-plugin-user-interaction/test/userInteraction.nozone.test.ts b/packages/opentelemetry-plugin-user-interaction/test/userInteraction.nozone.test.ts index 8c2d4b5090..0fc1b6456a 100644 --- a/packages/opentelemetry-plugin-user-interaction/test/userInteraction.nozone.test.ts +++ b/packages/opentelemetry-plugin-user-interaction/test/userInteraction.nozone.test.ts @@ -21,7 +21,7 @@ const originalSetTimeout = window.setTimeout; import { context } from '@opentelemetry/api'; import { isWrapped, LogLevel } from '@opentelemetry/core'; import { XMLHttpRequestPlugin } from '@opentelemetry/plugin-xml-http-request'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone-peer-dep'; +import { ZoneContextManager } from '@opentelemetry/context-zone-peer-dep'; import * as tracing from '@opentelemetry/tracing'; import { WebTracerProvider } from '@opentelemetry/web'; import * as assert from 'assert'; @@ -39,7 +39,7 @@ const FILE_URL = describe('UserInteractionPlugin', () => { describe('when zone.js is NOT available', () => { - let scopeManager: ZoneScopeManager; + let contextManager: ZoneContextManager; let userInteractionPlugin: UserInteractionPlugin; let sandbox: sinon.SinonSandbox; let webTracerProvider: WebTracerProvider; @@ -47,8 +47,8 @@ describe('UserInteractionPlugin', () => { let exportSpy: sinon.SinonSpy; let requests: sinon.SinonFakeXMLHttpRequest[] = []; beforeEach(() => { - scopeManager = new ZoneScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new ZoneContextManager().enable(); + context.setGlobalContextManager(contextManager); sandbox = sinon.createSandbox(); const fakeXhr = sandbox.useFakeXMLHttpRequest(); fakeXhr.onCreate = function(xhr: sinon.SinonFakeXMLHttpRequest) { @@ -81,7 +81,7 @@ describe('UserInteractionPlugin', () => { new tracing.SimpleSpanProcessor(dummySpanExporter) ); - // this is needed as window is treated as scope and karma is adding + // this is needed as window is treated as context and karma is adding // context which is then detected as spanContext (window as { context?: {} }).context = undefined; }); @@ -89,7 +89,7 @@ describe('UserInteractionPlugin', () => { requests = []; sandbox.restore(); exportSpy.restore(); - scopeManager.disable(); + contextManager.disable(); }); it('should handle task without async operation', () => { diff --git a/packages/opentelemetry-plugin-user-interaction/test/userInteraction.test.ts b/packages/opentelemetry-plugin-user-interaction/test/userInteraction.test.ts index fae06bb3c1..e4b773edad 100644 --- a/packages/opentelemetry-plugin-user-interaction/test/userInteraction.test.ts +++ b/packages/opentelemetry-plugin-user-interaction/test/userInteraction.test.ts @@ -21,7 +21,7 @@ const originalSetTimeout = window.setTimeout; import { context } from '@opentelemetry/api'; import { isWrapped, LogLevel } from '@opentelemetry/core'; import { XMLHttpRequestPlugin } from '@opentelemetry/plugin-xml-http-request'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone-peer-dep'; +import { ZoneContextManager } from '@opentelemetry/context-zone-peer-dep'; import * as tracing from '@opentelemetry/tracing'; import { WebTracerProvider } from '@opentelemetry/web'; import * as assert from 'assert'; @@ -42,7 +42,7 @@ const FILE_URL = describe('UserInteractionPlugin', () => { describe('when zone.js is available', () => { - let scopeManager: ZoneScopeManager; + let contextManager: ZoneContextManager; let userInteractionPlugin: UserInteractionPlugin; let sandbox: sinon.SinonSandbox; let webTracerProvider: WebTracerProvider; @@ -50,8 +50,8 @@ describe('UserInteractionPlugin', () => { let exportSpy: sinon.SinonSpy; let requests: sinon.SinonFakeXMLHttpRequest[] = []; beforeEach(() => { - scopeManager = new ZoneScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new ZoneContextManager().enable(); + context.setGlobalContextManager(contextManager); sandbox = sinon.createSandbox(); history.pushState({ test: 'testing' }, '', `${location.pathname}`); const fakeXhr = sandbox.useFakeXMLHttpRequest(); @@ -79,7 +79,7 @@ describe('UserInteractionPlugin', () => { new tracing.SimpleSpanProcessor(dummySpanExporter) ); - // this is needed as window is treated as scope and karma is adding + // this is needed as window is treated as context and karma is adding // context which is then detected as spanContext (window as { context?: {} }).context = undefined; }); @@ -87,7 +87,7 @@ describe('UserInteractionPlugin', () => { requests = []; sandbox.restore(); exportSpy.restore(); - scopeManager.disable(); + contextManager.disable(); }); it('should handle task without async operation', () => { diff --git a/packages/opentelemetry-plugin-xml-http-request/README.md b/packages/opentelemetry-plugin-xml-http-request/README.md index 07022c4066..122e4c3fce 100644 --- a/packages/opentelemetry-plugin-xml-http-request/README.md +++ b/packages/opentelemetry-plugin-xml-http-request/README.md @@ -19,10 +19,10 @@ npm install --save @opentelemetry/plugin-xml-http-request import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; import { WebTracer } from '@opentelemetry/web'; import { XMLHttpRequestPlugin } from '@opentelemetry/plugin-xml-http-request'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone'; +import { ZoneContextManager } from '@opentelemetry/context-zone'; const webTracerWithZone = new WebTracer({ - scopeManager: new ZoneScopeManager(), + contextManager: new ZoneContextManager(), plugins: [ new XMLHttpRequestPlugin({ propagateTraceHeaderCorsUrls: ['http://localhost:8090'] diff --git a/packages/opentelemetry-plugin-xml-http-request/package.json b/packages/opentelemetry-plugin-xml-http-request/package.json index 4937b8c620..557b962f69 100644 --- a/packages/opentelemetry-plugin-xml-http-request/package.json +++ b/packages/opentelemetry-plugin-xml-http-request/package.json @@ -44,7 +44,7 @@ }, "devDependencies": { "@babel/core": "^7.6.0", - "@opentelemetry/scope-zone": "^0.4.0", + "@opentelemetry/context-zone": "^0.4.0", "@opentelemetry/tracing": "^0.4.0", "@types/mocha": "^5.2.5", "@types/node": "^12.6.8", diff --git a/packages/opentelemetry-plugin-xml-http-request/test/xhr.test.ts b/packages/opentelemetry-plugin-xml-http-request/test/xhr.test.ts index abc1bc61ac..8c9f742142 100644 --- a/packages/opentelemetry-plugin-xml-http-request/test/xhr.test.ts +++ b/packages/opentelemetry-plugin-xml-http-request/test/xhr.test.ts @@ -22,7 +22,7 @@ import { X_B3_SPAN_ID, X_B3_TRACE_ID, } from '@opentelemetry/core'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone'; +import { ZoneContextManager } from '@opentelemetry/context-zone'; import * as tracing from '@opentelemetry/tracing'; import { PerformanceTimingNames as PTN, @@ -97,15 +97,15 @@ describe('xhr', () => { let requests: any[] = []; let prepareData: any; let clearData: any; - let scopeManager: ZoneScopeManager; + let contextManager: ZoneContextManager; beforeEach(() => { - scopeManager = new ZoneScopeManager().enable(); - types.context.setGlobalContextManager(scopeManager); + contextManager = new ZoneContextManager().enable(); + types.context.setGlobalContextManager(contextManager); }); afterEach(() => { - scopeManager.disable(); + contextManager.disable(); }); before(() => { diff --git a/packages/opentelemetry-tracing/package.json b/packages/opentelemetry-tracing/package.json index 4a59b40ba8..116bc02042 100644 --- a/packages/opentelemetry-tracing/package.json +++ b/packages/opentelemetry-tracing/package.json @@ -77,6 +77,6 @@ "@opentelemetry/base": "^0.4.0", "@opentelemetry/core": "^0.4.0", "@opentelemetry/resources": "^0.4.0", - "@opentelemetry/scope-base": "^0.4.0" + "@opentelemetry/context-base": "^0.4.0" } } diff --git a/packages/opentelemetry-tracing/src/Tracer.ts b/packages/opentelemetry-tracing/src/Tracer.ts index 48871c52ed..f7fd4d6248 100644 --- a/packages/opentelemetry-tracing/src/Tracer.ts +++ b/packages/opentelemetry-tracing/src/Tracer.ts @@ -119,7 +119,7 @@ export class Tracer implements api.Tracer { } /** - * Enters the scope of code where the given Span is in the current context. + * Enters the context of code where the given Span is in the current context. */ withSpan ReturnType>( span: api.Span, @@ -130,7 +130,7 @@ export class Tracer implements api.Tracer { } /** - * Bind a span (or the current one) to the target's scope + * Bind a span (or the current one) to the target's context */ bind(target: T, span?: api.Span): T { return api.context.bind( diff --git a/packages/opentelemetry-tracing/src/types.ts b/packages/opentelemetry-tracing/src/types.ts index 3d4ccb1123..a9b0960dc4 100644 --- a/packages/opentelemetry-tracing/src/types.ts +++ b/packages/opentelemetry-tracing/src/types.ts @@ -21,7 +21,7 @@ import { Sampler, } from '@opentelemetry/api'; import { LogLevel } from '@opentelemetry/core'; -import { ScopeManager } from '@opentelemetry/scope-base'; +import { ContextManager } from '@opentelemetry/context-base'; import { Resource } from '@opentelemetry/resources'; /** @@ -64,7 +64,7 @@ export interface SDKRegistrationConfig { propagator?: HttpTextFormat | null; /** Context manager to register as the global context manager */ - contextManager?: ScopeManager | null; + contextManager?: ContextManager | null; } /** Global configuration of trace service */ diff --git a/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts b/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts index 5fca2226c7..fae38a411c 100644 --- a/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts +++ b/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts @@ -25,13 +25,13 @@ import { TraceState, } from '@opentelemetry/core'; import { Resource } from '@opentelemetry/resources'; -import { NoopScopeManager, ScopeManager } from '@opentelemetry/scope-base'; +import { NoopContextManager, ContextManager } from '@opentelemetry/context-base'; import * as assert from 'assert'; import { BasicTracerProvider, Span } from '../src'; describe('BasicTracerProvider', () => { beforeEach(() => { - context.setGlobalContextManager(new NoopScopeManager()); + context.setGlobalContextManager(new NoopContextManager()); }); describe('constructor', () => { @@ -320,7 +320,7 @@ describe('BasicTracerProvider', () => { context.setGlobalContextManager({ active: () => setActiveSpan(Context.ROOT_CONTEXT, ('foo' as any) as Span), - } as ScopeManager); + } as ContextManager); const tracer = new BasicTracerProvider().getTracer('default'); assert.deepStrictEqual(tracer.getCurrentSpan(), 'foo'); @@ -328,7 +328,7 @@ describe('BasicTracerProvider', () => { }); describe('.withSpan()', () => { - it('should run scope with NoopScopeManager scope manager', done => { + it('should run context with NoopContextManager context manager', done => { const tracer = new BasicTracerProvider().getTracer('default'); const span = tracer.startSpan('my-span'); tracer.withSpan(span, () => { @@ -339,7 +339,7 @@ describe('BasicTracerProvider', () => { }); describe('.bind()', () => { - it('should bind scope with NoopScopeManager scope manager', done => { + it('should bind context with NoopContextManager context manager', done => { const tracer = new BasicTracerProvider().getTracer('default'); const span = tracer.startSpan('my-span'); const fn = () => { diff --git a/packages/opentelemetry-web/README.md b/packages/opentelemetry-web/README.md index ce14ca59fd..e0d5d1c691 100644 --- a/packages/opentelemetry-web/README.md +++ b/packages/opentelemetry-web/README.md @@ -21,7 +21,7 @@ Web Tracer currently supports one plugin for document load. Unlike Node Tracer (`NodeTracerProvider`), the plugins needs to be initialised and passed in configuration. The reason is to give user full control over which plugin will be bundled into web page. -You can choose to use the `ZoneScopeManager` if you want to trace asynchronous operations. +You can choose to use the `ZoneContextManager` if you want to trace asynchronous operations. ## Installation @@ -35,7 +35,7 @@ npm install --save @opentelemetry/web import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing'; import { WebTracerProvider } from '@opentelemetry/web'; import { DocumentLoad } from '@opentelemetry/plugin-document-load'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone'; +import { ZoneContextManager } from '@opentelemetry/context-zone'; // Minimum required setup - supports only synchronous operations const provider = new WebTracerProvider({ @@ -46,9 +46,9 @@ const provider = new WebTracerProvider({ provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); -// Changing default scopeManager to use ZoneScopeManager - supports asynchronous operations +// Changing default contextManager to use ZoneContextManager - supports asynchronous operations const providerWithZone = new WebTracerProvider({ - scopeManager: new ZoneScopeManager(), + contextManager: new ZoneContextManager(), plugins: [ new DocumentLoad() ] diff --git a/packages/opentelemetry-web/package.json b/packages/opentelemetry-web/package.json index 794f41ab99..52fb764a80 100644 --- a/packages/opentelemetry-web/package.json +++ b/packages/opentelemetry-web/package.json @@ -44,7 +44,7 @@ "devDependencies": { "@babel/core": "^7.6.0", "@opentelemetry/resources": "^0.4.0", - "@opentelemetry/scope-zone": "^0.4.0", + "@opentelemetry/context-zone": "^0.4.0", "@types/jquery": "^3.3.31", "@types/mocha": "^5.2.5", "@types/node": "^12.6.8", @@ -78,7 +78,7 @@ "dependencies": { "@opentelemetry/api": "^0.4.0", "@opentelemetry/core": "^0.4.0", - "@opentelemetry/scope-base": "^0.4.0", + "@opentelemetry/context-base": "^0.4.0", "@opentelemetry/tracing": "^0.4.0" } } diff --git a/packages/opentelemetry-web/src/StackScopeManager.ts b/packages/opentelemetry-web/src/StackContextManager.ts similarity index 52% rename from packages/opentelemetry-web/src/StackScopeManager.ts rename to packages/opentelemetry-web/src/StackContextManager.ts index 72ee4712c6..a8a7d9019b 100644 --- a/packages/opentelemetry-web/src/StackScopeManager.ts +++ b/packages/opentelemetry-web/src/StackContextManager.ts @@ -15,35 +15,35 @@ */ import { Context } from '@opentelemetry/api'; -import { ScopeManager } from '@opentelemetry/scope-base'; +import { ContextManager } from '@opentelemetry/context-base'; /** - * Stack Scope Manager for managing the state in web + * Stack Context Manager for managing the state in web * it doesn't fully support the async calls though */ -export class StackScopeManager implements ScopeManager { +export class StackContextManager implements ContextManager { /** - * whether the scope manager is enabled or not + * whether the context manager is enabled or not */ private _enabled = false; /** - * Keeps the reference to current scope + * Keeps the reference to current context */ - public _currentScope = Context.ROOT_CONTEXT; + public _currentContext = Context.ROOT_CONTEXT; /** * - * @param target Function to be executed within the scope - * @param scope + * @param target Function to be executed within the context + * @param context */ private _bindFunction( target: T, - scope = Context.ROOT_CONTEXT + context = Context.ROOT_CONTEXT ): T { const manager = this; const contextWrapper = function(...args: unknown[]) { - return manager.with(scope, () => target.apply(scope, args)); + return manager.with(context, () => target.apply(context, args)); }; Object.defineProperty(contextWrapper, 'length', { enumerable: false, @@ -55,68 +55,68 @@ export class StackScopeManager implements ScopeManager { } /** - * Returns the active scope + * Returns the active context */ active(): Context { - return this._currentScope; + return this._currentContext; } /** - * Binds a the certain scope or the active one to the target function and then returns the target + * Binds a the certain context or the active one to the target function and then returns the target * @param target - * @param scope + * @param context */ - bind(target: T, scope = Context.ROOT_CONTEXT): T { - // if no specific scope to propagate is given, we use the current one - if (scope === undefined) { - scope = this.active(); + bind(target: T, context = Context.ROOT_CONTEXT): T { + // if no specific context to propagate is given, we use the current one + if (context === undefined) { + context = this.active(); } if (typeof target === 'function') { - return this._bindFunction(target, scope); + return this._bindFunction(target, context); } return target; } /** - * Disable the scope manager (clears the current scope) + * Disable the context manager (clears the current context) */ disable(): this { - this._currentScope = Context.ROOT_CONTEXT; + this._currentContext = Context.ROOT_CONTEXT; this._enabled = false; return this; } /** - * Enables the scope manager and creates a default(root) scope + * Enables the context manager and creates a default(root) context */ enable(): this { if (this._enabled) { return this; } this._enabled = true; - this._currentScope = Context.ROOT_CONTEXT; + this._currentContext = Context.ROOT_CONTEXT; return this; } /** - * Calls the callback function [fn] with the provided [scope]. If [scope] is undefined then it will use the window. - * The scope will be set as active - * @param scope + * Calls the callback function [fn] with the provided [context]. If [context] is undefined then it will use the window. + * The context will be set as active + * @param context * @param fn Callback function */ with ReturnType>( - scope: Context | null, + context: Context | null, fn: () => ReturnType ): ReturnType { - const previousScope = this._currentScope; - this._currentScope = scope || Context.ROOT_CONTEXT; + const previousContext = this._currentContext; + this._currentContext = context || Context.ROOT_CONTEXT; try { - return fn.apply(scope); + return fn.apply(context); } catch (err) { throw err; } finally { - this._currentScope = previousScope; + this._currentContext = previousContext; } } } diff --git a/packages/opentelemetry-web/src/WebTracerProvider.ts b/packages/opentelemetry-web/src/WebTracerProvider.ts index 265e06ab40..2d4b625d9a 100644 --- a/packages/opentelemetry-web/src/WebTracerProvider.ts +++ b/packages/opentelemetry-web/src/WebTracerProvider.ts @@ -20,7 +20,7 @@ import { SDKRegistrationConfig, TracerConfig, } from '@opentelemetry/tracing'; -import { StackScopeManager } from './StackScopeManager'; +import { StackContextManager } from './StackContextManager'; /** * WebTracerConfig provides an interface for configuring a Web Tracer. @@ -33,7 +33,7 @@ export interface WebTracerConfig extends TracerConfig { } /** - * This class represents a web tracer with {@link StackScopeManager} + * This class represents a web tracer with {@link StackContextManager} */ export class WebTracerProvider extends BasicTracerProvider { /** @@ -60,7 +60,7 @@ export class WebTracerProvider extends BasicTracerProvider { */ register(config: SDKRegistrationConfig = {}) { if (config.contextManager === undefined) { - config.contextManager = new StackScopeManager(); + config.contextManager = new StackContextManager(); config.contextManager.enable(); } diff --git a/packages/opentelemetry-web/src/index.ts b/packages/opentelemetry-web/src/index.ts index c49b666cb9..aafef2114c 100644 --- a/packages/opentelemetry-web/src/index.ts +++ b/packages/opentelemetry-web/src/index.ts @@ -15,7 +15,7 @@ */ export * from './WebTracerProvider'; -export * from './StackScopeManager'; +export * from './StackContextManager'; export * from './enums/PerformanceTimingNames'; export * from './types'; export * from './utils'; diff --git a/packages/opentelemetry-web/test/StackContextManager.test.ts b/packages/opentelemetry-web/test/StackContextManager.test.ts new file mode 100644 index 0000000000..a45a127b0e --- /dev/null +++ b/packages/opentelemetry-web/test/StackContextManager.test.ts @@ -0,0 +1,180 @@ +/*! + * Copyright 2019, 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 { StackContextManager } from '../src'; +import { Context } from '@opentelemetry/api'; + +describe('StackContextManager', () => { + let contextManager: StackContextManager; + const key1 = Context.createKey('test key 1'); + + beforeEach(() => { + contextManager = new StackContextManager(); + contextManager.enable(); + }); + + afterEach(() => { + contextManager.disable(); + }); + + describe('.enable()', () => { + it('should work', () => { + assert.doesNotThrow(() => { + assert(contextManager.enable() === contextManager, 'should return this'); + assert( + contextManager.active() === Context.ROOT_CONTEXT, + 'should have root context' + ); + }); + }); + }); + + describe('.disable()', () => { + it('should work', () => { + assert.doesNotThrow(() => { + assert(contextManager.disable() === contextManager, 'should return this'); + assert( + contextManager.active() === Context.ROOT_CONTEXT, + 'should have no context' + ); + }); + }); + }); + + describe('.with()', () => { + it('should run the callback (null as target)', done => { + contextManager.with(null, done); + }); + + it('should run the callback (object as target)', done => { + const test = Context.ROOT_CONTEXT.setValue(key1, 1); + contextManager.with(test, () => { + assert.strictEqual(contextManager.active(), test, 'should have context'); + return done(); + }); + }); + + it('should run the callback (when disabled)', done => { + contextManager.disable(); + contextManager.with(null, () => { + contextManager.enable(); + return done(); + }); + }); + + it('should rethrow errors', done => { + assert.throws(() => { + contextManager.with(null, () => { + throw new Error('This should be rethrown'); + }); + }); + return done(); + }); + + it('should finally restore an old context', done => { + const ctx1 = Context.ROOT_CONTEXT.setValue(key1, 'ctx1'); + const ctx2 = Context.ROOT_CONTEXT.setValue(key1, 'ctx2'); + const ctx3 = Context.ROOT_CONTEXT.setValue(key1, 'ctx3'); + contextManager.with(ctx1, () => { + assert.strictEqual(contextManager.active(), ctx1); + contextManager.with(ctx2, () => { + assert.strictEqual(contextManager.active(), ctx2); + contextManager.with(ctx3, () => { + assert.strictEqual(contextManager.active(), ctx3); + }); + assert.strictEqual(contextManager.active(), ctx2); + }); + assert.strictEqual(contextManager.active(), ctx1); + return done(); + }); + assert.strictEqual(contextManager.active(), window); + }); + + it('should finally restore an old context when context is an object', done => { + const ctx1 = Context.ROOT_CONTEXT.setValue(key1, 1); + const ctx2 = Context.ROOT_CONTEXT.setValue(key1, 2); + const ctx3 = Context.ROOT_CONTEXT.setValue(key1, 3); + contextManager.with(ctx1, () => { + assert.strictEqual(contextManager.active(), ctx1); + contextManager.with(ctx2, () => { + assert.strictEqual(contextManager.active(), ctx2); + contextManager.with(ctx3, () => { + assert.strictEqual(contextManager.active(), ctx3); + }); + assert.strictEqual(contextManager.active(), ctx2); + }); + assert.strictEqual(contextManager.active(), ctx1); + return done(); + }); + assert.strictEqual(contextManager.active(), window); + }); + }); + + describe('.bind(function)', () => { + it('should call the function with previously assigned context', () => { + class Obj { + title: string; + + constructor(title: string) { + this.title = title; + } + + getTitle() { + return (contextManager.active().getValue(key1) as Obj).title; + } + } + + const obj1 = new Obj('a1'); + const ctx = Context.ROOT_CONTEXT.setValue(key1, obj1); + obj1.title = 'a2'; + const obj2 = new Obj('b1'); + const wrapper: any = contextManager.bind(obj2.getTitle, ctx); + assert.ok(wrapper(), 'a2'); + }); + + it('should return the same target (when enabled)', () => { + const test = Context.ROOT_CONTEXT.setValue(key1, 1); + assert.deepStrictEqual(contextManager.bind(test), test); + }); + + it('should return the same target (when disabled)', () => { + contextManager.disable(); + const test = Context.ROOT_CONTEXT.setValue(key1, 1); + assert.deepStrictEqual(contextManager.bind(test), test); + contextManager.enable(); + }); + + it('should return current context (when enabled)', done => { + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const fn: any = contextManager.bind(() => { + assert.strictEqual(contextManager.active(), context, 'should have context'); + return done(); + }, context); + fn(); + }); + + it('should return current context (when disabled)', done => { + contextManager.disable(); + const context = Context.ROOT_CONTEXT.setValue(key1, 1); + const fn: any = contextManager.bind(() => { + assert.strictEqual(contextManager.active(), context, 'should have context'); + return done(); + }, context); + fn(); + }); + }); +}); diff --git a/packages/opentelemetry-web/test/StackScopeManager.test.ts b/packages/opentelemetry-web/test/StackScopeManager.test.ts deleted file mode 100644 index bb0e92970d..0000000000 --- a/packages/opentelemetry-web/test/StackScopeManager.test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/*! - * Copyright 2019, 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 { StackScopeManager } from '../src'; -import { Context } from '@opentelemetry/api'; - -describe('StackScopeManager', () => { - let scopeManager: StackScopeManager; - const key1 = Context.createKey('test key 1'); - - beforeEach(() => { - scopeManager = new StackScopeManager(); - scopeManager.enable(); - }); - - afterEach(() => { - scopeManager.disable(); - }); - - describe('.enable()', () => { - it('should work', () => { - assert.doesNotThrow(() => { - assert(scopeManager.enable() === scopeManager, 'should return this'); - assert( - scopeManager.active() === Context.ROOT_CONTEXT, - 'should have root scope' - ); - }); - }); - }); - - describe('.disable()', () => { - it('should work', () => { - assert.doesNotThrow(() => { - assert(scopeManager.disable() === scopeManager, 'should return this'); - assert( - scopeManager.active() === Context.ROOT_CONTEXT, - 'should have no scope' - ); - }); - }); - }); - - describe('.with()', () => { - it('should run the callback (null as target)', done => { - scopeManager.with(null, done); - }); - - it('should run the callback (object as target)', done => { - const test = Context.ROOT_CONTEXT.setValue(key1, 1); - scopeManager.with(test, () => { - assert.strictEqual(scopeManager.active(), test, 'should have scope'); - return done(); - }); - }); - - it('should run the callback (when disabled)', done => { - scopeManager.disable(); - scopeManager.with(null, () => { - scopeManager.enable(); - return done(); - }); - }); - - it('should rethrow errors', done => { - assert.throws(() => { - scopeManager.with(null, () => { - throw new Error('This should be rethrown'); - }); - }); - return done(); - }); - - it('should finally restore an old scope', done => { - const scope1 = Context.ROOT_CONTEXT.setValue(key1, 'scope1'); - const scope2 = Context.ROOT_CONTEXT.setValue(key1, 'scope2'); - const scope3 = Context.ROOT_CONTEXT.setValue(key1, 'scope3'); - scopeManager.with(scope1, () => { - assert.strictEqual(scopeManager.active(), scope1); - scopeManager.with(scope2, () => { - assert.strictEqual(scopeManager.active(), scope2); - scopeManager.with(scope3, () => { - assert.strictEqual(scopeManager.active(), scope3); - }); - assert.strictEqual(scopeManager.active(), scope2); - }); - assert.strictEqual(scopeManager.active(), scope1); - return done(); - }); - assert.strictEqual(scopeManager.active(), window); - }); - - it('should finally restore an old scope when scope is an object', done => { - const scope1 = Context.ROOT_CONTEXT.setValue(key1, 1); - const scope2 = Context.ROOT_CONTEXT.setValue(key1, 2); - const scope3 = Context.ROOT_CONTEXT.setValue(key1, 3); - scopeManager.with(scope1, () => { - assert.strictEqual(scopeManager.active(), scope1); - scopeManager.with(scope2, () => { - assert.strictEqual(scopeManager.active(), scope2); - scopeManager.with(scope3, () => { - assert.strictEqual(scopeManager.active(), scope3); - }); - assert.strictEqual(scopeManager.active(), scope2); - }); - assert.strictEqual(scopeManager.active(), scope1); - return done(); - }); - assert.strictEqual(scopeManager.active(), window); - }); - }); - - describe('.bind(function)', () => { - it('should call the function with previously assigned scope', () => { - class Obj { - title: string; - - constructor(title: string) { - this.title = title; - } - - getTitle() { - return (scopeManager.active().getValue(key1) as Obj).title; - } - } - - const obj1 = new Obj('a1'); - const ctx = Context.ROOT_CONTEXT.setValue(key1, obj1); - obj1.title = 'a2'; - const obj2 = new Obj('b1'); - const wrapper: any = scopeManager.bind(obj2.getTitle, ctx); - assert.ok(wrapper(), 'a2'); - }); - - it('should return the same target (when enabled)', () => { - const test = Context.ROOT_CONTEXT.setValue(key1, 1); - assert.deepStrictEqual(scopeManager.bind(test), test); - }); - - it('should return the same target (when disabled)', () => { - scopeManager.disable(); - const test = Context.ROOT_CONTEXT.setValue(key1, 1); - assert.deepStrictEqual(scopeManager.bind(test), test); - scopeManager.enable(); - }); - - it('should return current scope (when enabled)', done => { - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const fn: any = scopeManager.bind(() => { - assert.strictEqual(scopeManager.active(), scope, 'should have scope'); - return done(); - }, scope); - fn(); - }); - - it('should return current scope (when disabled)', done => { - scopeManager.disable(); - const scope = Context.ROOT_CONTEXT.setValue(key1, 1); - const fn: any = scopeManager.bind(() => { - assert.strictEqual(scopeManager.active(), scope, 'should have scope'); - return done(); - }, scope); - fn(); - }); - }); -}); diff --git a/packages/opentelemetry-web/test/WebTracerProvider.test.ts b/packages/opentelemetry-web/test/WebTracerProvider.test.ts index 59e826adbf..1443238f2e 100644 --- a/packages/opentelemetry-web/test/WebTracerProvider.test.ts +++ b/packages/opentelemetry-web/test/WebTracerProvider.test.ts @@ -16,8 +16,8 @@ import { context } from '@opentelemetry/api'; import { BasePlugin, NoopLogger } from '@opentelemetry/core'; -import { ScopeManager } from '@opentelemetry/scope-base'; -import { ZoneScopeManager } from '@opentelemetry/scope-zone'; +import { ContextManager } from '@opentelemetry/context-base'; +import { ZoneContextManager } from '@opentelemetry/context-zone'; import { Tracer, Span } from '@opentelemetry/tracing'; import { Resource, TELEMETRY_SDK_RESOURCE } from '@opentelemetry/resources'; import * as assert from 'assert'; @@ -38,16 +38,16 @@ class DummyPlugin extends BasePlugin { describe('WebTracerProvider', () => { describe('constructor', () => { let defaultOptions: WebTracerConfig; - let scopeManager: ScopeManager; + let contextManager: ContextManager; beforeEach(() => { defaultOptions = {}; - scopeManager = new ZoneScopeManager().enable(); - context.setGlobalContextManager(scopeManager); + contextManager = new ZoneContextManager().enable(); + context.setGlobalContextManager(contextManager); }); afterEach(() => { - scopeManager.disable(); + contextManager.disable(); }); it('should construct an instance with required only options', () => { @@ -73,14 +73,14 @@ describe('WebTracerProvider', () => { assert.ok(spyEnable2.calledOnce === true); }); - it('should work without default scope manager', () => { + it('should work without default context manager', () => { assert.doesNotThrow(() => { new WebTracerProvider({}); }); }); - describe('when scopeManager is "ZoneScopeManager"', () => { - it('should correctly return the scopes for 2 parallel actions', () => { + describe('when contextManager is "ZoneContextManager"', () => { + it('should correctly return the contexts for 2 parallel actions', () => { const webTracerWithZone = new WebTracerProvider().getTracer('default'); const rootSpan = webTracerWithZone.startSpan('rootSpan'); diff --git a/packages/opentelemetry-web/test/registration.test.ts b/packages/opentelemetry-web/test/registration.test.ts index ea1e4a3ef1..d0930fa302 100644 --- a/packages/opentelemetry-web/test/registration.test.ts +++ b/packages/opentelemetry-web/test/registration.test.ts @@ -22,13 +22,13 @@ import { trace, } from '@opentelemetry/api'; import { HttpTraceContext } from '@opentelemetry/core'; -import { NoopScopeManager } from '@opentelemetry/scope-base'; +import { NoopContextManager } from '@opentelemetry/context-base'; import * as assert from 'assert'; -import { WebTracerProvider, StackScopeManager } from '../src'; +import { WebTracerProvider, StackContextManager } from '../src'; describe('API registration', () => { beforeEach(() => { - context.setGlobalContextManager(new NoopScopeManager()); + context.setGlobalContextManager(new NoopContextManager()); propagation.setGlobalPropagator(new NoopHttpTextFormat()); trace.setGlobalTracerProvider(new NoopTracerProvider()); }); @@ -37,7 +37,7 @@ describe('API registration', () => { const tracerProvider = new WebTracerProvider(); tracerProvider.register(); - assert.ok(context['_scopeManager'] instanceof StackScopeManager); + assert.ok(context['_contextManager'] instanceof StackContextManager); assert.ok(propagation['_propagator'] instanceof HttpTraceContext); assert.ok(trace['_tracerProvider'] === tracerProvider); }); @@ -45,7 +45,7 @@ describe('API registration', () => { it('should register configured implementations', () => { const tracerProvider = new WebTracerProvider(); - const contextManager = new NoopScopeManager(); + const contextManager = new NoopContextManager(); const propagator = new NoopHttpTextFormat(); tracerProvider.register({ @@ -53,7 +53,7 @@ describe('API registration', () => { propagator, }); - assert.ok(context['_scopeManager'] === contextManager); + assert.ok(context['_contextManager'] === contextManager); assert.ok(propagation['_propagator'] === propagator); assert.ok(trace['_tracerProvider'] === tracerProvider); @@ -65,7 +65,7 @@ describe('API registration', () => { contextManager: null, }); - assert.ok(context['_scopeManager'] instanceof NoopScopeManager); + assert.ok(context['_contextManager'] instanceof NoopContextManager); assert.ok(propagation['_propagator'] instanceof HttpTraceContext); assert.ok(trace['_tracerProvider'] === tracerProvider); @@ -79,7 +79,7 @@ describe('API registration', () => { assert.ok(propagation['_propagator'] instanceof NoopHttpTextFormat); - assert.ok(context['_scopeManager'] instanceof StackScopeManager); + assert.ok(context['_contextManager'] instanceof StackContextManager); assert.ok(trace['_tracerProvider'] === tracerProvider); }); }); From 6f46537f46c79da5ff58054eabc6d228589ffc9c Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Thu, 12 Mar 2020 15:54:18 -0400 Subject: [PATCH 2/2] chore: lint --- packages/opentelemetry-api/src/api/context.ts | 4 ++- .../src/AsyncHooksContextManager.ts | 4 ++- .../test/AsyncHooksContextManager.test.ts | 34 +++++++++++++++---- .../test/NoopContextManager.test.ts | 10 ++++-- .../test/ZoneContextManager.test.ts | 22 +++++++++--- .../test/BasicTracerProvider.test.ts | 5 ++- .../test/StackContextManager.test.ts | 28 ++++++++++++--- 7 files changed, 87 insertions(+), 20 deletions(-) diff --git a/packages/opentelemetry-api/src/api/context.ts b/packages/opentelemetry-api/src/api/context.ts index fc0398d7cc..3c5f7f0ea7 100644 --- a/packages/opentelemetry-api/src/api/context.ts +++ b/packages/opentelemetry-api/src/api/context.ts @@ -42,7 +42,9 @@ export class ContextAPI { /** * Set the current context manager. Returns the initialized context manager */ - public setGlobalContextManager(contextManager: ContextManager): ContextManager { + public setGlobalContextManager( + contextManager: ContextManager + ): ContextManager { this._contextManager = contextManager; return contextManager; } diff --git a/packages/opentelemetry-context-async-hooks/src/AsyncHooksContextManager.ts b/packages/opentelemetry-context-async-hooks/src/AsyncHooksContextManager.ts index e0caa3530c..138ab5e2f0 100644 --- a/packages/opentelemetry-context-async-hooks/src/AsyncHooksContextManager.ts +++ b/packages/opentelemetry-context-async-hooks/src/AsyncHooksContextManager.ts @@ -52,7 +52,9 @@ export class AsyncHooksContextManager implements ContextManager { } active(): Context { - return this._contexts[asyncHooks.executionAsyncId()] || Context.ROOT_CONTEXT; + return ( + this._contexts[asyncHooks.executionAsyncId()] || Context.ROOT_CONTEXT + ); } with ReturnType>( diff --git a/packages/opentelemetry-context-async-hooks/test/AsyncHooksContextManager.test.ts b/packages/opentelemetry-context-async-hooks/test/AsyncHooksContextManager.test.ts index 91e65e99b2..5bc4b99ede 100644 --- a/packages/opentelemetry-context-async-hooks/test/AsyncHooksContextManager.test.ts +++ b/packages/opentelemetry-context-async-hooks/test/AsyncHooksContextManager.test.ts @@ -36,7 +36,10 @@ describe('AsyncHooksContextManager', () => { it('should work', () => { assert.doesNotThrow(() => { contextManager = new AsyncHooksContextManager(); - assert(contextManager.enable() === contextManager, 'should return this'); + assert( + contextManager.enable() === contextManager, + 'should return this' + ); }); }); }); @@ -44,7 +47,10 @@ describe('AsyncHooksContextManager', () => { describe('.disable()', () => { it('should work', () => { assert.doesNotThrow(() => { - assert(contextManager.disable() === contextManager, 'should return this'); + assert( + contextManager.disable() === contextManager, + 'should return this' + ); }); contextManager.enable(); }); @@ -58,7 +64,11 @@ describe('AsyncHooksContextManager', () => { it('should run the callback (object as target)', done => { const test = Context.ROOT_CONTEXT.setValue(key1, 1); contextManager.with(test, () => { - assert.strictEqual(contextManager.active(), test, 'should have context'); + assert.strictEqual( + contextManager.active(), + test, + 'should have context' + ); return done(); }); }); @@ -116,7 +126,11 @@ describe('AsyncHooksContextManager', () => { it('should return current context (when enabled)', done => { const context = Context.ROOT_CONTEXT.setValue(key1, 1); const fn = contextManager.bind(() => { - assert.strictEqual(contextManager.active(), context, 'should have context'); + assert.strictEqual( + contextManager.active(), + context, + 'should have context' + ); return done(); }, context); fn(); @@ -130,7 +144,11 @@ describe('AsyncHooksContextManager', () => { contextManager.disable(); const context = Context.ROOT_CONTEXT.setValue(key1, 1); const fn = contextManager.bind(() => { - assert.strictEqual(contextManager.active(), context, 'should have context'); + assert.strictEqual( + contextManager.active(), + context, + 'should have context' + ); return done(); }, context); fn(); @@ -157,7 +175,11 @@ describe('AsyncHooksContextManager', () => { const context = Context.ROOT_CONTEXT.setValue(key1, 1); const fn = contextManager.bind(() => { setTimeout(() => { - assert.strictEqual(contextManager.active(), context, 'should have context'); + assert.strictEqual( + contextManager.active(), + context, + 'should have context' + ); return done(); }, 100); }, context); diff --git a/packages/opentelemetry-context-base/test/NoopContextManager.test.ts b/packages/opentelemetry-context-base/test/NoopContextManager.test.ts index b29541f8af..af0323fedb 100644 --- a/packages/opentelemetry-context-base/test/NoopContextManager.test.ts +++ b/packages/opentelemetry-context-base/test/NoopContextManager.test.ts @@ -24,7 +24,10 @@ describe('NoopContextManager', () => { it('should work', () => { assert.doesNotThrow(() => { contextManager = new NoopContextManager(); - assert(contextManager.enable() === contextManager, 'should return this'); + assert( + contextManager.enable() === contextManager, + 'should return this' + ); }); }); }); @@ -32,7 +35,10 @@ describe('NoopContextManager', () => { describe('.disable()', () => { it('should work', () => { assert.doesNotThrow(() => { - assert(contextManager.disable() === contextManager, 'should return this'); + assert( + contextManager.disable() === contextManager, + 'should return this' + ); }); contextManager.enable(); }); diff --git a/packages/opentelemetry-context-zone-peer-dep/test/ZoneContextManager.test.ts b/packages/opentelemetry-context-zone-peer-dep/test/ZoneContextManager.test.ts index 325432cf50..49571bf4bd 100644 --- a/packages/opentelemetry-context-zone-peer-dep/test/ZoneContextManager.test.ts +++ b/packages/opentelemetry-context-zone-peer-dep/test/ZoneContextManager.test.ts @@ -42,7 +42,10 @@ describe('ZoneContextManager', () => { it('should work', () => { const ctx = Context.ROOT_CONTEXT.setValue(key1, 1); assert.doesNotThrow(() => { - assert(contextManager.enable() === contextManager, 'should return this'); + assert( + contextManager.enable() === contextManager, + 'should return this' + ); contextManager.with(ctx, () => { assert(contextManager.active() === ctx, 'should have root context'); }); @@ -54,7 +57,10 @@ describe('ZoneContextManager', () => { it('should work', () => { const ctx = Context.ROOT_CONTEXT.setValue(key1, 1); assert.doesNotThrow(() => { - assert(contextManager.disable() === contextManager, 'should return this'); + assert( + contextManager.disable() === contextManager, + 'should return this' + ); contextManager.with(ctx, () => { assert( contextManager.active() === Context.ROOT_CONTEXT, @@ -73,7 +79,11 @@ describe('ZoneContextManager', () => { it('should run the callback (object as target)', done => { const test = Context.ROOT_CONTEXT.setValue(key1, 1); contextManager.with(test, () => { - assert.strictEqual(contextManager.active(), test, 'should have context'); + assert.strictEqual( + contextManager.active(), + test, + 'should have context' + ); return done(); }); }); @@ -234,7 +244,11 @@ describe('ZoneContextManager', () => { it('should return current context (when enabled)', done => { const context = Context.ROOT_CONTEXT.setValue(key1, { a: 1 }); const fn: any = contextManager.bind(() => { - assert.strictEqual(contextManager.active(), context, 'should have context'); + assert.strictEqual( + contextManager.active(), + context, + 'should have context' + ); return done(); }, context); fn(); diff --git a/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts b/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts index fae38a411c..85422703fc 100644 --- a/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts +++ b/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts @@ -25,7 +25,10 @@ import { TraceState, } from '@opentelemetry/core'; import { Resource } from '@opentelemetry/resources'; -import { NoopContextManager, ContextManager } from '@opentelemetry/context-base'; +import { + NoopContextManager, + ContextManager, +} from '@opentelemetry/context-base'; import * as assert from 'assert'; import { BasicTracerProvider, Span } from '../src'; diff --git a/packages/opentelemetry-web/test/StackContextManager.test.ts b/packages/opentelemetry-web/test/StackContextManager.test.ts index a45a127b0e..5c0fe26b22 100644 --- a/packages/opentelemetry-web/test/StackContextManager.test.ts +++ b/packages/opentelemetry-web/test/StackContextManager.test.ts @@ -34,7 +34,10 @@ describe('StackContextManager', () => { describe('.enable()', () => { it('should work', () => { assert.doesNotThrow(() => { - assert(contextManager.enable() === contextManager, 'should return this'); + assert( + contextManager.enable() === contextManager, + 'should return this' + ); assert( contextManager.active() === Context.ROOT_CONTEXT, 'should have root context' @@ -46,7 +49,10 @@ describe('StackContextManager', () => { describe('.disable()', () => { it('should work', () => { assert.doesNotThrow(() => { - assert(contextManager.disable() === contextManager, 'should return this'); + assert( + contextManager.disable() === contextManager, + 'should return this' + ); assert( contextManager.active() === Context.ROOT_CONTEXT, 'should have no context' @@ -63,7 +69,11 @@ describe('StackContextManager', () => { it('should run the callback (object as target)', done => { const test = Context.ROOT_CONTEXT.setValue(key1, 1); contextManager.with(test, () => { - assert.strictEqual(contextManager.active(), test, 'should have context'); + assert.strictEqual( + contextManager.active(), + test, + 'should have context' + ); return done(); }); }); @@ -161,7 +171,11 @@ describe('StackContextManager', () => { it('should return current context (when enabled)', done => { const context = Context.ROOT_CONTEXT.setValue(key1, 1); const fn: any = contextManager.bind(() => { - assert.strictEqual(contextManager.active(), context, 'should have context'); + assert.strictEqual( + contextManager.active(), + context, + 'should have context' + ); return done(); }, context); fn(); @@ -171,7 +185,11 @@ describe('StackContextManager', () => { contextManager.disable(); const context = Context.ROOT_CONTEXT.setValue(key1, 1); const fn: any = contextManager.bind(() => { - assert.strictEqual(contextManager.active(), context, 'should have context'); + assert.strictEqual( + contextManager.active(), + context, + 'should have context' + ); return done(); }, context); fn();