Adding the create call failed event (#46847)

v-dharmarajv · web-flow · commit 582075fec8f0 · 2024-10-25T15:41:42.000-07:00
* Adding the create call failed event

* adding the create call failed

* Adding the live test

* updating the asset file and changelog

* remove the unwanted changes
diff --git a/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md b/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md
@@ -1,14 +1,10 @@
 # Release History
 
-## 1.3.0-beta.2 (Unreleased)
+## 1.3.0-beta.2 (2024-10-25)
 
 ### Features Added
 
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
+- Added CreateCallFailed event to signify when create call API fails to establish a call
 
 ## 1.3.0-beta.1 (2024-08-02)
 
diff --git a/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs b/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs
@@ -178,6 +178,7 @@ public static partial class CallAutomationModelFactory
         public static Azure.Communication.CallAutomation.ContinuousDtmfRecognitionStopped ContinuousDtmfRecognitionStopped(string callConnectionId = null, string serverCallId = null, string correlationId = null, string operationContext = null, Azure.Communication.CallAutomation.ResultInformation resultInformation = null) { throw null; }
         public static Azure.Communication.CallAutomation.ContinuousDtmfRecognitionToneFailed ContinuousDtmfRecognitionToneFailed(string callConnectionId = null, string serverCallId = null, string correlationId = null, Azure.Communication.CallAutomation.ResultInformation resultInformation = null, string operationContext = null) { throw null; }
         public static Azure.Communication.CallAutomation.ContinuousDtmfRecognitionToneReceived ContinuousDtmfRecognitionToneReceived(int? sequenceId = default(int?), Azure.Communication.CallAutomation.DtmfTone? tone = default(Azure.Communication.CallAutomation.DtmfTone?), string callConnectionId = null, string serverCallId = null, string correlationId = null, Azure.Communication.CallAutomation.ResultInformation resultInformation = null, string operationContext = null) { throw null; }
+        public static Azure.Communication.CallAutomation.CreateCallFailed CreateCallFailed(string callConnectionId = null, string serverCallId = null, string correlationId = null, Azure.Communication.CallAutomation.ResultInformation resultInformation = null, string operationContext = null) { throw null; }
         public static Azure.Communication.CallAutomation.CreateCallResult CreateCallResult(Azure.Communication.CallAutomation.CallConnection callConnection = null, Azure.Communication.CallAutomation.CallConnectionProperties callConnectionProperties = null) { throw null; }
         public static Azure.Communication.CallAutomation.DtmfResult DtmfResult(System.Collections.Generic.IEnumerable<Azure.Communication.CallAutomation.DtmfTone> tones = null) { throw null; }
         public static Azure.Communication.CallAutomation.HoldFailed HoldFailed(string callConnectionId = null, string serverCallId = null, string correlationId = null, string operationContext = null, Azure.Communication.CallAutomation.ResultInformation resultInformation = null) { throw null; }
@@ -623,9 +624,15 @@ internal ContinuousDtmfRecognitionToneReceived() { }
     public partial class CreateCallEventResult
     {
         internal CreateCallEventResult() { }
+        public Azure.Communication.CallAutomation.CreateCallFailed FailureResult { get { throw null; } }
         public bool IsSuccess { get { throw null; } }
         public Azure.Communication.CallAutomation.CallConnected SuccessResult { get { throw null; } }
     }
+    public partial class CreateCallFailed : Azure.Communication.CallAutomation.CallAutomationEventBase
+    {
+        internal CreateCallFailed() { }
+        public static Azure.Communication.CallAutomation.CreateCallFailed Deserialize(string content) { throw null; }
+    }
     public partial class CreateCallOptions
     {
         public CreateCallOptions(Azure.Communication.CallAutomation.CallInvite callInvite, System.Uri callbackUri) { }
diff --git a/sdk/communication/Azure.Communication.CallAutomation/assets.json b/sdk/communication/Azure.Communication.CallAutomation/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/communication/Azure.Communication.CallAutomation",
-  "Tag": "net/communication/Azure.Communication.CallAutomation_b677f9cd0a"
+  "Tag": "net/communication/Azure.Communication.CallAutomation_1bf9634fdc"
 }
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/CallAutomationEventProcessor/EventResult/CreateCallEventResult.cs b/sdk/communication/Azure.Communication.CallAutomation/src/CallAutomationEventProcessor/EventResult/CreateCallEventResult.cs
@@ -16,10 +16,17 @@ public class CreateCallEventResult
         /// </summary>
         public CallConnected SuccessResult { get; }
 
-        internal CreateCallEventResult(bool isSuccess, CallConnected successResult)
+        /// <summary>
+        /// <see cref="CreateCallFailed"/> evnet will be returned when the call was not created.
+        /// </summary>
+        /// <value></value>
+        public CreateCallFailed FailureResult { get; }
+
+        internal CreateCallEventResult(bool isSuccess, CallConnected successResult, CreateCallFailed failureResult)
         {
             IsSuccess = isSuccess;
             SuccessResult = successResult;
+            FailureResult = failureResult;
         }
     }
 }
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/CreateCallFailed.Serialization.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/CreateCallFailed.Serialization.cs
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/CreateCallFailed.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/CreateCallFailed.cs
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/CallAutomationModelFactory.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/CallAutomationModelFactory.cs
@@ -552,5 +552,18 @@ public static TranscriptionFailed TranscriptionFailed(string operationContext =
 
             return new TranscriptionFailed(internalObject);
         }
+
+        /// <summary>
+        /// Initializes a new instance of create call failed event.
+        /// </summary>
+        public static CreateCallFailed CreateCallFailed(
+            string callConnectionId = default,
+            string serverCallId = default,
+            string correlationId = default,
+            ResultInformation resultInformation = default,
+            string operationContext = default)
+        {
+            return new CreateCallFailed(callConnectionId, serverCallId, correlationId, operationContext, resultInformation);
+        }
     }
 }
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/CreateCallResult.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/CreateCallResult.cs
@@ -48,7 +48,7 @@ public CreateCallEventResult WaitForEventProcessor(CancellationToken cancellatio
             var returnedEvent = _evHandler.WaitForEventProcessor(filter
                 => filter.CallConnectionId == _callConnectionId
                 && (filter.OperationContext == _operationContext || _operationContext is null)
-                && (filter.GetType() == typeof(CallConnected)),
+                && (filter.GetType() == typeof(CallConnected) || filter.GetType() == typeof(CreateCallFailed)),
                 cancellationToken);
 
             return SetReturnedEvent(returnedEvent);
@@ -69,15 +69,23 @@ public async Task<CreateCallEventResult> WaitForEventProcessorAsync(Cancellation
             var returnedEvent = await _evHandler.WaitForEventProcessorAsync(filter
                 => filter.CallConnectionId == _callConnectionId
                 && (filter.OperationContext == _operationContext || _operationContext is null)
-                && (filter.GetType() == typeof(CallConnected)),
+                && (filter.GetType() == typeof(CallConnected) || filter.GetType() == typeof(CreateCallFailed)),
                 cancellationToken).ConfigureAwait(false);
 
             return SetReturnedEvent(returnedEvent);
         }
 
         private static CreateCallEventResult SetReturnedEvent(CallAutomationEventBase returnedEvent)
         {
-            return new CreateCallEventResult(true, (CallConnected)returnedEvent);
+            switch (returnedEvent)
+            {
+                case CallConnected:
+                    return new CreateCallEventResult(true, (CallConnected)returnedEvent, null);
+                case CreateCallFailed:
+                    return new CreateCallEventResult(false, null, (CreateCallFailed)returnedEvent);
+                default:
+                    throw new NotSupportedException(returnedEvent.GetType().Name);
+            }
         }
     }
 }
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/Events/CallAutomationEventParser.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/Events/CallAutomationEventParser.cs
@@ -158,6 +158,8 @@ private static CallAutomationEventBase Deserialize(string eventData, string type
                     return MediaStreamingStopped.Deserialize(eventData);
                 case nameof(MediaStreamingFailed):
                     return MediaStreamingFailed.Deserialize(eventData);
+                case nameof(CreateCallFailed):
+                    return CreateCallFailed.Deserialize(eventData);
                 default:
                     return null;
             }
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/Events/CreateCallFailed.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/Events/CreateCallFailed.cs
@@ -0,0 +1,25 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+using System.Text.Json;
+using Azure.Core;
+namespace Azure.Communication.CallAutomation
+{
+    /// <summary>
+    /// The create call failed event.
+    /// </summary>
+    [CodeGenModel("CreateCallFailed", Usage = new string[] { "output" }, Formats = new string[] { "json" })]
+    public partial class CreateCallFailed : CallAutomationEventBase
+    {
+        /// <summary>
+        /// Deserialize <see cref="CreateCallFailed"/> event.
+        /// </summary>
+        /// <param name="content">The json content.</param>
+        /// <returns>The new <see cref="CreateCallFailed"/> object.</returns>
+        public static CreateCallFailed Deserialize(string content)
+        {
+            using var document = JsonDocument.Parse(content);
+            JsonElement element = document.RootElement;
+            return DeserializeCreateCallFailed(element);
+        }
+    }
+}
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md b/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md
@@ -10,7 +10,7 @@ model-namespace: false
 tag: package-2024-06-15-preview
 
 require:
-    - https://github.com/Azure/azure-rest-api-specs/blob/1aa912658531534e4e57ea613591075f7b97897c/specification/communication/data-plane/CallAutomation/readme.md
+    - https://github.com/Azure/azure-rest-api-specs/blob/6de4fd441872ef5a6d0cebf177988e8661410e04/specification/communication/data-plane/CallAutomation/readme.md
 
 
 title: Azure Communication Services
diff --git a/sdk/communication/Azure.Communication.CallAutomation/tests/CallAutomationClients/CallAutomationClientAutomatedLiveTests.cs b/sdk/communication/Azure.Communication.CallAutomation/tests/CallAutomationClients/CallAutomationClientAutomatedLiveTests.cs
@@ -11,7 +11,7 @@ namespace Azure.Communication.CallAutomation.Tests.CallAutomationClients
 {
     internal class CallAutomationClientAutomatedLiveTests : CallAutomationClientAutomatedLiveTestsBase
     {
-        public CallAutomationClientAutomatedLiveTests(bool isAsync) : base(isAsync)
+        public CallAutomationClientAutomatedLiveTests(bool isAsync) : base(isAsync, RecordedTestMode.Playback)
         {
         }
 
@@ -130,6 +130,11 @@ public async Task CreateCallAndReject()
                     // check reject response
                     Assert.IsFalse(rejectResponse.IsError);
 
+                    var createCallFailedEvent = await WaitForEvent<CreateCallFailed>(callConnectionId, TimeSpan.FromSeconds(20));
+                    Assert.IsNotNull(createCallFailedEvent);
+                    Assert.IsTrue(createCallFailedEvent is CreateCallFailed);
+                    Assert.AreEqual(callConnectionId, ((CreateCallFailed)createCallFailedEvent!).CallConnectionId);
+
                     try
                     {
                         // test get properties
diff --git a/sdk/communication/Azure.Communication.CallAutomation/tests/EventProcessors/ResultWithEventProcessorAsyncTests.cs b/sdk/communication/Azure.Communication.CallAutomation/tests/EventProcessors/ResultWithEventProcessorAsyncTests.cs
@@ -43,6 +43,29 @@ public async Task CreateCallEventResultSuccessTest()
             Assert.AreEqual(CallConnectionId, returnedResult.SuccessResult.CallConnectionId);
         }
 
+        [Test]
+        public async Task CreateCallEventResultFailedTest()
+        {
+            // Failed with operation mismatch
+            int successCode = (int)HttpStatusCode.Created;
+            CallAutomationClient callAutomationClient = CreateMockCallAutomationClient(
+                responseCode: successCode,
+                responseContent: CreateOrAnswerCallOrGetCallConnectionPayload,
+                options: new CallAutomationClientOptions() { Source = new CommunicationUserIdentifier("12345") });
+            CallAutomationEventProcessor handler = callAutomationClient.GetEventProcessor();
+            var response = callAutomationClient.CreateCall(new CreateCallOptions(CreateMockInvite(), new Uri(CallBackUri)));
+            Assert.AreEqual(successCode, response.GetRawResponse().Status);
+            SendAndProcessEvent(handler, new CreateCallFailed(CallConnectionId, ServerCallId, CorelationId, "mismatchedOperationId", null));
+            CreateCallEventResult returnedResult = await response.Value.WaitForEventProcessorAsync();
+            // Assert
+            Assert.NotNull(returnedResult);
+            Assert.AreEqual(false, returnedResult.IsSuccess);
+            Assert.NotNull(returnedResult.FailureResult);
+            Assert.IsNull(returnedResult.SuccessResult);
+            Assert.AreEqual(typeof(CreateCallFailed), returnedResult.FailureResult.GetType());
+            Assert.AreEqual(CallConnectionId, returnedResult.FailureResult.CallConnectionId);
+        }
+
         [Test]
         public async Task AnswerCallEventResultSuccessTest()
         {
diff --git a/sdk/communication/Azure.Communication.CallAutomation/tests/Events/CallAutomationEventParserTests.cs b/sdk/communication/Azure.Communication.CallAutomation/tests/Events/CallAutomationEventParserTests.cs
@@ -996,6 +996,32 @@ public void CancelAddParticipantFailedEventParsed_Test()
             }
         }
 
+        [Test]
+        public void CreateCallFailedEventParsed_Test()
+        {
+            CreateCallFailed @event = CallAutomationModelFactory.CreateCallFailed(
+                callConnectionId: "callConnectionId",
+                serverCallId: "serverCallId",
+                correlationId: "correlationId",
+                resultInformation: new ResultInformation(code: 400, subCode: 8510, message: "Action failed, some error."),
+                operationContext: "operationContext");
+            JsonSerializerOptions jsonOptions = new() { PropertyNamingPolicy = JsonNamingPolicy.CamelCase };
+            string jsonEvent = JsonSerializer.Serialize(@event, jsonOptions);
+            var parsedEvent = CallAutomationEventParser.Parse(jsonEvent, "Microsoft.Communication.CreateCallFailed");
+            if (parsedEvent is CreateCallFailed createCallFailed)
+            {
+                Assert.AreEqual("operationContext", createCallFailed.OperationContext);
+                Assert.AreEqual("callConnectionId", createCallFailed.CallConnectionId);
+                Assert.AreEqual("correlationId", createCallFailed.CorrelationId);
+                Assert.AreEqual("serverCallId", createCallFailed.ServerCallId);
+                Assert.AreEqual(400, createCallFailed.ResultInformation?.Code);
+            }
+            else
+            {
+                Assert.Fail("Event parsed wrongfully");
+            }
+        }
+
         [Test]
         public void TranscriptionStartedEventParsed_Test()
         {
diff --git a/sdk/communication/Azure.Communication.CallAutomation/tests/SessionRecordedEvents/CallAutomationClientAutomatedLiveTests/CreateCallAndReject.json b/sdk/communication/Azure.Communication.CallAutomation/tests/SessionRecordedEvents/CallAutomationClientAutomatedLiveTests/CreateCallAndReject.json
diff --git a/sdk/communication/Azure.Communication.CallAutomation/tests/SessionRecordedEvents/CallAutomationClientAutomatedLiveTests/CreateCallAndRejectAsync.json b/sdk/communication/Azure.Communication.CallAutomation/tests/SessionRecordedEvents/CallAutomationClientAutomatedLiveTests/CreateCallAndRejectAsync.json

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.CallAutomation",`
`5`		`- "Tag": "net/communication/Azure.Communication.CallAutomation_b677f9cd0a"`
	`5`	`+ "Tag": "net/communication/Azure.Communication.CallAutomation_1bf9634fdc"`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,17 @@ public class CreateCallEventResult`
`16`	`16`	`/// </summary>`
`17`	`17`	`public CallConnected SuccessResult { get; }`
`18`	`18`
`19`		`- internal CreateCallEventResult(bool isSuccess, CallConnected successResult)`
	`19`	`+ /// <summary>`
	`20`	`+ /// <see cref="CreateCallFailed"/> evnet will be returned when the call was not created.`
	`21`	`+ /// </summary>`
	`22`	`+ /// <value></value>`
	`23`	`+ public CreateCallFailed FailureResult { get; }`
	`24`	`+`
	`25`	`+ internal CreateCallEventResult(bool isSuccess, CallConnected successResult, CreateCallFailed failureResult)`
`20`	`26`	`{`
`21`	`27`	`IsSuccess = isSuccess;`
`22`	`28`	`SuccessResult = successResult;`
	`29`	`+ FailureResult = failureResult;`
`23`	`30`	`}`
`24`	`31`	`}`
`25`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -552,5 +552,18 @@ public static TranscriptionFailed TranscriptionFailed(string operationContext =`
`552`	`552`
`553`	`553`	`return new TranscriptionFailed(internalObject);`
`554`	`554`	`}`
	`555`	`+`
	`556`	`+ /// <summary>`
	`557`	`+ /// Initializes a new instance of create call failed event.`
	`558`	`+ /// </summary>`
	`559`	`+ public static CreateCallFailed CreateCallFailed(`
	`560`	`+ string callConnectionId = default,`
	`561`	`+ string serverCallId = default,`
	`562`	`+ string correlationId = default,`
	`563`	`+ ResultInformation resultInformation = default,`
	`564`	`+ string operationContext = default)`
	`565`	`+ {`
	`566`	`+ return new CreateCallFailed(callConnectionId, serverCallId, correlationId, operationContext, resultInformation);`
	`567`	`+ }`
`555`	`568`	`}`
`556`	`569`	`}`
Original file line number	Diff line number	Diff line change
`@@ -158,6 +158,8 @@ private static CallAutomationEventBase Deserialize(string eventData, string type`
`158`	`158`	`return MediaStreamingStopped.Deserialize(eventData);`
`159`	`159`	`case nameof(MediaStreamingFailed):`
`160`	`160`	`return MediaStreamingFailed.Deserialize(eventData);`
	`161`	`+ case nameof(CreateCallFailed):`
	`162`	`+ return CreateCallFailed.Deserialize(eventData);`
`161`	`163`	`default:`
`162`	`164`	`return null;`
`163`	`165`	`}`