Handle off-topic channel names that are invalid for servers in Server Discovery

[TizzySaurus]

Related Issues

Closes #2282
Closes #2500

What

This PR adds re-roll logic for when attempting to rename an off-topic channel to a name that's not allowed for servers in Server Discovery (such as ot0-welcome-and-fuck-you).

It will attempt to reroll a maximum of MAX_RENAME_ATTEMPTS per off-topic channel, and will send a message detailing any failed renames for a given off-topic channel to the internal mod-meta channel.

The code also deactivates names that are invalid, triggering a log.info, and adds logic for handling when the name pool isn't big enough (which triggers a log.warn).

Testing

As for testing, I found that the following works:

class Temp:
    def __init__(self, status, reason):
        self.status = status
        self.reason = reason

if (not channel_indx) or attempt < channel_indx:  # change as appropriate
    raise HTTPException(Temp("status", "reason"), {"code": 50035})
await channel.edit(name=name_after)

...and produces the following example message in the mod-meta channel:

To forcefully run the coroutine you can use the int eval command, with the following code:

# Reload Cog
await bot.reload_extension("bot.exts.fun.off_topic_names")

# Activate any deactivated off-topic names
names = await self.bot.api_client.get("bot/off-topic-channel-names", params={"active": "false"})
for name in names:
    await self.bot.api_client.patch(f"bot/off-topic-channel-names/{name}", data={"active": True})
    print(f"Activated otn name {name}")

# Call `update_names()` coroutine
cog = bot.get_cog("OffTopicNames")
await cog.update_names()

[RohanJnr]

Tested and works fine. Gj

[RohanJnr]

Also, the reroll command does not work if the channel name is not found in the database. This can be a super rare edge case but we can handle it. Under the re_roll_command function, you can catch the Exception on the await self.de_activate_ot_name(ctx, old_ot_name) and log it. After that the function will continue to rename the channel.

[TizzySaurus]

Also, the reroll command does not work if the channel name is not found in the database. This can be a super rare edge case but we can handle it. Under the re_roll_command function, you can catch the Exception on the await self.de_activate_ot_name(ctx, old_ot_name) and log it. After that the function will continue to rename the channel.

That seems unrelated to this work, so should probably go in a separate PR?

[RohanJnr]

separate

Ye sure, I'll open an issue for that later

[shtlrs]

IS this even possible ? We have a ton of channel names and we only rename 3.

[TizzySaurus]

It is strictly possible, however unlikely, so figured it should be accounted for - especially since the handling is relatively simple.

[TizzySaurus]

The handle for this has changed with the rewrite, but is still there here. Also figured it made more sense to send a message to mod_meta than a log.warn, so updated to reflect that.

[vivekashok1221]

I agree with keeping the handle since it could save some of my brain cells when, say, I'm running my own instance of the bot in a test server.

[shtlrs]

I don't think that all these comments are necessary, comments should exist to document things that don't jump straight to the eye.

[shtlrs]

That's what I'm saying, that the code can be understood by simply reading it, as the logic is kinda straightforward.

I personally don't think it's complex, we'll see what others have to say about it.

[TizzySaurus]

Yeah, in hindsight I agree -- these comments were removed as part of the rewrite.

[shtlrs]

I think the approach can be enhanced a bit.
We can fetch 3 names (number of attempts) for each channel.
We iterate over each channel, and try to rename it three times, then exit, that way we can increase the chance of a successful rename OP.

number_of_names_to_fetch = MAX_ATTEMPS * len(CHANNELS)
channels = [get_or_fetch_channel(channel) for channel in CHANNELS]
names = iter(api_client.fetch_names(params={"random_items": number_of_names_to_fetch}))

renamed = set()
failed = set()

for channel in channels:
    attempt = 0
    while attempt < MAX_ATTEMPS:
        attempt += 1
        try:
            old_name = channel.name
            name = next(names)
            channel.update(name=name)
            renamed.add(channel.id)
            break
        except:
            # Catch your code here & deactivate the name
            # Reraise if not the right exception
            failed.add(f"- {name}\n") # Leverage the new markdown support to dsplay as a bullet list
            ...

# Simplify the handling of the failed renames.

if failed:
    unchanged = [channel.name for channel in channels if channel.id not in renamed]
    message = f"Couldn't rename the following off-topic channels: {', '.join(unchanged)}" \
              f"The following off-topic names were deactivated:\n{failed}", 

[TizzySaurus]

Rewritten in 2f738ad (have made changes since, so see the "Files Changed" for modern version of the logic).

Currently untested, but lmk what you think :)

[Xithrius]

Closing in favor of recreating within a new PR.