Abbot – “cloud-event v1.1.2” by Serious Business

Code

<br /> /* ————————————————————————————————<br /> Use this skill to subscribe to cloud events such as Azure Event Grid using the<br /> Cloud Events WebHook Spec v1.0.1: https://github.com/cloudevents/spec/blob/v1.0.1/http-webhook.md<br /> ————————————————————————————————— */</p> <p>using Newtonsoft.Json;<br /> using Newtonsoft.Json.Linq;</p> <p>if (Bot.IsChat) {<br /> // This section describes the chat interactions<br /> var (cmd, arg, origin) = Bot.Arguments;</p> <p> Task reply = (cmd, arg, origin) switch {<br /> (IMissingArgument, _, _) => ReplyWithHelp(),<br /> ({Value: “list”}, IMissingArgument, _) => ReplyWithListTriggersWithAllowedOrigins(),<br /> ({Value: “list”}, var triggerArg, IMissingArgument) => ReplyWithListOfAllowedWebHooks(triggerArg),<br /> ({Value: “remove”}, var triggerArg, IMissingArgument) => RemoveAllAllowedOriginsAndReply(triggerArg),<br /> ({Value: “remove”}, var triggerArg, var originArg) => RemoveAllowedOriginAndReply(triggerArg, originArg.Value),<br /> _ => ReplyWithLackOfUnderstanding()<br /> };</p> <p> await reply;<br /> return;<br /> }</p> <p>/* ———————————————–<br /> The following methods handle webhook interactions.<br /> ————————————————– */<br /> if (Bot.Request.HttpMethod == HttpMethod.Options) {<br /> await HandleValidationOptionsRequest();<br /> return;<br /> }</p> <p>if (Bot.Request.IsJson) {<br /> string origin = Bot.Request.Headers.Origin;<br /> if (origin is not {Length: > 0}) {<br /> // Azure Cloud Events are not sending the Origin header, even though the spec requires it. They send this instead.<br /> // I’ve reported this to the proper authorities.<br /> origin = Bot.Request.Headers.WebHookRequestOrigin;<br /> }</p> <p> var allowedOrigins = await GetAllowedOrigins();<br /> if (!allowedOrigins.Contains(origin)) {<br /> await Bot.ReplyAsync($”Rejected origin `{origin}`.”);<br /> return;<br /> }</p> <p> var cloudEvent = GetCloudEvent();</p> <p> Task reply = cloudEvent.Type switch {<br /> “Microsoft.Web.AppUpdated” => ReplyWithAppUpdatedMessage(cloudEvent),<br /> “Microsoft.EventGrid.SubscriptionDeletedEvent” => Bot.ReplyAsync($”Azure EventGrid Subscription `{cloudEvent.Data.ToObject<SubscriptionData>().EventSubscriptionId}` deleted. This message came from {Bot.SkillUrl}”),<br /> _ when cloudEvent.Type.StartsWith(“Microsoft.Web.Slot”) => ReplyWithSlotSwapMessage(cloudEvent),<br /> _ => Bot.ReplyAsync($”Received an unknown event. Version: `{Bot.VersionInfo.ProductVersion}`. You may want to check the Activity logs for the trigger to see what’s up. This message came from {Bot.SkillUrl}.”)<br /> };</p> <p> await reply;<br /> return;<br /> }</p> <p>await Bot.ReplyAsync(“Received an unknown Cloud Event request. You may want to check the Activity logs to see what’s up. This message came from {Bot.SkillUrl}..”);</p> <p>Task ReplyWithSlotSwapMessage(CloudEvent cloudEvent) {<br /> var slotSwapData = cloudEvent.Data.ToObject<SlotSwapData>();<br /> if (cloudEvent.Type.StartsWith(“Microsoft.Web.SlotSwap”)) {<br /> string action = cloudEvent.Type switch {<br /> “Microsoft.Web.SlotSwapCompleted” => “completed”,<br /> “Microsoft.Web.SlotSwapStarted” => “started”,<br /> “Microsoft.Web.SlotSwapFailed” => “failed”,<br /> “Microsoft.Web.SlotSwapWithPreviewStarted” => “started with preview”,<br /> “Microsoft.Web.SlotSwapWithPreviewCancelled” => “cancelled with preview”,<br /> _ => cloudEvent.Type<br /> };</p> <p> // https://docs.microsoft.com/en-us/azure/event-grid/event-schema-app-service?tabs=cloud-event-schema<br /> // says we should get “siteName” but the actual payload has “name”. I’ve also reported this to the<br /> // proper authorities.<br /> var siteName = slotSwapData.SiteName ?? slotSwapData.Name;<br /> return Bot.ReplyAsync($”{siteName}: Swap from {slotSwapData.SourceSlot} to {slotSwapData.TargetSlot} {action}. Version: `{Bot.VersionInfo.ProductVersion}`. This message came from {Bot.SkillUrl}.”);<br /> }<br /> return Bot.ReplyAsync(“Something happened with an app service but I don’t know what.”);<br /> }</p> <p>Task ReplyWithAppUpdatedMessage(CloudEvent cloudEvent) {<br /> var appUpdatedData = cloudEvent.Data.ToObject<AppUpdatedData>();<br /> var siteName = appUpdatedData.SiteName ?? appUpdatedData.Name;<br /> return Bot.ReplyAsync($”{siteName}: Update {appUpdatedData.AppEventTypeDetail.Action}. Version: `{Bot.VersionInfo.ProductVersion}`. This message came from {Bot.SkillUrl}.”);<br /> }</p> <p>public CloudEvent GetCloudEvent() {<br /> // It’s possible to subscribe to event batches, hence this haaaaack.<br /> if (Bot.Request.RawBody.StartsWith(‘[‘)) {<br /> var list = Bot.Request.DeserializeBodyAs<List<CloudEvent>>();<br /> if (list is null or not { Count: 1 }) {<br /> return default;<br /> }<br /> return list.Single();<br /> }<br /> return Bot.Request.DeserializeBodyAs<CloudEvent>();<br /> }</p> <p>public class CloudEvent {<br /> public string Id { get; set; }<br /> public string Source { get; set; }<br /> public string SpecVersion { get; set; }<br /> public string Type { get; set; }<br /> public string DataSchema { get; set; }<br /> public string Subject { get; set; }<br /> public DateTimeOffset Time { get; set; }<br /> public JObject Data { get; set; }<br /> }</p> <p>public class AppServiceData {<br /> public string Name { get; set; }<br /> // https://docs.microsoft.com/en-us/azure/event-grid/event-schema-app-service?tabs=cloud-event-schema says we should get “siteName” but in<br /> // my testing I’m getting “name”<br /> public string SiteName { get; set; }<br /> public string ClientRequestID { get; set; }<br /> public string CorrelationRequestId { get; set; }<br /> public string RequestId { get; set; }<br /> public string Address { get; set; }<br /> public string Verb { get; set; }<br /> }</p> <p>public class AppUpdatedData : AppServiceData {<br /> public AppEventTypeDetail AppEventTypeDetail { get; set; }<br /> }</p> <p>public class AppEventTypeDetail {<br /> public string Action { get; set; }<br /> }</p> <p>public class SlotSwapData : AppServiceData<br /> {<br /> public string SourceSlot { get; set; }<br /> public string TargetSlot { get; set; }<br /> }</p> <p>public class SubscriptionData {<br /> public string EventSubscriptionId { get; set; }<br /> }</p> <p>// Handles the validation request: https://github.com/cloudevents/spec/blob/v1.0.1/http-webhook.md#41-validation-request<br /> async Task HandleValidationOptionsRequest() {<br /> // This is the origin that is requesting permission to send requests to this trigger.<br /> string origin = Bot.Request.Headers.WebHookRequestOrigin;</p> <p> // We want to save that this origin may send events to this specific trigger. Multiple origins may be<br /> // allowed to post to the same trigger so we use the trigger URL as the key.<br /> await AddToAllowedOrigins(origin);</p> <p> // Respond that this origin is allowed. This part of the spec.<br /> Bot.Response.Headers.WebHookAllowedOrigin = origin;<br /> Bot.Response.Headers.WebHookAllowedRate = 120;</p> <p> // And we should report to the room that it all went to plan.<br /> await Bot.ReplyAsync($”Validated that {origin} may deliver cloud events to this channel.”);<br /> }</p> <p>/* ———————————————-<br /> The following methods handle chat interactions.<br /> ————————————————- */</p> <p>async Task ReplyWithListTriggersWithAllowedOrigins() {<br /> var allTriggers = await GetAllTriggers();<br /> var triggerList = allTriggers.Select(subscription => subscription.Key.ToLowerInvariant())<br /> .ToOrderedList();<br /> if (!triggerList.Any()) {<br /> await Bot.ReplyAsync(“There are no allowed origins for this skill. `{Bot} help {Bot.SkillName}` for help using this skill.”);<br /> return;<br /> }<br /> await Bot.ReplyAsync($”These are the triggers for this skill that allow WebHooks. `{Bot} {Bot.SkillName} list #` or `{Bot} {Bot.SkillName} list {{url}}` to see which origins are allowed for that trigger:\n{triggerList}”);<br /> }</p> <p>async Task ReplyWithListOfAllowedWebHooks(IArgument triggerArg) {<br /> var triggerUrl = await GetTriggerUrlFromArgument(triggerArg);<br /> var allowedOrigins = await GetAllowedOrigins(triggerUrl);<br /> if (allowedOrigins is null or {Count: 0}) {<br /> await Bot.ReplyAsync($”There are no origins allowed to post to {triggerUrl}. That sounds like a bug in this skill.”);<br /> return;<br /> }<br /> await Bot.ReplyAsync($”These are the webhooks allowed to post to {triggerUrl}:\n{allowedOrigins.ToMarkdownList()}”);<br /> }</p> <p>Task ReplyWithHelp() {<br /> return Bot.ReplyAsync(GetHelpMessage());<br /> }</p> <p>Task ReplyWithLackOfUnderstanding() {<br /> return Bot.ReplyAsync($”Sorry, I did not understand that. {GetHelpMessage()}”);<br /> }</p> <p>async Task RemoveAllAllowedOriginsAndReply(IArgument triggerArg) {<br /> var triggerUrl = await GetTriggerUrlFromArgument(triggerArg);<br /> await Bot.Brain.DeleteAsync(triggerUrl);<br /> await Bot.ReplyAsync($”Removed all webhooks allowed to post to {triggerUrl}. You may still want to go to the source and delete the webhook registration.”);<br /> return;<br /> }</p> <p>async Task RemoveAllowedOriginAndReply(IArgument triggerArg, string origin) {<br /> var triggerUrl = await GetTriggerUrlFromArgument(triggerArg);<br /> var removed = await Bot.Brain.RemoveFromHashSetAsync(triggerUrl, origin);<br /> if (removed) {<br /> await Bot.ReplyAsync($”I removed {origin} from the list of webooks allowed to post to {triggerUrl}. You may still want to go to the source and delete the webhook registration.”);<br /> return;<br /> }<br /> await Bot.ReplyAsync($”The origin {origin} was not in the list of allowed origins that may post to {triggerUrl}.”);<br /> }</p> <p>string GetHelpMessage() {<br /> return $”`{Bot} help {Bot.SkillName}` to learn how to use this skill.”;<br /> }</p> <p>async Task<IReadOnlyList<ISkillDataItem>> GetAllTriggers() {<br /> var allTriggers = await Bot.Brain.GetAllAsync();<br /> return allTriggers<br /> .Where(item => !item.Key.Equals(“Log”, StringComparison.OrdinalIgnoreCase))<br /> .ToList();<br /> }</p> <p>async Task<string> GetTriggerUrlFromArgument(IArgument triggerArg) {<br /> var position = triggerArg.ToInt32(); // Attempt to convert to int, otherwise return null.<br /> if (position.HasValue) {<br /> var allSubscriptions = await GetAllTriggers();<br /> return allSubscriptions[position.Value – 1].Key.ToLowerInvariant();<br /> }<br /> return triggerArg.Value.ToLowerInvariant();<br /> }</p> <p>Task<HashSet<string>> GetAllowedOrigins() {<br /> return GetAllowedOrigins(Bot.Request.Url.ToString());<br /> }</p> <p>Task<HashSet<string>> GetAllowedOrigins(string url) {<br /> return Bot.Brain.GetHashSetAsync<string>(url);<br /> }</p> <p>Task AddToAllowedOrigins(string origin) {<br /> var triggerUrl = Bot.Request.Url.ToString();<br /> return Bot.Brain.AddToHashSetAsync(triggerUrl, origin);<br /> }<br />