Cog for code snippet links

[dolphingarlic]

I thought that it would be pretty cool if Discord could show the contents of a snippet link instead of just the link to the snippet, so I made a bot for that.

However, since adding third-party bots to the Python server was out of the question, I decided to add that functionality to the official server bot instead.

[ghost]

Thank you for contributing to Python Discord!

Please check out the following documents:

• Join the Discord server! - If you have not already, join the Discord server and introduce yourself in our #dev-contrib channel.
• Python Discord Contributor Wiki - A set of resources about setting up our services
• Python Discord Code of Conduct - Code of conduct for our community
• CONTRIBUTING.md - Guidelines on contributing to this repository

[ks129]

@dolphingarlic I don't think that this should good feature. Sending something every time when someone posts GitHub link is not a good idea. And all PRs have to have approved the linked issue, what this PR definitely don't have. Make issue first, then staff/core devs will discuss it and then decide will this come to bot or not.

[dolphingarlic]

Sorry, I didn't know that I should've created an issue first. (I don't think CONTRIBUTING.md mentioned that).

I think that printing out snippets would be quite useful since it means that people wouldn't have to open the links each time anymore. Sending embeds with details about repos basically just improves what Discord already does with repo links but with more details.

[aadibajpai]

@dolphingarlic I don't think that this should good feature. Sending something every time when someone posts GitHub link is not a good idea. And all PRs have to have approved the linked issue, what this PR definitely don't have. Make issue first, then staff/core devs will discuss it and then decide will this come to bot or not.

I think this was discussed in the #meta channel over at PyDis and there was some merit in the linked idea. Personally I think it is useful, especially when getting help in any of the help channels because you either copy paste your code standalone or link to it which would mean for the other person to switch back and forth.

[sco1]

Sorry, I didn't know that I should've created an issue first. (I don't think CONTRIBUTING.md mentioned that).

It's not mentioned because it's only a hard requirement for Seasonalbot. It's generally a good idea to make an issue first so you don't "waste" your time working on something that might not be merged, but since this seems to be something you've made for other reasons already it's a bit of a moo point.

I'm a bit meh on the repo link prettification, but the snippet formatting is deinitely interesting. We'll have to get some more opinions before we review formally, so please stand by. Is this something you've discussed in the server previously?

[dolphingarlic]

Yes - I've discussed it once in #meta a while ago

[dolphingarlic]

I can remove the repo link prettification if you'd like, but here's an example of when the snippet link feature is very useful:

Here, seeing just the single line linked in the snippet instead of having to open the link in a new tab is much more convenient. It would make debugging a lot faster.

[SebastiaanZ]

As Discord already embeds a link preview by default for GitHub-links, I'm not sure if I'm in favor of having the bot respond with a second embed containing some details about the repository. Apparently this is suppressed; looked over that.

If we were to have "repository information" feature, I think it would be better as an explicitly invoked command. I'm just not sure whether or not such a command fits the scope of our community utility bot. (I really mean: "not sure"; it's not a euphemism for "I don't think it fits".)

I do like the snippet feature, although I'm a bit concerned of "surprising" vertical space that's get inserted in a conversation. Maybe we could limit it to snippets that are only a few lines long? I wouldn't be surprised if people pasting a link to a snippet of code don't expect the bot to respond with a 15-line code snippet in the middle of a conversation. Alternatively, this could also have a command interface, which ensures that it's explicitly invoked.

[Numerlor]

If this were to be included, I'd prefer it to be a command or limited to maybe 3 lines without directly invoking it instead of looking up links in messages. Most github permalinks that I've seen get posted in discussion channels like python-language where this behavior wouldn't be as desired
While the repo information is nice I don't think the additional info like stars is particularly useful in most situations

[ks129]

One more thing: When we do this, this should get filtering too. Maybe someone wants to write a message that gets deleted by filters, but then add this GitHub and post a link. And however, this should have some text filter.

[dolphingarlic]

So since nobody seems to like the repo widget prettification feature, I removed that. To address the issue of people not wanting the bot to interrupt their conversations, I added the option for the author of the message to react with an ❌ emoji to delete the bot's message.

[MarkKoz]

Running the code reveals errors:

https://gitlab.com/gitlab-org/gitlab/-/blob/master/scripts/create_postgres_user.sh#L3-5 leads to

2021-01-30 12:12:37 | bot.exts.info.code_snippets | ERROR | Failed to fetch code snippet from https://api.github.com/repos/gitlab-org/gitlab/branches. HTTP Status: 404. Message: 404, message='Not Found', url=URL('https://api.github.com/repos/gitlab-org/gitlab/branches').
2021-01-30 12:12:37 | bot.exts.info.code_snippets | ERROR | Failed to fetch code snippet from https://api.github.com/repos/gitlab-org/gitlab/tags. HTTP Status: 404. Message: 404, message='Not Found', url=URL('https://api.github.com/repos/gitlab-org/gitlab/tags').
2021-01-30 12:12:37 | bot | ERROR | Unhandled exception in on_message.
Traceback (most recent call last):
  File "/home/mark/repos/python/bot-pydis/.venv/lib/python3.8/site-packages/discord/client.py", line 343, in _run_event
    await coro(*args, **kwargs)
  File "/home/mark/repos/python/bot-pydis/bot/exts/info/code_snippets.py", line 228, in on_message
    message_to_send += await handler(**match.groupdict())
  File "/home/mark/repos/python/bot-pydis/bot/exts/info/code_snippets.py", line 132, in _fetch_gitlab_snippet
    refs = branches + tags
TypeError: unsupported operand type(s) for +: 'NoneType' and 'NoneType'

Looks like it's trying to use the GitHub API to fetch a GitLab file. Perhaps you need some None checks too.

---

Any input (except for when the above happens) will lead to

2021-01-30 12:12:32 | bot | ERROR | Unhandled exception in on_message.
Traceback (most recent call last):
  File "/home/mark/repos/python/bot-pydis/.venv/lib/python3.8/site-packages/discord/client.py", line 343, in _run_event
    await coro(*args, **kwargs)
  File "/home/mark/repos/python/bot-pydis/bot/exts/info/code_snippets.py", line 232, in on_message
    await wait_for_deletion(
TypeError: wait_for_deletion() got an unexpected keyword argument 'client'

---

It'd be nicer to truncate code rather than showing nothing if it's too long. Right now it isn't immediately obvious why some links don't get code blocks from the bot. However, this isn't a requirement from me and I'd approve the PR regardless.

[dolphingarlic]

Truncating might be a bit tricky when there are multiple snippet links in a single message. Do you think I should do something like truncate all code blocks by ceil((len(message) - 2000) / (number of code blocks)) chars if needed? Also, what about the number of lines allowed per message?

[MarkKoz]

I imagine that trying to evenly distribute truncation would result in all code blocks being too heavily truncated to still be meaningful. A simpler strategy of truncating the first blocks and omitting the rest sounds fine.

Line limit should still apply to the final line count and will truncate at line boundaries. The limit could be raised to 20. Make sure you don't include "bare" file paths that lack code blocks because they got truncated. In other words, if there isn't enough space for the entire file path and at least some of the code block, then omit the file path too.

I think what I'm describing is pretty similar to the extant truncation logic for the snekbox eval command. It's worth investigating how much of that code can be shared between the two features.

[Xithrius]

@dolphingarlic Greetings. Will you be finishing up this PR?

[dolphingarlic]

I'm still waiting for my code to be reviewed again. Sorry about the delay

[Xithrius]

Thanks for the quick reply! I'll poke some people for reviews.

[vcokltfre]

Looking good! Apologies I wasn't able to review this earlier I just got the notification that xith requested my review