Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Archive helper: Add a helper for archiving old threads in a channel (#…
…285) The command `\help me archive <channel>` goes through all unarchived threads >14 days old and tags me to investigate if they're archivable. This is going to be a manual process because life is hard 😉 Also included here is a full rework of the thread management script into multiple subscripts that are more focused.
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,110 +1,65 @@ | ||
| import fs from "fs" | ||
| import { Client } from "discord.js" | ||
| import path from "path" | ||
| import { Robot } from "hubot" | ||
| import { fileURLToPath } from "url" | ||
| import { DiscordEventHandlers } from "../lib/discord/utils.ts" | ||
|
|
||
| export default function manageThreads(discordClient: Client, robot: Robot) { | ||
| fs.readdirSync( | ||
| path.join( | ||
| path.dirname(fileURLToPath(import.meta.url)), | ||
| "./thread-management", | ||
| ), | ||
| ) | ||
| .sort() | ||
| .filter( | ||
| (file) => | ||
| [".ts", ".js"].includes(path.extname(file)) && !file.startsWith("_"), | ||
| ) | ||
| .forEach(async (file) => { | ||
| try { | ||
| const threadManagementScript: { default: DiscordEventHandlers } = | ||
| await import( | ||
| path.join("..", "discord-scripts", "thread-management", file) | ||
| ) | ||
|
|
||
| Object.entries(threadManagementScript.default).forEach( | ||
| ([event, handler]) => { | ||
| discordClient.on(event, (...args) => { | ||
| const finalArgs = [...args, robot] | ||
| // @ts-expect-error We are doing some shenanigans here that TS can't | ||
| // handle to always pass a robot as the last parameter to the | ||
| // handler. | ||
| return handler(...finalArgs) | ||
| }) | ||
| }, | ||
| ) | ||
|
|
||
| if ("setup" in threadManagementScript) { | ||
| ;( | ||
| threadManagementScript.setup as ( | ||
| robot: Robot, | ||
| client: Client, | ||
| ) => Promise<void> | ||
| ).call(undefined, robot, discordClient) | ||
| } | ||
|
|
||
| robot.logger.info(`Loaded Discord thread management script ${file}.`) | ||
| } catch (error) { | ||
| const stackString = | ||
| // Errors may have a stack trace, or not---anyone's guess! | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| "stack" in (error as any) ? `\n${(error as any).stack}` : "" | ||
|
|
||
| const errorJson = JSON.stringify(error, null, 2) | ||
|
|
||
| const errorDescription = | ||
| errorJson.trim().length > 0 ? errorJson : String(error) | ||
|
|
||
| robot.logger.error( | ||
| `Failed to load Discord script ${file}: ${errorDescription}${stackString}`, | ||
| ) | ||
| } | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| import { AnyThreadChannel } from "discord.js" | ||
| import { | ||
| DiscordEventHandlers, | ||
| isInRecreationalCategory, | ||
| } from "../../lib/discord/utils.ts" | ||
|
|
||
| // When a thread is created, join it. | ||
| // | ||
| // Additionally, quietly tag a role so that all members of it are subscribed | ||
| // to the thread (they may later leave the thread to opt out). The role that | ||
| // is tagged is, in order: | ||
| // | ||
| // - If the containing channel's category is recreational, no role. | ||
| // - If the containnig channel has a role with a matching name, that role | ||
| // (e.g., a message to #tech will tag a Tech role if it exists). | ||
| // - If the containing channel's category has a role with a matching name, that role | ||
| // (e.g., a message to #taho-standup inside the Taho category will tag the | ||
| // Taho role if it exists). | ||
| // - If the containing channel's category is General and the channel is | ||
| // #main, @everyone. | ||
| // | ||
| // Quiet tags are achieved by dropping a placeholder message and then editing | ||
| // it to mention the right role. Discord's behavior in this scenario is not to | ||
| // ping the role, but to add all its members to the thread. | ||
| async function autoJoinThread( | ||
| thread: AnyThreadChannel<boolean>, | ||
| ): Promise<void> { | ||
| await thread.join() | ||
|
|
||
| if (isInRecreationalCategory(thread)) { | ||
| return | ||
| } | ||
|
|
||
| const { guild: server, parent: containingChannel } = thread | ||
|
|
||
| const placeholder = await thread.send("<placeholder>") | ||
|
|
||
| const matchingRole = server.roles.cache.find( | ||
| (role) => role.name.toLowerCase() === containingChannel?.name.toLowerCase(), | ||
| ) | ||
|
|
||
| if (matchingRole !== undefined) { | ||
| await placeholder.edit(matchingRole.toString()) | ||
| return | ||
| } | ||
|
|
||
| const categoryChannel = containingChannel?.parent | ||
| const categoryMatchingRole = server.roles.cache.find( | ||
| (role) => role.name.toLowerCase() === categoryChannel?.name.toLowerCase(), | ||
| ) | ||
|
|
||
| if (categoryMatchingRole !== undefined) { | ||
| await placeholder.edit(categoryMatchingRole.toString()) | ||
| return | ||
| } | ||
|
|
||
| if ( | ||
| categoryChannel?.name?.toLowerCase()?.endsWith("general") === true && | ||
| containingChannel?.name?.toLowerCase()?.endsWith("main") === true | ||
| ) { | ||
| await placeholder.edit(server.roles.everyone.toString()) | ||
| } | ||
|
|
||
| if ( | ||
| categoryChannel?.name?.toLowerCase()?.endsWith("general") === true && | ||
| containingChannel?.name?.toLowerCase()?.endsWith("bifrost") === true | ||
| ) { | ||
| // The everyone role does not work the way other roles work; in particular, | ||
| // it does _not_ add everyone to the thread. Instead, it just sits there, | ||
| // looking pretty. | ||
| await placeholder.edit(server.roles.everyone.toString()) | ||
| } | ||
|
|
||
| // If we hit this spot, be a monster and delete the useless placeholder and | ||
| // pray for our soul. Placeholder code as we figure out the best way to | ||
| // handle the General category. | ||
| await placeholder.delete() | ||
| } | ||
|
|
||
| const eventHandlers: DiscordEventHandlers = { | ||
| threadCreate: autoJoinThread, | ||
| } | ||
|
|
||
| export default eventHandlers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import { AnyThreadChannel, channelMention } from "discord.js" | ||
| import { isPrivate } from "../../lib/discord/utils.ts" | ||
|
|
||
| const PRIVATE_THREAD_CHANNEL = { id: "1079520580228894771", name: "operations" } | ||
|
|
||
| async function privateThreadAdmonishment( | ||
| thread: AnyThreadChannel<boolean>, | ||
| ): Promise<void> { | ||
| const { parent: containingChannel } = thread | ||
|
|
||
| if ( | ||
| isPrivate(thread) && | ||
| containingChannel?.id?.toLowerCase() !== PRIVATE_THREAD_CHANNEL.id | ||
| ) { | ||
| await thread.send( | ||
| "Private threads should largely only be used for discussions around " + | ||
| "confidential topics like legal and hiring. They should as a result " + | ||
| `almost always be created in ${channelMention( | ||
| PRIVATE_THREAD_CHANNEL.id, | ||
| )}; if you know you're ` + | ||
| "breaking both rules on purpose, go forth and conquer, but otherwise " + | ||
| "please start the thread there. I'm also going to auto-tag the " + | ||
| "appropriate roles now, which may compromise the privacy of the " + | ||
| "thread (**all members of the role who have access to this channel " + | ||
| "will have access to the thread**).", | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| const eventHandlers = { | ||
| threadCreate: privateThreadAdmonishment, | ||
| } | ||
|
|
||
| export default eventHandlers |
Oops, something went wrong.