aboutsummaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeLines
* Merge branch 'master' into bug/backend/894/win-selector-loopGravatar Daniel Brown2020-05-07-136/+405
|\
| * Merge pull request #919 from ↵Gravatar Sebastiaan Zeeff2020-05-05-0/+12
| |\ | | | | | | | | | | | | python-discord/bug/backend/911/log-listener-exceptions Log unhandled errors from event listeners
| | * Merge branch 'master' into bug/backend/911/log-listener-exceptionsGravatar Sebastiaan Zeeff2020-05-05-3/+16
| | |\ | | |/ | |/|
| * | Merge pull request #925 from Savant-Dev/antimalwareGravatar Daniel Brown2020-05-05-0/+12
| |\ \ | | | | | | | | Update to Antimalware Filter (.txt uploads)
| | * \ Merge branch 'master' into antimalwareGravatar Daniel Brown2020-05-05-2/+2
| | |\ \ | | |/ / | |/| |
| * | | Merge pull request #922 from python-discord/bug/info/914/user-animated-avatarGravatar kwzrd2020-05-01-2/+2
| |\ \ \ | | | | | | | | | | Display animated avatars in the user info command
| | * | | Tests: change avatar_url_as assertion to use static_formatGravatar MarkKoz2020-04-30-1/+1
| | | | |
| | * | | Display animated avatars in the user info commandGravatar MarkKoz2020-04-30-1/+1
| |/ / / | | | | | | | | | | | | Fixes #914
| | * | Update antimalware to filter txt files in cases where messages were longer ↵Gravatar Savant-Dev2020-05-04-5/+5
| | | | | | | | | | | | | | | | than 2000 chars
| | * | Update extension filter to distinguish .txt in cases where messages are ↵Gravatar Savant-Dev2020-05-01-1/+1
| | | | | | | | | | | | | | | | longer than 2000 characters
| | * | Update extension filter to distinguish .txt in cases where messages are ↵Gravatar Savant-Dev2020-05-01-0/+12
| |/ / | | | | | | | | | longer than 2000 characters
| * | Run a category check before logging that we are checking for an answered ↵Gravatar Joseph Banks2020-04-30-1/+2
| | | | | | | | | | | | help channel
| | * Log unhandled errors from event listenersGravatar MarkKoz2020-04-29-0/+12
| |/ | | | | | | | | | | | | | | | | | | | | By default, discord.py prints them to stderr. To better help detect such errors in production, they should instead be logged with an appropriate log level. Some sentry metadata has also been included. `on_error` doesn't work as a listener in a cog so it's been put in the Bot subclass. Fixes #911
| * Merge pull request #913 from python-discord/add-bottom-sorting-to-help-channelsGravatar Sebastiaan Zeeff2020-04-28-12/+63
| |\ | | | | | | Sort help channels and add support for `how-to-get-help` channel
| | * Log ID of member who claimed a help channelGravatar Sebastiaan Zeeff2020-04-28-0/+1
| | |
| | * Add option to ingore channels in help categoriesGravatar Sebastiaan Zeeff2020-04-28-3/+14
| | | | | | | | | | | | | | | | | | As we want to add an "informational" channel to the `Python Help: Available` category, we need to make sure that the Help Channel System ignores that channel. To do that, I've added an `is_excluded_channel` staticmethod that returns `True` if a channel is not a TextChannel or if it's in a special EXCLUDED_CHANNELS constant. This method is then used in the method that yields help channels from a category and in the `on_message` event listener that determines if a channel should be moved from `Available` to `Occupied`.
| | * Insert help channels at the bottom of the categoryGravatar Sebastiaan Zeeff2020-04-28-9/+48
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit reintroduces bottom sorting for help channels during a category move, but in a more reliable way that also causes far fewer "channel list glitches". This is accomplished by using the "bulk channels update" endpoint of the Discord API. ----------- The Problem ----------- Discord's positioning system is not that easy to work with for developers: Instead of having separate pools of position integers for each category, all text channels are considered to be part of the same "position pool" (or "bucket" in discord.py terms). This also means that changing the position integer of one channel may cause the position integer of another to change, regardless of if the channels share a category or even of if they are close to each other in the guild. As clients receive the position update for each channel as separate CHANNEL UPDATE events, this means that moving one channel may cause other channels to (temporarily) jump around as the client receives the EVENTS from the API. As some position changes affect all the channels in the guild, this will also trigger a nice "channel wave" rolling down the channel list from time to time. For our use case, this was exacerbated by the way `discord.py` handles position changes: It will enumerate the entire, sorted channel list whenever a position change occurs and send a "bulk request" with updated position integers for the entire guild to Discord. This was the reason that all of the sorting methods we've tried resulted in a lot of those "wave" glitches as clients would get a lot of CHANNEL UPDATE events. In addition, the way `discord.py` inserted channels into the payload also meant that our "high integer" methods did not work reliably. ------------ The Solution ------------ Fortunately, there is a solution that will work well most of the time: Making a `bulk channels update` request with only channels of the category we're currently interested in. By providing the current position of the channels that are already in the category, combined with the correct position of the channel moving into the category, we effectively "lock in" the existing channels at the location they already have. The new channel is simply moved into the right position in relation to the existing channels. This means that effectively, we only communicate one channel position change to Discord, making sure that as few channels as possible actually change their formal "position int". From there on, there are two options: 1. Keep the existing channels in place, add the new channel at the bottom (new highest int) 2. Keep the existing channels in place, add the new channel at the top (new lowest int) Both methods work, but option two has a flaw: The position int will get smaller and smaller, until it reaches `0`. Since negative position integers are not allowed, the entire category now has to be shifted upwards to make room for new top channels. This comes at the cost of a "wave" glitch within the category. My initial instinct was to solve this by giving the channels in the category a "really high" straight of position ints, but as Discord recalculates the ints from time to time anyway, this does not work. That's why I opted for the `bottom sort` option, which does not suffer from that issue. I've also asked the question of `top` vs `bottom` in #admins, without the context above, and the preferred method seemed to be `bottom` in any case. ----------- Limitations ----------- While Discord doesn't care that much about duplicates or neatly ascending integers, some channel move actions will inevitably result in a recalculation of the positions ints. This means that "wave" glitches may still happen from time to time, but they should be infrequent. (They also happen if you drag channels in your client; it seems to be a fundamental part of how positioning works.) I think this is something we'll have to live with. Another thing that I suspect may happen is that during times of API lag in the middle of help channel rush hour, some CHANNEL UPDATE events belonging to previous channel moves will not be received/processed yet by the time we make the next move. As we rely on cached position integers, this could mean that from time to time a channel is inserted near the bottom but not at the bottom. As Discord sends these CHANNEL UPDATE replies as individual events in an asynchronous manner instead of as a single response to our `bulk channels update` request, there's nothing much we can do about this. However, I have yet to observe this, so maybe it will never happen.
| * Merge pull request #895 from python-discord/broadening-eval-whitelistGravatar Mark2020-04-27-52/+249
| |\ | | | | | | Allowing `!eval` in help channels
| | * Merge branch 'master' into broadening-eval-whitelistGravatar Sebastiaan Zeeff2020-04-27-69/+60
| | |\ | | |/ | |/|
| * | Merge pull request #885 from python-discord/feat/frontend/839/help-channel-roleGravatar Sebastiaan Zeeff2020-04-27-69/+60
| |\ \ | | | | | | | | Use a role overwrite to keep track of help channel cooldowns
| | * \ Merge branch 'master' into feat/frontend/839/help-channel-roleGravatar Sebastiaan Zeeff2020-04-27-7/+50
| | |\ \ | | |/ / | |/| |
| | * | HelpChannels: rename dormant command to closeGravatar MarkKoz2020-04-20-4/+4
| | | | | | | | | | | | | | | | | | | | People are more familiar with the "close" alias than its actual name, "dormant". "close" also feels more natural.
| | * | HelpChannels: check if the help cooldown role existsGravatar MarkKoz2020-04-20-10/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | A NotFound error can be misleading since it may apply to the member or the role. The log message was not simply updated because each of the scenarios need to have different log levels: missing members is a normal thing but an invalid role is not.
| | * | HelpChannels: pass coroutine func instead to `_change_cooldown_role`Gravatar MarkKoz2020-04-20-6/+8
| | | | | | | | | | | | | | | | | | | | This will allow `_change_cooldown_role` to handle the role argument rather than putting that burden on the callers.
| | * | HelpChannels: tidy up log messagesGravatar MarkKoz2020-04-20-5/+1
| | | | | | | | | | | | | | | | | | | | | | | | * Remove obsolete log message * Shorten a log message which was the only line in the entire module over 100 characters
| | * | HelpChannels: handle errors when changing cooldown roleGravatar MarkKoz2020-04-17-12/+35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A user may leave the guild before their role can be changed. Sometimes, there could also be role hierarchy issues or other network issues. It's not productive to halt everything and just dump these as exceptions to the loggers. The error handler provides a more graceful approach to these exceptions. * Add a wrapper function around `add_roles` & `remove_roles` which catches exceptions
| | * | HelpChannels: fix role not resetting after dormant commandGravatar MarkKoz2020-04-17-13/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Resetting permissions relied on getting the member from the cache, but the member was already removed from the cache prior to resetting the role. Now the member is passed directly rather than relying on the cache.
| | * | HelpChannels: mention dormant cmd in available message embedGravatar MarkKoz2020-04-17-2/+3
| | | | | | | | | | | | | | | | Users should know they can close their own channels.
| | * | HelpChannels: add info about cooldown role & dormant cmd to docstringGravatar MarkKoz2020-04-17-0/+3
| | | |
| | * | HelpChannels: add/remove a cooldown role rather than using overwritesGravatar MarkKoz2020-04-17-13/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Overwrites had issues syncing with channels in the category. * Remove update_category_permissions; obsolete * Add constant for the cooldown role wrapped in a discord.Object
| | * | HelpChannels: clear roles when resetting permissionsGravatar MarkKoz2020-04-17-9/+7
| | | | | | | | | | | | | | | | | | | | Claimants will have a special role that needs to be removed rather than using member overwrites for the category.
| | * | HelpChannels: add helper function to check for claimant roleGravatar MarkKoz2020-04-17-0/+5
| | | |
| | * | HelpChannels: remove ensure_permissions_synchronizationGravatar MarkKoz2020-04-17-29/+1
| | | |
| | * | Constants: add help channel cooldown roleGravatar MarkKoz2020-04-17-0/+2
| | | |
| | | * Add DMChannel tests for in_whitelist decoratorGravatar Sebastiaan Zeeff2020-04-27-31/+63
| | | | | | | | | | | | | | | | | | | | | | | | The `in_whitelist` decorator should not fail when a decorated command was called in a DMChannel; it should simply conclude that the user is not allowed to use the command. I've added a test case that uses a DMChannel context with User, not Member, objects. In addition, I've opted to display a test case description in the `subTest`: Simply printing the actual arguments and context is messy and does not actually show you the information you'd like. This description is enough to figure out which test is failing and what the gist of the test is.
| | | * Add mock for discord.DMChannelsGravatar Sebastiaan Zeeff2020-04-27-0/+21
| | | |
| | | * Exclude never-run lines from coverageGravatar Sebastiaan Zeeff2020-04-27-2/+2
| | | |
| | | * Simplify `in_whitelisted_context` decorator APIGravatar Sebastiaan Zeeff2020-04-23-92/+72
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The API of the `in_whitelisted_context` decorator was a bit clunky: - The long parameter names frequently required multiline decorators - Despite `#bot-commands` being the defacto default, it needed to be passed - The name of the function, `in_whitelisted_context` is fairly long in itself To shorten the call length of the decorator, the parameter names were shortened by dropping the `whitelisted_` prefix. This means that the parameter names are now just `channels`, `categories`, and `roles`. This already means that all current usages of the decorator are reduced to one line. In addition, `#bot-commands` has now been made the default redirect channel for the decorator. This means that if no `redirect` was passed, users will be redirected to `bot-commands` to use the command. If needed, `None` (or any falsey value) can be passed to disable redirection. Passing another channel id will trigger that channel to be used as the redirection target instead of bot-commands. Finally, the name of the decorator was shortened to `in_whitelist`, which already communicates what it is supposed to do.
| | | * Allow `!eval` in help channel categoriesGravatar Sebastiaan Zeeff2020-04-23-1/+3
| | | | | | | | | | | | | | | | As help conversations now take place in their own, dedicated channels, there's no longer a pressing need to restrict the `!eval` command in help channels for regular members. As the command can be a valuable tool in explaining and teaching Python, we've therefore chosen to allow it in channels in `Help: Available` and `Help: Occupied` catagories.
| | | * Add tests for `in_whitelisted_context` decoratorGravatar Sebastiaan Zeeff2020-04-23-0/+115
| | | | | | | | | | | | | | | | I have added tests for the new `in_whitelisted_context` decorator. They work by calling the decorator with different kwargs to generate a specific predicate callable. That callable is then called to assess if it comes to the right conclusion.
| | | * Remove vestigial kwargs from MockTextChannel.__init__Gravatar Sebastiaan Zeeff2020-04-23-1/+1
| | | |
| | | * Replace `in_channel` decorator by `in_whitelisted_context`Gravatar Sebastiaan Zeeff2020-04-23-47/+94
| | |/ | |/| | | | | | | | | | | | | | | | | | | The `in_channel` decorator that served as a factory for `in_channel` checks was replaced by the broaded `in_whitelisted_context` decorator. This means that we can now whitelist commands using channel IDs, category IDs, and/or role IDs. The whitelists will be applied in an "OR" fashion, meaning that as soon as some part of the context happens to be whitelisted, the `predicate` check the decorator produces will return `True`. To reflect that this is now a broader decorator that checks for a whitelisted *context* (as opposed to just whitelisted channels), the exception the predicate raises has been changed to `InWhitelistedContextCheckFailure` to reflect the broader scope of the decorator. I've updated all the commands that used the previous version, `in_channel`, to use the replacement.
| * | Merge pull request #904 from Akarys42/free-tagGravatar Shirayuki Nekomata2020-04-23-0/+5
| |\ \ | | | | | | | | Free tag
| | * \ Merge branch 'master' into free-tagGravatar Shirayuki Nekomata2020-04-23-12/+57
| | |\ \ | | |/ / | |/| |
| | * | Free tag: fix typo in headerGravatar kwzrd2020-04-23-1/+1
| | | |
| | * | Simplify free tagGravatar Matteo Bertucci2020-04-23-3/+2
| | | |
| | * | Use IDs instead of hard-coding category names in the free tagGravatar Matteo Bertucci2020-04-16-2/+1
| | | | | | | | | | | | Co-Authored-By: Shirayuki Nekomata <[email protected]>
| | * | Add a title at the top of the free tagGravatar Matteo Bertucci2020-04-16-0/+2
| | | | | | | | | | | | Co-Authored-By: Shirayuki Nekomata <[email protected]>
| | * | Create temporary free tagGravatar Matteo Bertucci2020-04-16-0/+5
| | | |
* | | | Fix awaiting non-coroutine when closing the statsd transportGravatar MarkKoz2020-04-24-1/+1
| | | | | | | | | | | | | | | | | | | | `BaseTransport.close()` is not a coroutine and therefore should not be awaited.