Merge pull request #669 from Azure/release-3.4.0

SeanFeldman · web-flow · commit ff1093d6c538 · 2019-03-20T17:05:19.000-07:00
Release 3.4.0
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,3 +1,13 @@
+---
+name: Bug report
+about: Report a bug to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+
 ## Actual Behavior
 1. 
 2. 
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. E.g. “I’m always frustrated when [...]”
+
+**Describe the solution you’d like**
+
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you’ve considered**
+
+A clear and concise description of any alternative solutions or features you’ve considered.
+
+**Additional context**
+
+Add any other context or screenshots about the feature request here.
diff --git a/src/Microsoft.Azure.ServiceBus/Amqp/AmqpConnectionHelper.cs b/src/Microsoft.Azure.ServiceBus/Amqp/AmqpConnectionHelper.cs
@@ -4,6 +4,7 @@
 namespace Microsoft.Azure.ServiceBus.Amqp
 {
     using System;
+    using System.Net;
     using Microsoft.Azure.Amqp;
     using Microsoft.Azure.Amqp.Sasl;
     using Microsoft.Azure.Amqp.Transport;
@@ -101,7 +102,8 @@ public static TransportSettings CreateTcpTransportSettings(
         public static TransportSettings CreateWebSocketTransportSettings(
             string networkHost,
             string hostName,
-            int port)
+            int port,
+            IWebProxy proxy)
         {
             var uriBuilder = new UriBuilder(
                 WebSocketConstants.WebSocketSecureScheme,
@@ -112,7 +114,8 @@ public static TransportSettings CreateWebSocketTransportSettings(
             {
                 Uri = uriBuilder.Uri,
                 ReceiveBufferSize = AmqpConstants.TransportBufferSize,
-                SendBufferSize = AmqpConstants.TransportBufferSize
+                SendBufferSize = AmqpConstants.TransportBufferSize,
+                Proxy = proxy
             };
 
             TransportSettings tpSettings = webSocketTransportSettings;
diff --git a/src/Microsoft.Azure.ServiceBus/Core/MessageSender.cs b/src/Microsoft.Azure.ServiceBus/Core/MessageSender.cs
@@ -237,6 +237,11 @@ public async Task SendAsync(IList<Message> messageList)
             this.ThrowIfClosed();
 
             var count = MessageSender.ValidateMessages(messageList);
+            if (count <= 0)
+            {
+                return;
+            }
+
             MessagingEventSource.Log.MessageSendStart(this.ClientId, count);
 
             bool isDiagnosticSourceEnabled = ServiceBusDiagnosticSource.IsEnabled();
diff --git a/src/Microsoft.Azure.ServiceBus/Management/ManagementClient.cs b/src/Microsoft.Azure.ServiceBus/Management/ManagementClient.cs
@@ -18,7 +18,6 @@ public class ManagementClient
         private HttpClient httpClient;
         private readonly string endpointFQDN;
         private readonly ITokenProvider tokenProvider;
-        private readonly TimeSpan operationTimeout;
         private readonly int port;
         private readonly string clientId;
 
@@ -48,14 +47,13 @@ public ManagementClient(string endpoint, ITokenProvider tokenProvider)
         /// <param name="tokenProvider">Token provider which will generate security tokens for authorization.</param>
         public ManagementClient(ServiceBusConnectionStringBuilder connectionStringBuilder, ITokenProvider tokenProvider = default)
         {
-            this.httpClient = new HttpClient();
+            this.httpClient = new HttpClient { Timeout = connectionStringBuilder.OperationTimeout };
             this.endpointFQDN = connectionStringBuilder.Endpoint;
             this.tokenProvider = tokenProvider ?? CreateTokenProvider(connectionStringBuilder);
-            this.operationTimeout = Constants.DefaultOperationTimeout;
             this.port = GetPort(connectionStringBuilder.Endpoint);
             this.clientId = nameof(ManagementClient) + Guid.NewGuid().ToString("N").Substring(0, 6);
 
-            MessagingEventSource.Log.ManagementClientCreated(this.clientId, this.operationTimeout.TotalSeconds, this.tokenProvider.ToString());
+            MessagingEventSource.Log.ManagementClientCreated(this.clientId, this.httpClient.Timeout.TotalSeconds, this.tokenProvider.ToString());
         }
 
         public static HttpRequestMessage CloneRequest(HttpRequestMessage req)
diff --git a/src/Microsoft.Azure.ServiceBus/Management/NamespaceInfoExtensions.cs b/src/Microsoft.Azure.ServiceBus/Management/NamespaceInfoExtensions.cs
@@ -57,11 +57,19 @@ private static NamespaceInfo ParseFromEntryElement(XElement xEntry)
                     case "Alias":
                         nsInfo.Alias = element.Value;
                         break;
+                    case "MessagingUnits":
+                        int.TryParse(element.Value, out var units);
+                        nsInfo.MessagingUnits = units;
+                        break;
                     case "NamespaceType":
                         if (Enum.TryParse<NamespaceType>(element.Value, out var nsType))
                         {
                             nsInfo.NamespaceType = nsType;
                         }
+                        else if (element.Value == "Messaging") // TODO: workaround till next major as it's a breaking change
+                        {
+                            nsInfo.NamespaceType = NamespaceType.ServiceBus;
+                        }
                         else
                         {
                             nsInfo.NamespaceType = NamespaceType.Others;
diff --git a/src/Microsoft.Azure.ServiceBus/Management/NamespaceType.cs b/src/Microsoft.Azure.ServiceBus/Management/NamespaceType.cs
@@ -15,7 +15,7 @@ public enum NamespaceType
 
         /// <summary>
         /// Supported only for backward compatibility.
-        /// Namespace can contain mixture of messaging entities and notification hubs. 
+        /// Namespace can contain mixture of messaging entities and notification hubs.
         /// </summary>
         Mixed = 2,
 
diff --git a/src/Microsoft.Azure.ServiceBus/Message.cs b/src/Microsoft.Azure.ServiceBus/Message.cs
@@ -268,7 +268,7 @@ public TimeSpan TimeToLive
         /// <summary>
         /// Gets the total size of the message body in bytes.
         /// </summary>
-        public long Size => Body.Length;
+        public long Size => this.Body != null ? this.Body.Length : 0;
 
         /// <summary>
         /// Gets the "user properties" bag, which can be used for custom message metadata.
diff --git a/src/Microsoft.Azure.ServiceBus/Microsoft.Azure.ServiceBus.csproj b/src/Microsoft.Azure.ServiceBus/Microsoft.Azure.ServiceBus.csproj
@@ -23,14 +23,14 @@
     <GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>
     <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <NoWarn>CS1591;CS1573</NoWarn>
+    <NoWarn>CS1591;CS1573;NU5125</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Azure.Amqp" Version="[2.3.7, 3.0.0)" />
+    <PackageReference Include="Microsoft.Azure.Amqp" Version="[2.4.1, 3.0.0)" />
     <PackageReference Include="Microsoft.Azure.Services.AppAuthentication" Version="[1.0.1, 2.0.0)" />
     <PackageReference Include="Microsoft.IdentityModel.Clients.ActiveDirectory" Version="[3.17.2, 5.0.0)" />
-    <PackageReference Include="System.Diagnostics.DiagnosticSource" Version="4.4.1" />
+    <PackageReference Include="System.Diagnostics.DiagnosticSource" Version="4.5.1" />
     <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="[5.2.2, 6.0.0)" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0-beta2-18618-05" PrivateAssets="All" />
   </ItemGroup>
diff --git a/src/Microsoft.Azure.ServiceBus/ServiceBusConnection.cs b/src/Microsoft.Azure.ServiceBus/ServiceBusConnection.cs
@@ -4,6 +4,7 @@
 namespace Microsoft.Azure.ServiceBus
 {
     using System;
+    using System.Net;
     using System.Threading.Tasks;
     using Microsoft.Azure.Amqp;
     using Microsoft.Azure.Amqp.Framing;
@@ -37,19 +38,43 @@ public ServiceBusConnection(ServiceBusConnectionStringBuilder connectionStringBu
         /// <param name="namespaceConnectionString">Namespace connection string</param>
         /// <remarks>It is the responsibility of the user to close the connection after use through <see cref="CloseAsync"/></remarks>
         public ServiceBusConnection(string namespaceConnectionString)
-            : this(namespaceConnectionString, Constants.DefaultOperationTimeout, RetryPolicy.Default)
+            : this(namespaceConnectionString, RetryPolicy.Default)
         {
         }
 
+        /// <summary>
+        /// Creates a new connection to service bus.
+        /// </summary>
+        /// <param name="namespaceConnectionString">Namespace connection string.</param>
+        /// <param name="retryPolicy">Retry policy for operations. Defaults to <see cref="RetryPolicy.Default"/></param>
+        /// <remarks>It is the responsibility of the user to close the connection after use through <see cref="CloseAsync"/></remarks>
+        public ServiceBusConnection(string namespaceConnectionString, RetryPolicy retryPolicy = null)
+            : this(retryPolicy)
+        {
+            if (string.IsNullOrWhiteSpace(namespaceConnectionString))
+            {
+                throw Fx.Exception.ArgumentNullOrWhiteSpace(nameof(namespaceConnectionString));
+            }
+
+            var serviceBusConnectionStringBuilder = new ServiceBusConnectionStringBuilder(namespaceConnectionString);
+            if (!string.IsNullOrWhiteSpace(serviceBusConnectionStringBuilder.EntityPath))
+            {
+                throw Fx.Exception.Argument(nameof(namespaceConnectionString), "NamespaceConnectionString should not contain EntityPath.");
+            }
+
+            this.InitializeConnection(serviceBusConnectionStringBuilder);
+        }
+
         /// <summary>
         /// Creates a new connection to service bus.
         /// </summary>
         /// <param name="namespaceConnectionString">Namespace connection string.</param>
         /// <param name="operationTimeout">Duration after which individual operations will timeout.</param>
         /// <param name="retryPolicy">Retry policy for operations. Defaults to <see cref="RetryPolicy.Default"/></param>
         /// <remarks>It is the responsibility of the user to close the connection after use through <see cref="CloseAsync"/></remarks>
+        [Obsolete("This constructor is obsolete. Use ServiceBusConnection(string namespaceConnectionString, RetryPolicy retryPolicy) constructor instead, providing operationTimeout in the connection string.")]
         public ServiceBusConnection(string namespaceConnectionString, TimeSpan operationTimeout, RetryPolicy retryPolicy = null)
-            : this(operationTimeout, retryPolicy)
+            : this(retryPolicy)
         {
             if (string.IsNullOrWhiteSpace(namespaceConnectionString))
             {
@@ -63,6 +88,8 @@ public ServiceBusConnection(string namespaceConnectionString, TimeSpan operation
             }
 
             this.InitializeConnection(serviceBusConnectionStringBuilder);
+            // operationTimeout argument explicitly provided by caller should take precedence over OperationTimeout found in the connection string.
+            this.OperationTimeout = operationTimeout;
         }
 
         /// <summary>
@@ -72,7 +99,7 @@ public ServiceBusConnection(string namespaceConnectionString, TimeSpan operation
         /// <param name="transportType">Transport type.</param>
         /// <param name="retryPolicy">Retry policy for operations. Defaults to <see cref="RetryPolicy.Default"/></param>
         public ServiceBusConnection(string endpoint, TransportType transportType, RetryPolicy retryPolicy = null)
-            : this(Constants.DefaultOperationTimeout, retryPolicy)
+            : this(retryPolicy)
         {
             if (string.IsNullOrWhiteSpace(endpoint))
             {
@@ -88,9 +115,8 @@ public ServiceBusConnection(string endpoint, TransportType transportType, RetryP
             this.InitializeConnection(serviceBusConnectionStringBuilder);
         }
 
-        internal ServiceBusConnection(TimeSpan operationTimeout, RetryPolicy retryPolicy = null)
+        internal ServiceBusConnection(RetryPolicy retryPolicy = null)
         {
-            this.OperationTimeout = operationTimeout;
             this.RetryPolicy = retryPolicy ?? RetryPolicy.Default;
             this.syncLock = new object();
         }
@@ -193,6 +219,7 @@ void InitializeConnection(ServiceBusConnectionStringBuilder builder)
                 this.TokenProvider = new SharedAccessSignatureTokenProvider(builder.SasKeyName, builder.SasKey);
             }
 
+            this.OperationTimeout = builder.OperationTimeout;
             this.TransportType = builder.TransportType;
             this.ConnectionManager = new FaultTolerantAmqpObject<AmqpConnection>(this.CreateConnectionAsync, CloseConnection);
             this.TransactionController = new FaultTolerantAmqpObject<Controller>(this.CreateControllerAsync, CloseController);
@@ -283,7 +310,8 @@ TransportSettings CreateTransportSettings()
                 return AmqpConnectionHelper.CreateWebSocketTransportSettings(
                     networkHost: networkHost,
                     hostName: hostName,
-                    port: port);
+                    port: port,
+                    proxy: WebRequest.DefaultWebProxy);
             }
 
             return AmqpConnectionHelper.CreateTcpTransportSettings(
diff --git a/src/Microsoft.Azure.ServiceBus/ServiceBusConnectionStringBuilder.cs b/src/Microsoft.Azure.ServiceBus/ServiceBusConnectionStringBuilder.cs
@@ -5,6 +5,7 @@ namespace Microsoft.Azure.ServiceBus
 {
     using System;
     using System.Collections.Generic;
+    using System.Globalization;
     using System.Text;
     using Primitives;
 
@@ -24,6 +25,8 @@ public class ServiceBusConnectionStringBuilder
         const string EntityPathConfigName = "EntityPath";
         const string TransportTypeConfigName = "TransportType";
 
+        const string OperationTimeoutConfigName = "OperationTimeout";
+
         string entityPath, sasKeyName, sasKey, sasToken, endpoint;
 
         /// <summary>
@@ -212,6 +215,12 @@ public string SasToken
         /// </summary>
         public TransportType TransportType { get; set; }
 
+        /// <summary>
+        /// Duration after which individual operations will timeout.
+        /// </summary>
+        /// <remarks>Defaults to 1 minute.</remarks>
+        public TimeSpan OperationTimeout { get; set; } = Constants.DefaultOperationTimeout;
+
         internal Dictionary<string, string> ConnectionStringProperties = new Dictionary<string, string>(StringComparer.CurrentCultureIgnoreCase);
 
         /// <summary>
@@ -243,7 +252,12 @@ public string GetNamespaceConnectionString()
 
             if (this.TransportType != TransportType.Amqp)
             {
-                connectionStringBuilder.Append($"{TransportTypeConfigName}{KeyValueSeparator}{this.TransportType}");
+                connectionStringBuilder.Append($"{TransportTypeConfigName}{KeyValueSeparator}{this.TransportType}{KeyValuePairDelimiter}");
+            }
+
+            if (this.OperationTimeout != Constants.DefaultOperationTimeout)
+            {
+                connectionStringBuilder.Append($"{OperationTimeoutConfigName}{KeyValueSeparator}{this.OperationTimeout}{KeyValuePairDelimiter}");
             }
 
             return connectionStringBuilder.ToString().Trim(';');
@@ -319,6 +333,31 @@ void ParseConnectionString(string connectionString)
                         this.TransportType = transportType;
                     }
                 }
+                else if (key.Equals(OperationTimeoutConfigName, StringComparison.OrdinalIgnoreCase))
+                {
+                    if (int.TryParse(value, NumberStyles.Integer, NumberFormatInfo.InvariantInfo, out var timeoutInSeconds))
+                    {
+                        this.OperationTimeout = TimeSpan.FromSeconds(timeoutInSeconds);
+                    }
+                    else if (TimeSpan.TryParse(value, NumberFormatInfo.InvariantInfo, out var operationTimeout))
+                    {
+                        this.OperationTimeout = operationTimeout;
+                    }
+                    else
+                    {
+                        throw Fx.Exception.Argument(nameof(connectionString), $"The {OperationTimeoutConfigName} ({value}) format is invalid. It must be an integer representing a number of seconds.");
+                    }
+
+                    if (this.OperationTimeout.TotalMilliseconds <= 0)
+                    {
+                        throw Fx.Exception.Argument(nameof(connectionString), $"The {OperationTimeoutConfigName} ({value}) must be greater than zero.");
+                    }
+
+                    if (this.OperationTimeout.TotalHours >= 1)
+                    {
+                        throw Fx.Exception.Argument(nameof(connectionString), $"The {OperationTimeoutConfigName} ({value}) must be smaller than one hour.");
+                    }
+                }
                 else
                 {
                     ConnectionStringProperties[key] = value;
diff --git a/test/Microsoft.Azure.ServiceBus.UnitTests/API/ApiApprovals.ApproveAzureServiceBus.approved.txt b/test/Microsoft.Azure.ServiceBus.UnitTests/API/ApiApprovals.ApproveAzureServiceBus.approved.txt
@@ -309,6 +309,10 @@ namespace Microsoft.Azure.ServiceBus
     {
         public ServiceBusConnection(Microsoft.Azure.ServiceBus.ServiceBusConnectionStringBuilder connectionStringBuilder) { }
         public ServiceBusConnection(string namespaceConnectionString) { }
+        public ServiceBusConnection(string namespaceConnectionString, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy = null) { }
+        [System.ObsoleteAttribute("This constructor is obsolete. Use ServiceBusConnection(string namespaceConnection" +
+            "String, RetryPolicy retryPolicy) constructor instead, providing operationTimeout" +
+            " in the connection string.")]
         public ServiceBusConnection(string namespaceConnectionString, System.TimeSpan operationTimeout, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy = null) { }
         public ServiceBusConnection(string endpoint, Microsoft.Azure.ServiceBus.TransportType transportType, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy = null) { }
         public System.Uri Endpoint { get; set; }
@@ -329,6 +333,7 @@ namespace Microsoft.Azure.ServiceBus
         public ServiceBusConnectionStringBuilder(string endpoint, string entityPath, string sharedAccessSignature, Microsoft.Azure.ServiceBus.TransportType transportType) { }
         public string Endpoint { get; set; }
         public string EntityPath { get; set; }
+        public System.TimeSpan OperationTimeout { get; set; }
         public string SasKey { get; set; }
         public string SasKeyName { get; set; }
         public string SasToken { get; set; }
diff --git a/test/Microsoft.Azure.ServiceBus.UnitTests/Management/ManagementClientTests.cs b/test/Microsoft.Azure.ServiceBus.UnitTests/Management/ManagementClientTests.cs
@@ -639,7 +639,8 @@ public async Task GetNamespaceInfoTest()
         {
             var nsInfo = await client.GetNamespaceInfoAsync();
             Assert.NotNull(nsInfo);
-            Assert.Equal(MessagingSku.Standard, nsInfo.MessagingSku);   // Most CI systems generally use standard, hence this check just to ensure the API is working.
+            Assert.Equal(MessagingSku.Standard, nsInfo.MessagingSku);    // Most CI systems generally use standard, hence this check just to ensure the API is working.
+            Assert.Equal(NamespaceType.ServiceBus, nsInfo.NamespaceType); // Common namespace type used for testing is messaging.
         }
 
         public void Dispose()
diff --git a/test/Microsoft.Azure.ServiceBus.UnitTests/Microsoft.Azure.ServiceBus.UnitTests.csproj b/test/Microsoft.Azure.ServiceBus.UnitTests/Microsoft.Azure.ServiceBus.UnitTests.csproj
@@ -36,14 +36,14 @@
     <compile Remove="..\..\test\Microsoft.Azure.ServiceBus.UnitTests\Diagnostics\SubscriptionClientDiagnosticsTests.cs" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.6.2" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.0.1" />
     <PackageReference Include="System.Net.WebSockets.Client" Version="4.3.2" />
     <PackageReference Include="System.ValueTuple" Version="4.5.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="PublicApiGenerator" Version="8.1.0" />
-    <PackageReference Include="ApprovalTests" Version="3.0.18" NoWarn="NU1701" />
-    <PackageReference Include="ApprovalUtilities" Version="3.0.18" NoWarn="NU1701" />
+    <PackageReference Include="ApprovalTests" Version="3.0.21" NoWarn="NU1701" />
+    <PackageReference Include="ApprovalUtilities" Version="3.0.21" NoWarn="NU1701" />
     <PackageReference Include="Microsoft.Extensions.PlatformAbstractions" Version="1.1.0" />
   </ItemGroup>
 
@@ -56,7 +56,7 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net461'">
-    <PackageReference Include="WindowsAzure.ServiceBus" Version="4.1.2" />
+    <PackageReference Include="WindowsAzure.ServiceBus" Version="5.1.0" />
   </ItemGroup>
 
 
diff --git a/test/Microsoft.Azure.ServiceBus.UnitTests/SenderReceiverTests.cs b/test/Microsoft.Azure.ServiceBus.UnitTests/SenderReceiverTests.cs
diff --git a/test/Microsoft.Azure.ServiceBus.UnitTests/ServiceBusConnectionStringBuilderTests.cs b/test/Microsoft.Azure.ServiceBus.UnitTests/ServiceBusConnectionStringBuilderTests.cs
