This projects is in a very early state of development, so please use with caution. Most endpoints are currently not unit-tested and the general API may change during development. See the ToDo section to take a look into things that must be done until release.
DiscordGo Redis State - or for short: dgrs (pronounced: daggers) - is a custom state manager for DiscordGo which uses a Redis Instance to store and sync state.
This implementation has four core advantages:
-
The default state management of DiscordGo uses multi-layer maps where all cached objects are stored in the application heap. If you are dealing with a lot of data, this can really increase the load on the applications garbage collector and can eventually reduce the performance of your bot. By storing all of those objects in Redis (which is also way more optimized for storing large amounts of data and making them quckly accessable), your applications GC is not responsible to keep track of all of these objects.
-
By connecting to the same Redis instance, you can share state across multiple sharded replicas of your bot fairly easily.
-
As long as your Redis instance is up, the state is persistently cached and you don't need to build up your cache state from the beginning at every restart of your bot, which can safe a lot of time and unnessecary API calls.
-
You can set cache expirations for each type of state object after which the cached value is invalidated. This is not possible with the default state implementation of DiscordGo.
// Create a new DiscordGo session.
session, _ := discordgo.New("Bot " + token)
// Create the State instance passing the
// DiscordGo session and Redis client
// configuration.
state, err := dgrs.New(dgrs.Options{
DiscordSession: session,
RedisOptions: redis.Options{
Addr: "localhost:6379",
},
FetchAndStore: true,
})
guilds, err := state.Guilds()
if err != nil {
log.Fatal(err)
}
for _, g := range guilds {
fmt.Println(g.Name)
}- Add more unit tests
- Add custom marshal/unmarshal function option
- Optimize state updating
- Optimize code documentation
© 2021 Ringo Hoffmann (zekro Development).
Covered by the MIT License.