Move common W3C classes from web to base (#1064)

* Move common W3C classes from web to base * Move W3C to a new namespace
microsoft · Jan 24, 2019 · 020f928 · 020f928
1 parent e927a73
commit 020f928
Show file tree

Hide file tree

Showing 12 changed files with 1,144 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@ This changelog will be used to generate documentation on [release notes page](ht
 - [Fix data losses in ServerTelemetryChannel.](https://github.com/Microsoft/ApplicationInsights-dotnet/issues/1049)
 - [InitialSamplingRate is now correctly applied if set in applicationInsights.config] (https://github.com/Microsoft/ApplicationInsights-dotnet/pull/1048)
 
+## Version 2.9.0
+- [Move W3C methods from Web SDK](https://github.com/Microsoft/ApplicationInsights-dotnet/pull/1064)
+
 ## Version 2.9.0-beta3
 - [Flatten IExtension and Unknown ITelemetry implementations for Rich Payload Event Source consumption](https://github.com/Microsoft/ApplicationInsights-dotnet/pull/1017)
 - [Fix: Start/StopOperation with W3C distributed tracing enabled does not track telemetry](https://github.com/Microsoft/ApplicationInsights-dotnet/pull/1031)

diff --git a/PublicAPI/Microsoft.ApplicationInsights.dll/net45/PublicAPI.Unshipped.txt b/PublicAPI/Microsoft.ApplicationInsights.dll/net45/PublicAPI.Unshipped.txt
@@ -1 +1,18 @@
-Microsoft.ApplicationInsights.TelemetryClient.InitializeInstrumentationKey(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry) -> void
+Microsoft.ApplicationInsights.Extensibility.W3C.W3CUtilities
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CUtilities.GenerateTraceId() -> string
+Microsoft.ApplicationInsights.Extensibility.W3C.W3COperationCorrelationTelemetryInitializer
+Microsoft.ApplicationInsights.Extensibility.W3C.W3COperationCorrelationTelemetryInitializer.Initialize(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry) -> void
+Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GenerateW3CContext(this System.Diagnostics.Activity activity) -> System.Diagnostics.Activity
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetParentSpanId(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetSpanId(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetTraceId(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetTraceparent(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetTracestate(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.IsW3CActivity(this System.Diagnostics.Activity activity) -> bool
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.SetTraceparent(this System.Diagnostics.Activity activity, string value) -> void
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.SetTracestate(this System.Diagnostics.Activity activity, string value) -> void
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.UpdateContextOnActivity(this System.Diagnostics.Activity activity) -> System.Diagnostics.Activity
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.UpdateTelemetry(this System.Diagnostics.Activity activity, Microsoft.ApplicationInsights.Channel.ITelemetry telemetry, bool forceUpdate) -> void
+Microsoft.ApplicationInsights.TelemetryClient.InitializeInstrumentationKey(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry) -> void
+
diff --git a/PublicAPI/Microsoft.ApplicationInsights.dll/net46/PublicAPI.Unshipped.txt b/PublicAPI/Microsoft.ApplicationInsights.dll/net46/PublicAPI.Unshipped.txt
@@ -1 +1,17 @@
+Microsoft.ApplicationInsights.Extensibility.W3C.W3CUtilities
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CUtilities.GenerateTraceId() -> string
+Microsoft.ApplicationInsights.Extensibility.W3C.W3COperationCorrelationTelemetryInitializer
+Microsoft.ApplicationInsights.Extensibility.W3C.W3COperationCorrelationTelemetryInitializer.Initialize(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry) -> void
+Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GenerateW3CContext(this System.Diagnostics.Activity activity) -> System.Diagnostics.Activity
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetParentSpanId(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetSpanId(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetTraceId(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetTraceparent(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetTracestate(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.IsW3CActivity(this System.Diagnostics.Activity activity) -> bool
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.SetTraceparent(this System.Diagnostics.Activity activity, string value) -> void
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.SetTracestate(this System.Diagnostics.Activity activity, string value) -> void
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.UpdateContextOnActivity(this System.Diagnostics.Activity activity) -> System.Diagnostics.Activity
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.UpdateTelemetry(this System.Diagnostics.Activity activity, Microsoft.ApplicationInsights.Channel.ITelemetry telemetry, bool forceUpdate) -> void
 Microsoft.ApplicationInsights.TelemetryClient.InitializeInstrumentationKey(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry) -> void
diff --git a/PublicAPI/Microsoft.ApplicationInsights.dll/netstandard1.3/PublicAPI.Unshipped.txt b/PublicAPI/Microsoft.ApplicationInsights.dll/netstandard1.3/PublicAPI.Unshipped.txt
@@ -1 +1,17 @@
-Microsoft.ApplicationInsights.TelemetryClient.InitializeInstrumentationKey(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry) -> void
+Microsoft.ApplicationInsights.Extensibility.W3C.W3CUtilities
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CUtilities.GenerateTraceId() -> string
+Microsoft.ApplicationInsights.Extensibility.W3C.W3COperationCorrelationTelemetryInitializer
+Microsoft.ApplicationInsights.Extensibility.W3C.W3COperationCorrelationTelemetryInitializer.Initialize(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry) -> void
+Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GenerateW3CContext(this System.Diagnostics.Activity activity) -> System.Diagnostics.Activity
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetParentSpanId(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetSpanId(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetTraceId(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetTraceparent(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.GetTracestate(this System.Diagnostics.Activity activity) -> string
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.IsW3CActivity(this System.Diagnostics.Activity activity) -> bool
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.SetTraceparent(this System.Diagnostics.Activity activity, string value) -> void
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.SetTracestate(this System.Diagnostics.Activity activity, string value) -> void
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.UpdateContextOnActivity(this System.Diagnostics.Activity activity) -> System.Diagnostics.Activity
+static Microsoft.ApplicationInsights.Extensibility.W3C.W3CActivityExtensions.UpdateTelemetry(this System.Diagnostics.Activity activity, Microsoft.ApplicationInsights.Channel.ITelemetry telemetry, bool forceUpdate) -> void
+Microsoft.ApplicationInsights.TelemetryClient.InitializeInstrumentationKey(Microsoft.ApplicationInsights.Channel.ITelemetry telemetry) -> void
diff --git a/...soft.ApplicationInsights.Test/Shared/Microsoft.ApplicationInsights.Shared.Tests.projitems b/...soft.ApplicationInsights.Test/Shared/Microsoft.ApplicationInsights.Shared.Tests.projitems
@@ -120,6 +120,9 @@
     <Compile Include="$(MSBuildThisFileDirectory)Metrics\TestUtility\StubApplicationInsightsTelemetryChannel.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Metrics\TestUtility\TestCategoryNames.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Metrics\TestUtility\TestUtil.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)W3C\W3CActivityExtensionsTests.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)W3C\W3COperationCorrelationTelemetryInitializerTests.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)W3C\W3CUtilitiesTests.cs" />
     <None Include="$(MSBuildThisFileDirectory)Metrics\TestUtility\Materials\StdDev Test Tool.xlsx" />
     <Compile Include="$(MSBuildThisFileDirectory)Properties\AssemblyInfo.cs" />
   </ItemGroup>

diff --git a/Test/Microsoft.ApplicationInsights.Test/Shared/W3C/W3CActivityExtensionsTests.cs b/Test/Microsoft.ApplicationInsights.Test/Shared/W3C/W3CActivityExtensionsTests.cs
@@ -0,0 +1,254 @@
+namespace Microsoft.ApplicationInsights.W3C
+{
+    using System.Diagnostics;
+    using System.Linq;
+    using Microsoft.ApplicationInsights.Extensibility.W3C;
+    using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+    [TestClass]
+    public class W3CActivityExtensionsTests
+    {
+        private const string TraceId = "01010101010101010101010101010101";
+        private const string ParenSpanId = "0202020202020202";
+
+        [TestCleanup]
+        public void Cleanup()
+        {
+            while (Activity.Current != null)
+            {
+                Activity.Current.Stop();
+            }
+        }
+
+        [TestMethod]
+        public void SetInvalidTraceParent()
+        {
+            var invalidTraceParents = new[]
+            {
+                "123", string.Empty, null, "00-00", "00-00-00", "00-00-00-", "-00-00-00", "00-00-00-00-00",
+                "00-00-00- ", " -00-00-00", "---",  "00---", "00-00--", "00--00-", "00---00"
+            };
+            foreach (var traceparent in invalidTraceParents)
+            {
+                var a = new Activity("foo");
+                a.SetTraceparent(traceparent);
+
+                Assert.IsFalse(a.Tags.Any(t => t.Key == W3CConstants.ParentSpanIdTag), traceparent);
+                Assert.IsNull(a.GetParentSpanId());
+                Assert.IsNull(a.GetTracestate());
+
+                Assert.AreEqual(W3CConstants.DefaultVersion, a.Tags.Single(t => t.Key == W3CConstants.VersionTag).Value, traceparent);
+                Assert.AreEqual(W3CConstants.TraceFlagRecordedAndNotRequested, a.Tags.Single(t => t.Key == W3CConstants.SampledTag).Value, traceparent);
+
+                Assert.IsTrue(a.IsW3CActivity(), traceparent);
+                Assert.AreEqual(32, a.GetTraceId().Length, traceparent);
+                Assert.AreEqual(16, a.GetSpanId().Length, traceparent);
+
+                Assert.AreEqual($"{W3CConstants.DefaultVersion}-{a.GetTraceId()}-{a.GetSpanId()}-{W3CConstants.TraceFlagRecordedAndNotRequested}", a.GetTraceparent(), traceparent);
+            }
+        }
+
+        [TestMethod]
+        public void InvalidTraceIdAllTraceparentIsIgnored()
+        {
+            var invalidTraceIds = new[]
+            {
+                "123",
+                "000102030405060708090a0b0c0d0f", // 30 chars
+                "000102030405060708090a0b0c0d0f0", // 31 char
+                "000102030405060708090a0b0c0d0f0g", // 32 char non-hex
+                "000102030405060708090a0b0c0d0f0A", // 32 char upper case
+                "000102030405060708090a0b0c0d0f000" // 33 chars
+            };
+            foreach (var traceId in invalidTraceIds)
+            {
+                var a = new Activity("foo");
+
+                a.SetTraceparent($"00-{traceId}-{ParenSpanId}-00");
+
+                Assert.IsFalse(a.Tags.Any(t => t.Key == W3CConstants.ParentSpanIdTag), traceId);
+                Assert.IsNull(a.GetParentSpanId());
+                Assert.IsNull(a.GetTracestate());
+
+                Assert.AreEqual(W3CConstants.DefaultVersion, a.Tags.Single(t => t.Key == W3CConstants.VersionTag).Value, traceId);
+                Assert.AreEqual(W3CConstants.TraceFlagRecordedAndNotRequested, a.Tags.Single(t => t.Key == W3CConstants.SampledTag).Value, traceId);
+
+                Assert.IsTrue(a.IsW3CActivity(), traceId);
+                Assert.AreEqual(32, a.GetTraceId().Length, traceId);
+                Assert.AreEqual(16, a.GetSpanId().Length, traceId);
+
+                Assert.AreEqual($"{W3CConstants.DefaultVersion}-{a.GetTraceId()}-{a.GetSpanId()}-{W3CConstants.TraceFlagRecordedAndNotRequested}", a.GetTraceparent(), traceId);
+            }
+        }
+
+        [TestMethod]
+        public void InvalidSapnIdAllTraceparentIsIgnored()
+        {
+            var invalidSpanIds = new[]
+            {
+                "123",
+                "00010203040506", // 14 chars
+                "000102030405060", // 15 char
+                "000102030405060g", // 16 char non-hex
+                "000102030405060A", // 16 char upper case
+                "00010203040506070" // 15 chars
+            };
+            foreach (var parentSpanId in invalidSpanIds)
+            {
+                var a = new Activity("foo");
+
+                a.SetTraceparent($"00-{TraceId}-{parentSpanId}-00");
+
+                Assert.IsFalse(a.Tags.Any(t => t.Key == W3CConstants.ParentSpanIdTag), parentSpanId);
+                Assert.IsNull(a.GetParentSpanId());
+                Assert.IsNull(a.GetTracestate());
+
+                Assert.AreEqual(W3CConstants.DefaultVersion, a.Tags.Single(t => t.Key == W3CConstants.VersionTag).Value, parentSpanId);
+                Assert.AreEqual(W3CConstants.TraceFlagRecordedAndNotRequested, a.Tags.Single(t => t.Key == W3CConstants.SampledTag).Value, parentSpanId);
+
+                Assert.IsTrue(a.IsW3CActivity(), parentSpanId);
+                Assert.AreEqual(32, a.GetTraceId().Length, parentSpanId);
+                Assert.AreEqual(16, a.GetSpanId().Length, parentSpanId);
+
+                Assert.AreEqual($"{W3CConstants.DefaultVersion}-{a.GetTraceId()}-{a.GetSpanId()}-{W3CConstants.TraceFlagRecordedAndNotRequested}", a.GetTraceparent(), parentSpanId);
+            }
+        }
+
+        [TestMethod]
+        public void SetValidTraceParent()
+        {
+            var a = new Activity("foo");
+            a.SetTraceparent($"00-{TraceId}-{ParenSpanId}-00");
+
+            Assert.IsTrue(a.IsW3CActivity());
+            Assert.AreEqual(TraceId, a.Tags.SingleOrDefault(t => t.Key == W3CConstants.TraceIdTag).Value);
+            Assert.AreEqual(ParenSpanId, a.Tags.SingleOrDefault(t => t.Key == W3CConstants.ParentSpanIdTag).Value);
+            Assert.IsNotNull(a.Tags.SingleOrDefault(t => t.Key == W3CConstants.SpanIdTag));
+            Assert.AreEqual(16, a.Tags.Single(t => t.Key == W3CConstants.SpanIdTag).Value.Length);
+            Assert.AreEqual(W3CConstants.TraceFlagRecordedAndNotRequested, a.Tags.SingleOrDefault(t => t.Key == W3CConstants.SampledTag).Value);
+            Assert.AreEqual(W3CConstants.DefaultVersion, a.Tags.SingleOrDefault(t => t.Key == W3CConstants.VersionTag).Value);
+
+            Assert.AreEqual(TraceId, a.GetTraceId());
+            Assert.AreEqual(ParenSpanId, a.GetParentSpanId());
+            Assert.IsNotNull(a.GetSpanId());
+            Assert.AreEqual(a.Tags.Single(t => t.Key == W3CConstants.SpanIdTag).Value, a.GetSpanId());
+            Assert.AreEqual($"{W3CConstants.DefaultVersion}-{TraceId}-{a.GetSpanId()}-{W3CConstants.TraceFlagRecordedAndNotRequested}", a.GetTraceparent());
+            Assert.IsNull(a.GetTracestate());
+        }
+
+        [TestMethod]
+        public void UpdateContextWithoutParent()
+        {
+            var a = new Activity("foo");
+
+            Assert.IsFalse(a.IsW3CActivity());
+
+            a.UpdateContextOnActivity();
+            Assert.IsTrue(a.IsW3CActivity());
+            Assert.IsNotNull(a.GetTraceId());
+            Assert.IsNotNull(a.GetSpanId());
+            Assert.IsNull(a.GetParentSpanId());
+            Assert.IsNotNull(a.GetSpanId());
+
+            Assert.AreEqual($"00-{a.GetTraceId()}-{a.GetSpanId()}-02", a.GetTraceparent());
+            Assert.IsNull(a.GetTracestate());
+        }
+
+        [TestMethod]
+        public void UpdateContextFromCompatibleRootId()
+        {
+            var a = new Activity("foo");
+            a.SetParentId(TraceId);
+
+            Assert.IsFalse(a.IsW3CActivity());
+
+            a.UpdateContextOnActivity();
+            Assert.IsTrue(a.IsW3CActivity());
+            Assert.AreEqual(TraceId, a.GetTraceId());
+            Assert.IsNotNull(a.GetSpanId());
+            Assert.IsNull(a.GetParentSpanId());
+            Assert.IsNotNull(a.GetSpanId());
+
+            Assert.AreEqual($"00-{a.GetTraceId()}-{a.GetSpanId()}-02", a.GetTraceparent());
+            Assert.IsNull(a.GetTracestate());
+        }
+
+        [TestMethod]
+        public void UpdateContextFromIncompatibleRootId()
+        {
+            var a = new Activity("foo");
+            a.SetParentId("abc");
+
+            Assert.IsFalse(a.IsW3CActivity());
+
+            a.UpdateContextOnActivity();
+            Assert.IsTrue(a.IsW3CActivity());
+            Assert.AreNotEqual("abc", a.GetTraceId());
+            Assert.IsNotNull(a.GetTraceId());
+            Assert.IsNotNull(a.GetSpanId());
+            Assert.IsNull(a.GetParentSpanId());
+            Assert.IsNotNull(a.GetSpanId());
+
+            Assert.AreEqual($"00-{a.GetTraceId()}-{a.GetSpanId()}-02", a.GetTraceparent());
+            Assert.IsNull(a.GetTracestate());
+        }
+
+        [TestMethod]
+        public void UpdateContextWithParent()
+        {
+            var parent = new Activity("foo").Start();
+            parent.SetTraceparent($"00-{TraceId}-{ParenSpanId}-01");
+            parent.SetTracestate("some=state");
+            var child = new Activity("bar").Start();
+            child.UpdateContextOnActivity();
+
+            Assert.IsTrue(child.IsW3CActivity());
+            Assert.AreEqual(TraceId, child.GetTraceId());
+            Assert.AreEqual(parent.GetSpanId(), child.GetParentSpanId());
+            Assert.AreEqual($"{W3CConstants.DefaultVersion}-{TraceId}-{child.GetSpanId()}-{W3CConstants.TraceFlagRecordedAndRequested}", child.GetTraceparent());
+            Assert.AreEqual(parent.GetTracestate(), child.GetTracestate());
+        }
+
+        [TestMethod]
+        public void SetTraceState()
+        {
+            var a = new Activity("foo").Start();
+            a.SetTracestate("some=state");
+            Assert.AreEqual("some=state", a.GetTracestate());
+        }
+
+        [TestMethod]
+        public void UnsupportedVersionsAreIgnored()
+        {
+            var a = new Activity("foo").Start();
+            a.SetTraceparent($"12-{TraceId}-{ParenSpanId}-00");
+
+            var b = new Activity("bar").Start();
+            b.SetTraceparent($"ff-{TraceId}-{ParenSpanId}-00");
+
+            Assert.AreEqual($"00-{TraceId}-{a.GetSpanId()}-02", a.GetTraceparent());
+            Assert.AreEqual($"00-{TraceId}-{b.GetSpanId()}-02", b.GetTraceparent());
+        }
+
+        [TestMethod]
+        public void RequestedFlagIsRespected()
+        {
+            var requestedParents = new[] { "01", "03", "05", "ff" };
+            var notRequestedParents = new[] { "00", "02", "04", "fe" };
+
+            foreach (var req in requestedParents)
+            {
+                var a = new Activity("foo").Start();
+                a.SetTraceparent($"00-{TraceId}-{ParenSpanId}-{req}");
+                Assert.AreEqual($"00-{TraceId}-{a.GetSpanId()}-03", a.GetTraceparent(), req);
+            }
+
+            foreach (var notReq in notRequestedParents)
+            {
+                var a = new Activity("foo").Start();
+                a.SetTraceparent($"00-{TraceId}-{ParenSpanId}-{notReq}");
+                Assert.AreEqual($"00-{TraceId}-{a.GetSpanId()}-02", a.GetTraceparent(), notReq);
+            }
+        }
+    }
+}