Abbot – “github v2.0.1” by Serious Business

Code

<br /> /*<br /> Description: Useful skill for GitHub customers. Retrieve and assign issues. Get billing info.</p> <p>Usage:<br /> `@abbot github default {owner}/{repo}` – sets the default repository for this skill for the current room.<br /> `@abbot github user {{mention}} is {{github-username}}` to map a chat user to their GitHub username.<br /> `@abbot github issue triage [{owner}/{repo}]` – Retrieves unassigned issues. Limited to 20.<br /> `@abbot github issue close #{number} [{owner}/{repo}]` – closes the specified issue.<br /> `@abbot github issue #{number} [{owner}/{repo}]` – retrieves the issue by the issue number. `{owner}/{repo}` is not needed if the default repo is set.<br /> `@abbot github issue assign #{number} to {assignee} [{owner}/{repo}]` – assigns {assignee} to the issue. {assignee} could be a chat user, a GitHub username without the `@` prefix, or “me”.<br /> `@abbot github issues assigned to {assignee}` – Retrieves open issues assigned to {assignee}. {assignee} could be a chat user, a GitHub username without the `@` prefix, or “me”.<br /> `@abbot github billing {org-or-user}` – reports billing info for the specified organization or user. _Requires that a secret named `GitHubToken` be set with `admin:org` permission for orgs and `user` scope if reporting on a user._<br /> */<br /> using Octokit;</p> <p>// The key used to store and retrieve the default repository.<br /> // Embedding the room name ensures the default repository is per-room so<br /> // each room can have its own default.<br /> var roomKey = Bot.Room.Id ?? Bot.Room.Name;;<br /> readonly string DefaultRepositoryBrainKey = $”{roomKey}|DefaultRepository”;</p> <p>// GitHub Developer Token with access to the repository and org to query.<br /> var githubToken = await Bot.Secrets.GetAsync(“GitHubToken”);<br /> if (githubToken is not {Length: > 0}) {<br /> await Bot.ReplyAsync(“This skill requires a GitHub Developer Token set up as a secret. ”<br /> + “Visit https://github.com/settings/tokens to create a token. ”<br /> + $”Then visit {Bot.SkillUrl} and click \”Manage skill secrets\” to add a secret named `GitHubToken` with the token you created at GitHub.com.”);<br /> return;<br /> }</p> <p>// For GitHub Enterprise, pass in the Base URL after the ProductHeaderValue argument.<br /> // TODO: Make the API url settable so GitHub Enterprise users don’t have to edit the skill.<br /> var github = new GitHubClient(new ProductHeaderValue(“Abbot”)) {<br /> Credentials = new Credentials(githubToken)<br /> };</p> <p>/*———————————–<br /> MAIN ENTRY POINT<br /> *———————————–*/<br /> var (cmd, arg) = Bot.Arguments;</p> <p>Task action = (cmd, arg) switch {<br /> ({Value: “default”}, _) => GetOrSetDefaultRepoAsync(Bot.Arguments.Skip(1)),<br /> ({Value: “billing”}, _) => ReplyWithBillingInfoAsync(Bot.Arguments.Skip(1)),<br /> ({Value: “issue”} or {Value: “issues”}, _) => HandleIssueSubCommandAsync(Bot.Arguments.Skip(1)),<br /> ({Value: “user”}, _) => MapGitHubUserToChatUser(Bot.Arguments.Skip(1)),<br /> _ => ReplyWithUsage()<br /> };<br /> await action;</p> <p>if (!Bot.IsChat && !Bot.IsInteraction && !Bot.IsRequest) {<br /> // This was called by a schedule. Yes, we should have a property for this.<br /> await Bot.ReplyAsync(“_Previous message brought to you by a scheduled `github` skill._”);<br /> }</p> <p>async Task HandleIssueSubCommandAsync(IArguments arguments) {<br /> Task result = arguments switch {<br /> (IMissingArgument, _) => Bot.ReplyAsync(“`@abbot help github` to learn how to use this skill.”),<br /> ({Value: “triage”}, _) => ReplyWithIssueTriageAsync(arguments.Skip(1)),<br /> ({Value: “assign”}, _) => AssignIssueAndReplyAsync(arguments.Skip(1)),<br /> ({Value: “close”}, _) => CloseIssueAndReplyAsync(arguments.Skip(1)),<br /> ({Value: “assigned”}, _) => ReplyWithAssignedIssues(arguments.Skip(1)),<br /> ({Value: “user”}, _) => MapGitHubUserToChatUser(arguments.Skip(1)),<br /> var (issueNumber, repo) => ReplyWithIssueAsync(issueNumber, repo)<br /> };</p> <p> await result;<br /> }</p> <p>async Task MapGitHubUserToChatUser(IArguments args) {<br /> var (user, preposition, mapping) = args;<br /> if (mapping is IMissingArgument) { // Preposition is optional.<br /> mapping = preposition;<br /> }</p> <p> Task task = (user, mapping) switch {<br /> (IMissingArgument, _) or (_, IMissingArgument) => Bot.ReplyAsync(“Please supply both a GitHub username and a chat user”),<br /> (IMentionArgument, IMentionArgument) => Bot.ReplyAsync(“You specified two chat users. One should be a GitHub username without the `@` sign.”),<br /> (IMentionArgument mention, var githubUser) => MapGitHubUserToChatUser(githubUser.Value, mention.Mentioned),<br /> (var githubUser, IMentionArgument mention) => MapGitHubUserToChatUser(githubUser.Value, mention.Mentioned),<br /> (_, _) => Bot.ReplyAsync(“You specified two GitHub users. One should be a GitHub username without the `@` sign and the other should be a chat user mention.”),<br /> };<br /> await task;<br /> }</p> <p>async Task MapGitHubUserToChatUser(string username, IChatUser chatUser) {<br /> var gitHubUsername = await EnsureGitHubUsername(username);<br /> if (gitHubUsername is null) {<br /> await Bot.ReplyAsync($”GitHub tells me {username} does not exist.”);<br /> }<br /> await Bot.Brain.WriteAsync(GetUserMapKey(chatUser), gitHubUsername);<br /> await Bot.ReplyAsync($”Mapped {chatUser} to GitHub user {gitHubUsername}.”);<br /> }</p> <p>async Task<string> GetGitHubUserNameForMention(IChatUser mentioned) {<br /> return await Bot.Brain.GetAsync(GetUserMapKey(mentioned));<br /> }</p> <p>string GetUserMapKey(IChatUser user) {<br /> return $”user:{user.Id}”;<br /> }</p> <p>async Task CloseIssueAndReplyAsync(IArguments args) {<br /> var (numArg, prepositionArg, repositoryArg) = args;<br /> // We support @abbot github issue close #123 for aseriousbiz/blog or<br /> // @abbot github issue close #123 aseriousbiz/blog (without the preposition).<br /> if (repositoryArg is IMissingArgument) {<br /> repositoryArg = prepositionArg;<br /> }</p> <p> var issueNumber = numArg.ToInt32();<br /> if (issueNumber is null) {<br /> await Bot.ReplyAsync(“Please provide an issue number.”);<br /> return;<br /> }</p> <p> var (owner, repo) = await GetRepoOrDefault(repositoryArg);</p> <p> if (owner is null || repo is null) {<br /> await Bot.ReplyAsync($”Please specify which repository this is for or set a default repository first. `@abbot help github` to learn more.”);<br /> return;<br /> }</p> <p> var issue = await github.Issue.Get(owner, repo, issueNumber.Value);<br /> if (issue is null) {<br /> await Bot.ReplyAsync($”Could not find issue #{issueNumber} for {owner}/{repo} or I do not have access to it.”);<br /> return;<br /> }<br /> var update = issue.ToUpdate();<br /> update.State = ItemState.Closed;<br /> await github.Issue.Update(owner, repo, issueNumber.Value, update);<br /> await Bot.ReplyAsync($”Closed issue #{issueNumber}.”);<br /> }</p> <p>async Task AssignIssueAndReplyAsync(IArguments args) {<br /> var (numArg, prepositionArg, assigneeArg, repositoryArg) = args;<br /> // We support @abbot github issue assign #123 to haacked or<br /> // @abbot github issue assign #123 haacked<br /> // (without the preposition).<br /> if (assigneeArg is IMissingArgument) {<br /> assigneeArg = prepositionArg;<br /> }</p> <p> var issueNumber = numArg.ToInt32();<br /> var (owner, repo) = await GetRepoOrDefault(repositoryArg);</p> <p> Task task = (issueNumber, assigneeArg, owner, repo) switch {<br /> (null, _, _, _) => Bot.ReplyAsync($”Please provide an issue number and an assignee. `-{numArg.Value}-` {assigneeArg}”),<br /> (_, IMissingArgument, _, _) => Bot.ReplyAsync(“Please provide an assignee.”),<br /> (_, _, _, _) => AssignIssue(issueNumber.Value, assigneeArg, owner, repo)<br /> };<br /> await task;<br /> }</p> <p>async Task AssignIssue(int issueNumber, IArgument assigneeArg, string owner, string repo) {<br /> if (owner is null || repo is null) {<br /> await Bot.ReplyAsync($”Please specify which repository this is for or set a default repository first. `@abbot help github` to learn more.”);<br /> return;<br /> }</p> <p> var assignee = await GetAssigneeFromArgument(assigneeArg);<br /> if (assignee is null) {<br /> await Bot.ReplyAsync(GetUserNotFoundMessage(assigneeArg));<br /> return;<br /> }</p> <p> var issue = await github.Issue.Get(owner, repo, issueNumber);<br /> if (issue is null) {<br /> await Bot.ReplyAsync($”Could not find issue #{issueNumber} for {owner}/{repo} or I do not have access to it.”);<br /> return;<br /> }</p> <p> var update = issue.ToUpdate();<br /> update.ClearAssignees();<br /> update.AddAssignee(assignee);<br /> await github.Issue.Update(owner, repo, issueNumber, update);<br /> await Bot.ReplyAsync($”Assigned {issueNumber} to {assignee}.”);<br /> }</p> <p>static string GetUserNotFoundMessage(IArgument userArg) {<br /> return userArg is IMentionArgument mentioned<br /> ? $”I don’t know the GitHub username for {userArg}. `@abbot github user {{mention}} is {{github-username}}` to tell me.”<br /> : $”I could not find the GitHub user with the username `{userArg}. Either the user does not exist or the GitHub Token supplied to this skill does not have permissions for that user.”;<br /> }</p> <p>async Task ReplyWithAssignedIssues(IArguments args) {<br /> var (prepositionArg, assigneeArg, forArg, repoArg) = args;<br /> // User can ask `@abbot github issues assigned to me` or `@abbot github issues assigned me`<br /> if (prepositionArg is not {Value: “to”}) {<br /> // Move arguments up by one.<br /> repoArg = forArg;<br /> forArg = assigneeArg;<br /> assigneeArg = prepositionArg;<br /> }</p> <p> if (repoArg is IMissingArgument) {<br /> // User can ask `@abbot github issues assigned to me for aseriousbiz/abbot-skills` or `@abbot github issues assigned me aseriousbiz/abbot-skills`<br /> repoArg = forArg;<br /> }</p> <p> var assignee = await GetAssigneeFromArgument(assigneeArg);<br /> if (assignee is null) {<br /> await Bot.ReplyAsync(GetUserNotFoundMessage(assigneeArg));<br /> return;<br /> }</p> <p> var (owner, repo) = await GetRepoOrDefault(repoArg);</p> <p> var request = new RepositoryIssueRequest {<br /> Assignee = assignee,<br /> State = ItemStateFilter.Open,<br /> Filter = IssueFilter.All<br /> };<br /> var apiOptions = new ApiOptions {<br /> PageSize = 20,<br /> PageCount = 1<br /> };<br /> var issues = await github.Issue.GetAllForRepository(owner, repo, request, apiOptions);<br /> if (issues is {Count: 0}) {<br /> var assigneeOut = assigneeArg is {Value: “me”}<br /> ? “you”<br /> : assignee;<br /> await Bot.ReplyAsync($”Good job! No open issues assigned to {assigneeOut}.”);<br /> return;<br /> }<br /> var reply = issues.Select(FormatIssue).ToMarkdownList();<br /> await Bot.ReplyAsync(reply);<br /> }</p> <p>// Return all open and unassigend issues in the repository.<br /> async Task ReplyWithIssueTriageAsync(IArguments args) {<br /> var (prepositionArg, repoArg) = args;<br /> if (repoArg is IMissingArgument) {<br /> repoArg = prepositionArg;<br /> }</p> <p> var (owner, repo) = await GetRepoOrDefault(repoArg);</p> <p> if (repo is null || owner is null) {<br /> await Bot.ReplyAsync(“Repository must set as default or supplied in the form `owner/name`. `@abbot help github` for more information.”);<br /> return;<br /> }<br /> var request = new RepositoryIssueRequest {<br /> Assignee = “none”,<br /> State = ItemStateFilter.Open,<br /> Filter = IssueFilter.All<br /> };<br /> var apiOptions = new ApiOptions {<br /> PageSize = 20,<br /> PageCount = 1<br /> };<br /> var issues = await github.Issue.GetAllForRepository(owner, repo, request, apiOptions);<br /> if (issues is {Count: 0}) {<br /> await Bot.ReplyAsync(“Good job! No issues to triage.”);<br /> return;<br /> }<br /> var reply = issues.Select(FormatIssue).ToMarkdownList();<br /> await Bot.ReplyAsync(reply);<br /> }</p> <p>async Task ReplyWithIssueAsync(IArgument numArg, IArgument repository) {<br /> var (owner, repo) = await GetRepoOrDefault(repository);<br /> if (repo is null || owner is null) {<br /> await Bot.ReplyAsync(“Repository must set as default or supplied in the form `owner/name`. `@abbot help github` for more information.”);<br /> return;<br /> }</p> <p> var num = numArg.ToInt32();</p> <p> if (!num.HasValue) {<br /> await Bot.ReplyAsync(“Issue number must be a number”);<br /> return;<br /> }<br /> try {<br /> var issue = await github.Issue.Get(owner, repo, num.Value);<br /> await Bot.ReplyAsync($”{FormatIssue(issue)}\n{issue.Body}”);<br /> }<br /> catch (NotFoundException) {<br /> await Bot.ReplyAsync($”Could not retrieve issue {num} in {owner}/{repo}.”);<br /> }<br /> }</p> <p>async Task ReplyWithBillingInfoAsync(IArguments args) {<br /> var (forArg, ownerArg) = args;<br /> if (ownerArg is IMissingArgument) {<br /> ownerArg = forArg;<br /> }</p> <p> if (ownerArg is IMissingArgument) {<br /> await Bot.ReplyAsync(“Please specify an owner (user or org) to get billing info for. Ex: `@abbot github billing {owner}`.”);<br /> return;<br /> }</p> <p> var isOrg = await IsOrgAsync(ownerArg.Value);</p> <p> var billingBaseApiUrl = github.BaseAddress<br /> + (isOrg ? “orgs” : “users”)<br /> + $”/{ownerArg}/settings/billing/”;</p> <p> var apiRequests = new Task<dynamic>[] {<br /> GetBillingInfoAsync(billingBaseApiUrl, “actions”),<br /> GetBillingInfoAsync(billingBaseApiUrl, “packages”),<br /> GetBillingInfoAsync(billingBaseApiUrl, “shared-storage”)<br /> };</p> <p> var responses = await Task.WhenAll(apiRequests);<br /> var actions = responses[0];<br /> var packages = responses[1];<br /> var storage = responses[2];</p> <p> await Bot.ReplyAsync($@”Billing Info for `{ownerArg}`.<br /> GitHub Actions:<br /> “`<br /> Total Minutes Used: {actions.total_minutes_used}<br /> Paid Minutes Used : {actions.total_paid_minutes_used}<br /> Included Minutes : {actions.included_minutes}<br /> Minutes Used Breakdown: {actions.minutes_used_breakdown}<br /> “`</p> <p>GitHub Packages:<br /> “`<br /> Total Bandwidth Used (GB): {packages.total_gigabytes_bandwidth_used}<br /> Paid Bandwidth Used (GB) : {packages.total_paid_gigabytes_bandwidth_used}<br /> Included Bandwidth (GB) : {packages.included_gigabytes_bandwidth}<br /> “`</p> <p>GitHub Storage:<br /> “`<br /> Days Left in Billing Cycle : {storage.days_left_in_billing_cycle}<br /> Estimated Paid Storage for Month: {storage.estimated_paid_storage_for_month}<br /> Estimated Storage for Month : {storage.estimated_storage_for_month}<br /> “`<br /> “);<br /> }</p> <p>bool isOrg = true; // Only applies to the Billing API call</p> <p>async Task<dynamic> GetBillingInfoAsync(string baseApiUrl, string endpoint) {<br /> var headers = new Headers {<br /> {“Authorization”, $”token {githubToken}”},<br /> {“Accept”, “application/vnd.github.v3+json”}<br /> };<br /> var apiUrl = new Uri($”{baseApiUrl}{endpoint}”);<br /> try {<br /> return await Bot.Http.GetJsonAsync(apiUrl, headers);<br /> }<br /> catch(HttpRequestException) {<br /> isOrg = false;</p> <p> return new {<br /> total_minutes_used = “unknown”,<br /> total_paid_minutes_used = “unknown”,<br /> included_minutes = “unknown”,<br /> total_gigabytes_bandwidth_used = “unknown”,<br /> total_paid_gigabytes_bandwidth_used = “unknown”,<br /> included_gigabytes_bandwidth = “unknown”,<br /> days_left_in_billing_cycle = “unknown”,<br /> estimated_paid_storage_for_month = “unknown”,<br /> estimated_storage_for_month = “unknown”,<br /> minutes_used_breakdown = “unknown”<br /> };<br /> }<br /> }</p> <p>async Task<(string, string)> GetRepoOrDefault(IArgument arg) {<br /> var nameWithOwner = arg is IMissingArgument<br /> ? await GetDefaultRepoAsync()<br /> : arg.Value;<br /> return ParseNameWithOwner(nameWithOwner);<br /> }</p> <p>(string, string) ParseNameWithOwner(IArgument arg) {<br /> return ParseNameWithOwner(arg.Value);<br /> }</p> <p>(string, string) ParseNameWithOwner(string repository) {<br /> if (repository is null) {<br /> return (null, null);<br /> }<br /> var parts = repository.Split(‘/’);<br /> if (parts is {Length: 2}) {<br /> return (parts[0], parts[1]);<br /> }<br /> return (null, null);<br /> }</p> <p>async Task ReplyWithUsage() {<br /> var usage = $@”`{Bot} help {Bot.SkillName}` to get help using this skill.”;<br /> await Bot.ReplyAsync(usage);<br /> }</p> <p>string FormatIssue(Issue issue) {<br /> return $”[#{issue.Number} – {issue.Title} ({FormatAssignee(issue.Assignee)} – {issue.State})]({issue.HtmlUrl})”;<br /> }</p> <p>string FormatAssignee(User user) {<br /> return user is null<br /> ? “unassigned”<br /> : “assigned to {user.Name}”;<br /> }</p> <p>async Task<bool> IsOrgAsync(string org) {<br /> try {<br /> var organization = await github.Organization.Get(org);<br /> return organization is not null;<br /> }<br /> catch (NotFoundException) {<br /> return false;<br /> }<br /> }</p> <p>async Task GetOrSetDefaultRepoAsync(IArguments args) {<br /> var (isArg, repoArg) = args;</p> <p> if (repoArg is IMissingArgument) {<br /> // We support “@abbot default is aseriousbiz/abbot-skills” and “@abbot default aseriousbiz/abbot-skills”<br /> repoArg = isArg;<br /> }</p> <p> if (repoArg is IMissingArgument) {<br /> var currentDefault = await GetDefaultRepoAsync();<br /> if (currentDefault is null) {<br /> await Bot.ReplyAsync(“There is no default repository set for this channel yet. `@abbot github default owner/repo` to set a default repository.”);<br /> }<br /> else {<br /> await Bot.ReplyAsync($”The current default repository is `{currentDefault}`.”);<br /> }<br /> return;<br /> }<br /> var (owner, repo) = ParseNameWithOwner(repoArg);<br /> if (owner is null || repo is null) {<br /> await Bot.ReplyAsync(“To set a default repository, make sure the repository is provided in the `owner/repo` format.”);<br /> return;<br /> }</p> <p> try {<br /> var repository = await github.Repository.Get(owner, repo);<br /> }<br /> catch (NotFoundException) {<br /> await Bot.ReplyAsync($”{repoArg} doesn’t seem to be a repository or access is denied. Check your GitHub Token permissions.”);<br /> return;<br /> }<br /> await WriteDefaultRepoAsync(repoArg.Value);<br /> await Bot.ReplyAsync($”`{repoArg}` is now the default repository.”);<br /> }</p> <p>async Task<string> GetDefaultRepoAsync() {<br /> return await Bot.Brain.GetAsync(DefaultRepositoryBrainKey);<br /> }</p> <p>async Task WriteDefaultRepoAsync(string repo) {<br /> await Bot.Brain.WriteAsync(DefaultRepositoryBrainKey, repo);<br /> }</p> <p>async Task<string> GetAssigneeFromArgument(IArgument assigneeArg) {<br /> return assigneeArg switch {<br /> {Value: “me”} or {Value: “mi”} or {Value: “moi”} => await GetGitHubUserNameForMention(Bot.From),<br /> IMentionArgument mentioned => await GetGitHubUserNameForMention(mentioned.Mentioned),<br /> _ => await EnsureGitHubUsername(assigneeArg.Value)<br /> };<br /> }</p> <p>async Task<string> EnsureGitHubUsername(string username) {<br /> try {<br /> var user = await github.User.Get(username);<br /> return user.Name;<br /> }<br /> catch (NotFoundException) {<br /> return null;<br /> }<br /> }