DefaultActivityHandler.cs

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

usingSystem;
usingSystem.Linq;
usingSystem.Threading;
usingSystem.Threading.Tasks;
usingMicrosoft.Bot.Builder;
usingMicrosoft.Bot.Builder.Dialogs;
usingMicrosoft.Bot.Builder.Integration.AspNet.Core.Skills;
usingMicrosoft.Bot.Builder.Teams;
usingMicrosoft.Bot.Schema;
usingMicrosoft.Bot.Schema.Teams;
usingMicrosoft.Bot.Solutions;
usingMicrosoft.Bot.Solutions.Responses;
usingMicrosoft.Bot.Solutions.Skills;
usingMicrosoft.Extensions.DependencyInjection;
usingMicrosoft.Teams.Apps.VirtualAssistant.Extension;
usingMicrosoft.Teams.Apps.VirtualAssistant.Models;
usingNewtonsoft.Json;
usingNewtonsoft.Json.Linq;

namespaceMicrosoft.Teams.Apps.VirtualAssistant.Bots
{
publicclassDefaultActivityHandler<T>:TeamsActivityHandler
whereT:Dialog
{
privatereadonlyDialog_dialog;
privatereadonlyBotState_conversationState;
privateIStatePropertyAccessor<DialogState>_dialogStateAccessor;
privateLocaleTemplateEngineManager_templateEngine;
privatereadonlySkillHttpClient_skillHttpClient;
privatereadonlySkillsConfiguration_skillsConfig;
privatereadonlyIBotTelemetryClient_telemetryClient;
privatereadonlystring_appId;
privatereadonlystring_composeExtensionCommandIdSeparator;

publicDefaultActivityHandler(IServiceProviderserviceProvider,Tdialog,stringappId)
{
_dialog=dialog;
_conversationState=serviceProvider.GetService<ConversationState>();
_dialogStateAccessor=_conversationState.CreateProperty<DialogState>(nameof(DialogState));
_templateEngine=serviceProvider.GetService<LocaleTemplateEngineManager>();
_skillHttpClient=serviceProvider.GetService<SkillHttpClient>();
_skillsConfig=serviceProvider.GetService<SkillsConfiguration>();
_telemetryClient=serviceProvider.GetService<IBotTelemetryClient>();
this._appId=appId;
_composeExtensionCommandIdSeparator=":";
}

publicoverrideasyncTaskOnTurnAsync(ITurnContextturnContext,CancellationTokencancellationToken=default)
{
awaitbase.OnTurnAsync(turnContext,cancellationToken);

// Save any state changes that might have occured during the turn.
await_conversationState.SaveChangesAsync(turnContext,false,cancellationToken);
}

protectedoverrideTaskOnMessageActivityAsync(ITurnContext<IMessageActivity>turnContext,CancellationTokencancellationToken)
{
return_dialog.RunAsync(turnContext,_dialogStateAccessor,cancellationToken);
}

protectedoverrideTaskOnTeamsSigninVerifyStateAsync(ITurnContext<IInvokeActivity>turnContext,CancellationTokencancellationToken)
{
return_dialog.RunAsync(turnContext,_dialogStateAccessor,cancellationToken);
}

protectedoverrideasyncTaskOnEventActivityAsync(ITurnContext<IEventActivity>turnContext,CancellationTokencancellationToken)
{
varev=turnContext.Activity.AsEventActivity();
varvalue=ev.Value?.ToString();

switch(ev.Name)
{
caseTokenEvents.TokenResponseEventName:
{
// Forward the token response activity to the dialog waiting on the stack.
await_dialog.RunAsync(turnContext,_dialogStateAccessor,cancellationToken);
break;
}

default:
{
awaitturnContext.SendActivityAsync(newActivity(type:ActivityTypes.Trace,text:$"Unknown Event '{ev.Name??"undefined"}' was received but not processed."));
break;
}
}
}

protectedoverrideasyncTaskOnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>turnContext,CancellationTokencancellationToken)
{
await_dialog.RunAsync(turnContext,_dialogStateAccessor,cancellationToken);
}

// Invoked when a "task/fetch" event is received to invoke task module.
protectedoverrideasyncTask<TaskModuleResponse>OnTeamsTaskModuleFetchAsync(ITurnContext<IInvokeActivity>turnContext,TaskModuleRequesttaskModuleRequest,CancellationTokencancellationToken)
{
try
{
stringskillId=(turnContext.ActivityasActivity).GetSkillId();
varskill=_skillsConfig.Skills.Where(s =>s.Value.AppId==skillId).FirstOrDefault().Value;

// Forward request to correct skill
varinvokeResponse=await_skillHttpClient.PostActivityAsync(this._appId,skill,_skillsConfig.SkillHostEndpoint,turnContext.ActivityasActivity,cancellationToken);

returninvokeResponse.GetTaskModuleRespose();
}
catch(Exceptionexception)
{
awaitturnContext.SendActivityAsync(_templateEngine.GenerateActivityForLocale("ErrorMessage"));
_telemetryClient.TrackException(exception);

returnnull;
}
}

// Invoked when a 'task/submit' invoke activity is received for task module submit actions.
protectedoverrideasyncTask<TaskModuleResponse>OnTeamsTaskModuleSubmitAsync(ITurnContext<IInvokeActivity>turnContext,TaskModuleRequesttaskModuleRequest,CancellationTokencancellationToken)
{
try
{
stringskillId=(turnContext.ActivityasActivity).GetSkillId();
varskill=_skillsConfig.Skills.Where(s =>s.Value.AppId==skillId).FirstOrDefault().Value;

// Forward request to correct skill
varinvokeResponse=await_skillHttpClient.PostActivityAsync(this._appId,skill,_skillsConfig.SkillHostEndpoint,turnContext.ActivityasActivity,cancellationToken).ConfigureAwait(false);

returninvokeResponse.GetTaskModuleRespose();
}
catch(Exceptionexception)
{
awaitturnContext.SendActivityAsync(_templateEngine.GenerateActivityForLocale("ErrorMessage"));
_telemetryClient.TrackException(exception);

returnnull;
}
}

// Invoked when a 'composeExtension/query' invoke activity is received for compose extension query command.
protectedoverrideasyncTask<MessagingExtensionResponse>OnTeamsMessagingExtensionQueryAsync(ITurnContext<IInvokeActivity>turnContext,MessagingExtensionQueryquery,CancellationTokencancellationToken)
{
varskillId=ExtractSkillIdFromComposeExtensionQueryCommand(turnContext,query);
varskill=_skillsConfig.Skills.Where(s =>s.Value.AppId==skillId).FirstOrDefault().Value;
varinvokeResponse=await_skillHttpClient.PostActivityAsync(this._appId,skill,_skillsConfig.SkillHostEndpoint,turnContext.ActivityasActivity,cancellationToken).ConfigureAwait(false);

returninvokeResponse.GetMessagingExtensionResponse();
}

// Invoked when a 'composeExtension/selectItem' invoke activity is received for compose extension query command.
protectedoverrideasyncTask<MessagingExtensionResponse>OnTeamsMessagingExtensionSelectItemAsync(ITurnContext<IInvokeActivity>turnContext,JObjectquery,CancellationTokencancellationToken)
{
vardata=JsonConvert.DeserializeObject<SkillCardActionData>(query.ToString());
varskill=_skillsConfig.Skills.Where(s =>s.Value.AppId==data.SkillId).FirstOrDefault().Value;
varinvokeResponse=await_skillHttpClient.PostActivityAsync(this._appId,skill,_skillsConfig.SkillHostEndpoint,turnContext.ActivityasActivity,cancellationToken).ConfigureAwait(false);

returninvokeResponse.GetMessagingExtensionResponse();
}

// Invoked when a 'composeExtension/submitAction' invoke activity is received for compose extension action command.
protectedoverrideasyncTask<MessagingExtensionActionResponse>OnTeamsMessagingExtensionSubmitActionAsync(ITurnContext<IInvokeActivity>turnContext,MessagingExtensionActionaction,CancellationTokencancellationToken)
{
returnawaitForwardMessagingExtensionActionCommandActivityToSkill(turnContext,action,cancellationToken);
}

// Invoked when a 'composeExtension/submitAction' invoke activity is received for compose extension edit preview action command.
protectedoverrideasyncTask<MessagingExtensionActionResponse>OnTeamsMessagingExtensionBotMessagePreviewEditAsync(ITurnContext<IInvokeActivity>turnContext,MessagingExtensionActionaction,CancellationTokencancellationToken)
{
returnawaitForwardMessagingExtensionActionCommandActivityToSkill(turnContext,action,cancellationToken);
}

// Invoked when a 'composeExtension/submitAction' invoke activity is received for compose extension send preview action command.
protectedoverrideasyncTask<MessagingExtensionActionResponse>OnTeamsMessagingExtensionBotMessagePreviewSendAsync(ITurnContext<IInvokeActivity>turnContext,MessagingExtensionActionaction,CancellationTokencancellationToken)
{
returnawaitForwardMessagingExtensionActionCommandActivityToSkill(turnContext,action,cancellationToken);
}

// Invoked when a 'composeExtension/fetchTask' invoke activity is received for compose extension action command.
protectedoverrideasyncTask<MessagingExtensionActionResponse>OnTeamsMessagingExtensionFetchTaskAsync(ITurnContext<IInvokeActivity>turnContext,MessagingExtensionActionaction,CancellationTokencancellationToken)
{
returnawaitForwardMessagingExtensionActionCommandActivityToSkill(turnContext,action,cancellationToken);
}

// Forwards invoke activity to right skill for compose extension action commands.
privateasyncTask<MessagingExtensionActionResponse>ForwardMessagingExtensionActionCommandActivityToSkill(ITurnContext<IInvokeActivity>turnContext,MessagingExtensionActionaction,CancellationTokencancellationToken)
{
varskillId=ExtractSkillIdFromComposeExtensionActionCommand(turnContext,action);
varskill=_skillsConfig.Skills.Where(s =>s.Value.AppId==skillId).FirstOrDefault().Value;
varinvokeResponse=await_skillHttpClient.PostActivityAsync(this._appId,skill,_skillsConfig.SkillHostEndpoint,turnContext.ActivityasActivity,cancellationToken).ConfigureAwait(false);

returninvokeResponse.GetMessagingExtensionActionResponse();
}

// Extracts skill Id from messaging extension query command and updates activity value
privatestringExtractSkillIdFromComposeExtensionQueryCommand(ITurnContext<IInvokeActivity>turnContext,MessagingExtensionQueryquery)
{
varcommandArray=query.CommandId.Split(_composeExtensionCommandIdSeparator);
varskillId=commandArray.Last();

// Update activity value by removing skill id before forwarding to the skill.
varactivityValue=JsonConvert.DeserializeObject<MessagingExtensionQuery>(turnContext.Activity.Value.ToString());
activityValue.CommandId=string.Join(_composeExtensionCommandIdSeparator,commandArray.Take(commandArray.Length-1));
turnContext.Activity.Value=activityValue;

returnskillId;
}

// Extracts skill Id from messaging extension command and updates activity value
privatestringExtractSkillIdFromComposeExtensionActionCommand(ITurnContext<IInvokeActivity>turnContext,MessagingExtensionActionaction)
{
varcommandArray=action.CommandId.Split(_composeExtensionCommandIdSeparator);
varskillId=commandArray.Last();

// Update activity value by removing skill id before forwarding to the skill.
varactivityValue=JsonConvert.DeserializeObject<MessagingExtensionAction>(turnContext.Activity.Value.ToString());
activityValue.CommandId=string.Join(_composeExtensionCommandIdSeparator,commandArray.Take(commandArray.Length-1));
turnContext.Activity.Value=activityValue;

returnskillId;
}
}
}