Merge pull request Azure#1698 from haocs/bugfix

[#111991911] Limit the size of the ConcurrentQueue of debug messages

Author: Hovsep

src/Common/Commands.Common/Commands.Common.csproj

@@ -149,6 +149,7 @@
     <Compile Include="AzureRmProfileProvider.cs" />
     <Compile Include="AzureSMProfileProvder.cs" />
     <Compile Include="AzureSubscriptionExtensions.cs" />
+    <Compile Include="ConcurrentQueueExtensions.cs" />
     <Compile Include="Constants.cs" />
     <Compile Include="ContextExtensions.cs" />
     <Compile Include="IProfileProvider.cs" />

src/Common/Commands.Common/ConcurrentQueueExtensions.cs

@@ -0,0 +1,44 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// 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
+// http://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.
+// ----------------------------------------------------------------------------------
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using System.Collections.Concurrent;
+
+namespace Microsoft.WindowsAzure.Commands.Common
+{
+    public static class ConcurrentQueueExtensions
+    {
+        private const int Capacity = 500;
+        public static void CheckAndEnqueue(this ConcurrentQueue<string> queue, string item)
+        {
+            if (queue == null || item == null)
+            {
+                return;
+            }
+            lock(queue)
+            {
+                while (queue.Count >= Capacity)
+                {
+                    string result;
+                    queue.TryDequeue(out result);
+                }
+                queue.Enqueue(item);
+            } 
+        }
+    }
+}

src/Common/Commands.Common/DebugStreamTraceListener.cs

@@ -34,7 +34,7 @@ public static void AddAdalTracing(DebugStreamTraceListener listener)
         public ConcurrentQueue<string> Messages; 
         public override void Write(string message)
         {
-            Messages.Enqueue(message);
+            Messages.CheckAndEnqueue(message);
         }
 
         public override void WriteLine(string message)

src/Common/Commands.Common/RecordingTracingInterceptor.cs

@@ -18,6 +18,7 @@
 using System.Net.Http;
 using Hyak.Common;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
+using Microsoft.WindowsAzure.Commands.Common;
 
 namespace Microsoft.Azure.Common.Authentication.Models
 {
@@ -34,17 +35,17 @@ private void Write(string message, params object[] arguments)
         {
             if (arguments == null || arguments.Length == 0)
             {
-                MessageQueue.Enqueue(message);
+                MessageQueue.CheckAndEnqueue(message);
             }
             else
             {
-                MessageQueue.Enqueue(string.Format(message, arguments));
+                MessageQueue.CheckAndEnqueue(string.Format(message, arguments));
             }
         }
 
         public void Information(string message)
         {
-            MessageQueue.Enqueue(message);
+            MessageQueue.CheckAndEnqueue(message);
         }
 
         public void Configuration(string source, string name, string value)

src/Common/Commands.Common/ServiceClientTracingInterceptor.cs

@@ -20,7 +20,6 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
-
 namespace Microsoft.WindowsAzure.Commands.Common
 {
     class ServiceClientTracingInterceptor : IServiceClientTracingInterceptor
@@ -49,19 +48,19 @@ public void ExitMethod(string invocationId, object returnValue)
 
         public void Information(string message)
         {
-            MessageQueue.Enqueue(message);
+            MessageQueue.CheckAndEnqueue(message);
         }
 
         public void ReceiveResponse(string invocationId, System.Net.Http.HttpResponseMessage response)
         {
             string responseAsString = response == null ? string.Empty : response.AsFormattedString();
-            MessageQueue.Enqueue(responseAsString);
+            MessageQueue.CheckAndEnqueue(responseAsString);
         }
 
         public void SendRequest(string invocationId, System.Net.Http.HttpRequestMessage request)
         {
             string requestAsString = request == null ? string.Empty : request.AsFormattedString();
-            MessageQueue.Enqueue(requestAsString);
+            MessageQueue.CheckAndEnqueue(requestAsString);
         }
 
         public void TraceError(string invocationId, Exception exception)

src/ResourceManager/Profile/Commands.Profile.Test/AzureRMProfileTests.cs

@@ -23,6 +23,8 @@
 using Microsoft.WindowsAzure.Commands.ScenarioTest;
 using Microsoft.WindowsAzure.Commands.Common;
 using Moq;
+using System.Collections.Concurrent;
+using System.Threading.Tasks;
 
 namespace Microsoft.Azure.Commands.ResourceManager.Common.Test
 {
@@ -243,7 +245,7 @@ public void NoSubscriptionsInListDoesNotThrow()
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
-      public void SetContextPreservesTokenCache()
+        public void SetContextPreservesTokenCache()
         {
             AzureRMProfile profile = null;
             AzureContext context = new AzureContext(null, null, null, null);
@@ -253,5 +255,21 @@ public void SetContextPreservesTokenCache()
             profile.SetContextWithCache(context);
             Assert.Equal(TokenCache.DefaultShared.Serialize(), profile.Context.TokenCache);
         }
+
+        [Fact]
+        public void AzurePSComletMessageQueue()
+        {
+            ConcurrentQueue<string> queue = new ConcurrentQueue<string>();
+      
+            Parallel.For(0, 5, i =>
+            {
+                for (int j = 0; j < 300; j++)
+                {
+                    queue.CheckAndEnqueue(j.ToString());
+                }
+            });
+
+            Assert.Equal(500, queue.Count);
+        }
     }
 }