-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Web PubSub function bindings sdk. (#20459)
* Init version for Web PubSub function bindings * fix warns and dependencies. * fix styling check. * fix typo in readme and minor update. * remove deploy files. * fix and resolve comments * add changelog. * fix bug * refactor and resolve some comments. * resolve a few comments * resolve comments. * add generated api. * Add package description and update changelog * update readme. * update authenticate part * minor improve description. * remove snippet.
- Loading branch information
Showing
68 changed files
with
3,322 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/CHANGELOG.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Release History | ||
|
||
## 1.0.0-beta.2 (Unreleased) | ||
|
||
## 1.0.0-beta.1 (2021-04-26) | ||
|
||
- The initial beta release of Microsoft.Azure.WebJobs.Extensions.WebPubSub 1.0.0 |
7 changes: 7 additions & 0 deletions
7
sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/Directory.Build.props
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
<PropertyGroup> | ||
<IsClientLibrary>true</IsClientLibrary> | ||
</PropertyGroup> | ||
|
||
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory)..\, Directory.Build.props))\Directory.Build.props" /> | ||
</Project> |
31 changes: 31 additions & 0 deletions
31
...osoft.Azure.WebJobs.Extensions.WebPubSub/Microsoft.Azure.WebJobs.Extensions.WebPubSub.sln
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
|
||
Microsoft Visual Studio Solution File, Format Version 12.00 | ||
# Visual Studio Version 16 | ||
VisualStudioVersion = 16.0.30803.129 | ||
MinimumVisualStudioVersion = 10.0.40219.1 | ||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.WebJobs.Extensions.WebPubSub", "src\Microsoft.Azure.WebJobs.Extensions.WebPubSub.csproj", "{6CF5F6B5-F8D6-4D92-9AE5-F766B1C83EED}" | ||
EndProject | ||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.WebJobs.Extensions.WebPubSub.Tests", "tests\Microsoft.Azure.WebJobs.Extensions.WebPubSub.Tests.csproj", "{89759B66-5CF1-4A86-9D07-D3DA48300AE9}" | ||
EndProject | ||
Global | ||
GlobalSection(SolutionConfigurationPlatforms) = preSolution | ||
Debug|Any CPU = Debug|Any CPU | ||
Release|Any CPU = Release|Any CPU | ||
EndGlobalSection | ||
GlobalSection(ProjectConfigurationPlatforms) = postSolution | ||
{6CF5F6B5-F8D6-4D92-9AE5-F766B1C83EED}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
{6CF5F6B5-F8D6-4D92-9AE5-F766B1C83EED}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
{6CF5F6B5-F8D6-4D92-9AE5-F766B1C83EED}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
{6CF5F6B5-F8D6-4D92-9AE5-F766B1C83EED}.Release|Any CPU.Build.0 = Release|Any CPU | ||
{89759B66-5CF1-4A86-9D07-D3DA48300AE9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
{89759B66-5CF1-4A86-9D07-D3DA48300AE9}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
{89759B66-5CF1-4A86-9D07-D3DA48300AE9}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
{89759B66-5CF1-4A86-9D07-D3DA48300AE9}.Release|Any CPU.Build.0 = Release|Any CPU | ||
EndGlobalSection | ||
GlobalSection(SolutionProperties) = preSolution | ||
HideSolutionNode = FALSE | ||
EndGlobalSection | ||
GlobalSection(ExtensibilityGlobals) = postSolution | ||
SolutionGuid = {AFE7981B-5322-4E4D-BACC-3380116A52F5} | ||
EndGlobalSection | ||
EndGlobal |
152 changes: 152 additions & 0 deletions
152
sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,152 @@ | ||
# Azure WebJobs Web PubSub client library for .NET | ||
|
||
This extension provides functionality for receiving Web PubSub webhook calls in Azure Functions, allowing you to easily write functions that respond to any event published to Web PubSub. | ||
|
||
## Getting started | ||
|
||
### Install the package | ||
|
||
Install the Web PubSub extension with [NuGet][nuget]: | ||
|
||
```Powershell | ||
dotnet add package Microsoft.Azure.WebJobs.Extensions.WebPubSub --prerelease | ||
``` | ||
|
||
### Prerequisites | ||
|
||
You must have an [Azure subscription](https://azure.microsoft.com/free/) and an Azure resource group with a Web PubSub resource. Follow this [step-by-step tutorial](https://review.docs.microsoft.com/azure/azure-web-pubsub/howto-develop-create-instance?branch=release-azure-web-pubsub) to create an Azure Web PubSub instance. | ||
|
||
### Authenticate the client | ||
|
||
In order to let the extension work with Azure Web PubSub service, you will need to provide a valid `ConnectionString`. | ||
|
||
You can find the **Keys** for you Azure Web PubSub service in the [Azure Portal](https://portal.azure.com/). | ||
|
||
The `AzureWebJobsStorage` connection string is used to preserve the processing checkpoint information as required refer to [Storage considerations](https://docs.microsoft.com/azure/azure-functions/storage-considerations#storage-account-requirements) | ||
|
||
For the local development use the `local.settings.json` file to store the connection string, `<connection_name>` can be set to `WebPubSubConnectionString` as default supported in the extension, or you can set customized names by mapping it with `ConnectionStringSetting = <connection_name>` in function binding attributes: | ||
|
||
```json | ||
{ | ||
"Values": { | ||
"AzureWebJobsStorage": "UseDevelopmentStorage=true", | ||
"<connection_name>": "Endpoint=https://<webpubsub-name>.webpubsub.azure.com;AccessKey=<access-key>;Version=1.0;" | ||
} | ||
} | ||
``` | ||
When deployed use the [application settings](https://docs.microsoft.com/azure/azure-functions/functions-how-to-use-azure-function-app-settings) to set the connection string. | ||
|
||
## Key concepts | ||
|
||
### Using Web PubSub input binding | ||
|
||
Please follow the [input binding tutorial](#functions-that-uses-web-pubsub-input-binding) to learn about using this extension for building `WebPubSubConnection` to create Websockets connection to service with input binding. | ||
|
||
### Using Web PubSub output binding | ||
|
||
Please follow the [output binding tutorial](#functions-that-uses-web-pubsub-output-binding) to learn about using this extension for publishing Web PubSub messages. | ||
|
||
### Using Web PubSub trigger | ||
|
||
Please follow the [trigger binding tutorial](#functions-that-uses-web-pubsub-trigger) to learn about triggering an Azure Function when an event is sent from service upstream. | ||
|
||
In `Connect` and `Message` events, function will respect return values to send back service. Then service will depend on the response to proceed the request or else. The responses and events are paired. For example, `Connect` will only respect `ConnectResponse` or `ErrorResponse`, and ignore other returns. When `ErrorResponse` is returned, service will drop client connection. Please follow the [trigger binding return value tutorial](#functions-that-uses-web-pubsub-trigger-return-value) to learn about using the trigger return value. | ||
|
||
## Examples | ||
|
||
### Functions that uses Web PubSub input binding | ||
|
||
```cs | ||
[FunctionName("WebPubSubInputBindingFunction")] | ||
public static WebPubSubConnection Run( | ||
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req, | ||
[WebPubSubConnection(Hub = "simplechat", UserId = "{query.userid}")] WebPubSubConnection connection) | ||
{ | ||
Console.WriteLine("login"); | ||
return connection; | ||
} | ||
``` | ||
|
||
### Functions that uses Web PubSub output binding | ||
|
||
```cs | ||
[FunctionName("WebPubSubOutputBindingFunction")] | ||
public static async Task RunAsync( | ||
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req, | ||
[WebPubSub(Hub = "simplechat")] IAsyncCollector<WebPubSubOperation> operation) | ||
{ | ||
await operation.AddAsync(new SendToAll | ||
{ | ||
Message = BinaryData.FromString("Hello Web PubSub"), | ||
DataType = MessageDataType.Text | ||
}); | ||
} | ||
``` | ||
|
||
### Functions that uses Web PubSub trigger | ||
|
||
```cs | ||
[FunctionName("WebPubSubTriggerFunction")] | ||
public static void Run( | ||
[WebPubSubTrigger("message", WebPubSubEventType.User)] | ||
ConnectionContext context, | ||
string message, | ||
MessageDataType dataType) | ||
{ | ||
Console.WriteLine($"Request from: {context.userId}"); | ||
Console.WriteLine($"Request message: {message}"); | ||
Console.WriteLine($"Request message DataType: {dataType}"); | ||
} | ||
``` | ||
|
||
### Functions that uses Web PubSub trigger return value | ||
|
||
```cs | ||
[FunctionName("WebPubSubTriggerReturnValueFunction")] | ||
public static MessageResponse RunAsync( | ||
[WebPubSubTrigger("message", WebPubSubEventType.User)] ConnectionContext context) | ||
{ | ||
return new MessageResponse | ||
{ | ||
Message = BinaryData.FromString("ack"), | ||
DataType = MessageDataType.Text | ||
}; | ||
} | ||
``` | ||
|
||
## Troubleshooting | ||
|
||
Please refer to [Monitor Azure Functions](https://docs.microsoft.com/azure/azure-functions/functions-monitoring) for troubleshooting guidance. | ||
|
||
## Next steps | ||
|
||
Read the [introduction to Azure Function](https://docs.microsoft.com/azure/azure-functions/functions-overview) or [creating an Azure Function guide](https://docs.microsoft.com/azure/azure-functions/functions-create-first-azure-function). | ||
|
||
## Contributing | ||
|
||
See our [CONTRIBUTING.md][contrib] for details on building, | ||
testing, and contributing to this library. | ||
|
||
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 [cla.microsoft.com][cla]. | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct][coc]. | ||
For more information see the [Code of Conduct FAQ][coc_faq] | ||
or contact [[email protected]][coc_contact] with any | ||
additional questions or comments. | ||
|
||
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fsearch%2FMicrosoft.Azure.WebJobs.Extensions.WebPubSub%2FREADME.png) | ||
|
||
<!-- LINKS --> | ||
[source]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/search/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src | ||
[package]: https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.WebPubSub/ | ||
[docs]: https://docs.microsoft.com/dotnet/api/Microsoft.Azure.WebJobs.Extensions.WebPubSub | ||
[nuget]: https://www.nuget.org/ | ||
|
||
[contrib]: https://github.com/Azure/azure-sdk-for-net/tree/master/CONTRIBUTING.md | ||
[cla]: https://cla.microsoft.com | ||
[coc]: https://opensource.microsoft.com/codeofconduct/ | ||
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ | ||
[coc_contact]: mailto:[email protected] |
Oops, something went wrong.