Merge pull request #147 from lazybytez/feature/add-redis-cache

Add Redis as cache provider

.env.example

@@ -1,8 +1,8 @@
 TOKEN="your-secret-token-here"
 DATABASE_MODE="SQLite"
-DATABASE_URL=""
+DATABASE_URL="postgres://jojo:jojo@127.0.0.1:5432/jojo"
 CACHE_MODE=memory
-CACHE_DSN=""
+CACHE_DSN="redis://:changeme123@127.0.0.1:6379"
 WEBAPI_MODE="debug"
 WEBAPI_BIND=":8080"
 WEBAPI_HOST="localhost:8080"

Makefile

@@ -45,6 +45,23 @@ run: openapi/generate
 build: openapi/generate
 	go build -ldflags "-X github.com/lazybytez/jojo-discord-bot/build.Version=edge -X github.com/lazybytez/jojo-discord-bot/build.CommitSHA=`git rev-parse --short HEAD`" .
 
+# === Database services ===
+# =====================
+# Start database and redis development instances
+.PHONY: services/start
+services/start:
+	docker-compose up -d
+
+# Stop database and redis development instances
+.PHONY: services/stop
+services/stop:
+	docker-compose stop
+
+# Destroy database and redis development instances
+.PHONY: services/destroy
+services/destroy:
+	docker-compose down -v
+
 # === Quality Assurance ===
 # =========================
 # Runs tests with specified arguments

README.md

@@ -78,6 +78,25 @@ Local linting to assure code styling.
 make lint
 ```
 
+### Database services
+To use the local PostgreSQL and Redis it is necesary to have `Docker` and `docker-compose`
+installed locally.
+
+Start local database and redis:
+```bash
+make services/start
+```
+
+Stop local database and redis:
+```bash
+make services/stop
+```
+
+Destroy local database and redis:
+```bash
+make services/start
+```
+
 ## Contributing
 
 If you want to take part in contribution, like fixing issues and contributing directly to the code base, please visit

api/entities/audit_log_config.go

@@ -66,7 +66,7 @@ func (alcem *AuditLogConfigEntityManager) GetByGuildId(guildId uint) (*AuditLogC
 		return auditLogConfig, err
 	}
 
-	cache.Update(cacheKey, *auditLogConfig)
+	_ = cache.Update(cacheKey, *auditLogConfig)
 
 	return auditLogConfig, nil
 }

api/entities/audit_log_config_test.go

@@ -50,7 +50,8 @@ func (suite *AuditLogConfigEntityManagerTestSuite) SetupTest() {
 		&suite.em,
 	}
 
-	cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	err := cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	suite.NoError(err)
 }
 
 func (suite *AuditLogConfigEntityManagerTestSuite) TestNewAuditLogConfigEntityManager() {
@@ -98,7 +99,8 @@ func (suite *AuditLogConfigEntityManagerTestSuite) TestGetByGuildIDWithCache() {
 		GuildID: testGuildId,
 	}
 
-	cache.Update(testCacheKey, *testAuditLogConfig)
+	err := cache.Update(testCacheKey, *testAuditLogConfig)
+	suite.NoError(err)
 
 	// Do not expect call of GetFirstEntity or DB calls
 	// When GetFirstEntity is called, test will fail as call is unexpected

api/entities/global_component_status.go

@@ -69,9 +69,9 @@ func (gem *GlobalComponentStatusEntityManager) Get(registeredComponentStatusId u
 	}
 
 	// Invalidate cache item (if present)
-	cache.Update(gem.getCacheKey(registeredComponentStatusId), *globalCompStatus)
+	_ = cache.Update(gem.getCacheKey(registeredComponentStatusId), *globalCompStatus)
 
-	return globalCompStatus, err
+	return globalCompStatus, nil
 }
 
 // GetDisplayString returns the string that indicates whether a component is

api/entities/global_component_status_test.go

@@ -50,7 +50,8 @@ func (suite *GlobalComponentStatusEntityManagerTestSuite) SetupTest() {
 		&suite.em,
 	}
 
-	cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	err := cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	suite.NoError(err)
 }
 
 func (suite *GlobalComponentStatusEntityManagerTestSuite) TestNewGlobalComponentStatusEntityManager() {
@@ -96,7 +97,8 @@ func (suite *GlobalComponentStatusEntityManagerTestSuite) TestGetWithCache() {
 		ComponentID: testId,
 	}
 
-	cache.Update(testCacheKey, *testGlobalComponentStatus)
+	err := cache.Update(testCacheKey, *testGlobalComponentStatus)
+	suite.NoError(err)
 
 	// Do not expect call of GetFirstEntity or DB calls
 	// When GetFirstEntity is called, test will fail as call is unexpected

api/entities/guild.go

@@ -73,9 +73,9 @@ func (gem *GuildEntityManager) Get(guildId string) (*Guild, error) {
 		return &Guild{}, err
 	}
 
-	cache.Update(gem.getCacheKeyFromStringGuildId(guildId), *guild)
+	_ = cache.Update(gem.getCacheKeyFromStringGuildId(guildId), *guild)
 
-	return guild, err
+	return guild, nil
 }
 
 // Count returns the number of all guilds stored in the entities

api/entities/guild_component_status.go

@@ -71,7 +71,7 @@ func (gcsem *GuildComponentStatusEntityManager) Get(guildId uint, componentId ui
 		return guildCompStatus, err
 	}
 
-	cache.Update(cacheKey, *guildCompStatus)
+	_ = cache.Update(cacheKey, *guildCompStatus)
 
 	return guildCompStatus, nil
 }

api/entities/guild_component_status_test.go

@@ -50,7 +50,8 @@ func (suite *GuildComponentStatusEntityManagerTestSuite) SetupTest() {
 		&suite.em,
 	}
 
-	cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	err := cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	suite.NoError(err)
 }
 
 func (suite *GuildComponentStatusEntityManagerTestSuite) TestGetCacheKey() {
@@ -115,7 +116,8 @@ func (suite *GuildComponentStatusEntityManagerTestSuite) TestGetWithCache() {
 		ComponentID: componentId,
 	}
 
-	cache.Update(testCacheKey, *testGuildComponentStatus)
+	err := cache.Update(testCacheKey, *testGuildComponentStatus)
+	suite.NoError(err)
 
 	// Do not expect call of GetFirstEntity or DB calls
 	// When GetFirstEntity is called, test will fail as call is unexpected

api/entities/guild_test.go

@@ -50,7 +50,8 @@ func (suite *GuildEntityManagerTestSuite) SetupTest() {
 		&suite.em,
 	}
 
-	cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	err := cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	suite.NoError(err)
 }
 
 func (suite *GuildEntityManagerTestSuite) TestNewGuildEntityManager() {
@@ -99,7 +100,8 @@ func (suite *GuildEntityManagerTestSuite) TestGetWithCache() {
 		GuildID: testId,
 	}
 
-	cache.Update(testCacheKey, *testGuild)
+	err := cache.Update(testCacheKey, *testGuild)
+	suite.NoError(err)
 
 	// Do not expect call of GetFirstEntity or DB calls
 	// When GetFirstEntity is called, test will fail as call is unexpected

api/entities/registered_component.go

@@ -80,9 +80,9 @@ func (rgem *RegisteredComponentEntityManager) Get(registeredComponentCode Compon
 		return regComp, err
 	}
 
-	cache.Update(cacheKey, *regComp)
+	_ = cache.Update(cacheKey, *regComp)
 
-	return regComp, err
+	return regComp, nil
 }
 
 // GetAvailable returns all components that have been registered

api/entities/registered_component_test.go

@@ -51,7 +51,8 @@ func (suite *RegisteredComponentEntityManagerTestSuite) SetupTest() {
 		[]ComponentCode{},
 	}
 
-	cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	err := cache.Init(cache.ModeMemory, 10*time.Minute, "")
+	suite.NoError(err)
 }
 
 func (suite *RegisteredComponentEntityManagerTestSuite) TestNewRegisteredComponentEntityManager() {
@@ -99,7 +100,8 @@ func (suite *RegisteredComponentEntityManagerTestSuite) TestGetWithCache() {
 		Code: testCode,
 	}
 
-	cache.Update(testCacheKey, *testRegisteredComponent)
+	err := cache.Update(testCacheKey, *testRegisteredComponent)
+	suite.NoError(err)
 
 	// Do not expect call of GetFirstEntity or DB calls
 	// When GetFirstEntity is called, test will fail as call is unexpected

api/slash_commands_test.go

@@ -295,14 +295,13 @@ func (suite *SlashCommandManagerTestSuite) TestGetCommandsForComponentWithComman
 	}
 
 	result := suite.slashCommandManager.GetCommandsForComponent(testComponentCode)
+	expected := []*Command{
+		foundCommandOne,
+		foundCommandTwo,
+	}
 
 	suite.Len(result, 2)
-
-	suite.Equal(foundCommandOne.c.Code, result[0].c.Code)
-	suite.Equal(foundCommandOne.Category, result[0].Category)
-
-	suite.Equal(foundCommandTwo.c.Code, result[1].c.Code)
-	suite.Equal(foundCommandTwo.Category, result[1].Category)
+	suite.Equal(expected, result)
 }
 
 func TestSlashCommandManager(t *testing.T) {

core_components/bot_core/command/module/rate_limiter.go

@@ -61,7 +61,12 @@ func increaseRateLimitCount(guild *entities.Guild) bool {
 	}
 
 	toggleCount += 1
-	cache.Update(cacheKey, toggleCount)
+	err := cache.Update(cacheKey, toggleCount)
+	if nil != err {
+		C.Logger().Err(err, fmt.Sprintf(
+			"Failed to store incremented module toggle rate limit count in cache for guild %d",
+			guild.GuildID))
+	}
 
 	return true
 }

core_components/bot_core/command/sync_commands/subcommand_handler.go

@@ -83,7 +83,12 @@ func HandleSyncCommandSubCommand(
 	C.SlashCommandManager().SyncApplicationComponentCommands(s, i.GuildID)
 
 	currentTime := time.Now()
-	cache.Update(cacheKey, currentTime)
+	err = cache.Update(cacheKey, currentTime)
+	if nil != err {
+		C.Logger().Err(err, fmt.Sprintf(
+			"Failed to store time of last command sync for guild \"%s\" in the cache.",
+			dgoGuild.ID))
+	}
 
 	finishWitSuccess(s, i, resp)
 	C.BotAuditLogger().Log(

core_components/bot_webapi/command_api_types.go

@@ -150,7 +150,10 @@ func getCommandDTOs() []CommandDTO {
 	commands := C.SlashCommandManager().GetCommands()
 	commandDTOs := CommandDTOsFromCommands(commands)
 
-	cache.Update(CommandDTOsWebApiCacheKey, commandDTOs)
+	err := cache.Update(CommandDTOsWebApiCacheKey, commandDTOs)
+	if nil != err {
+		C.Logger().Warn(fmt.Sprintf("Failed to cache aggregated CommandDTOs: %s", err.Error()))
+	}
 
 	return commandDTOs
 }

core_components/bot_webapi/get_command.go

@@ -86,7 +86,13 @@ func CommandGet(g *gin.Context) {
 			return
 		}
 
-		cache.Update(cacheKey, cmdDTO)
+		err := cache.Update(cacheKey, cmdDTO)
+		if nil != err {
+			C.Logger().Warn(fmt.Sprintf(
+				"Failed to cache web api response for CommandGet endpoint for command \"%s\": %s",
+				cmdID,
+				err.Error()))
+		}
 	}
 
 	g.JSON(http.StatusOK, cmdDTO)

core_components/bot_webapi/get_components.go

@@ -23,11 +23,16 @@ import (
 	"github.com/gin-gonic/gin"
 	"github.com/lazybytez/jojo-discord-bot/api"
 	"github.com/lazybytez/jojo-discord-bot/api/entities"
+	"github.com/lazybytez/jojo-discord-bot/services/cache"
 	"github.com/lazybytez/jojo-discord-bot/webapi"
 	"net/http"
 	"time"
 )
 
+// ComponentDTOsResponseWebApiCacheKey is the cache key used to store and retrieve all components
+// as ComponentDTO instances from the cache.
+const ComponentDTOsResponseWebApiCacheKey = "bot_web_api_components_get_cache"
+
 // ComponentDTO is an intermediate data transfer object
 // that can be output or received by the WebAPI.
 // This type is used, because the bot both has the general api.Component
@@ -97,6 +102,13 @@ func ComponentDTOFromComponent(c *api.Component, guildId string) (ComponentDTO,
 // @Failure		500 {object} webapi.ErrorResponse "An error indicating that an internal error happened"
 // @Router      /components [get]
 func ComponentsGet(g *gin.Context) {
+	cachedResponse, ok := cache.Get(ComponentDTOsResponseWebApiCacheKey, []ComponentDTO{})
+	if ok {
+		g.JSON(http.StatusOK, cachedResponse)
+
+		return
+	}
+
 	componentDTOs := make([]ComponentDTO, len(api.Components))
 	var err error
 
@@ -116,5 +128,10 @@ func ComponentsGet(g *gin.Context) {
 		}
 	}
 
+	err = cache.Update(ComponentDTOsResponseWebApiCacheKey, componentDTOs)
+	if nil != err {
+		C.Logger().Err(err, "Failed to cache ComponentDTOs for GET components web api endpoint!")
+	}
+
 	g.JSON(http.StatusOK, componentDTOs)
 }

docker-compose.yaml

@@ -0,0 +1,33 @@
+version: "3.7"
+
+services:
+  db:
+    image: bitnami/postgresql:14
+    environment:
+      - POSTGRES_USER=jojo
+      - POSTGRES_PASSWORD=jojo
+      - POSTGRES_DB=jojo
+    ports:
+      - "5432:5432"
+    volumes:
+      - db_data:/bitnami/postgresql
+    healthcheck:
+      test: [ "CMD", "pg_isready" ]
+      interval: 10s
+      timeout: 5s
+      retries: 5    
+
+  redis:
+    image: bitnami/redis:7.0
+    environment:
+      REDIS_PASSWORD: "changeme123"
+    ports:
+      - "6379:6379"
+    healthcheck:
+      test: [ "CMD", "redis-cli", "ping" ]
+      interval: 1s
+      timeout: 3s
+      retries: 30
+
+volumes:
+  db_data: