Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

making TextWriterTraceAdapter synchronized #1043

Merged
merged 1 commit into from
Mar 6, 2017
Merged

making TextWriterTraceAdapter synchronized #1043

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/Microsoft.Azure.WebJobs.Host/Bindings/TraceWriter/TextWriterTraceAdapter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ internal class TextWriterTraceAdapter : TextWriter
private readonly StringBuilder _text;
private readonly TraceWriter _traceWriter;

public TextWriterTraceAdapter(TraceWriter traceWriter)
private TextWriterTraceAdapter(TraceWriter traceWriter)
: base(CultureInfo.InvariantCulture)
{
_text = new StringBuilder();
Expand All @@ -27,14 +27,18 @@ public override Encoding Encoding
{
get { return Encoding.Default; }
}
public static TextWriter Synchronized(TraceWriter traceWriter)
{
return TextWriter.Synchronized(new TextWriterTraceAdapter(traceWriter));
}

public override void Write(char value)
{
// buffer all output
_text.Append(value);

int len = _text.Length;
if (len > 2 && _text[len - 2] == '\r' && _text[len - 1] == '\n')
if (len >= 2 && _text[len - 2] == '\r' && _text[len - 1] == '\n')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain this change?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my test, I just log WriteLine(string.Empty) -- which looks like it just sends '\r\n'. In that case, the string length was only 2, so this logic didn't kick in like I would have expected. Instead, it waited until it had '\r\n\r\n' before flushing. It's a minor change -- but I thought it made sense.

{
// when we see a newline, flush the output
// flushing often is very important - we need to ensure that output
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Azure.WebJobs.Host/Bindings/TraceWriter/TraceWriterBinding.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public Task<IValueProvider> BindAsync(BindingContext context)
else
{
// bind to an adapter
tracer = new TextWriterTraceAdapter(context.Trace);
tracer = TextWriterTraceAdapter.Synchronized(context.Trace);
}

return BindAsync(tracer, context.ValueContext);
Expand Down
9 changes: 6 additions & 3 deletions src/Microsoft.Azure.WebJobs.Host/GlobalSuppressions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,13 @@
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.IConverterManagerExtensions.#AddConverterBuilder`3(Microsoft.Azure.WebJobs.IConverterManager,System.Type,System.Object[])")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.IConverterManagerExtensions.#AddConverterBuilder`3(Microsoft.Azure.WebJobs.IConverterManager,System.Object)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Tables.TableAttributeBindingProvider+Table2IQueryableConverter`1.#Convert(Microsoft.Azure.WebJobs.Host.Storage.Table.IStorageTable)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Tables.TableAttributeBindingProvider+Object2ITableEntityConverter`1.#Convert(!0)")][assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "WindowsAzure", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.AzureStorageDeploymentValidator.#Validate()")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Tables.TableAttributeBindingProvider+Object2ITableEntityConverter`1.#Convert(!0)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "WindowsAzure", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.AzureStorageDeploymentValidator.#Validate()")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.AsyncCollectorBinding`2.#BuildAsync(!0,Microsoft.Azure.WebJobs.Host.Bindings.BindingContext)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.ExactTypeBindingProvider`2+ExactBinding.#BuildAsync(!0,Microsoft.Azure.WebJobs.Host.Bindings.BindingContext)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.GenericItemBindingProvider`1+Binding.#BuildAsync(!0,Microsoft.Azure.WebJobs.Host.Bindings.BindingContext)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.ItemBindingProvider`1+Binding.#BuildAsync(!0,Microsoft.Azure.WebJobs.Host.Bindings.BindingContext)")][assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Tables.TableAttributeBindingProvider+Object2ITableEntityConverter`1.#Convert(!0)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.ItemBindingProvider`1+Binding.#BuildAsync(!0,Microsoft.Azure.WebJobs.Host.Bindings.BindingContext)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Tables.TableAttributeBindingProvider+Object2ITableEntityConverter`1.#Convert(!0)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.BindingFactory.#BindToInput`2(System.Boolean,System.Type,System.Object[])")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.BindingFactory.#BindToInput`2(System.Boolean,System.Object)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.BindingFactory.#BindToInput`2(System.Object)")]
Expand All @@ -49,4 +51,5 @@
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.IConverterManager.#AddConverter`3(System.Func`3<System.Type,System.Type,System.Func`2<System.Object,System.Object>>)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.IConverterManagerExtensions.#AddConverter`3(Microsoft.Azure.WebJobs.IConverterManager,System.Type,System.Object[])")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.IConverterManagerExtensions.#AddConverter`3(Microsoft.Azure.WebJobs.IConverterManager,System.Object)")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.BindingFactory.#BindToCollector`2(System.Type,System.Object[])")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.BindingFactory.#BindToCollector`2(System.Type,System.Object[])")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Host.Bindings.TextWriterTraceAdapter.#Synchronized(Microsoft.Azure.WebJobs.Host.TraceWriter)")]
26 changes: 24 additions & 2 deletions ...icrosoft.Azure.WebJobs.Host.UnitTests/Bindings/TraceWriter/TextWriterTraceAdapterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Threading.Tasks;
using Microsoft.Azure.WebJobs.Host.Bindings;
using Microsoft.Azure.WebJobs.Host.TestCommon;
using Moq;
using Xunit;

Expand All @@ -12,12 +15,12 @@ namespace Microsoft.Azure.WebJobs.Host.UnitTests.Bindings
public class TextWriterTraceAdapterTests
{
private readonly Mock<TraceWriter> _mockTraceWriter;
private readonly TextWriterTraceAdapter _adapter;
private readonly TextWriter _adapter;

public TextWriterTraceAdapterTests()
{
_mockTraceWriter = new Mock<TraceWriter>(MockBehavior.Strict, TraceLevel.Verbose);
_adapter = new TextWriterTraceAdapter(_mockTraceWriter.Object);
_adapter = TextWriterTraceAdapter.Synchronized(_mockTraceWriter.Object);
}

[Fact]
Expand Down Expand Up @@ -70,5 +73,24 @@ public void Flush_FlushesRemainingBuffer()

_mockTraceWriter.VerifyAll();
}

[Fact]
public async Task TestMultipleThreads()
{
// This validates a bug where writing from multiple threads throws an exception.
TestTraceWriter trace = new TestTraceWriter(TraceLevel.Verbose);
TextWriter adapter = TextWriterTraceAdapter.Synchronized(trace);

// Start Tasks to write
List<Task> tasks = new List<Task>();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this test repro the problem reliably?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, every time.

for (int i = 0; i < 1000; i++)
{
tasks.Add(adapter.WriteLineAsync(string.Empty));
}

await Task.WhenAll(tasks);

Assert.Equal(1000, trace.Traces.Count);
}
}
}