[Communication]-Sms-Added optional DeliveryReportTimeoutInSeconds to smsSendOptions (Azure#42836)

besh2014 · besh2014 · web-flow · commit 9c12980bf1ac · 2024-04-11T16:17:52.000+03:00
* Added support of DeliveryReportTimeoutInSeconds for Sms requests.

* Executed Eng\scripts\CodeChecks.ps1 -ServiceDirectory communication\Azure.Communication.Sms\

* Updated tests

* Refresh test recording asset id.

* Updated snippets

* Updated test asset recording to reference onylyc smstestapp

* Added UriRegexSanitizer

* Removed System.IO form snippet

---------

Co-authored-by: besh2014 &lt;vibesliu@microsoft.com&gt;
diff --git a/sdk/communication/Azure.Communication.Sms/CHANGELOG.md b/sdk/communication/Azure.Communication.Sms/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Release History
 
+## 1.1.0-beta.1 (2024-03-25)
+- Added optional DeliveryReportTimeoutInSeconds to smsSendOptions.
+
 ## 1.0.2 (2021-10-05)
 - Dependency versions updated.
 
diff --git a/sdk/communication/Azure.Communication.Sms/README.md b/sdk/communication/Azure.Communication.Sms/README.md
@@ -64,6 +64,7 @@ var response = await smsClient.SendAsync(
     options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL
     {
         Tag = "marketing", // custom tags
+        DeliveryReportTimeoutInSeconds = 90
     });
 foreach (SmsSendResult result in response.Value)
 {
diff --git a/sdk/communication/Azure.Communication.Sms/api/Azure.Communication.Sms.netstandard2.0.cs b/sdk/communication/Azure.Communication.Sms/api/Azure.Communication.Sms.netstandard2.0.cs
@@ -14,15 +14,17 @@ public SmsClient(System.Uri endpoint, Azure.Core.TokenCredential tokenCredential
     }
     public partial class SmsClientOptions : Azure.Core.ClientOptions
     {
-        public SmsClientOptions(Azure.Communication.Sms.SmsClientOptions.ServiceVersion version = Azure.Communication.Sms.SmsClientOptions.ServiceVersion.V2021_03_07) { }
+        public SmsClientOptions(Azure.Communication.Sms.SmsClientOptions.ServiceVersion version = Azure.Communication.Sms.SmsClientOptions.ServiceVersion.V2024_02_05_Preview) { }
         public enum ServiceVersion
         {
             V2021_03_07 = 1,
+            V2024_02_05_Preview = 2,
         }
     }
     public partial class SmsSendOptions
     {
         public SmsSendOptions(bool enableDeliveryReport) { }
+        public int? DeliveryReportTimeoutInSeconds { get { throw null; } set { } }
         public bool EnableDeliveryReport { get { throw null; } }
         public string Tag { get { throw null; } set { } }
     }
diff --git a/sdk/communication/Azure.Communication.Sms/assets.json b/sdk/communication/Azure.Communication.Sms/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/communication/Azure.Communication.Sms",
-  "Tag": "net/communication/Azure.Communication.Sms_9077b6b480"
+  "Tag": "net/communication/Azure.Communication.Sms_3b274f81e7"
 }
diff --git a/sdk/communication/Azure.Communication.Sms/samples/Sample1_SendSms.md b/sdk/communication/Azure.Communication.Sms/samples/Sample1_SendSms.md
@@ -38,6 +38,7 @@ var response = smsClient.Send(
     options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL
     {
         Tag = "marketing", // custom tags
+        DeliveryReportTimeoutInSeconds = 90
     });
 foreach (SmsSendResult result in response.Value)
 {
diff --git a/sdk/communication/Azure.Communication.Sms/samples/Sample1_SendSmsAsync.md b/sdk/communication/Azure.Communication.Sms/samples/Sample1_SendSmsAsync.md
@@ -38,6 +38,7 @@ var response = await smsClient.SendAsync(
     options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL
     {
         Tag = "marketing", // custom tags
+        DeliveryReportTimeoutInSeconds = 90
     });
 foreach (SmsSendResult result in response.Value)
 {
diff --git a/sdk/communication/Azure.Communication.Sms/src/Azure.Communication.Sms.csproj b/sdk/communication/Azure.Communication.Sms/src/Azure.Communication.Sms.csproj
@@ -6,7 +6,7 @@
       Microsoft Azure Communication Sms quickstart - https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/send?pivots=programming-language-csharp
     </Description>
     <AssemblyTitle>Azure Communication Sms Service</AssemblyTitle>
-    <Version>1.0.2</Version>
+    <Version>1.1.0-beta.1</Version>
     <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
     <ApiCompatVersion>1.0.1</ApiCompatVersion>
     <PackageTags>Microsoft Azure Communication Sms Service;Microsoft;Azure;Azure Communication Service;Azure Communication Sms Service;Sms;Communication;$(PackageCommonTags)</PackageTags>
diff --git a/sdk/communication/Azure.Communication.Sms/src/Generated/Models/SmsSendOptions.Serialization.cs b/sdk/communication/Azure.Communication.Sms/src/Generated/Models/SmsSendOptions.Serialization.cs
diff --git a/sdk/communication/Azure.Communication.Sms/src/Generated/Models/SmsSendOptions.cs b/sdk/communication/Azure.Communication.Sms/src/Generated/Models/SmsSendOptions.cs
diff --git a/sdk/communication/Azure.Communication.Sms/src/Generated/SmsRestClient.cs b/sdk/communication/Azure.Communication.Sms/src/Generated/SmsRestClient.cs
diff --git a/sdk/communication/Azure.Communication.Sms/src/SmsClient.cs b/sdk/communication/Azure.Communication.Sms/src/SmsClient.cs
@@ -7,11 +7,10 @@
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
-
-using Azure.Core;
-using Azure.Core.Pipeline;
 using Azure.Communication.Pipeline;
 using Azure.Communication.Sms.Models;
+using Azure.Core;
+using Azure.Core.Pipeline;
 
 namespace Azure.Communication.Sms
 {
@@ -83,7 +82,7 @@ private SmsClient(string endpoint, AzureKeyCredential keyCredential, SmsClientOp
         private SmsClient(string endpoint, HttpPipeline httpPipeline, SmsClientOptions options)
         {
             _clientDiagnostics = new ClientDiagnostics(options);
-            RestClient = new SmsRestClient(_clientDiagnostics, httpPipeline, endpoint, options.ApiVersion);
+            RestClient = new SmsRestClient(_clientDiagnostics, httpPipeline, new Uri(endpoint), options.ApiVersion);
         }
 
         #endregion
diff --git a/sdk/communication/Azure.Communication.Sms/src/SmsClientOptions.cs b/sdk/communication/Azure.Communication.Sms/src/SmsClientOptions.cs
@@ -14,7 +14,7 @@ public class SmsClientOptions : ClientOptions
         /// <summary>
         /// The latest version of the Sms service.
         /// </summary>
-        private const ServiceVersion LatestVersion = ServiceVersion.V2021_03_07;
+        private const ServiceVersion LatestVersion = ServiceVersion.V2024_02_05_Preview;
 
         internal string ApiVersion { get; }
 
@@ -26,6 +26,7 @@ public SmsClientOptions(ServiceVersion version = LatestVersion)
             ApiVersion = version switch
             {
                 ServiceVersion.V2021_03_07 => "2021-03-07",
+                ServiceVersion.V2024_02_05_Preview => "2024-02-05-preview",
                 _ => throw new ArgumentOutOfRangeException(nameof(version)),
             };
         }
@@ -35,11 +36,15 @@ public SmsClientOptions(ServiceVersion version = LatestVersion)
         /// </summary>
         public enum ServiceVersion
         {
+#pragma warning disable CA1707 // Identifiers should not contain underscores
             /// <summary>
-            /// The V1 of the Sms service.
+            /// The "2021-03-07" version of the Sms service.
             /// </summary>
-#pragma warning disable CA1707 // Identifiers should not contain underscores
-            V2021_03_07 = 1
+            V2021_03_07 = 1,
+            /// <summary>
+            /// The "2024-02-05-preview" of the Sms service.
+            /// </summary>
+            V2024_02_05_Preview = 2
 #pragma warning restore CA1707 // Identifiers should not contain underscores
         }
     }
diff --git a/sdk/communication/Azure.Communication.Sms/src/autorest.md b/sdk/communication/Azure.Communication.Sms/src/autorest.md
@@ -6,10 +6,10 @@ Run `dotnet msbuild /t:GenerateCode` to generate code.
 > see https://aka.ms/autorest
 
 ``` yaml
-tag: package-sms-2021-03-07
+tag: package-sms-2024-02-05-preview
 model-namespace: false
 require:
-    -  https://raw.githubusercontent.com/Azure/azure-rest-api-specs/896d05e37dbb00712726620b8d679cc3c3be09fb/specification/communication/data-plane/Sms/readme.md
+    -  https://raw.githubusercontent.com/Azure/azure-rest-api-specs/8df53db16935b96733fda9882c3f197e2f961287/specification/communication/data-plane/Sms/readme.md
 payload-flattening-threshold: 10
 generation1-convenience-client: true
 ```
diff --git a/sdk/communication/Azure.Communication.Sms/tests/SmsClientLiveTestBase.cs b/sdk/communication/Azure.Communication.Sms/tests/SmsClientLiveTestBase.cs
@@ -4,20 +4,23 @@
 using System;
 using Azure.Core;
 using Azure.Core.TestFramework;
+using Azure.Core.TestFramework.Models;
 using Azure.Identity;
 using NUnit.Framework;
 
 namespace Azure.Communication.Sms.Tests
 {
     public class SmsClientLiveTestBase : RecordedTestBase<SmsClientTestEnvironment>
     {
+        private const string URIDomainNameReplacerRegEx = @"https://([^/?]+)";
         public SmsClientLiveTestBase(bool isAsync) : base(isAsync)
         {
             JsonPathSanitizers.Add("$..from");
             JsonPathSanitizers.Add("$..to");
             JsonPathSanitizers.Add("$..repeatabilityRequestId");
             JsonPathSanitizers.Add("$..repeatabilityFirstSent");
             SanitizedHeaders.Add("x-ms-content-sha256");
+            UriRegexSanitizers.Add(new UriRegexSanitizer(URIDomainNameReplacerRegEx, "https://sanitized.communication.azure.com"));
         }
 
         [OneTimeSetUp]
diff --git a/sdk/communication/Azure.Communication.Sms/tests/SmsClientLiveTests.cs b/sdk/communication/Azure.Communication.Sms/tests/SmsClientLiveTests.cs
@@ -3,13 +3,12 @@
 
 #region Snippet:Azure_Communication_Sms_Tests_UsingStatements
 using System;
-/*@@*/ using System.IO;
 //@@ using Azure.Communication.Sms;
 #endregion Snippet:Azure_Communication_Sms_Tests_UsingStatements
 
+using System.IO;
 using System.Collections.Generic;
 using System.Threading.Tasks;
-using Newtonsoft.Json.Linq;
 using NUnit.Framework;
 
 namespace Azure.Communication.Sms.Tests
@@ -109,6 +108,7 @@ public async Task SendingSmsMessageToGroupWithOptions()
                    options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL
                    {
                        Tag = "marketing", // custom tags
+                       DeliveryReportTimeoutInSeconds = 90 // OPTIONAL
                    });
                 AssertRawResponseHappyPath(response.GetRawResponse().ContentStream ?? new MemoryStream());
                 foreach (SmsSendResult result in response.Value)
diff --git a/sdk/communication/Azure.Communication.Sms/tests/SmsClientTest.cs b/sdk/communication/Azure.Communication.Sms/tests/SmsClientTest.cs
@@ -61,7 +61,7 @@ public void SmsClient_ThrowsWithNullOrEmptyConnectionString()
         [Test]
         public void SmsClientOptions_ThrowsWithInvalidVersion()
         {
-            var invalidServiceVersion = (SmsClientOptions.ServiceVersion)2;
+            var invalidServiceVersion = (SmsClientOptions.ServiceVersion)99;
 
             Assert.Throws<ArgumentOutOfRangeException>(() => new SmsClientOptions(invalidServiceVersion));
         }
diff --git a/sdk/communication/Azure.Communication.Sms/tests/SmsRestClientTest.cs b/sdk/communication/Azure.Communication.Sms/tests/SmsRestClientTest.cs
@@ -6,7 +6,6 @@
 using System.Threading.Tasks;
 using Azure.Communication.Sms.Models;
 using Azure.Core.Pipeline;
-using Azure.Core.TestFramework;
 using NUnit.Framework;
 
 namespace Azure.Communication.Sms.Tests
@@ -17,7 +16,7 @@ public class SmsRestClientTest
         public void SmsRestClient_NullClientDiagnostics_ShouldThrow()
         {
             var httpPipeline = HttpPipelineBuilder.Build(new SmsClientOptions());
-            var uri = "http://localhost";
+            var uri = new Uri("http://localhost");
 
             Assert.Throws<ArgumentNullException>(() => new SmsRestClient(null, httpPipeline, uri));
         }
@@ -26,7 +25,7 @@ public void SmsRestClient_NullClientDiagnostics_ShouldThrow()
         public void SmsRestClient_NullHttpPipeline_ShouldThrow()
         {
             var clientDiagnostics = new ClientDiagnostics(new SmsClientOptions());
-            var endpoint = "http://localhost";
+            var endpoint = new Uri("http://localhost");
 
             Assert.Throws<ArgumentNullException>(() => new SmsRestClient(clientDiagnostics, null, endpoint));
         }
@@ -46,7 +45,7 @@ public void SmsRestClient_NullVersion_ShouldThrow()
             var clientOptions = new SmsClientOptions();
             var clientDiagnostics = new ClientDiagnostics(clientOptions);
             var httpPipeline = HttpPipelineBuilder.Build(clientOptions);
-            var uri = "http://localhost";
+            var uri = new Uri("http://localhost");
 
             Assert.Throws<ArgumentNullException>(() => new SmsRestClient(clientDiagnostics, httpPipeline, uri, null));
         }
@@ -170,7 +169,7 @@ private SmsRestClient CreateSmsRestClient()
             var clientOptions = new SmsClientOptions();
             var clientDiagnostics = new ClientDiagnostics(clientOptions);
             var httpPipeline = HttpPipelineBuilder.Build(clientOptions);
-            var endpoint = "http://localhost";
+            var endpoint = new Uri("http://localhost");
 
             return new SmsRestClient(clientDiagnostics, httpPipeline, endpoint);
         }
diff --git a/sdk/communication/Azure.Communication.Sms/tests/samples/Sample1_SmsClient.cs b/sdk/communication/Azure.Communication.Sms/tests/samples/Sample1_SmsClient.cs
@@ -49,6 +49,7 @@ public async Task SendingGroupSMSMessageWithOptionsAsync()
                 options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL
                 {
                     Tag = "marketing", // custom tags
+                    DeliveryReportTimeoutInSeconds = 90
                 });
             foreach (SmsSendResult result in response.Value)
             {
@@ -90,6 +91,7 @@ public void SendingGroupSMSMessageWithOptions()
                 options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL
                 {
                     Tag = "marketing", // custom tags
+                    DeliveryReportTimeoutInSeconds = 90
                 });
             foreach (SmsSendResult result in response.Value)
             {

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,7 @@ var response = await smsClient.SendAsync(`
`64`	`64`	`options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL`
`65`	`65`	`{`
`66`	`66`	`Tag = "marketing", // custom tags`
	`67`	`+ DeliveryReportTimeoutInSeconds = 90`
`67`	`68`	`});`
`68`	`69`	`foreach (SmsSendResult result in response.Value)`
`69`	`70`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,15 +14,17 @@ public SmsClient(System.Uri endpoint, Azure.Core.TokenCredential tokenCredential`
`14`	`14`	`}`
`15`	`15`	`public partial class SmsClientOptions : Azure.Core.ClientOptions`
`16`	`16`	`{`
`17`		`- public SmsClientOptions(Azure.Communication.Sms.SmsClientOptions.ServiceVersion version = Azure.Communication.Sms.SmsClientOptions.ServiceVersion.V2021_03_07) { }`
	`17`	`+ public SmsClientOptions(Azure.Communication.Sms.SmsClientOptions.ServiceVersion version = Azure.Communication.Sms.SmsClientOptions.ServiceVersion.V2024_02_05_Preview) { }`
`18`	`18`	`public enum ServiceVersion`
`19`	`19`	`{`
`20`	`20`	`V2021_03_07 = 1,`
	`21`	`+ V2024_02_05_Preview = 2,`
`21`	`22`	`}`
`22`	`23`	`}`
`23`	`24`	`public partial class SmsSendOptions`
`24`	`25`	`{`
`25`	`26`	`public SmsSendOptions(bool enableDeliveryReport) { }`
	`27`	`+ public int? DeliveryReportTimeoutInSeconds { get { throw null; } set { } }`
`26`	`28`	`public bool EnableDeliveryReport { get { throw null; } }`
`27`	`29`	`public string Tag { get { throw null; } set { } }`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`	`"AssetsRepo": "Azure/azure-sdk-assets",`
`3`	`3`	`"AssetsRepoPrefixPath": "net",`
`4`	`4`	`"TagPrefix": "net/communication/Azure.Communication.Sms",`
`5`		`- "Tag": "net/communication/Azure.Communication.Sms_9077b6b480"`
	`5`	`+ "Tag": "net/communication/Azure.Communication.Sms_3b274f81e7"`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ var response = smsClient.Send(`
`38`	`38`	`options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL`
`39`	`39`	`{`
`40`	`40`	`Tag = "marketing", // custom tags`
	`41`	`+ DeliveryReportTimeoutInSeconds = 90`
`41`	`42`	`});`
`42`	`43`	`foreach (SmsSendResult result in response.Value)`
`43`	`44`	`{`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ var response = await smsClient.SendAsync(`
`38`	`38`	`options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL`
`39`	`39`	`{`
`40`	`40`	`Tag = "marketing", // custom tags`
	`41`	`+ DeliveryReportTimeoutInSeconds = 90`
`41`	`42`	`});`
`42`	`43`	`foreach (SmsSendResult result in response.Value)`
`43`	`44`	`{`