Merge pull request #222523 from Y-Sindo/isolated

Add c# isolated worker for quick start sample

Author: JamesJBarnett

articles/azure-signalr/signalr-quickstart-azure-functions-csharp.md

@@ -6,17 +6,26 @@ ms.service: signalr
 ms.devlang: csharp
 ms.topic: quickstart
 ms.custom: devx-track-csharp, mode-other
-ms.date: 03/30/2022
+ms.date: 12/28/2022
 ms.author: lianwei
 ---
 
 # Quickstart: Create an app showing GitHub star count with Azure Functions and SignalR Service via C#
 
 In this article, you'll learn how to use SignalR Service and Azure Functions to build a serverless application with C# to broadcast messages to clients.
 
+# [In-process](#tab/in-process)
+
 > [!NOTE]
 > You can get the code mentioned in this article from [GitHub](https://github.com/aspnet/AzureSignalR-samples/tree/main/samples/QuickStartServerless/csharp).
 
+# [Isolated process](#tab/isolated-process)
+
+> [!NOTE]
+> You can get the code mentioned in this article from [GitHub](https://github.com/aspnet/AzureSignalR-samples/tree/main/samples/QuickStartServerless/csharp-isolated).
+
+---
+
 ## Prerequisites
 
 The following prerequisites are needed for this quickstart:
@@ -37,6 +46,8 @@ You'll need the Azure Functions Core Tools for this step.
 1. Create an empty directory and change to the directory with the command line.
 1. Initialize a new project.
 
+    # [In-process](#tab/in-process)
+
     ```bash
     # Initialize a function project
     func init --worker-runtime dotnet
@@ -45,8 +56,22 @@ You'll need the Azure Functions Core Tools for this step.
     dotnet add package Microsoft.Azure.WebJobs.Extensions.SignalRService
     ```
 
+    # [Isolated process](#tab/isolated-process)
+
+    ```bash
+    # Initialize a function project
+    func init --worker-runtime dotnet-isolated
+
+    # Add extensions package references to the project
+    dotnet add package Microsoft.Azure.Functions.Worker.Extensions.Http
+    dotnet add package Microsoft.Azure.Functions.Worker.Extensions.SignalRService
+    dotnet add package Microsoft.Azure.Functions.Worker.Extensions.Timer
+    ```
+
 1. Using your code editor, create a new file with the name *Function.cs*. Add the following code to *Function.cs*:
 
+    # [In-process](#tab/in-process)
+
     ```csharp
     using System;
     using System.IO;
@@ -59,15 +84,15 @@ You'll need the Azure Functions Core Tools for this step.
     using Microsoft.Azure.WebJobs.Extensions.Http;
     using Microsoft.Azure.WebJobs.Extensions.SignalRService;
     using Newtonsoft.Json;
-    
+
     namespace CSharp
     {
         public static class Function
         {
             private static HttpClient httpClient = new HttpClient();
             private static string Etag = string.Empty;
             private static string StarCount = "0";
-    
+
             [FunctionName("index")]
             public static IActionResult GetHomePage([HttpTrigger(AuthorizationLevel.Anonymous)]HttpRequest req, ExecutionContext context)
             {
@@ -78,15 +103,15 @@ You'll need the Azure Functions Core Tools for this step.
                     ContentType = "text/html",
                 };
             }
-    
+
             [FunctionName("negotiate")]
-            public static SignalRConnectionInfo Negotiate( 
+            public static SignalRConnectionInfo Negotiate(
                 [HttpTrigger(AuthorizationLevel.Anonymous)] HttpRequest req,
                 [SignalRConnectionInfo(HubName = "serverless")] SignalRConnectionInfo connectionInfo)
             {
                 return connectionInfo;
             }
-    
+
             [FunctionName("broadcast")]
             public static async Task Broadcast([TimerTrigger("*/5 * * * * *")] TimerInfo myTimer,
             [SignalR(HubName = "serverless")] IAsyncCollector<SignalRMessage> signalRMessages)
@@ -104,15 +129,15 @@ You'll need the Azure Functions Core Tools for this step.
                     var result = JsonConvert.DeserializeObject<GitResult>(await response.Content.ReadAsStringAsync());
                     StarCount = result.StarCount;
                 }
-                
+
                 await signalRMessages.AddAsync(
                     new SignalRMessage
                     {
                         Target = "newMessage",
                         Arguments = new[] { $"Current star count of https://github.com/Azure/azure-signalr is: {StarCount}" }
                     });
             }
-    
+
             private class GitResult
             {
                 [JsonRequired]
@@ -123,6 +148,75 @@ You'll need the Azure Functions Core Tools for this step.
     }
     ```
 
+    # [Isolated process](#tab/isolated-process)
+
+    ```csharp
+    using System.Net;
+    using System.Net.Http.Json;
+    using System.Text.Json.Serialization;
+    using Microsoft.Azure.Functions.Worker;
+    using Microsoft.Azure.Functions.Worker.Http;
+
+    namespace csharp_isolated;
+
+    public class Functions
+    {
+        private static readonly HttpClient HttpClient = new();
+        private static string Etag = string.Empty;
+        private static int StarCount = 0;
+
+        [Function("index")]
+        public static HttpResponseData GetHomePage([HttpTrigger(AuthorizationLevel.Anonymous)] HttpRequestData req)
+        {
+            var response = req.CreateResponse(HttpStatusCode.OK);
+            response.WriteString(File.ReadAllText("content/index.html"));
+            response.Headers.Add("Content-Type", "text/html");
+            return response;
+        }
+
+        [Function("negotiate")]
+        public static HttpResponseData Negotiate([HttpTrigger(AuthorizationLevel.Anonymous)] HttpRequestData req,
+            [SignalRConnectionInfoInput(HubName = "serverless")] string connectionInfo)
+        {
+            var response = req.CreateResponse(HttpStatusCode.OK);
+            response.Headers.Add("Content-Type", "application/json");
+            response.WriteString(connectionInfo);
+            return response;
+        }
+
+        [Function("broadcast")]
+        [SignalROutput(HubName = "serverless")]
+        public static async Task<SignalRMessageAction> Broadcast([TimerTrigger("*/5 * * * * *")] TimerInfo timerInfo)
+        {
+            var request = new HttpRequestMessage(HttpMethod.Get, "https://api.github.com/repos/azure/azure-signalr");
+            request.Headers.UserAgent.ParseAdd("Serverless");
+            request.Headers.Add("If-None-Match", Etag);
+            var response = await HttpClient.SendAsync(request);
+            if (response.Headers.Contains("Etag"))
+            {
+                Etag = response.Headers.GetValues("Etag").First();
+            }
+            if (response.StatusCode == HttpStatusCode.OK)
+            {
+                var result = await response.Content.ReadFromJsonAsync<GitResult>();
+                if (result != null)
+                {
+                    StarCount = result.StarCount;
+                }
+            }
+            return new SignalRMessageAction("newMessage", new object[] { $"Current star count of https://github.com/Azure/azure-signalr is: {StarCount}" });
+        }
+
+        private class GitResult
+        {
+            [JsonPropertyName("stargazers_count")]
+            public int StarCount { get; set; }
+        }
+    }
+    ```
+
+    ---
+
     The code in *Function.cs* has three functions:
     - `GetHomePage` is used to get a website as client.
     - `Negotiate` is used by the client to get an access token.
@@ -166,6 +260,11 @@ You'll need the Azure Functions Core Tools for this step.
     </ItemGroup>
     ```
 
+1. Azure Functions requires a storage account to work. You can install and run the [Azure Storage Emulator](../storage/common/storage-use-azurite.md). **Or** you can update the setting to use your real storage account with the following command:
+    ```bash
+    func settings add AzureWebJobsStorage "<storage-connection-string>"
+    ```
+
 1. It's almost done now. The last step is to set a connection string of the SignalR Service to Azure Function settings.
 
     1. Confirm the SignalR Service instance was successfully created by searching for its name in the search box at the top of the portal. Select the instance to open it.
@@ -188,11 +287,8 @@ You'll need the Azure Functions Core Tools for this step.
     func start
     ```
 
-    After the Azure function is running locally, open `http://localhost:7071/api/index` and you can see the current star count. If you star or unstar in the GitHub, you'll get a star count refreshing every few seconds.
+    After the Azure function is running locally, open `http://localhost:7071/api/index`, and you can see the current star count. If you star or unstar in the GitHub, you'll get a star count refreshing every few seconds.
 
-    > [!NOTE]
-    > SignalR binding needs Azure Storage, but you can use a local storage emulator when the function is running locally.
-    > If you got the error `There was an error performing a read operation on the Blob Storage Secret Repository. Please ensure the 'AzureWebJobsStorage' connection string is valid.` You need to download and enable [Storage Emulator](../storage/common/storage-use-emulator.md)
 
 [!INCLUDE [Cleanup](includes/signalr-quickstart-cleanup.md)]
 

articles/azure-signalr/signalr-quickstart-azure-functions-java.md

@@ -22,7 +22,7 @@ In this article, you'll use Azure SignalR Service, Azure Functions, and Java to
 - A code editor, such as [Visual Studio Code](https://code.visualstudio.com/)
 - An Azure account with an active subscription. If you don't already have an account, [create an account for free](https://azure.microsoft.com/free/?ref=microsoft.com&utm_source=microsoft.com&utm_medium=docs&utm_campaign=visualstudio).
 - [Azure Functions Core Tools](https://github.com/Azure/azure-functions-core-tools#installing). Used to run Azure Function apps locally.
-  
+
   - The required SignalR Service bindings in Java are only supported in Azure Function Core Tools version 2.4.419 (host version 2.0.12332) or above.
   - To install extensions, Azure Functions Core Tools requires the [.NET Core SDK](https://dotnet.microsoft.com/download) installed. However, no knowledge of .NET is required to build Java Azure Function apps.
 
@@ -52,13 +52,13 @@ Make sure you have Azure Function Core Tools, Java (version 11 in the sample), a
     | **groupId** | `com.signalr` | A value that uniquely identifies your project across all projects, following the [package naming rules](https://docs.oracle.com/javase/specs/jls/se6/html/packages.html#7.7) for Java. |
     | **artifactId** | `java` | A value that is the name of the jar, without a version number. |
     | **version** | `1.0-SNAPSHOT` | Choose the default value. |
-    | **package** | `com.signalr` | A value that is the Java package for the generated function code. Use the default. |  
+    | **package** | `com.signalr` | A value that is the Java package for the generated function code. Use the default. |
 
 1. Go to the folder `src/main/java/com/signalr` and copy the following code to *Function.java*:
 
     ```java
     package com.signalr;
-    
+
     import com.google.gson.Gson;
     import com.microsoft.azure.functions.ExecutionContext;
     import com.microsoft.azure.functions.HttpMethod;
@@ -71,10 +71,10 @@ Make sure you have Azure Function Core Tools, Java (version 11 in the sample), a
     import com.microsoft.azure.functions.annotation.TimerTrigger;
     import com.microsoft.azure.functions.signalr.*;
     import com.microsoft.azure.functions.signalr.annotation.*;
-    
+
     import org.apache.commons.io.IOUtils;
-    
-    
+
+
     import java.io.IOException;
     import java.io.InputStream;
     import java.net.URI;
@@ -84,24 +84,24 @@ Make sure you have Azure Function Core Tools, Java (version 11 in the sample), a
     import java.net.http.HttpResponse.BodyHandlers;
     import java.nio.charset.StandardCharsets;
     import java.util.Optional;
-    
+
     public class Function {
         private static String Etag = "";
         private static String StarCount;
-    
+
         @FunctionName("index")
         public HttpResponseMessage run(
                 @HttpTrigger(
                     name = "req",
                     methods = {HttpMethod.GET},
                     authLevel = AuthorizationLevel.ANONYMOUS)HttpRequestMessage<Optional<String>> request,
                 final ExecutionContext context) throws IOException {
-            
+
             InputStream inputStream = getClass().getClassLoader().getResourceAsStream("content/index.html");
             String text = IOUtils.toString(inputStream, StandardCharsets.UTF_8.name());
             return request.createResponseBuilder(HttpStatus.OK).header("Content-Type", "text/html").body(text).build();
         }
-    
+
         @FunctionName("negotiate")
         public SignalRConnectionInfo negotiate(
                 @HttpTrigger(
@@ -111,10 +111,10 @@ Make sure you have Azure Function Core Tools, Java (version 11 in the sample), a
                 @SignalRConnectionInfoInput(
                     name = "connectionInfo",
                     hubName = "serverless") SignalRConnectionInfo connectionInfo) {
-                    
+
             return connectionInfo;
         }
-    
+
         @FunctionName("broadcast")
         @SignalROutput(name = "$return", hubName = "serverless")
         public SignalRMessage broadcast(
@@ -132,10 +132,10 @@ Make sure you have Azure Function Core Tools, Java (version 11 in the sample), a
                 GitResult result = gson.fromJson(res.body(), GitResult.class);
                 StarCount = result.stargazers_count;
             }
-            
+
             return new SignalRMessage("newMessage", "Current start count of https://github.com/Azure/azure-signalr is:".concat(StarCount));
         }
-    
+
         class GitResult {
             public String stargazers_count;
         }
@@ -169,7 +169,7 @@ Make sure you have Azure Function Core Tools, Java (version 11 in the sample), a
         | | - main
         | | | - java
         | | | | - com
-        | | | | | - signalr 
+        | | | | | - signalr
         | | | | | | - Function.java
         | | | - resources
         | | | | - content
@@ -183,7 +183,7 @@ Make sure you have Azure Function Core Tools, Java (version 11 in the sample), a
 
     ```html
     <html>
-    
+
     <body>
         <h1>Azure SignalR Serverless Sample</h1>
         <div id="messages"></div>
@@ -198,15 +198,17 @@ Make sure you have Azure Function Core Tools, Java (version 11 in the sample), a
             connection.on('newMessage', (message) => {
             document.getElementById("messages").innerHTML = message;
             });
-    
+
             connection.start()
             .catch(console.error);
         </script>
     </body>
-    
+
     </html>
     ```
 
+1. Azure Functions requires a storage account to work. You can install and run the [Azure Storage Emulator](../storage/common/storage-use-azurite.md).
+
 1. You're almost done now. The last step is to set a connection string of the SignalR Service to Azure Function settings.
 
     1. Search for the Azure SignalR instance you deployed earlier using the **Search** box in Azure portal. Select the instance to open it.
@@ -234,10 +236,6 @@ Make sure you have Azure Function Core Tools, Java (version 11 in the sample), a
 
     After Azure Function is running locally, go to  `http://localhost:7071/api/index` and you'll see the current star count. If you star or "unstar" in the GitHub, you'll get a star count refreshing every few seconds.
 
-    > [!NOTE]
-    > SignalR binding needs Azure Storage, but you can use local storage emulator when the Function is running locally.
-    > If you got some error like `There was an error performing a read operation on the Blob Storage Secret Repository. Please ensure the 'AzureWebJobsStorage' connection string is valid.` You need to download and enable [Storage Emulator](../storage/common/storage-use-emulator.md)
-
 [!INCLUDE [Cleanup](includes/signalr-quickstart-cleanup.md)]
 
 Having issues? Try the [troubleshooting guide](signalr-howto-troubleshoot-guide.md) or [let us know](https://aka.ms/asrs/qsjava).