Resolved CustomCallingContextInternal Sip/Voip Header swap issue + Unit Test for IncomingCall Event (Azure#48727)

v-saasomani · web-flow · commit 346f011968ab · 2025-03-24T10:07:55.000-07:00
* Modified headers for CustomCallingContextInternal.

* Added unit test for Incoming Call Event. Added IncomingCall to CallAutomationModelFactory.

* Exported latest API

* Modified CustomCallingContext.cs initialization for SipHeaders and VoipHeaders.

* Modified CustomCallingContextInternal initialization of headers in CallAutomationClient.cs

* Swapped Sip/Voip Headers in CustomCallingContext.cs and references. Updated headers in Incoming Call unit test.

* Fix autorest package.
diff --git a/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.net8.0.cs b/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.net8.0.cs
@@ -229,6 +229,7 @@ public static partial class CallAutomationModelFactory
         public static Azure.Communication.CallAutomation.HoldAudioResumed HoldAudioResumed(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.HoldAudioStarted HoldAudioStarted(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.HoldFailed HoldFailed(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.IncomingCall IncomingCall(Azure.Communication.CommunicationIdentifier to = null, Azure.Communication.CommunicationIdentifier from = null, string callerDisplayName = null, string serverCallId = null, Azure.Communication.CallAutomation.CustomCallingContext customContext = null, string incomingCallContext = null, Azure.Communication.CommunicationIdentifier onBehalfOfCallee = null, string correlationId = null) { throw null; }
         public static Azure.Communication.CallAutomation.MediaStreamingFailed MediaStreamingFailed(Azure.Communication.CallAutomation.MediaStreamingUpdate mediaStreamingUpdate = null, 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.MediaStreamingStarted MediaStreamingStarted(Azure.Communication.CallAutomation.MediaStreamingUpdate mediaStreamingUpdate = null, 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.MediaStreamingStopped MediaStreamingStopped(Azure.Communication.CallAutomation.MediaStreamingUpdate mediaStreamingUpdate = null, string callConnectionId = null, string serverCallId = null, string correlationId = null, string operationContext = null, Azure.Communication.CallAutomation.ResultInformation resultInformation = null) { throw null; }
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
@@ -229,6 +229,7 @@ public static partial class CallAutomationModelFactory
         public static Azure.Communication.CallAutomation.HoldAudioResumed HoldAudioResumed(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.HoldAudioStarted HoldAudioStarted(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.HoldFailed HoldFailed(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.IncomingCall IncomingCall(Azure.Communication.CommunicationIdentifier to = null, Azure.Communication.CommunicationIdentifier from = null, string callerDisplayName = null, string serverCallId = null, Azure.Communication.CallAutomation.CustomCallingContext customContext = null, string incomingCallContext = null, Azure.Communication.CommunicationIdentifier onBehalfOfCallee = null, string correlationId = null) { throw null; }
         public static Azure.Communication.CallAutomation.MediaStreamingFailed MediaStreamingFailed(Azure.Communication.CallAutomation.MediaStreamingUpdate mediaStreamingUpdate = null, 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.MediaStreamingStarted MediaStreamingStarted(Azure.Communication.CallAutomation.MediaStreamingUpdate mediaStreamingUpdate = null, 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.MediaStreamingStopped MediaStreamingStopped(Azure.Communication.CallAutomation.MediaStreamingUpdate mediaStreamingUpdate = null, string callConnectionId = null, string serverCallId = null, string correlationId = null, string operationContext = null, Azure.Communication.CallAutomation.ResultInformation resultInformation = null) { throw null; }
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/CallAutomationClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/CallAutomationClient.cs
@@ -258,8 +258,8 @@ private AnswerCallRequestInternal CreateAnswerCallRequest(AnswerCallOptions opti
             request.AnsweredBy = Source == null ? null : new CommunicationUserIdentifierModel(Source.Id);
             request.OperationContext = options.OperationContext;
             request.CustomCallingContext = new CustomCallingContextInternal(
-                options.CustomCallingContext?.SipHeaders ?? new ChangeTrackingDictionary<string, string>(),
-                options.CustomCallingContext?.VoipHeaders ?? new ChangeTrackingDictionary<string, string>());
+                options.CustomCallingContext?.VoipHeaders ?? new ChangeTrackingDictionary<string, string>(),
+                options.CustomCallingContext?.SipHeaders ?? new ChangeTrackingDictionary<string, string>());
 
             return request;
         }
@@ -295,8 +295,8 @@ public virtual async Task<Response> RedirectCallAsync(RedirectCallOptions option
                 RedirectCallRequestInternal request = new RedirectCallRequestInternal(options.IncomingCallContext, CommunicationIdentifierSerializer.Serialize(options.CallInvite.Target));
 
                 request.CustomCallingContext = new CustomCallingContextInternal(
-                   options.CallInvite.CustomCallingContext.SipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.SipHeaders,
-                   options.CallInvite.CustomCallingContext.VoipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.VoipHeaders);
+                   options.CallInvite.CustomCallingContext.VoipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.VoipHeaders,
+                   options.CallInvite.CustomCallingContext.SipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.SipHeaders);
 
                 return await AzureCommunicationServicesRestClient.RedirectCallAsync(request, cancellationToken).ConfigureAwait(false);
             }
@@ -338,8 +338,8 @@ public virtual Response RedirectCall(RedirectCallOptions options, CancellationTo
                 RedirectCallRequestInternal request = new RedirectCallRequestInternal(options.IncomingCallContext, CommunicationIdentifierSerializer.Serialize(options.CallInvite.Target));
 
                 request.CustomCallingContext = new CustomCallingContextInternal(
-                                   options.CallInvite.CustomCallingContext.SipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.SipHeaders,
-                                   options.CallInvite.CustomCallingContext.VoipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.VoipHeaders);
+                                   options.CallInvite.CustomCallingContext.VoipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.VoipHeaders,
+                                   options.CallInvite.CustomCallingContext.SipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.SipHeaders);
 
                 return AzureCommunicationServicesRestClient.RedirectCall(request, cancellationToken);
             }
@@ -729,8 +729,8 @@ private CreateCallRequestInternal CreateCallRequest(CreateCallOptions options)
             };
 
             request.CustomCallingContext = new CustomCallingContextInternal(
-               options.CallInvite.CustomCallingContext.SipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.SipHeaders,
-               options.CallInvite.CustomCallingContext.VoipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.VoipHeaders);
+               options.CallInvite.CustomCallingContext.VoipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.VoipHeaders,
+               options.CallInvite.CustomCallingContext.SipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CallInvite.CustomCallingContext.SipHeaders);
 
             // Add CallIntelligenceOptions such as custom cognitive service domain name
             string cognitiveServicesEndpoint = options.CallIntelligenceOptions?.CognitiveServicesEndpoint?.AbsoluteUri;
@@ -766,8 +766,8 @@ private CreateCallRequestInternal CreateCallRequest(CreateGroupCallOptions optio
             };
 
             request.CustomCallingContext = new CustomCallingContextInternal(
-               options.CustomCallingContext.SipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CustomCallingContext.SipHeaders,
-               options.CustomCallingContext.VoipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CustomCallingContext.VoipHeaders);
+               options.CustomCallingContext.VoipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CustomCallingContext.VoipHeaders,
+               options.CustomCallingContext.SipHeaders == null ? new ChangeTrackingDictionary<string, string>() : options.CustomCallingContext.SipHeaders);
 
             // Add CallIntelligenceOptions such as custom cognitive service domain name
             string cognitiveServicesEndpoint = options.CallIntelligenceOptions?.CognitiveServicesEndpoint?.AbsoluteUri;
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/CallConnection.cs b/sdk/communication/Azure.Communication.CallAutomation/src/CallConnection.cs
@@ -283,8 +283,8 @@ private static TransferToParticipantRequestInternal CreateTransferToParticipantR
             TransferToParticipantRequestInternal request = new(CommunicationIdentifierSerializer.Serialize(options.Target))
             {
                 CustomCallingContext = new CustomCallingContextInternal(
-                options.CustomCallingContext?.SipHeaders ?? new ChangeTrackingDictionary<string, string>(),
-                options.CustomCallingContext?.VoipHeaders ?? new ChangeTrackingDictionary<string, string>()),
+                options.CustomCallingContext?.VoipHeaders ?? new ChangeTrackingDictionary<string, string>(),
+                options.CustomCallingContext?.SipHeaders ?? new ChangeTrackingDictionary<string, string>()),
                 OperationContext = options.OperationContext == default ? Guid.NewGuid().ToString() : options.OperationContext,
                 Transferee = options.Transferee == default ? null : CommunicationIdentifierSerializer.Serialize(options.Transferee),
                 OperationCallbackUri = options.OperationCallbackUri?.AbsoluteUri,
@@ -386,8 +386,8 @@ private static AddParticipantRequestInternal CreateAddParticipantRequest(AddPart
             AddParticipantRequestInternal request = new(CommunicationIdentifierSerializer.Serialize(options.ParticipantToAdd.Target))
             {
                 CustomCallingContext = new CustomCallingContextInternal(
-                    options.ParticipantToAdd.CustomCallingContext?.SipHeaders ?? new ChangeTrackingDictionary<string, string>(),
-                    options.ParticipantToAdd.CustomCallingContext?.VoipHeaders ?? new ChangeTrackingDictionary<string, string>()
+                    options.ParticipantToAdd.CustomCallingContext?.VoipHeaders ?? new ChangeTrackingDictionary<string, string>(),
+                    options.ParticipantToAdd.CustomCallingContext?.SipHeaders ?? new ChangeTrackingDictionary<string, string>()
                     ),
                 SourceCallerIdNumber = options.ParticipantToAdd.SourceCallerIdNumber == null
                     ? null
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/CallAutomationModelFactory.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/CallAutomationModelFactory.cs
@@ -636,5 +636,32 @@ public static CreateCallFailed CreateCallFailed(
             var createdCallFailedInternal = new CreateCallFailedInternal(callConnectionId, serverCallId, correlationId, operationContext, resultInformation);
             return new CreateCallFailed(createdCallFailedInternal);
         }
+
+        /// <summary> Initializes a new instance of IncomingCall. </summary>
+        /// <param name="to"> The recipient of the call. </param>
+        /// <param name="from"> The caller initiating the call.</param>
+        /// <param name="callerDisplayName"> The display name of the caller. </param>
+        /// <param name="serverCallId"> Server call ID. </param>
+        /// <param name="customContext"> Custom Sip and Voip Headers of call.</param>
+        /// <param name="incomingCallContext"> The context of the incoming call. </param>
+        /// <param name="onBehalfOfCallee"> The identifier of the user on whose behalf the call is received.</param>
+        /// <param name="correlationId"> The correlation ID for tracking the event. </param>
+        /// <returns>A new <see cref="CallAutomation.IncomingCall"/> instance for mocking. </returns>
+        public static IncomingCall IncomingCall(CommunicationIdentifier to = null, CommunicationIdentifier @from = null, string callerDisplayName = null, string serverCallId = null,
+            CustomCallingContext customContext = null, string incomingCallContext = null, CommunicationIdentifier onBehalfOfCallee = null, string correlationId = null)
+        {
+            var internalObject = new IncomingCallInternal(
+                to == null ? null : CommunicationIdentifierSerializer.Serialize(to),
+                @from == null ? null : CommunicationIdentifierSerializer.Serialize(@from),
+                callerDisplayName,
+                serverCallId,
+                customContext == null ? null : new CustomCallingContextInternal(customContext.VoipHeaders, customContext.SipHeaders),
+                incomingCallContext,
+                onBehalfOfCallee == null ? null : CommunicationIdentifierSerializer.Serialize(onBehalfOfCallee),
+                correlationId
+                );
+
+            return new IncomingCall(internalObject);
+        }
     }
 }
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/CustomCallingContext.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/CustomCallingContext.cs
@@ -20,10 +20,10 @@ public class CustomCallingContext
         /// <summary>
         /// Creates a new CustomCallingContext.
         /// </summary>
-        internal CustomCallingContext(IDictionary<string, string> sipHeaders, IDictionary<string, string> voipHeaders)
+        internal CustomCallingContext(IDictionary<string, string> voipHeaders, IDictionary<string, string> sipHeaders)
         {
-            SipHeaders = sipHeaders;
-            VoipHeaders = voipHeaders;
+            SipHeaders = sipHeaders ?? new ChangeTrackingDictionary<string, string>();
+            VoipHeaders = voipHeaders ?? new ChangeTrackingDictionary<string, string>();
         }
 
         /// <summary>
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/CustomCallingContextInternal.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/CustomCallingContextInternal.cs
@@ -10,7 +10,7 @@ namespace Azure.Communication.CallAutomation
     [CodeGenModel("CustomCallingContext", Usage = new string[] { "output" }, Formats = new string[] { "json" })]
     internal partial class CustomCallingContextInternal
     {
-        public CustomCallingContextInternal(IDictionary<string, string> sipHeaders, IDictionary<string, string> voipHeaders)
+        public CustomCallingContextInternal(IDictionary<string, string> voipHeaders, IDictionary<string, string> sipHeaders)
         {
             SipHeaders = sipHeaders;
             VoipHeaders = voipHeaders;
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/Events/IncomingCall.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/Events/IncomingCall.cs
@@ -23,7 +23,7 @@ internal IncomingCall(IncomingCallInternal internalEvent)
             From = CommunicationIdentifierSerializer.Deserialize(internalEvent.From);
             ServerCallId = internalEvent.ServerCallId;
             CallerDisplayName = internalEvent.CallerDisplayName;
-            CustomContext = new CustomCallingContext(internalEvent.CustomContext.SipHeaders, internalEvent.CustomContext.VoipHeaders);
+            CustomContext = new CustomCallingContext(internalEvent.CustomContext.VoipHeaders, internalEvent.CustomContext.SipHeaders);
             IncomingCallContext = internalEvent.IncomingCallContext;
 
             if (internalEvent.OnBehalfOfCallee != null)
diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/TransferToParticipantOptions.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/TransferToParticipantOptions.cs
@@ -18,7 +18,7 @@ public class TransferToParticipantOptions
         public TransferToParticipantOptions(PhoneNumberIdentifier targetPhoneNumberIdentity)
         {
             Target = targetPhoneNumberIdentity;
-            CustomCallingContext = new CustomCallingContext(sipHeaders: new Dictionary<string, string>(), null);
+            CustomCallingContext = new CustomCallingContext(sipHeaders: new Dictionary<string, string>(), voipHeaders: null);
         }
 
         /// <summary>
diff --git a/sdk/communication/Azure.Communication.CallAutomation/tests/Events/CallAutomationEventParserTests.cs b/sdk/communication/Azure.Communication.CallAutomation/tests/Events/CallAutomationEventParserTests.cs

Original file line number	Diff line number	Diff line change
`@@ -20,10 +20,10 @@ public class CustomCallingContext`
`20`	`20`	`/// <summary>`
`21`	`21`	`/// Creates a new CustomCallingContext.`
`22`	`22`	`/// </summary>`
`23`		`- internal CustomCallingContext(IDictionary<string, string> sipHeaders, IDictionary<string, string> voipHeaders)`
	`23`	`+ internal CustomCallingContext(IDictionary<string, string> voipHeaders, IDictionary<string, string> sipHeaders)`
`24`	`24`	`{`
`25`		`- SipHeaders = sipHeaders;`
`26`		`- VoipHeaders = voipHeaders;`
	`25`	`+ SipHeaders = sipHeaders ?? new ChangeTrackingDictionary<string, string>();`
	`26`	`+ VoipHeaders = voipHeaders ?? new ChangeTrackingDictionary<string, string>();`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ namespace Azure.Communication.CallAutomation`
`10`	`10`	`[CodeGenModel("CustomCallingContext", Usage = new string[] { "output" }, Formats = new string[] { "json" })]`
`11`	`11`	`internal partial class CustomCallingContextInternal`
`12`	`12`	`{`
`13`		`- public CustomCallingContextInternal(IDictionary<string, string> sipHeaders, IDictionary<string, string> voipHeaders)`
	`13`	`+ public CustomCallingContextInternal(IDictionary<string, string> voipHeaders, IDictionary<string, string> sipHeaders)`
`14`	`14`	`{`
`15`	`15`	`SipHeaders = sipHeaders;`
`16`	`16`	`VoipHeaders = voipHeaders;`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public class TransferToParticipantOptions`
`18`	`18`	`public TransferToParticipantOptions(PhoneNumberIdentifier targetPhoneNumberIdentity)`
`19`	`19`	`{`
`20`	`20`	`Target = targetPhoneNumberIdentity;`
`21`		`- CustomCallingContext = new CustomCallingContext(sipHeaders: new Dictionary<string, string>(), null);`
	`21`	`+ CustomCallingContext = new CustomCallingContext(sipHeaders: new Dictionary<string, string>(), voipHeaders: null);`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`/// <summary>`