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

Jump to bottom

refactor TransmissionPolicy #2311

Merged
merged 8 commits into from
Jun 24, 2021
Merged

refactor TransmissionPolicy #2311

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5c07597
refactor TransmissionPolicy
TimothyMothra Jun 22, 2021
5db7401
fix
TimothyMothra Jun 22, 2021
0c47ba8
typo
TimothyMothra Jun 22, 2021
d2fb8c2
fix
TimothyMothra Jun 22, 2021
c397077
fix
TimothyMothra Jun 23, 2021
bf52489
new tests
TimothyMothra Jun 23, 2021
0cfbef0
Merge branch 'develop' into tilee/refactor_transmissionpolicy
TimothyMothra Jun 23, 2021
60317c2
cleanup
TimothyMothra Jun 23, 2021
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
2 changes: 2 additions & 0 deletions ...Test/ServerTelemetryChannel.Test/TelemetryChannel.Tests/Helpers/StubTransmissionPolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Helpers
{
using System;

using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation;
using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy;

internal class StubTransmissionPolicy : TransmissionPolicy
{
Expand Down
5 changes: 3 additions & 2 deletions BASE/Test/ServerTelemetryChannel.Test/TelemetryChannel.Tests/Helpers/StubTransmitter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
using Microsoft.ApplicationInsights.Channel;
using Microsoft.ApplicationInsights.Channel.Implementation;
using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation;
using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy;

internal class StubTransmitter : Transmitter
{
Expand All @@ -16,13 +17,13 @@ internal class StubTransmitter : Transmitter


public StubTransmitter()
: base(new StubTransmissionSender(), new StubTransmissionBuffer(), new StubTransmissionStorage(), Enumerable.Empty<TransmissionPolicy>(), new BackoffLogicManager(TimeSpan.FromMinutes(30)))
: base(new StubTransmissionSender(), new StubTransmissionBuffer(), new StubTransmissionStorage(), new TransmissionPolicyCollection(Enumerable.Empty<TransmissionPolicy>()), new BackoffLogicManager(TimeSpan.FromMinutes(30)))
{

}

public StubTransmitter(BackoffLogicManager backoffLogicManager)
: base(new StubTransmissionSender(), new StubTransmissionBuffer(), new StubTransmissionStorage(), Enumerable.Empty<TransmissionPolicy>(), backoffLogicManager)
: base(new StubTransmissionSender(), new StubTransmissionBuffer(), new StubTransmissionStorage(), new TransmissionPolicyCollection(Enumerable.Empty<TransmissionPolicy>()), backoffLogicManager)
{

}
Expand Down
6 changes: 2 additions & 4 deletions ...icationLifecycleTransmissionPolicyTest.cs → ...icationLifecycleTransmissionPolicyTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Threading.Tasks;
using Microsoft.ApplicationInsights.TestFramework;
using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Helpers;
using Microsoft.VisualStudio.TestTools.UnitTesting;

using Channel.Helpers;

using TaskEx = System.Threading.Tasks.Task;

public class ApplicationLifecycleTransmissionPolicyTest
{
[TestClass]
[TestCategory("TransmissionPolicy")]
public class HandleApplicationStoppingEvent : ApplicationLifecycleTransmissionPolicyTest
{
[TestMethod]
Expand Down
3 changes: 2 additions & 1 deletion ...on/ErrorHandlingTransmissionPolicyTest.cs → ...cy/ErrorHandlingTransmissionPolicyTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using System.Net.Http;

namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Diagnostics.Tracing;
Expand All @@ -23,6 +23,7 @@ namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implement
public class ErrorHandlingTransmissionPolicyTest
{
[TestClass]
[TestCategory("TransmissionPolicy")]
[TestCategory("WindowsOnly")] // these tests are flaky on linux builds.
public class HandleTransmissionSentEvent : ErrorHandlingTransmissionPolicyTest
{
Expand Down
6 changes: 5 additions & 1 deletion ...workAvailabilityTransmissionPolicyTest.cs → ...workAvailabilityTransmissionPolicyTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Diagnostics.Tracing;
Expand All @@ -13,9 +13,11 @@
using TaskEx = System.Threading.Tasks.Task;

[TestClass]
[TestCategory("TransmissionPolicy")]
public class NetworkAvailabilityTransmissionPolicyTest
{
[TestClass]
[TestCategory("TransmissionPolicy")]
public class Class : NetworkAvailabilityTransmissionPolicyTest
{
[TestMethod]
Expand Down Expand Up @@ -44,6 +46,7 @@ public void DisposeUnsubscribesNetworkChangeEvents()
}

[TestClass]
[TestCategory("TransmissionPolicy")]
public class Initialize : NetworkAvailabilityTransmissionPolicyTest
{
[TestMethod]
Expand Down Expand Up @@ -122,6 +125,7 @@ public void HandlesExceptionsThrownByNetworkWhenAddingAddressChangedEventHandler
}

[TestClass]
[TestCategory("TransmissionPolicy")]
public class HandleNetworkStatusChangedEvent : NetworkAvailabilityTransmissionPolicyTest
{
[TestMethod]
Expand Down
3 changes: 2 additions & 1 deletion ...n/PartialSuccessTransmissionPolicyTest.cs → ...y/PartialSuccessTransmissionPolicyTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.Channel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Collections.Generic;
Expand All @@ -15,6 +15,7 @@
using TaskEx = System.Threading.Tasks.Task;

[TestClass]
[TestCategory("TransmissionPolicy")]
public class PartialSuccessTransmissionPolicyTest
{
[TestMethod]
Expand Down
24 changes: 11 additions & 13 deletions ...ation/ThrottlingTransmissionPolicyTest.cs → ...olicy/ThrottlingTransmissionPolicyTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Diagnostics.Tracing;
Expand All @@ -13,29 +13,28 @@
public class ThrottlingTransmissionPolicyTest
{
[TestClass]
[TestCategory("TransmissionPolicy")]
public class HandleTransmissionSentEvent : ErrorHandlingTransmissionPolicyTest
{
private const int ResponseCodeTooManyRequests = 429;
private const int ResponseCodeTooManyRequestsOverExtendedTime = 439;
private const int ResponseCodePaymentRequired = 402;
private const int ResponseCodeUnsupported = 0;

[TestMethod]
public void AssertTooManyRequestsStopsSending()
{
this.PositiveTest(ResponseCodeTooManyRequests, 0, null, null, false);
this.PositiveTest(ResponseStatusCodes.ResponseCodeTooManyRequests, 0, null, null, false);
}

[TestMethod]
public void AssertTooManyRequestsStopsSendingWithFlushAsyncTask()
{
this.PositiveTest(ResponseCodeTooManyRequests, 0, 0, null, true);
this.PositiveTest(ResponseStatusCodes.ResponseCodeTooManyRequests, 0, 0, null, true);
}

[TestMethod]
public void AssertTooManyRequestsOverExtendedTimeStopsSendingAndCleansCache()
{
this.PositiveTest(ResponseCodeTooManyRequestsOverExtendedTime, 0, 0, 0, false);
this.PositiveTest(ResponseStatusCodes.ResponseCodeTooManyRequestsOverExtendedTime, 0, 0, 0, false);
}

[TestMethod]
Expand Down Expand Up @@ -124,23 +123,22 @@ private void PositiveTest(int responseCode, int? expectedSenderCapacity, int? ex
**/;

var policyApplied = new AutoResetEvent(false);
var transmitter = new StubTransmitter();
transmitter.OnApplyPolicies = () =>
var transmitter = new StubTransmitter
{
policyApplied.Set();
OnApplyPolicies = () => policyApplied.Set(),
};

var policy = new ThrottlingTransmissionPolicy();
policy.Initialize(transmitter);

string statusDescription = null;

transmitter.OnTransmissionSent(
new TransmissionProcessedEventArgs(
new StubTransmission() { IsFlushAsyncInProgress = hasFlushTask }, null, new HttpWebResponseWrapper()
transmission: new StubTransmission() { IsFlushAsyncInProgress = hasFlushTask },
exception: null,
response: new HttpWebResponseWrapper()
{
StatusCode = responseCode,
StatusDescription = statusDescription,
StatusDescription = null,
RetryAfterHeader = retryAfter
}));

Expand Down
58 changes: 58 additions & 0 deletions ...metryChannel.Tests/Implementation/TransmissionPolicy/TransmissionPolicyCollectionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using Microsoft.VisualStudio.TestTools.UnitTesting;

[TestClass]
[TestCategory("TransmissionPolicy")]
public class TransmissionPolicyCollectionTests
{
[TestMethod]
public void VerifyCalcuateMinimums()
{
// Setup
var policies = new TransmissionPolicyCollection(policies: new List<TransmissionPolicy>
{
new MockValueTransmissionPolicy(maxSenderCapacity: null, maxBufferCapacity: null, maxStorageCapacity: null),
new MockValueTransmissionPolicy(maxSenderCapacity: 1, maxBufferCapacity: 2, maxStorageCapacity: 3),
new MockValueTransmissionPolicy(maxSenderCapacity: 101, maxBufferCapacity: 102, maxStorageCapacity: 103),
});

// Act & Verify
Assert.AreEqual(1, policies.CalculateMinimumMaxSenderCapacity());
Assert.AreEqual(2, policies.CalculateMinimumMaxBufferCapacity());
Assert.AreEqual(3, policies.CalculateMinimumMaxStorageCapacity());
}


[TestMethod]
public void VerifyCalcuateMinimums_CanHandleNulls()
{
// Setup
var policies = new TransmissionPolicyCollection(policies: new List<TransmissionPolicy>
{
new MockValueTransmissionPolicy(maxSenderCapacity: null, maxBufferCapacity: null, maxStorageCapacity: null),
});

// Act & Verify
Assert.AreEqual(null, policies.CalculateMinimumMaxSenderCapacity());
Assert.AreEqual(null, policies.CalculateMinimumMaxBufferCapacity());
Assert.AreEqual(null, policies.CalculateMinimumMaxStorageCapacity());
}

private class MockValueTransmissionPolicy : TransmissionPolicy
{
public MockValueTransmissionPolicy(int? maxSenderCapacity, int? maxBufferCapacity, int? maxStorageCapacity)
{
this.MaxSenderCapacity = maxSenderCapacity;
this.MaxBufferCapacity = maxBufferCapacity;
this.MaxStorageCapacity = maxStorageCapacity;
}
}
}
}
2 changes: 1 addition & 1 deletion .../Implementation/TransmissionPolicyTest.cs → ...nsmissionPolicy/TransmissionPolicyTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Helpers;
Expand Down
5 changes: 3 additions & 2 deletions ...Test/ServerTelemetryChannel.Test/TelemetryChannel.Tests/Implementation/TransmitterTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
using TaskEx = System.Threading.Tasks.Task;
using System.Threading.Tasks;
using System.Threading;
using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy;

public class TransmitterTest
{
Expand All @@ -35,13 +36,13 @@ private static Transmitter CreateTransmitter(
TransmissionSender sender = null,
TransmissionBuffer buffer = null,
TransmissionStorage storage = null,
IEnumerable<TransmissionPolicy> policies = null)
IEnumerable<TransmissionPolicy.TransmissionPolicy> policies = null)
{
return new Transmitter(
sender ?? new StubTransmissionSender(),
buffer ?? new StubTransmissionBuffer(),
storage ?? new StubTransmissionStorage(),
policies);
new TransmissionPolicyCollection(policies));
}

[TestClass]
Expand Down
2 changes: 1 addition & 1 deletion ...ApplicationLifecycleTransmissionPolicy.cs → ...ApplicationLifecycleTransmissionPolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
Copy link
Contributor

Choose a reason for hiding this comment

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

dont think its really worthy as these are internals anyway.

Copy link
Member Author

Choose a reason for hiding this comment

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

We have 5 classes that inherit TransmissionPolicy. (I'm adding a 6th in my new PR).
I had a hard time finding the existing clrasses because they were all in the root.

I've moved them all to a unique subfolder and updated the namespace to match.

{
internal class ApplicationLifecycleTransmissionPolicy : TransmissionPolicy
{
Expand Down
2 changes: 1 addition & 1 deletion ...tation/ErrorHandlingTransmissionPolicy.cs → ...Policy/ErrorHandlingTransmissionPolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Globalization;
Expand Down
2 changes: 1 addition & 1 deletion .../NetworkAvailabilityTransmissionPolicy.cs → .../NetworkAvailabilityTransmissionPolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Net.NetworkInformation;
Expand Down
2 changes: 1 addition & 1 deletion ...ation/PartialSuccessTransmissionPolicy.cs → ...olicy/PartialSuccessTransmissionPolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Threading.Tasks;
Expand Down
2 changes: 1 addition & 1 deletion ...mentation/ThrottlingTransmissionPolicy.cs → ...ionPolicy/ThrottlingTransmissionPolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;
using System.Threading.Tasks;
Expand Down
2 changes: 1 addition & 1 deletion ...nnel/Implementation/TransmissionPolicy.cs → .../TransmissionPolicy/TransmissionPolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation
namespace Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.Implementation.TransmissionPolicy
{
using System;

Expand Down
Loading