From dcef0b65069fb38fd0f6c4382353167f603ebff1 Mon Sep 17 00:00:00 2001 From: LLLL Colonq Date: Thu, 16 Nov 2023 19:06:43 -0500 Subject: Initial commit --- deps/discord-haskell/docs/todo.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 deps/discord-haskell/docs/todo.md (limited to 'deps/discord-haskell/docs/todo.md') diff --git a/deps/discord-haskell/docs/todo.md b/deps/discord-haskell/docs/todo.md new file mode 100644 index 0000000..e555a85 --- /dev/null +++ b/deps/discord-haskell/docs/todo.md @@ -0,0 +1,36 @@ + +### TODO + + +#### Handle eventHandler backpressure + +What happens when discord sends more events than the user can handle? + +Each event forks a new thread at the moment we get it. What happens when the library receives 1000 events very quickly, how many threads do we spawn? + +#### Ensure ratelimiting is minimal + +discord/reest/http.hs implements ratelimiting https://discord.com/developers/docs/topics/rate-limits + +Print out all the headers as we get them and ensure the library is actually sending requests as fast as possible. + + +#### Cache + +Cache is a TODO at the moment. + +A cache is nice for a user to query, and we could do some automatic RestCall response caching for free performance. + +https://github.com/discord-haskell/discord-haskell/issues/44 wants to access the roles (in a `GuildMember` object) of the user who sent a `CreateMessage` event. However it only contains a `User` object. Need a separate RestCall to get the roles. + +https://github.com/discord-haskell/discord-haskell/issues/89 asks that a user can put their own data in the cache and access it. + +#### Higher level bot interface? easier to add state and stuff + +https://github.com/discord-haskell/discord-haskell/blob/master/examples/state-counter.hs + +https://github.com/discord-haskell/discord-haskell/issues/42 and https://github.com/discord-haskell/discord-haskell/issues/81 ask about how to store state in between event handler calls. + +https://github.com/discord-haskell/discord-haskell/issues/63 asks for docs on how to deploy a bot to heroku. + +The [state-counter.hs`](../examples/state-counter.hs) example shows how to increment a count between eventHandlers, and persist state to a file. -- cgit v1.2.3