aboutsummaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeLines
...
| * | | | | Allow infraction management in modmail categoryGravatar Leon Sandøy2020-05-27-12/+13
| | | | | |
| * | | | | Refactor the in_whitelist deco to a check.Gravatar Leon Sandøy2020-05-27-53/+86
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We're moving the actual predicate into the `utils.checks` folder, just like we're doing with most of the other decorators. This is to allow us the flexibility to use it as a pure check, not only as a decorator. This commit doesn't actually change any functionality, just moves it around.
| | * | | | Fix ATROCIOUS comment.Gravatar Leon Sandøy2020-05-27-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | I should be shot.
| | * | | | Refactor typestring converters to partialmethods.Gravatar Leon Sandøy2020-05-27-30/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We're using functools.partialmethod to make the code a little cleaner and more readable here. Read more about them here: https://docs.python.org/3/library/functools.html#functools.partial https://docs.python.org/3/library/functools.html#functools.partialmethod
| | * | | | Floats are no longer permitted as RedisCache keys.Gravatar Leon Sandøy2020-05-27-43/+86
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Also added a test for this. This is the DRYest approach I could find. It's a little ugly, but I think it's probably good enough.
| | * | | | Refactor .increment and add lock test.Gravatar Leon Sandøy2020-05-27-65/+109
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The way we were doing the asyncio.Lock() stuff for increment was slightly problematic. @aeros has adviced us that it's better to just initialize the lock as None in __init__, and then initialize it inside the first coroutine that uses it instead. This ensures that the correct loop gets attached to the lock, so we don't end up getting errors like this one: RuntimeError: got Future <Future pending> attached to a different loop This happens because the lock and the actual calling coroutines aren't on the same loop. When creating a new test, test_increment_lock, we discovered that we needed a small refactor here and also in the test class to make this new test pass. So, now we're creating a DummyCog for every test method, and this will ensure the loop streams never cross. Cause we all know we must never cross the streams.
| | * | | | Clear cache in asyncSetUp instead of tests.Gravatar Leon Sandøy2020-05-27-6/+1
| | | | | |
| | * | | | Merge branch 'master' into redis_persistenceGravatar Leon Sandøy2020-05-26-24/+97
| | |\ \ \ \ | | |/ / / / | |/| | | |
| | * | | | Add a test for RuntimeErrors.Gravatar Leon Sandøy2020-05-26-0/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This just tests that the various RuntimeErrors are reachable - that includes the error about not having a bot instance, the one about not being a class attribute, and the one about not having instantiated the class. This test addresses a concern raised by @MarkKoz in a review. I've decided not to test that actual contents of these RuntimeErrors, because I believe that sort of testing is a bit too brittle. It shouldn't break a test just to change the content of an error string.
| | * | | | Swap the order for the validate_cache checks.Gravatar Leon Sandøy2020-05-26-8/+8
| | | | | |
| | * | | | Improve some docstrings for RedisCache.Gravatar Leon Sandøy2020-05-26-5/+3
| | | | | | | | | | | | | | | | | | | | | | | | Thanks @MarkKoz!
| | * | | | Make self.increment_lock private.Gravatar Leon Sandøy2020-05-26-2/+2
| | | | | |
| | * | | | Add better docstring for RedisCache.updateGravatar Leon Sandøy2020-05-26-2/+12
| | | | | |
| | * | | | Fix edge case where pop might not delete.Gravatar Leon Sandøy2020-05-26-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If you passed a key for a value that was the same as your optional, it would just return it but not delete it. This edge case isn't worth it, so I'm just removing that condition and letting the extra API call fly.
| | * | | | Turn log.exception into log.errorGravatar Leon Sandøy2020-05-26-17/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Also, refactor error messages to be consistent and DRY throughout the file.
| | * | | | Expose the redis port to the hostGravatar MarkKoz2020-05-25-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Useful for those that run redis with docker-compose but not the bot. The bot on the host won't have access to the Docker network in such case so the port must be exposed.
| | * | | | Improve output of section name in config validation subtestsGravatar MarkKoz2020-05-25-1/+1
| | | | | |
| | * | | | Support validating collection types for constantsGravatar MarkKoz2020-05-25-8/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a simple validation that only check the type of the collection. It does not validate the types inside the collection because that has proven to be quite complex.
| | * | | | Add support for Union type annotations for constantsGravatar MarkKoz2020-05-24-12/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Note that `Optional[x]` is just an alias for `Union[None, x]` so this effectively supports `Optional` too. This was especially troublesome because the redis password must be unset/None in order to avoid authentication, but the test would complain that `None` isn't a `str`. Setting to an empty string would pass the test but then make redis authenticate and fail.
| | * | | | Improve error and error testing for incrementGravatar Leon Sandøy2020-05-24-1/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Changed a RuntimeError to a KeyError (thanks @MarkKoz), and also added some tests to ensure that the right errors are raised whenever this method is used incorrectly.
| | * | | | Add an option to use fakeredis in Bot.Gravatar Leon Sandøy2020-05-24-48/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Without this option, all contributors would need to set up a Redis server in order to run the bot. But with use_fakeredis set to True, this is no longer necessary because it will just set up a fakeredis redis pool instead of trying to contact an actual server. This is more than good enough for most local testing purposes, since data persistence across restarts isn't really relevant for them. This also means we need to move fakeredis into our real dependency list instead of having it as a dev dependency, so there's a minor change for that as well. I also made a small kaizen change to sort all the dependencies in the Pipfile alphabetically.
| | * | | | MockBot needs to be aware of redis_readyGravatar Leon Sandøy2020-05-24-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Forgot to update the additional_spec_asyncs when changing the name of this Bot attribute to be public.
| | * | | | Add logging to the RedisCache.Gravatar Leon Sandøy2020-05-24-3/+39
| | | | | | | | | | | | | | | | | | | | | | | | Mostly trace and exception logging.
| | * | | | Rename Bot._redis_ready to Bot.redis_readyGravatar Leon Sandøy2020-05-24-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | It's a public attribute, we're accessing it from RedisCache.
| | * | | | Add .increment and .decrement methods.Gravatar Leon Sandøy2020-05-24-0/+69
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sometimes, we just want to store a counter in the cache. In this case, it is convenient to have a single method that will allow us to increment or decrement this counter. These methods allow you to decrement or increment floats and integers by an specified amount. By default, it'll increment or decrement by 1. Since this involves several API requests, we create an asyncio.Lock so that we don't end up with race conditions.
| | * | | | Make .items return ItemsView instead of AsyncIterGravatar Leon Sandøy2020-05-24-9/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There really was no compelling reason why this method should return an AsyncIterator or than that `async for items in cache.items()` has nice readability, but there were a few concerns. One is a concern about race conditions raised by @SebastiaanZ, and @MarkKoz raised a concern that it was misleading to have an AsyncIterator that only "pretended" to be lazy. To address these concerns, I've refactored it to return a regular ItemsView instead. I also improved the docstring, and fixed the relevant tests.
| | * | | | Better RuntimeErrors.Gravatar Leon Sandøy2020-05-24-2/+14
| | | | | | | | | | | | | | | | | | | | | | | | We provide suggestions for how to solve these problems now.
| | * | | | Improves various docstrings and comments.Gravatar Leon Sandøy2020-05-24-10/+27
| | | | | | | | | | | | | | | | | | | | | | | | Thanks to @MarkKoz for suggesting most of these in their code review.
| | * | | | Refactor the nice prefix/type strings to constantsGravatar Leon Sandøy2020-05-24-31/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It's leaner to just move that code out of the class and up to the module level as constants. This commit also renames ValidRedisType to RedisType.
| | * | | | len(prefix) instead of hardcoding 2Gravatar Leon Sandøy2020-05-24-1/+1
| | | | | | | | | | | | | | | | | | Co-authored-by: Mark <[email protected]>
| | * | | | use __name__ for type list Gravatar Leon Sandøy2020-05-24-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Instead of relying on __str__ representation, we'll use the __name__ dunder. Co-authored-by: Mark <[email protected]>
| | * | | | Merge branch 'master' into redis_persistenceGravatar Leon Sandøy2020-05-23-4/+6
| | |\ \ \ \
| | * | | | | Show a warning when redis pool isn't closedGravatar MarkKoz2020-05-23-0/+5
| | | | | | |
| | * | | | | Remove redis session mock from MockBotGravatar MarkKoz2020-05-23-16/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It's not feasible to mock it because all the commands return futures rather than being coroutines, so they cannot automatically be turned into AsyncMocks. Furthermore, no code should ever use the redis session directly besides RedisCache. Since the tests for RedisCache already use fakeredis, there's no use in trying to mock redis in MockBot.
| | * | | | | DRY approach to typestring prefix resolutionGravatar Leon Sandøy2020-05-23-15/+60
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Thanks to @kwzrd for this idea, basically we're making a constant with the typestring prefixes and iterating that in all our converters. These converter functions will also now raise TypeErrors if we try to convert something that isn't in this constants list. I've also added a new test that tests this functionality.
| | * | | | | Don't rely on HDEL ignoring keys for .popGravatar Leon Sandøy2020-05-23-2/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously we would try to .delete keys that did not exist if a default was provided when calling .pop. This is okay to do (because HDEL will just ignore any attempts to delete non-existing calls), but it does add an additional pointless API call to Redis, so I've added some validation as a small optimization. This also adds a few additional lines of documentation as requested by @SebastiaanZ in their review.
| | * | | | | Fix typo in test_to_dict docstringGravatar Leon Sandøy2020-05-23-1/+1
| | | | | | |
| | * | | | | Update exception message Gravatar Leon Sandøy2020-05-23-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This was incorrectly suggesting the user needed to create an instance of RedisCache, when in fact it is the parent that needs to be instantiated. Co-authored-by: Sebastiaan Zeeff <[email protected]>
| | * | | | | CI needs REDIS_PASSWORD to pass testsGravatar Leon Sandøy2020-05-23-0/+1
| | | | | | |
| | * | | | | Moving the Redis session creation to Bot._recreateGravatar Leon Sandøy2020-05-23-2/+5
| | | | | | |
| | * | | | | Unbreak the error_handlerGravatar Leon Sandøy2020-05-23-1/+1
| | | | | | |
| | * | | | | Merge branch 'redis_persistence' of github.com:python-discord/bot into ↵Gravatar Leon Sandøy2020-05-23-44/+127
| | |\ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | redis_persistence
| | | * \ \ \ \ Merge branch 'master' into redis_persistenceGravatar Leon Sandøy2020-05-23-44/+127
| | | |\ \ \ \ \
| | * | | | | | | Better docstring for RedisCache.containsGravatar Leon Sandøy2020-05-23-1/+5
| | |/ / / / / /
| | * | | | | | Better docstring for RedisCacheGravatar Leon Sandøy2020-05-23-1/+31
| | | | | | | |
| | * | | | | | Complete asyncified test suite for RedisCacheGravatar Leon Sandøy2020-05-23-94/+112
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit just alters existing code to work with the new interface, and with async. All tests are passing successfully.
| | * | | | | | Finish asyncifying RedisCache methodsGravatar Leon Sandøy2020-05-23-16/+34
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - All methods will now do a validation check - Complete interface spec added to class: - .update - .clear - .pop - .to_dict - .length - .contains - .delete - .get - .set
| | * | | | | | Finish .set and .get, and add tests.Gravatar Leon Sandøy2020-05-23-25/+85
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The .set and .get will accept ints, floats, and strings. These will be converted into "typestrings", which is basically just a simple format that's been invented for this object. For example, an int looks like `b"i|2423"`. Note how it is still stored as a bytestring (like everything in Redis), but because of this prefix we are able to coerce it into the type we want on the way out of the db.
| | * | | | | | Use autospecced mocks in MockBot for the stats and aiohttp sessionGravatar MarkKoz2020-05-22-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This will help catch anything that tries to get/set an attribute/method which doesn't exist. It'll also catch missing/too many parameters being passed to methods.
| | * | | | | | Properly mock the redis pool in MockBotGravatar MarkKoz2020-05-22-9/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Because some of the redis pool/connection methods return futures rather than being coroutines, the redis pool had to be mocked using the CustomMockMixin so it could take advantage of `additional_spec_asyncs` to use AsyncMocks for these future-returning methods.
generated by cgit v1.2.3 (git 2.39.1) at 2025-10-23 15:35:20 +0000