Merge pull request #394 from jovandeginste/gorm-cache

Implement simple query caching

go.mod

@@ -52,6 +52,7 @@ require (
 	github.com/dustin/go-humanize v1.0.1 // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/glebarez/go-sqlite v1.22.0 // indirect
+	github.com/go-gorm/caches/v4 v4.0.5 // indirect
 	github.com/go-openapi/jsonpointer v0.21.0 // indirect
 	github.com/go-openapi/jsonreference v0.21.0 // indirect
 	github.com/go-openapi/spec v0.21.0 // indirect

go.sum

@@ -43,6 +43,8 @@ github.com/glebarez/go-sqlite v1.22.0 h1:uAcMJhaA6r3LHMTFgP0SifzgXg46yJkgxqyuyec
 github.com/glebarez/go-sqlite v1.22.0/go.mod h1:PlBIdHe0+aUEFn+r2/uthrWq4FxbzugL0L8Li6yQJbc=
 github.com/glebarez/sqlite v1.11.0 h1:wSG0irqzP6VurnMEpFGer5Li19RpIRi2qvQz++w0GMw=
 github.com/glebarez/sqlite v1.11.0/go.mod h1:h8/o8j5wiAsqSPoWELDUdJXhjAhsVliSn7bWZjOhrgQ=
+github.com/go-gorm/caches/v4 v4.0.5 h1:Sdj9vxbEM0sCmv5+s5o6GzoVMuraWF0bjJJvUU+7c1U=
+github.com/go-gorm/caches/v4 v4.0.5/go.mod h1:Ms8LnWVoW4GkTofpDzFH8OfDGNTjLxQDyxBmRN67Ujw=
 github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY=
 github.com/go-logfmt/logfmt v0.5.0/go.mod h1:wCYkCAKZfumFQihp8CzCvQ3paCTfi41vtzG1KdI/P7A=
 github.com/go-openapi/jsonpointer v0.21.0 h1:YgdVicSA9vH5RiHs9TZW5oyafXZFc6+2Vc1rr/O9oNQ=

pkg/database/gorm.go

@@ -51,6 +51,10 @@ func Connect(driver, dsn string, debug bool, logger *slog.Logger) (*gorm.DB, err
 		return nil, err
 	}
 
+	if err := db.Use(NewMemoryCache()); err != nil {
+		return nil, err
+	}
+
 	if err := preMigrationActions(db); err != nil {
 		return nil, err
 	}

pkg/database/gorm_cache.go

@@ -0,0 +1,69 @@
+package database
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"sync"
+
+	"github.com/go-gorm/caches/v4"
+)
+
+var ErrInvalidDataInCache = errors.New("invalid cache data")
+
+type memoryCacher struct {
+	store *sync.Map
+}
+
+func (c *memoryCacher) init() {
+	if c.store == nil {
+		c.store = &sync.Map{}
+	}
+}
+
+func (c *memoryCacher) Get(ctx context.Context, key string, q *caches.Query[any]) (*caches.Query[any], error) {
+	val, ok := c.store.Load(key)
+	if !ok {
+		// Not stored in cache
+		return nil, nil //nolint:nilnil
+	}
+
+	b, ok := val.([]byte)
+	if !ok {
+		return nil, ErrInvalidDataInCache // invalid data stored in cache
+	}
+
+	if err := q.Unmarshal(b); err != nil {
+		return nil, fmt.Errorf("%w: %s", ErrInvalidDataInCache, err) //  invalid data stored in cache
+	}
+
+	return q, nil
+}
+
+func (c *memoryCacher) Store(ctx context.Context, key string, val *caches.Query[any]) error {
+	res, err := val.Marshal()
+	if err != nil {
+		return err
+	}
+
+	c.store.Store(key, res)
+
+	return nil
+}
+
+func (c *memoryCacher) Invalidate(ctx context.Context) error {
+	c.store = &sync.Map{}
+	return nil
+}
+
+func NewMemoryCache() *caches.Caches {
+	c := &memoryCacher{}
+	c.init()
+
+	cachesPlugin := &caches.Caches{Conf: &caches.Config{
+		Cacher: c,
+		Easer:  true,
+	}}
+
+	return cachesPlugin
+}