Skip to content

Commit 4517729

Browse files
committed
Ensure every path to close a help channel cancels scheduled closes
1 parent a6a104c commit 4517729

File tree

2 files changed

+22
-12
lines changed

2 files changed

+22
-12
lines changed

bot/exts/help_channels/_channel.py

+18-8
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,11 @@ def is_help_forum_post(channel: discord.abc.GuildChannel) -> bool:
4141
return getattr(channel, "parent_id", None) == constants.Channels.python_help
4242

4343

44-
async def _close_help_post(closed_post: discord.Thread, closing_reason: _stats.ClosingReason) -> None:
44+
async def _close_help_post(
45+
closed_post: discord.Thread,
46+
closing_reason: _stats.ClosingReason,
47+
scheduler: scheduling.Scheduler,
48+
) -> None:
4549
"""Close the help post and record stats."""
4650
# Get Thread with updated metadata (such as the title)
4751
closed_post = await get_or_fetch_channel(bot.instance, closed_post.id)
@@ -82,6 +86,8 @@ async def _close_help_post(closed_post: discord.Thread, closing_reason: _stats.C
8286
locked=True,
8387
reason="Locked a closed help post",
8488
)
89+
if closed_post.id in scheduler:
90+
scheduler.cancel(closed_post.id)
8591

8692
_stats.report_post_count()
8793
await _stats.report_complete_session(closed_post, closing_reason)
@@ -98,14 +104,18 @@ async def send_opened_post_message(post: discord.Thread) -> None:
98104
await post.send(embed=embed, content=post.owner.mention)
99105

100106

101-
async def help_post_opened(opened_post: discord.Thread, *, reopen: bool = False) -> None:
107+
async def help_post_opened(
108+
opened_post: discord.Thread,
109+
*,
110+
scheduler: scheduling.Scheduler,
111+
) -> None:
102112
"""Apply new post logic to a new help forum post."""
103113
_stats.report_post_count()
104114
bot.instance.stats.incr("help.claimed")
105115

106116
if not isinstance(opened_post.owner, discord.Member):
107117
log.debug(f"{opened_post.owner_id} isn't a member. Closing post.")
108-
await _close_help_post(opened_post, _stats.ClosingReason.CLEANUP)
118+
await _close_help_post(opened_post, _stats.ClosingReason.CLEANUP, scheduler)
109119
return
110120

111121
try:
@@ -124,12 +134,12 @@ async def help_post_opened(opened_post: discord.Thread, *, reopen: bool = False)
124134
await send_opened_post_message(opened_post)
125135

126136

127-
async def help_post_closed(closed_post: discord.Thread) -> None:
137+
async def help_post_closed(closed_post: discord.Thread, scheduler: scheduling.Scheduler) -> None:
128138
"""Apply archive logic to a manually closed help forum post."""
129-
await _close_help_post(closed_post, _stats.ClosingReason.COMMAND)
139+
await _close_help_post(closed_post, _stats.ClosingReason.COMMAND, scheduler)
130140

131141

132-
async def help_post_archived(archived_post: discord.Thread) -> None:
142+
async def help_post_archived(archived_post: discord.Thread, scheduler: scheduling.Scheduler) -> None:
133143
"""Apply archive logic to an archived help forum post."""
134144
async for thread_update in archived_post.guild.audit_logs(limit=50, action=discord.AuditLogAction.thread_update):
135145
if thread_update.target.id != archived_post.id:
@@ -140,7 +150,7 @@ async def help_post_archived(archived_post: discord.Thread) -> None:
140150
if thread_update.user.id == bot.instance.user.id:
141151
return
142152

143-
await _close_help_post(archived_post, _stats.ClosingReason.NATIVE)
153+
await _close_help_post(archived_post, _stats.ClosingReason.NATIVE, scheduler)
144154

145155

146156
async def help_post_deleted(deleted_post_event: discord.RawThreadDeleteEvent) -> None:
@@ -204,7 +214,7 @@ async def maybe_archive_idle_post(post: discord.Thread, scheduler: scheduling.Sc
204214
log.info(
205215
f"#{post} ({post.id}) is idle past {closing_time} and will be archived. Reason: {closing_reason.value}"
206216
)
207-
await _close_help_post(post, closing_reason)
217+
await _close_help_post(post, closing_reason, scheduler)
208218
return
209219

210220
if post.id in scheduler:

bot/exts/help_channels/_cog.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,7 @@ async def close_command(self, ctx: commands.Context) -> None:
8181
# Don't use a discord.py check because the check needs to fail silently.
8282
if await self.close_check(ctx):
8383
log.info(f"Close command invoked by {ctx.author} in #{ctx.channel}.")
84-
await _channel.help_post_closed(ctx.channel)
85-
if ctx.channel.id in self.scheduler:
86-
self.scheduler.cancel(ctx.channel.id)
84+
await _channel.help_post_closed(ctx.channel, self.scheduler)
8785

8886
@help_forum_group.command(name="title", root_aliases=("title",))
8987
async def rename_help_post(self, ctx: commands.Context, *, title: str) -> None:
@@ -112,7 +110,7 @@ async def new_post_listener(self, message: discord.Message) -> None:
112110
if thread.parent_id != self.help_forum_channel.id:
113111
return
114112

115-
await _channel.help_post_opened(thread)
113+
await _channel.help_post_opened(thread, scheduler=self.scheduler)
116114

117115
delay = min(constants.HelpChannels.deleted_idle_minutes, constants.HelpChannels.idle_minutes) * 60
118116
self.scheduler.schedule_later(
@@ -128,6 +126,8 @@ async def on_thread_update(self, before: discord.Thread, after: discord.Thread)
128126
return
129127
if not before.archived and after.archived:
130128
await _channel.help_post_archived(after)
129+
if after.id in self.scheduler:
130+
self.scheduler.cancel(after.id)
131131

132132
@commands.Cog.listener()
133133
async def on_raw_thread_delete(self, deleted_thread_event: discord.RawThreadDeleteEvent) -> None:

0 commit comments

Comments
 (0)