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.

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

Feature/communication server calling preview1 #21017

Merged
merged 78 commits into from
Jun 8, 2021

Conversation

zihzhan-msft
Copy link
Member

@zihzhan-msft zihzhan-msft commented May 12, 2021

All SDK Contribution checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.

  • Please open PR in Draft mode if it is:
    • Work in progress or not intended to be merged.
    • Encountering multiple pipeline failures and working on fixes.
  • If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
  • I have read the contribution guidelines.
  • The pull request does not introduce breaking changes.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

SDK Generation Guidelines

  • The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
  • The *.csproj and AssemblyInfo.cs files have been updated with the new version of the SDK. Please double check nuget.org current release version.

Additional management plane SDK specific contribution checklist:

Note: Only applies to Microsoft.Azure.Management.[RP] or Azure.ResourceManager.[RP]

  • Include updated management metadata.
  • Update AzureRP.props to add/remove version info to maintain up to date API versions.

Management plane SDK Troubleshooting

  • If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add new service label and/or contact assigned reviewer.

  • If the check fails at the Verify Code Generation step, please ensure:

    • Do not modify any code in generated folders.
    • Do not selectively include/remove generated files in the PR.
    • Do use generate.ps1/cmd to generate this PR instead of calling autorest directly.
      Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version.

    Note: We have recently updated the PSH module called by generate.ps1 to emit additional data. This would help reduce/eliminate the Code Verification check error. Please run following command:

      `dotnet msbuild eng/mgmt.proj /t:Util /p:UtilityName=InstallPsModules`
    

Old outstanding PR cleanup

Please note:
If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

@check-enforcer
Copy link

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them. In order to bootstrap pipelines for a new service, please perform following steps:

For data-plane/track 2 SDKs Issue the following command as a pull request comment:

/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run net - [service] - ci

For track 1 management-plane SDKs

Please open a separate PR and to your service SDK path in this file. Once that PR has been merged, you can re-run the pipeline to trigger the verification.

Copy link
Member

@RezaJooyandeh RezaJooyandeh left a comment

Choose a reason for hiding this comment

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

This a great start! I left some comments.


namespace Azure.Communication
{
internal partial class CommunicationUserIdentifierModel : IUtf8JsonSerializable
Copy link
Member

Choose a reason for hiding this comment

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

Same question, I thought Serialization code is supposed to be generated

Optional<string> conversationId = default;
foreach (var property in element.EnumerateObject())
{
if (property.NameEquals("recordingId") || property.NameEquals("RecordingId"))
Copy link
Member

Choose a reason for hiding this comment

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

Questions about these Serialization classes v introduced:

  1. Looks like this is all manually written? Why is that?
  2. Why do the properties check names with different cases? (e.g recordingId and RecordingId)

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

@minnieliu - We have added these classes to deserialize the events which user received on the callback.

The reason for providing deserialization on our end is because of issue with deserializing CommunicationIdentifierModel. As Service side only understands model defined in Communication.Common, so it is sending that information to user and user don't have way to deserialize it.

We will fix point#2.

Copy link
Member

Choose a reason for hiding this comment

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

We have serializer and deserialzer for CommunicationIdentifierModel in the Shared folder. Please refer to how the chat project is using them.

Copy link
Member

Choose a reason for hiding this comment

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

This Deserialization methods are generated if any of the response contains CommunicationIdentifierModel. In our case we don't have any such response. This is done for deserializing Events.

Copy link
Member

Choose a reason for hiding this comment

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

This is fixed.

EventSubscriptionType.DtmfReceived
});
```
```C# Snippet:Azure_Communication_Call_Tests_CreateCallAsync
Copy link
Member

Choose a reason for hiding this comment

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

The syntax for this snippet seems wrong... it is missing the end ) bracket that closes off CreateCallAsync

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for catching this. Addressed.

}
}

private static T AssertNotNull<T>(T argument, string argumentName)
Copy link
Member

Choose a reason for hiding this comment

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

We have added a PR that moves these into Azure.Core and we dont need to define them manually here. #21542

Please remove and refer to Arguments.cs instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

Synced with master and remove those two methods.

@minnieliu minnieliu dismissed their stale review June 4, 2021 00:50

Fixed most issues

- Create a Call from a Azure Communication Resource identity to a phone number
- Specify request payload for the created call.

#### You can find samples for each of these functions below.
Copy link
Member

Choose a reason for hiding this comment

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

Is #### the right mark up?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we are intended to use it.


return RestClient.JoinCall(
conversationId: conversationId,
source: CommunicationIdentifierSerializer.Serialize(source),
Copy link
Member

Choose a reason for hiding this comment

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

Do you also need to check that the source is not null since you are serializing it?

Copy link
Member Author

Choose a reason for hiding this comment

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

this will get addressed in the update.


return await RestClient.JoinCallAsync(
conversationId: conversationId,
source: CommunicationIdentifierSerializer.Serialize(source),
Copy link
Member

Choose a reason for hiding this comment

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

Do you also need to check that the source is not null since you are serializing it?

Copy link
Member Author

Choose a reason for hiding this comment

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

good catch, this will get addressed in the update.

return InstrumentClient(client);
}

// Todo: add CorrelationVectorLogs
Copy link
Member

Choose a reason for hiding this comment

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

Is this still planning to be done or in the next PR?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is addressed, added in the update.

}
],
"Variables": {
"AZURE_PHONE_NUMBER": "\u002B15129104698",
Copy link
Member

@minnieliu minnieliu Jun 7, 2021

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

This is addressed in updates.

zihzhan-msft and others added 4 commits June 7, 2021 15:47
…nto feature/communication-ServerCalling-preview1
…nto feature/communication-ServerCalling-preview1
* Enable living testing.

* Test Playback.

* Add playaudio test record.

* Add createcall test record.

* Add delete call record.

* Add hangup call test record.

* Add cancelAllMediaOperations call test record.

* Enable living tests.

* Address comments.
/// </summary>
public class CallingServerTestEnvironment : CommunicationTestEnvironment
{
public string ToPhoneNumber => GetRecordedVariable(AzurePhoneNumber, options => options.IsSecret());
Copy link
Member

Choose a reason for hiding this comment

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

We probably need a separate phone number for these tests to avoid conflicts with the phone number and sms packages tests

Copy link
Member

@RezaJooyandeh RezaJooyandeh left a comment

Choose a reason for hiding this comment

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

Looks good to me for the initial PR. Feel free to merge once @minnieliu 's comments are applied.

Great job on your first PR!

@minnieliu minnieliu merged commit b227152 into master Jun 8, 2021
@minnieliu minnieliu deleted the feature/communication-ServerCalling-preview1 branch June 8, 2021 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.