Merge pull request #44 from h2floh/feature/speech

Adding Speech capability

Author: angie4u

.gitignore

@@ -351,4 +351,7 @@ MigrationBackup/
 
 # Terraform
 .terraform
-*.tfstate*
+*.tfstate*
+
+# AppSettings
+appsettings.json

Deploy/DeployInfrastructure.ps1

@@ -69,6 +69,18 @@ $success = $success -and $LASTEXITCODE
 # Clean Up
 Remove-Item -Path $azureBotRegions
 
+# 2. Retrieve Bot Data from Terraform infrastructure execution
+Write-Host "## 2. Retrieve Bot Data from Terraform infrastructure execution"
+$Bot = Get-TerraformOutput("bot") | ConvertFrom-Json
+$success = $success -and $?
+
+# 3. Retrive DirectlineKey and register it to KV
+Write-Host "## 3. Retrive DirectlineKey and register it to KV"
+$directline = $(az bot directline show --resource-group $Bot.resource_group --name $Bot.name --with-secrets true) | ConvertFrom-Json
+$success = $success -and $?
+# create a secret in Key Vault called DirectlineKey
+az keyvault secret set --vault-name $Bot.name --name 'DirectlineKey' --value $directline.properties.properties.sites.key > $null
+
 # Check successful execution
 Write-ExecutionStatus -success $success
 exit $success

Deploy/IaC/regions.tf

@@ -129,3 +129,44 @@ resource "azurerm_cognitive_account" "LUISRegion" {
   sku_name = "S0"
 }
 
+// For every region add the Speech KEY to KeyVault
+resource "azurerm_key_vault_secret" "SpeechKeyRegion" {
+  for_each = local.azure_bot_regions
+
+  name         = "SpeechAPIKey${each.key}"
+  value        = azurerm_cognitive_account.SpeechRegion[each.key].primary_access_key
+  key_vault_id = azurerm_key_vault.GeoBot.id
+
+  depends_on = [
+    azurerm_key_vault_access_policy.currentClient
+  ]
+}
+
+// For every region add the Speech endpoint URL to KeyVault
+resource "azurerm_key_vault_secret" "SpeechEndpointRegion" {
+  for_each = local.azure_bot_regions
+
+  name         = "SpeechAPIHostName${each.key}"
+  value        = azurerm_cognitive_account.SpeechRegion[each.key].endpoint
+  key_vault_id = azurerm_key_vault.GeoBot.id
+
+  depends_on = [
+    azurerm_key_vault_access_policy.currentClient
+  ]
+}
+
+// Create a Speech Endpoint/Key for every Region
+resource "azurerm_cognitive_account" "SpeechRegion" {
+  for_each = local.azure_bot_regions
+
+  name                = "${var.bot_name}Speech${each.key}"
+  location            = azurerm_resource_group.Region[each.key].location
+  resource_group_name = azurerm_resource_group.Region[each.key].name
+  kind                = "SpeechServices"
+
+  sku {
+    name = "S0"
+    tier = "Standard"
+  }
+}
+

Deploy/RetrieveWebChatLink.ps1

@@ -32,23 +32,27 @@ $success = $True
 # Tell who you are (See HelperFunction.ps1)
 Write-WhoIAm
 
-# 1. Export SSL Certificate
+# 1. Retrieve Bot Data from Terraform infrastructure execution
 Write-Host "## 1. Retrieve Bot Data from Terraform infrastructure execution"
 $Bot = Get-TerraformOutput("bot") | ConvertFrom-Json
 $success = $success -and $?
 
-# 2. Retrieve DirectLine Secret and generate Link
-Write-Host "## 2. Retrieve DirectLine Secret and generate Link"
-$directline = $(az bot directline show --resource-group $Bot.resource_group --name $Bot.name --with-secrets true) | ConvertFrom-Json
+# 2. Retrieve Bot endpoint information using Azure CLI
+Write-Host "## 2. Retrieve Bot endpoint information using Azure CLI"
+$botSettings = $(az bot show -n $Bot.name -g $Bot.resource_group) | ConvertFrom-Json
 $success = $success -and $?
-$queryparams = "?bot=$($Bot.name)&key=$($directline.properties.properties.sites.key)"
-$webchathtmlfile = Get-ItemProperty -Path "$(Get-ScriptPath)/../WebChat/index.html"
-
+$endpoint = $botSettings.properties.endpoint
+# If this bot using azure web app, we need to replace '/api/messages'
+if ($endpoint -like "*/api/messages") { 
+    $endpoint = $endpoint.Replace("/api/messages", "")
+}
+Write-Host "endpoint: $endpoint"
+
+# 3. Generate Link
+Write-Host "## 3. Generate Link"
 Write-Host -ForegroundColor Green "`n`n### If you were lucky and there were no errors in between your Geo Distributed Bot is ready!`n### If you are just testing you can use this link to open a WebChat to your Bot from any browser.`n### E.g. if you want to test it from different VM's or VPN connections."
-Write-Host -ForegroundColor Red "### Do not use this link if you want to go to production since the Directline Key will get exposed on the network (query params are not encrypted):"
-Write-Host -ForegroundColor Red "### https://h2floh.github.io/GeoDistributedAzureBot/WebChat/index.html$queryparams"
-Write-Host -ForegroundColor Yellow "###`n### Use this link on your local computer (if you cloned the repo to your local computer) in order to not expose your Directline Key:"
-Write-Host -ForegroundColor Yellow "### $($webchathtmlfile.FullName)$queryparams"
+Write-Host -ForegroundColor Yellow "###`n### Use this link with your browser"
+Write-Host -ForegroundColor Yellow "### $endpoint/"
 
 # Return execution status
 Write-ExecutionStatus -success $success

GeoBot/GeoBot/Controllers/DirectlineController.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+
+namespace GeoBot.Controllers
+{
+    [ApiController]
+    public class DirectlineController : ControllerBase
+    {
+        private readonly Directline directline;
+        public DirectlineController(Directline directline)
+        {
+            this.directline = directline;
+        }
+
+        [Route("directline/token")]
+        [HttpGet]
+        public async Task<DirectlineToken> GetAsync()
+        {
+            DirectlineToken directlineToken = new DirectlineToken
+            {
+                token = await directline.GetDirectlineToken()
+            };
+
+            return directlineToken;
+        }
+    }
+
+    public class DirectlineToken
+    {
+        public string token { get; set; }
+    }
+}

GeoBot/GeoBot/Controllers/SpeechController.cs

@@ -0,0 +1,40 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+
+namespace GeoBot.Controllers
+{
+    // This ASP Controller is created to handle healthcheck requests from TrafficManager.
+    [ApiController]
+    public class SpeechController : ControllerBase
+    {
+        private readonly Speech speech;
+
+        public SpeechController(Speech speech)
+        {
+            this.speech = speech;
+        }
+
+        [Route("speech/token")]
+        [HttpGet]
+        public async Task<SpeechToken> GetTokenAsync()
+        {
+            SpeechToken speechToken = new SpeechToken
+            {
+                token = await speech.GetSpeechToken(),
+                region = speech.GetSpeechRegion()
+            };
+
+            return speechToken;
+        }
+    }
+
+    public class SpeechToken
+    {
+        public string token { get; set; }
+        public string region { get; set; }
+    }
+
+}

GeoBot/GeoBot/Directline.cs

@@ -0,0 +1,70 @@
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net.Http;
+using System.Net.Http.Headers;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GeoBot
+{
+    public class Directline
+    {
+        protected readonly IConfiguration configuration;
+        protected readonly ILogger logger;
+        private static readonly HttpClient httpClient = new HttpClient();
+
+        public Directline(IConfiguration configuration, ILogger<Directline> logger)
+        {
+            this.configuration = configuration;
+            this.logger = logger;
+        }
+
+        public async Task<string> GetDirectlineToken()
+        {
+            // Check on Speech Endpoint
+            var directlineIsConfigured = !string.IsNullOrEmpty(configuration["DirectlineKey"]);
+            if (directlineIsConfigured)
+            {
+                var directlineKey = configuration["DirectlineKey"];
+                var directlineUrl = $"https://directline.botframework.com/v3/directline/tokens/generate";
+
+                using (var client = new HttpClient())
+                {
+                    HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, directlineUrl);
+                    request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", directlineKey);
+                    var userId = $"dl_{Guid.NewGuid()}";
+
+                    request.Content = new StringContent(
+                        JsonConvert.SerializeObject(
+                            new { User = new { Id = userId } }),
+                            Encoding.UTF8,
+                            "application/json");
+
+                    var result = await client.SendAsync(request);
+                    string token = String.Empty;
+
+                    if (result.IsSuccessStatusCode)
+                    {
+                        var body = await result.Content.ReadAsStringAsync();
+                        token = JsonConvert.DeserializeObject<DirectLineToken>(body).token;
+
+                        return token;
+                    }
+                    else
+                    {
+                        return "There is something wrong when issue the directline token";
+                    }
+                }
+            }
+            else
+            {
+                // In Case Directline is not configured
+                return null;
+            }
+        }
+    }
+}

GeoBot/GeoBot/Healthcheck.cs

@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Net;
 using System.Net.Http;
+using System.Net.Http.Headers;
 using System.Security.Policy;
 using System.Text;
 using System.Text.RegularExpressions;
@@ -11,6 +12,7 @@
 using Microsoft.Azure.Cosmos;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
+using Newtonsoft.Json;
 
 namespace GeoBot
 {
@@ -39,9 +41,14 @@ public async Task CheckHealthAsync(HttpResponse response)
             var cosmosDBresult = await CheckCosmosDB();
             response.Headers.Add("CosmosDBInnerStatusCode", cosmosDBresult.StatusCode);
             response.Headers.Add("CosmosDBInnerStatusReason", cosmosDBresult.StatusMessage);
+            // Check Speech
+            var speechResult = await CheckSpeech();
+            response.Headers.Add("SpeechInnerStatusCode", speechResult.StatusCode);
+            response.Headers.Add("SpeechInnerStatusReason", speechResult.StatusMessage);
 
             // Check overall success
-            if (lUISresult.Success && cosmosDBresult.Success) {
+            if (lUISresult.Success && cosmosDBresult.Success && speechResult.Success)
+            {
                 response.StatusCode = 200;
             }
         }
@@ -85,12 +92,12 @@ private async Task<HealthcheckResult> CheckCosmosDB()
                     // read container - to check if until container level all is working
                     using (CosmosClient client = new CosmosClient(configuration["CosmosDBStateStoreEndpoint"], configuration["CosmosDBStateStoreKey"]))
                     {
-                        
+
                         var container = client.GetContainer(configuration["CosmosDBStateStoreDatabaseId"],
                                                             configuration["CosmosDBStateStoreCollectionId"]);
-                        
+
                         var readContainer = await container.ReadContainerAsync();
-                        
+
                         // Return Success
                         return new HealthcheckResult(true, readContainer.StatusCode.ToString(), "CosmosDB account, database and container accessible");
                     }
@@ -113,7 +120,7 @@ private async Task<HealthcheckResult> CheckCosmosDB()
 
                     return new HealthcheckResult(false, statusCode, e.Message);
                 }
-               
+
             }
             else
             {
@@ -122,6 +129,55 @@ private async Task<HealthcheckResult> CheckCosmosDB()
             }
         }
 
+        private async Task<HealthcheckResult> CheckSpeech()
+        {
+            // Check on LUIS Endpoint
+            var speechKeyKey = "SpeechAPIKey" + configuration["region"];
+            var speechHostNameKey = "SpeechAPIHostName" + configuration["region"];
+
+            var speechIsConfigured = !string.IsNullOrEmpty(configuration[speechKeyKey]) && !string.IsNullOrEmpty(configuration[speechHostNameKey]);
+            if (speechIsConfigured)
+            {
+                try
+                {
+                    // Get Speech service token
+                    Speech speech = new Speech(configuration, null);
+                    var speechTokenResult = await speech.GetSpeechToken();
+
+                    var speechUrl = $"https://{configuration["region"]}.tts.speech.microsoft.com/cognitiveservices/voices/list";
+                    
+                    httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", speechTokenResult);
+                    var requestMessage = new HttpRequestMessage(HttpMethod.Get, speechUrl);
+                    var responseMessage = await httpClient.SendAsync(requestMessage);
+                    
+                    return new HealthcheckResult(responseMessage.IsSuccessStatusCode, responseMessage.StatusCode.ToString(), responseMessage.ReasonPhrase);
+                }
+                catch (Exception e)
+                {
+                    // Return failure
+                    var statusCode = "503";
+                    // Try to extract status code from expeption message: Response status code does not indicate success: 401 
+                    try
+                    {
+                        var rx = new Regex(@"Response status code does not indicate success: (\d{3})");
+                        Match match = rx.Match(e.Message);
+                        if (match.Success)
+                        {
+                            statusCode = match.Groups[1].Value;
+                        }
+                    }
+                    catch { }
+
+                    return new HealthcheckResult(false, statusCode, e.Message);
+                }
+            }
+            else
+            {
+                return new HealthcheckResult(true, "200", "Speech not configured");
+            }
+            
+        }
+
         // Data Object
         internal class HealthcheckResult
         {
@@ -137,3 +193,10 @@ internal HealthcheckResult(bool success, string statusCode, string statusMessage
         }
     }
 }
+
+public class DirectLineToken
+{
+    public string conversationId { get; set; }
+    public string token { get; set; }
+    public int expires_in { get; set; }
+}