[core] Update @azure/core-tracing to use @opentelemetry/[email protected] (#1…

…5883) Now that `@opentelemetry/api` GA'd at [1.0.0](https://www.npmjs.com/package/@opentelemetry/api) we can bump our own dependency to `@opentelemetry/[email protected]` Reminder: not _all_ packages are on the latest @opentelemetry/api... those that depend on @azure/core-rest-pipeline cannot be upgraded yet.
Azure · Jun 22, 2021 · ac8d65c · ac8d65c
1 parent 8ab9b83
commit ac8d65c
Show file tree

Hide file tree

Showing 9 changed files with 123 additions and 92 deletions.
diff --git a/common/config/rush/common-versions.json b/common/config/rush/common-versions.json
@@ -56,7 +56,8 @@
     // ]
     // Following is required to allow for backward compatibility with Event Processor Host Track 1
     "@azure/event-hubs": ["^2.1.4"],
-    "@opentelemetry/api": ["^0.18.1"],
+    // Monitor-opentelemetry-exporter and monitor-query both depend on different versions of @opentelemetry and need to be updated
+    "@opentelemetry/api": ["^0.18.1", "0.21.0"],
     // Monitor: Allow node 10 types until Timeout / Timer conflict is resolved in OpenTelemetry repo
     // TODO: remove when released https://github.com/open-telemetry/opentelemetry-js/pull/1352
     // eslint v7.15 needs node v10.12
@@ -74,7 +75,8 @@
     // Issue #14771 tracks updating to these versions
     "@microsoft/api-extractor": ["7.13.2"],
     "prettier": ["2.2.1"],
-    // All packages should move to 1.0.0-preview.12 once core-rest-pipeline 1.1.0 GAs
+    // All packages should move to 1.0.0 once core-rest-pipeline 1.1.0 GAs
     "@azure/core-tracing": ["1.0.0-preview.11"]
+
   }
 }
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/sdk/core/core-rest-pipeline/package.json b/sdk/core/core-rest-pipeline/package.json
@@ -93,7 +93,7 @@
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-tracing": "1.0.0-preview.12",
+    "@azure/core-tracing": "1.0.0-preview.11",
     "@azure/logger": "^1.0.0",
     "form-data": "^3.0.0",
     "tslib": "^2.2.0",

diff --git a/sdk/core/core-rest-pipeline/src/policies/tracingPolicy.ts b/sdk/core/core-rest-pipeline/src/policies/tracingPolicy.ts
@@ -77,7 +77,7 @@ export function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolic
 
       try {
         // set headers
-        const spanContext = span.spanContext();
+        const spanContext = span.context();
         const traceParentHeader = getTraceParentHeader(spanContext);
         if (traceParentHeader) {
           request.headers.set("traceparent", traceParentHeader);

diff --git a/sdk/core/core-rest-pipeline/test/tracingPolicy.spec.ts b/sdk/core/core-rest-pipeline/test/tracingPolicy.spec.ts
@@ -14,30 +14,47 @@ import {
 import {
   setTracer,
   NoOpTracer,
-  NoOpSpan,
   SpanContext,
   TraceFlags,
+  Span,
   TraceState,
   context,
   setSpan,
   SpanStatus,
-  SpanStatusCode
+  SpanStatusCode,
+  SpanAttributes,
+  Tracer,
+  SpanAttributeValue
 } from "@azure/core-tracing";
 
-class MockSpan extends NoOpSpan {
+class MockSpan implements Span {
   private _endCalled = false;
   private _status: SpanStatus = {
     code: SpanStatusCode.UNSET
   };
-  private _attributes: { [s: string]: unknown } = {};
+  private _attributes: SpanAttributes = {};
 
   constructor(
     private traceId: string,
     private spanId: string,
     private flags: TraceFlags,
     private state: string
-  ) {
-    super();
+  ) {}
+
+  addEvent(): this {
+    throw new Error("Method not implemented.");
+  }
+
+  isRecording(): boolean {
+    return true;
+  }
+
+  recordException(): void {
+    throw new Error("Method not implemented.");
+  }
+
+  updateName(): this {
+    throw new Error("Method not implemented.");
   }
 
   didEnd(): boolean {
@@ -57,7 +74,12 @@ class MockSpan extends NoOpSpan {
     return this;
   }
 
-  setAttribute(key: string, value: unknown) {
+  setAttributes(attributes: SpanAttributes): this {
+    this._attributes = attributes;
+    return this;
+  }
+
+  setAttribute(key: string, value: SpanAttributeValue) {
     this._attributes[key] = value;
     return this;
   }
@@ -66,7 +88,7 @@ class MockSpan extends NoOpSpan {
     return this._attributes[key];
   }
 
-  spanContext(): SpanContext {
+  context(): SpanContext {
     const state = this.state;
 
     const traceState = {
@@ -95,7 +117,7 @@ class MockSpan extends NoOpSpan {
   }
 }
 
-class MockTracer extends NoOpTracer {
+class MockTracer implements Tracer {
   private spans: MockSpan[] = [];
   private _startSpanCalled = false;
 
@@ -104,9 +126,7 @@ class MockTracer extends NoOpTracer {
     private spanId = "",
     private flags = TraceFlags.NONE,
     private state = ""
-  ) {
-    super();
-  }
+  ) {}
 
   getStartedSpans(): MockSpan[] {
     return this.spans;

diff --git a/sdk/core/core-tracing/CHANGELOG.md b/sdk/core/core-tracing/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## 1.0.0-preview.12 (Unreleased)
 
+- Update `@opentelemetry/api` to version 1.0.0 [PR #15883](https://github.com/Azure/azure-sdk-for-js/pull/15883)
+
 ### Breaking Changes
 
 - Removed `OpenCensusSpanWrapper` and `OpenCensusTracerWrapper` from the public API. Customers using these wrappers should migrate to using `OpenTelemetry` directly. [PR #15770](https://github.com/Azure/azure-sdk-for-js/pull/15770)

diff --git a/sdk/core/core-tracing/package.json b/sdk/core/core-tracing/package.json
@@ -60,7 +60,7 @@
   "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-tracing/README.md",
   "sideEffects": false,
   "dependencies": {
-    "@opentelemetry/api": "0.20.0",
+    "@opentelemetry/api": "^1.0.0",
     "tslib": "^2.2.0"
   },
   "devDependencies": {

diff --git a/sdk/core/core-tracing/test/cache.spec.ts b/sdk/core/core-tracing/test/cache.spec.ts
@@ -6,7 +6,7 @@ import * as fs from "fs";
 import { Context } from "mocha";
 import * as path from "path";
 
-const validOpenTelemetryVersions = ["0.20.0"];
+const validOpenTelemetryVersions = ["^1.0.0"];
 
 describe("cache", () => {
   it("ensure current @opentelemetry/api has been validated", function(this: Context) {

diff --git a/sdk/monitor/monitor-query/package.json b/sdk/monitor/monitor-query/package.json
@@ -111,8 +111,8 @@
     "@azure/monitor-opentelemetry-exporter": "1.0.0-beta.4",
     "@azure/test-utils-recorder": "^1.0.0",
     "@microsoft/api-extractor": "7.7.11",
-    "@opentelemetry/api": "0.20.0",
-    "@opentelemetry/node": "0.20.0",
+    "@opentelemetry/api": "0.21.0",
+    "@opentelemetry/node": "0.21.0",
     "@opentelemetry/tracing": "^0.18.2",
     "@types/chai-as-promised": "^7.1.0",
     "@types/chai": "^4.1.6",