Merge pull request #422 from Microsoft/develop

Merge develop to master with changes for 2.3 beta 2

Author: cijothomas

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 This changelog will be used to generate documentation on [release notes page](http://azure.microsoft.com/en-us/documentation/articles/app-insights-release-notes-dotnet/).
 
+## Version 2.3.0-beta2
+- Added constructor overloads for TelemetryConfiguration and added creation of a default InMemoryChannel when no channel is specified for a new instance.
+  TelemetryClient will no longer create an InMemoryChannel on the configuration instance if TelemetryChannel is null, instead the configuration instances will always have a channel when created.
+- TelemetryConfiguration will no longer dispose of user provided ITelemetryChannel instances.  Users must properly dispose of any channel instances which they create, the configuration will only auto-dispose of default channel instances it creates when none are specified by the user.
+
 ## Version 2.3.0-beta1
 - Added metric aggregation functionality via MetricManager and Metric classes.
 - Exposed a source field on RequestTelemetry. This can be used to store a representation of the component that issued the incoming http request. 

GlobalStaticVersion.props

@@ -8,7 +8,7 @@
     <SemanticVersionMajor>2</SemanticVersionMajor>
     <SemanticVersionMinor>3</SemanticVersionMinor>
     <SemanticVersionPatch>0</SemanticVersionPatch>
-    <PreReleaseMilestone>beta1</PreReleaseMilestone>
+    <PreReleaseMilestone>beta2</PreReleaseMilestone>
     <!-- 
       Date when Semantic Version was changed. 
       Update for every public release.

README.md

@@ -20,7 +20,7 @@ We recommend consuming the library as a NuGet package. Make sure to look for the
 
 ### Initialize a TelemetryClient
 
-The `TelemetryClient` object is the primary root object for the library. Almost all functionality around telemetry sending is located on this object. You must intiialize an instance of this object and populate it with your Instrumentation Key to identify your data.
+The `TelemetryClient` object is the primary root object for the library. Almost all functionality around telemetry sending is located on this object. You must initialize an instance of this object and populate it with your Instrumentation Key to identify your data.
 
 ```C#
 using Microsoft.ApplicationInsights;
@@ -62,7 +62,7 @@ Read about [how to use the API and see the results in the portal][api-overview].
 ## Branches
 
 - [master][master] contains the *latest* published release located on [NuGet][NuGetCore].
-- [development][develop] contains the code for the *next* release. 
+- [develop][develop] contains the code for the *next* release. 
 
 ## Contributing
 

Test/CoreSDK.Test/Shared/Channel/TelemetryBufferTest.cs

@@ -26,23 +26,54 @@ public void DefaultValueIsAppropriateForProductionEnvironmentAndUnitTests()
         {
             var buffer = new TelemetryBuffer();
             Assert.Equal(500, buffer.Capacity);
+            Assert.Equal(1000000, buffer.BacklogSize);
         }
 
         [TestMethod]
         public void CanBeSetByChannelToTunePerformance()
         {
             var buffer = new TelemetryBuffer();
             buffer.Capacity = 42;
+            buffer.BacklogSize = 9999;
             Assert.Equal(42, buffer.Capacity);
+            Assert.Equal(9999, buffer.BacklogSize);
         }
 
         [TestMethod]
-        public void WhenNewValueIsLessThanOneSetToDefault()
+        public void WhenNewValueIsLessThanMinimumSetToDefault()
         {
             var buffer = new TelemetryBuffer();
             buffer.Capacity = 0;
+            buffer.BacklogSize = 1000; //1001 is the minimum, setting to anything low should be overruled with minimum allowed.
 
-            Assert.Equal(buffer.Capacity, 500);
+            Assert.Equal(500,buffer.Capacity);
+            Assert.Equal(1001, buffer.BacklogSize);
+        }
+
+        [TestMethod]
+        public void MaxBacklogCannotBeBelowCapacity()
+        {     
+            var buffer = new TelemetryBuffer();
+            buffer.Capacity = 9999; // a value greater than the minimum allowed for MaxBacklogSize            
+
+            //Attempt to set MaxBacklogSize below Capacity
+            buffer.BacklogSize = buffer.Capacity - 1;
+
+            // Validate that MaximumBacklogSize will be set to Capacity
+            Assert.Equal(buffer.Capacity, buffer.BacklogSize);
+        }
+
+        [TestMethod]
+        public void CapacityCannotBeAboveBacklogSize()
+        {
+
+            var buffer = new TelemetryBuffer();            
+
+            //Attempt to set Capacity above MaxBacklogSize
+            buffer.Capacity = buffer.BacklogSize + 1;
+
+            // Validate that Capacity will be set to MaxBacklogSize
+            Assert.Equal(buffer.Capacity, buffer.BacklogSize);
         }
 
         [TestMethod]
@@ -58,5 +89,28 @@ public void TelemetryBufferCallingOnFullActionWhenBufferCapacityReached()
             Assert.NotNull(items);
             Assert.Equal(2, items.Count());
         }
+
+        [TestMethod]
+        public void TelemetryBufferDoesNotGrowBeyondMaxBacklogSize()
+        {            
+            TelemetryBuffer buffer = new TelemetryBuffer { Capacity = 2, BacklogSize = 1002};
+            buffer.OnFull = () => { //intentionaly blank to simulate situation where buffer
+                                    //is not emptied.
+                                  };
+
+            // Add more items to buffer than the max backlog size
+            for(int i = 0; i < 1005; i++)
+            {
+                buffer.Enqueue(new EventTelemetry("Event" + i));
+            }
+            
+            
+
+            // validate that items are not added after maxunsentbacklogsize is reached.
+            // this also validate that items can still be added after Capacity is reached as it is only a soft limit.
+            int bufferItemCount = buffer.Dequeue().Count();
+            Assert.Equal(1002, bufferItemCount);
+
+        }
     }
 }

Test/CoreSDK.Test/Shared/Extensibility/Implementation/Platform/PlatformImplementationTest.cs

@@ -2,6 +2,7 @@
 {
     using System;
     using System.IO;
+    using System.Security.Permissions;
     using System.Text;
     using Microsoft.VisualStudio.TestTools.UnitTesting;
 
@@ -45,6 +46,23 @@ public void ReadConfigurationXmlIgnoresMissingApplicationInsightsConfigurationFi
             Assert.AreEqual(0, configuration.Length);
         }
 
+        [TestMethod]
+        public void FailureToReadEnvironmentVariablesDoesNotThrowExceptions()
+        {
+            EnvironmentPermission permission = new EnvironmentPermission(EnvironmentPermissionAccess.NoAccess, "PATH");
+            try
+            {
+                permission.PermitOnly();
+                PlatformImplementation platform = new PlatformImplementation();
+                Assert.IsNull(platform.GetEnvironmentVariable("PATH"));
+                permission = null;
+            }
+            finally
+            {
+                EnvironmentPermission.RevertAll();
+            }
+        }
+
         protected virtual void Dispose(bool disposing)
         {
             if (disposing == true)

Test/CoreSDK.Test/Shared/Extensibility/Implementation/TaskTimerTest.cs

@@ -153,7 +153,7 @@ public void CancelsPreviousActionWhenStartIsCalledMultipleTimes()
             }
 
             [TestMethod]
-            [Timeout(1000)]
+            [Timeout(1500)]
             public void HandlesAsyncExceptionThrownByTheDelegate()
             {
                 TaskTimer timer = new TaskTimer { Delay = TimeSpan.FromMilliseconds(1) };
@@ -169,7 +169,7 @@ public void HandlesAsyncExceptionThrownByTheDelegate()
             }
 
             [TestMethod]
-            [Timeout(1000)]
+            [Timeout(1500)]
             public void HandlesSyncExceptionThrownByTheDelegate()
             {
                 TaskTimer timer = new TaskTimer { Delay = TimeSpan.FromMilliseconds(1) };

Test/CoreSDK.Test/Shared/Extensibility/Implementation/TelemetryProcessorChainBuilderTest.cs

@@ -84,7 +84,7 @@ public void BuildUsesTelemetryProcesorFactoryOnEachCall()
         [TestMethod]
         public void BuildOrdersTelemetryChannelsInOrderOfUseCalls()
         {
-           var config = new TelemetryConfiguration() {TelemetryChannel = new StubTelemetryChannel()};
+           var config = new TelemetryConfiguration(string.Empty, new StubTelemetryChannel());
            StringBuilder outputCollector = new StringBuilder();
            var builder = new TelemetryProcessorChainBuilder(config);
            builder.Use((next) => new StubTelemetryProcessor(next) { OnProcess = (item) => { outputCollector.Append("processor1"); } });

Test/CoreSDK.Test/Shared/Extensibility/Implementation/Tracing/PortalDiagnosticsSenderTest.cs

@@ -31,11 +31,7 @@ private readonly IDiagnoisticsEventThrottlingManager dontThrottleManager
         public PortalDiagnosticsSenderTest()
         {
             var configuration =
-                new TelemetryConfiguration
-                {
-                    TelemetryChannel = new StubTelemetryChannel { OnSend = item => this.sendItems.Add(item) },
-                    InstrumentationKey = Guid.NewGuid().ToString()
-                };
+                new TelemetryConfiguration(Guid.NewGuid().ToString(), new StubTelemetryChannel { OnSend = item => this.sendItems.Add(item) });
 
             this.nonThrottlingPortalSender = new PortalDiagnosticsSender(
                 configuration, 

Test/CoreSDK.Test/Shared/Extensibility/MetricManagerTest.cs

@@ -261,7 +261,7 @@ public void DisposingManagerCreatesAggregatedMetricTelemetry()
         private TelemetryClient InitializeTelemetryClient(List<ITelemetry> sentTelemetry)
         {
             var channel = new StubTelemetryChannel { OnSend = t => sentTelemetry.Add(t) };
-            var telemetryConfiguration = new TelemetryConfiguration { InstrumentationKey = Guid.NewGuid().ToString(), TelemetryChannel = channel };
+            var telemetryConfiguration = new TelemetryConfiguration(Guid.NewGuid().ToString(), channel);
 
             var client = new TelemetryClient(telemetryConfiguration);
 

Test/CoreSDK.Test/Shared/Extensibility/MetricTest.cs

@@ -409,7 +409,7 @@ private TelemetryClient InitializeTelemetryClient(List<ITelemetry> sentTelemetry
         {
             var channel = new StubTelemetryChannel { OnSend = t => sentTelemetry.Add(t) };
 
-            var telemetryConfiguration = new TelemetryConfiguration { InstrumentationKey = Guid.NewGuid().ToString(), TelemetryChannel = channel };
+            var telemetryConfiguration = new TelemetryConfiguration(Guid.NewGuid().ToString(), channel);
             telemetryConfiguration.MetricProcessors.Add(new StubMetricProcessor(sentSamples));
 
             var client = new TelemetryClient(telemetryConfiguration);