added tests to ensure we are forwarding the traces with properties se…

…t and that operation traces split input

src/Microsoft.Health.Dicom.Core.UnitTests/Features/Diagnostic/LogForwarderExtensionsTests.cs

@@ -0,0 +1,177 @@
+// -------------------------------------------------------------------------------------------------
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
+// -------------------------------------------------------------------------------------------------
+
+using System;
+using System.Collections.Generic;
+using Microsoft.ApplicationInsights;
+using Microsoft.ApplicationInsights.Channel;
+using Microsoft.ApplicationInsights.Extensibility;
+using Microsoft.Health.Dicom.Core.Features.Diagnostic;
+using Microsoft.Health.Dicom.Core.Features.Model;
+using Microsoft.Health.Dicom.Core.Features.Partitioning;
+using Microsoft.Health.Dicom.Tests.Common;
+using Xunit;
+
+namespace Microsoft.Health.Dicom.Core.UnitTests.Features.Diagnostic;
+
+public class LogForwarderExtensionsTests
+{
+    public LogForwarderExtensionsTests()
+    {
+    }
+
+    public class MockTelemetryChannel : ITelemetryChannel
+    {
+        public IList<ITelemetry> Items { get; private set; } = new List<ITelemetry>();
+
+        public void Send(ITelemetry item)
+        {
+            Items.Add(item);
+        }
+
+        public void Flush()
+        {
+            throw new NotImplementedException();
+        }
+
+        public bool? DeveloperMode { get; set; }
+        public string EndpointAddress { get; set; }
+
+        public void Dispose()
+        {
+            throw new NotImplementedException();
+        }
+    }
+
+    [Fact]
+    public void GivenClientUsingForwardTelemetry_ExpectForwardLogFlagIsSetWithNoAdditionalProperties()
+    {
+        MockTelemetryChannel channel = new MockTelemetryChannel();
+
+        TelemetryConfiguration configuration = new TelemetryConfiguration
+        {
+            TelemetryChannel = channel,
+#pragma warning disable CS0618 // Type or member is obsolete
+            InstrumentationKey = Guid.NewGuid().ToString()
+#pragma warning restore CS0618 // Type or member is obsolete
+        };
+        configuration.TelemetryInitializers.Add(new OperationCorrelationTelemetryInitializer());
+
+        TelemetryClient telemetryClient = new TelemetryClient(configuration);
+        telemetryClient.ForwardLogTrace("A message");
+
+        Assert.Single(channel.Items);
+#pragma warning disable CS0618 // Type or member is obsolete
+        Assert.Single(channel.Items[0].Context.Properties);
+        Assert.Equal(Boolean.TrueString, channel.Items[0].Context.Properties["forwardLog"]);
+#pragma warning restore CS0618 // Type or member is obsolete
+    }
+
+    [Fact]
+    public void GivenClientUsingForwardTelemetryWithIdentifier_ExpectForwardLogFlagIsSetWithAdditionalProperties()
+    {
+        MockTelemetryChannel channel = new MockTelemetryChannel();
+
+        TelemetryConfiguration configuration = new TelemetryConfiguration
+        {
+            TelemetryChannel = channel,
+#pragma warning disable CS0618 // Type or member is obsolete
+            InstrumentationKey = Guid.NewGuid().ToString()
+#pragma warning restore CS0618 // Type or member is obsolete
+        };
+        configuration.TelemetryInitializers.Add(new OperationCorrelationTelemetryInitializer());
+
+        TelemetryClient telemetryClient = new TelemetryClient(configuration);
+
+        var expectedIdentifier = new InstanceIdentifier(TestUidGenerator.Generate(), TestUidGenerator.Generate(),
+            TestUidGenerator.Generate(), Partition.Default);
+        telemetryClient.ForwardLogTrace("A message", expectedIdentifier);
+
+        Assert.Single(channel.Items);
+#pragma warning disable CS0618 // Type or member is obsolete
+        Assert.Equal(5, channel.Items[0].Context.Properties.Count);
+        Assert.Equal(expectedIdentifier.SopInstanceUid,
+            channel.Items[0].Context.Properties["dicomAdditionalInformation_sopInstanceUID"]);
+        Assert.Equal(expectedIdentifier.SeriesInstanceUid,
+            channel.Items[0].Context.Properties["dicomAdditionalInformation_seriesInstanceUID"]);
+        Assert.Equal(expectedIdentifier.StudyInstanceUid,
+            channel.Items[0].Context.Properties["dicomAdditionalInformation_studyInstanceUID"]);
+        Assert.Equal(expectedIdentifier.Partition.Name,
+            channel.Items[0].Context.Properties["dicomAdditionalInformation_partitionName"]);
+        Assert.Equal(Boolean.TrueString, channel.Items[0].Context.Properties["forwardLog"]);
+#pragma warning restore CS0618 // Type or member is obsolete
+    }
+
+    [Fact]
+    public void GivenClientUsingForwardTelemetry_whenForwardOperationLogTraceWithSizeLimit_ExpectForwardLogFlagIsSet()
+    {
+        MockTelemetryChannel channel = new MockTelemetryChannel();
+
+        TelemetryConfiguration configuration = new TelemetryConfiguration
+        {
+            TelemetryChannel = channel,
+#pragma warning disable CS0618 // Type or member is obsolete
+            InstrumentationKey = Guid.NewGuid().ToString()
+#pragma warning restore CS0618 // Type or member is obsolete
+        };
+        configuration.TelemetryInitializers.Add(new OperationCorrelationTelemetryInitializer());
+
+        TelemetryClient telemetryClient = new TelemetryClient(configuration);
+
+        var operationId = Guid.NewGuid().ToString();
+        var input = "input";
+        var message = "a message";
+        telemetryClient.ForwardOperationLogTrace(message, operationId, input);
+
+        Assert.Single(channel.Items);
+#pragma warning disable CS0618 // Type or member is obsolete
+        Assert.Equal(3, channel.Items[0].Context.Properties.Count);
+        Assert.Equal(Boolean.TrueString, channel.Items[0].Context.Properties["forwardLog"]);
+        Assert.Equal(operationId, channel.Items[0].Context.Properties["dicomAdditionalInformation_operationId"]);
+        Assert.Equal(input, channel.Items[0].Context.Properties["dicomAdditionalInformation_input"]);
+#pragma warning restore CS0618 // Type or member is obsolete
+    }
+
+    [Fact]
+    public void
+        GivenClientUsingForwardTelemetry_whenForwardOperationLogTraceWithSizeLimitExceeded_ExpectForwardLogFlagIsSetAndMultipleTelemetriesEmitted()
+    {
+        MockTelemetryChannel channel = new MockTelemetryChannel();
+
+        TelemetryConfiguration configuration = new TelemetryConfiguration
+        {
+            TelemetryChannel = channel,
+#pragma warning disable CS0618 // Type or member is obsolete
+            InstrumentationKey = Guid.NewGuid().ToString()
+#pragma warning restore CS0618 // Type or member is obsolete
+        };
+        configuration.TelemetryInitializers.Add(new OperationCorrelationTelemetryInitializer());
+
+        TelemetryClient telemetryClient = new TelemetryClient(configuration);
+
+        var operationId = Guid.NewGuid().ToString();
+        var expectedFirstItemInput = "a".PadRight(32 * 1024); // split occurs at 32 kb
+        var expectedSecondItemInput = "b".PadRight(32 * 1024); // split occurs at 32 kb
+        var fullInput = expectedFirstItemInput + expectedSecondItemInput;
+        var message = "a message";
+        telemetryClient.ForwardOperationLogTrace(message, operationId, fullInput);
+
+        Assert.Equal(2, channel.Items.Count);
+
+#pragma warning disable CS0618 // Type or member is obsolete
+        var firstItem = channel.Items[0];
+        Assert.Equal(3, firstItem.Context.Properties.Count);
+        Assert.Equal(Boolean.TrueString, firstItem.Context.Properties["forwardLog"]);
+        Assert.Equal(operationId, firstItem.Context.Properties["dicomAdditionalInformation_operationId"]);
+        Assert.Equal(expectedFirstItemInput, firstItem.Context.Properties["dicomAdditionalInformation_input"]);
+
+        var secondItem = channel.Items[1];
+        Assert.Equal(3, secondItem.Context.Properties.Count);
+        Assert.Equal(Boolean.TrueString, secondItem.Context.Properties["forwardLog"]);
+        Assert.Equal(operationId, secondItem.Context.Properties["dicomAdditionalInformation_operationId"]);
+        Assert.Equal(expectedSecondItemInput, secondItem.Context.Properties["dicomAdditionalInformation_input"]);
+#pragma warning restore CS0618 // Type or member is obsolete
+    }
+}

src/Microsoft.Health.Dicom.Core/Features/Diagnostic/LogForwarderExtensions.cs

@@ -16,7 +16,7 @@ namespace Microsoft.Health.Dicom.Core.Features.Diagnostic;
 /// </summary>
 internal static class LogForwarderExtensions
 {
-    private const int MaxShoeboxPropertySize = 32 * 1024;
+    internal const int MaxShoeboxPropertySize = 32 * 1024;
     private const string ForwardLogFlag = "forwardLog";
     private const string Prefix = "dicomAdditionalInformation_";
     private const string StudyInstanceUID = $"{Prefix}studyInstanceUID";