[WebPubSub]Init pr for webpubsub client sdk: Add public interface (#3…

…2406) # Contributing to the Azure SDK Please see our [CONTRIBUTING.md](https://github.com/Azure/azure-sdk-for-net/blob/main/CONTRIBUTING.md) if you are not familiar with contributing to this repository or have questions. For specific information about pull request etiquette and best practices, see [this section](https://github.com/Azure/azure-sdk-for-net/blob/main/CONTRIBUTING.md#pull-request-etiquette-and-best-practices).
Azure · Nov 14, 2022 · edd266f · edd266f
1 parent 2f97c71
commit edd266f
Show file tree

Hide file tree

Showing 51 changed files with 2,774 additions and 1 deletion.
diff --git a/.vscode/cspell.json b/.vscode/cspell.json
@@ -926,7 +926,15 @@
       "words": [
         "Orgs"
       ]
-    }
+    },
+    {
+      "filename": "**/sdk/webpubsub/**/*.cs",
+      "words": [
+        "protobuf",
+        "Ackable",
+        "awps"
+        ]
+    }  
   ],
   "allowCompoundWords": true
 }
diff --git a/sdk/webpubsub/Azure.Messaging.WebPubSub.Client/Azure.Messaging.WebPubSub.Client.sln b/sdk/webpubsub/Azure.Messaging.WebPubSub.Client/Azure.Messaging.WebPubSub.Client.sln
@@ -0,0 +1,56 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.2.32616.157
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Messaging.WebPubSub.Client", "src\Azure.Messaging.WebPubSub.Client.csproj", "{845299CD-399C-4296-9F61-D4E02679363E}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Messaging.WebPubSub.Client.Tests", "tests\Azure.Messaging.WebPubSub.Client.Tests.csproj", "{0B6AAD06-F541-4931-A661-16BE3BE24EEF}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{E5726134-6AA7-4AED-A654-53C92F09485A}"
+	ProjectSection(SolutionItems) = preProject
+		tests\test.runsettings = tests\test.runsettings
+	EndProjectSection
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Debug|x64 = Debug|x64
+		Debug|x86 = Debug|x86
+		Release|Any CPU = Release|Any CPU
+		Release|x64 = Release|x64
+		Release|x86 = Release|x86
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{845299CD-399C-4296-9F61-D4E02679363E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Debug|x64.Build.0 = Debug|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Debug|x86.Build.0 = Debug|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Release|x64.ActiveCfg = Release|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Release|x64.Build.0 = Release|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Release|x86.ActiveCfg = Release|Any CPU
+		{845299CD-399C-4296-9F61-D4E02679363E}.Release|x86.Build.0 = Release|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Debug|x64.Build.0 = Debug|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Debug|x86.Build.0 = Debug|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Release|x64.ActiveCfg = Release|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Release|x64.Build.0 = Release|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Release|x86.ActiveCfg = Release|Any CPU
+		{0B6AAD06-F541-4931-A661-16BE3BE24EEF}.Release|x86.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {72FA37A6-5914-405F-9A01-605ED24270D3}
+	EndGlobalSection
+EndGlobal
diff --git a/sdk/webpubsub/Azure.Messaging.WebPubSub.Client/CHANGELOG.md b/sdk/webpubsub/Azure.Messaging.WebPubSub.Client/CHANGELOG.md
@@ -0,0 +1,4 @@
+# Release History
+
+## 1.0.0-beta.1 (Unreleased)
+- Initial beta release
diff --git a/sdk/webpubsub/Azure.Messaging.WebPubSub.Client/Directory.Build.props b/sdk/webpubsub/Azure.Messaging.WebPubSub.Client/Directory.Build.props
@@ -0,0 +1,6 @@
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <!--
+    Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props
+  -->
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" />
+</Project>
diff --git a/sdk/webpubsub/Azure.Messaging.WebPubSub.Client/README.md b/sdk/webpubsub/Azure.Messaging.WebPubSub.Client/README.md
@@ -0,0 +1,202 @@
+# Azure Web PubSub client library for .NET
+
+[Azure Web PubSub Service](https://aka.ms/awps/doc) is an Azure-managed service that helps developers easily build web applications with real-time features and publish-subscribe pattern. Any scenario that requires real-time publish-subscribe messaging between server and clients or among clients can use Azure Web PubSub service. Traditional real-time features that often require polling from server or submitting HTTP requests can also use Azure Web PubSub service.
+
+You can use this library in your client side to manage the WebSocket client connections, as shown in below diagram:
+
+![overflow](https://user-images.githubusercontent.com/668244/140014067-25a00959-04dc-47e8-ac25-6957bd0a71ce.png)
+
+Use this library to:
+
+- Send messages to groups
+- Send event to event handlers
+- Join and leave groups
+- Listen messages from groups and servers
+
+Details about the terms used here are described in [Key concepts](#key-concepts) section.
+
+[Source code](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/webpubsub/Azure.Messaging.WebPubSub.Client/src) |
+[API reference documentation](https://aka.ms/awps/sdk/csharp) |
+[Product documentation](https://aka.ms/awps/doc) |
+
+## Getting started
+
+### Install the package
+
+Install the client library from [NuGet](https://www.nuget.org/):
+
+```dotnetcli
+dotnet add package Azure.Messaging.WebPubSub.Client
+```
+
+### Prerequisites
+
+- An [Azure subscription][azure_sub].
+- An existing Azure Web PubSub service instance. [Create Azure Web PubSub service instance](https://learn.microsoft.com/azure/azure-web-pubsub/howto-develop-create-instance)
+
+### Authenticate the client
+
+In order to interact with the service, you'll need to create an instance of the `WebPubSubClient` class. To make this possible, you'll need an access token. You can copy and paste an access token from Azure portal.
+
+```C# Snippet:WebPubSubClient_Construct
+var client = new WebPubSubClient(new Uri("<client-access-uri>"));
+```
+
+And in production, you usually get `ClientAccessUri` from a negotiate server.
+
+```C# Snippet:WebPubSubClient_Construct2
+var client = new WebPubSubClient(new WebPubSubClientCredential(token =>
+{
+    // In common practice, you will have a negotiation server for generating token. Client should fetch token from it.
+    return FetchClientAccessTokenFromServerAsync(token);
+}));
+```
+
+The `FetchClientAccessTokenFromServerAsync` usually fetch the token from server via Http request. And in the server side, you can use `WebPubSubServiceClient` to generate token and response to the fetch request.
+
+```C# Snippet:WebPubSubClient_GenerateClientAccessUri
+var serviceClient = new WebPubSubServiceClient("<< Connection String >>", "hub");
+return await serviceClient.GetClientAccessUriAsync();
+```
+
+## Key concepts
+
+### Connection
+
+A connection, also known as a client connection, represents an individual WebSocket connection connected to the Web PubSub service. When successfully connected, the Web PubSub service assigns the connection a unique connection ID. Each `WebPubSubClient` creates its own exclusive connection.
+
+### Recovery
+
+If using reliable protocols, a new WebSocket will try to reconnect using the connection ID of the lost connection. If the WebSocket connection is successfully connected, the connection is recovered. And all group contexts will be recovered, and unreceived messages will be resent.
+
+### Hub
+
+A hub is a logical concept representing a collection of client connections. Usually, you use one hub for one purpose: for example, a chat hub, or a notification hub. When a client connection is created, it connects to a hub and, and during its lifetime, it is bound to that hub. Different applications can share one Azure Web PubSub service by using different hub names.
+
+### Group
+
+A group is a subset of connections to the hub. You can add and remove connections from a group at any time. For example, a chat room can be considered a group.  When clients join and leave the room, they are added and removed from the group. A connection can belong to multiple groups, and a group can contain multiple connections.
+
+### User
+
+Connections to Web PubSub can belong to one user. A user might have multiple connections, for example when a single user is connected across multiple devices or browser tabs.
+
+### Message
+
+When a client is connected, it can send messages to the upstream application, or receive messages from the upstream application, through the WebSocket connection. Also, it can send messages to groups and receive message from joined groups.
+
+## Examples
+
+### Send to groups
+
+```C# Snippet:WebPubSubClient_SendToGroup
+// Send message to group "testGroup"
+await client.SendToGroupAsync("testGroup", BinaryData.FromString("hello world"), WebPubSubDataType.Text);
+```
+
+### Send events to event handler
+
+```C# Snippet:WebPubSubClient_SendEvent
+// Send custom event to server
+await client.SendEventAsync("testEvent", BinaryData.FromString("hello world"), WebPubSubDataType.Text);
+```
+
+### Handle the Connected event
+
+The `Connected` event is called after the client receives connected message. The event will be triggered every reconnection.
+
+```C# Snippet:WebPubSubClient_Subscribe_Connected
+client.Connected += eventArgs =>
+{
+    Console.WriteLine($"Connection {eventArgs.ConnectionId} is connected");
+    return Task.CompletedTask;
+};
+```
+
+### Handle the Disconnected event
+
+The `Disconnected` event is triggered every time the connection closed and could not be recovered
+
+```C# Snippet:WebPubSubClient_Subscribe_Disconnected
+client.Disconnected += eventArgs =>
+{
+    Console.WriteLine($"Connection is disconnected");
+    return Task.CompletedTask;
+};
+```
+
+### Handle the Stopped event
+
+The `Stopped` event is triggered when the client is stopped. The client won't try to reconnect after being stopped. This event is typically the result of calling `StopAsync` or disabling the `AutoReconnect`
+
+```C# Snippet:WebPubSubClient_Subscribe_Stopped
+client.Stopped += eventArgs =>
+{
+    Console.WriteLine($"Client is stopped");
+    return Task.CompletedTask;
+};
+```
+
+### Handle the Server message event
+
+The `ServerMessageReceived` event is triggered when there's a message from server.
+
+```C# Snippet:WebPubSubClient_Subscribe_ServerMessage
+client.ServerMessageReceived += eventArgs =>
+{
+    Console.WriteLine($"Receive message: {eventArgs.Message.Data}");
+    return Task.CompletedTask;
+};
+```
+
+### Handle the Group message event
+
+The `GroupMessageReceived` event is triggered when there's a message from a group. You must join a group before you can receive messages from it.
+
+```C# Snippet:WebPubSubClient_Subscribe_GroupMessage
+client.GroupMessageReceived += eventArgs =>
+{
+    Console.WriteLine($"Receive group message from {eventArgs.Message.Group}: {eventArgs.Message.Data}");
+    return Task.CompletedTask;
+};
+```
+
+### Handle the restore failure event
+
+The `RestoreGroupFailed` event is triggered when the `AutoRejoinGroups` is enabled and rejoining a group fails after reconnection.
+
+```C# Snippet:WebPubSubClient_Subscribe_RestoreFailed
+client.RejoinGroupFailed += eventArgs =>
+{
+    Console.WriteLine($"Restore group failed");
+    return Task.CompletedTask;
+};
+```
+
+## Troubleshooting
+
+### Setting up console logging
+
+You can also [enable console logging](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md#logging) if you want to dig deeper into the requests you're making against the service.
+
+## Next steps
+
+You can also find [more samples here][awps_sample].
+
+## Contributing
+
+This project welcomes contributions and suggestions.
+Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.
+For details, visit <https://cla.microsoft.com.>
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment).
+Simply follow the instructions provided by the bot.
+You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png)
+
+[azure_sub]: https://azure.microsoft.com/free/dotnet/
+[awps_sample]: https://github.com/Azure/azure-webpubsub/tree/main/samples/csharp