[performance] cache recently allowed/denied domains to cut down on db calls (#794)

* fetch creation and fetching domain blocks from db

Signed-off-by: kim <grufwub@gmail.com>

* add separate domainblock cache type, handle removing block from cache on delete

Signed-off-by: kim <grufwub@gmail.com>

* fix sentinel nil values being passed into cache

Signed-off-by: kim <grufwub@gmail.com>

Signed-off-by: kim <grufwub@gmail.com>

4 files changed, 119 insertions, 22 deletions

diff --git a/internal/db/bundb/bundb.go b/internal/db/bundb/bundb.go
index ca123543a..6bf3571b4 100644
--- a/internal/db/bundb/bundb.go
+++ b/internal/db/bundb/bundb.go
@@ -173,6 +173,9 @@ func NewBunDBService(ctx context.Context) (db.DB, error) {
 	notifCache.SetTTL(time.Minute*5, false)
 	notifCache.Start(time.Second * 10)
 
+	// Prepare domain block cache
+	blockCache := cache.NewDomainBlockCache()
+
 	ps := &bunDBService{
 		Account: accounts,
 		Admin: &adminDB{
@@ -182,7 +185,8 @@ func NewBunDBService(ctx context.Context) (db.DB, error) {
 			conn: conn,
 		},
 		Domain: &domainDB{
-			conn: conn,
+			conn:  conn,
+			cache: blockCache,
 		},
 		Emoji: &emojiDB{
 			conn: conn,
diff --git a/internal/db/bundb/domain.go b/internal/db/bundb/domain.go
index fadb6dcf9..4cad75e4d 100644
--- a/internal/db/bundb/domain.go
+++ b/internal/db/bundb/domain.go
@@ -20,59 +20,134 @@ package bundb
 
 import (
 	"context"
+	"database/sql"
 	"net/url"
 	"strings"
 
+	"github.com/superseriousbusiness/gotosocial/internal/cache"
 	"github.com/superseriousbusiness/gotosocial/internal/config"
 	"github.com/superseriousbusiness/gotosocial/internal/db"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
-	"github.com/superseriousbusiness/gotosocial/internal/util"
 )
 
 type domainDB struct {
-	conn *DBConn
+	conn  *DBConn
+	cache *cache.DomainBlockCache
 }
 
-func (d *domainDB) IsDomainBlocked(ctx context.Context, domain string) (bool, db.Error) {
-	if domain == "" || domain == config.GetHost() {
-		return false, nil
+func (d *domainDB) CreateDomainBlock(ctx context.Context, block gtsmodel.DomainBlock) db.Error {
+	// Normalize to lowercase
+	block.Domain = strings.ToLower(block.Domain)
+
+	// Attempt to insert new domain block
+	_, err := d.conn.NewInsert().
+		Model(&block).
+		Exec(ctx, &block)
+	if err != nil {
+		return d.conn.ProcessError(err)
 	}
 
+	// Cache this domain block
+	d.cache.Put(block.Domain, &block)
+
+	return nil
+}
+
+func (d *domainDB) GetDomainBlock(ctx context.Context, domain string) (*gtsmodel.DomainBlock, db.Error) {
+	// Normalize to lowercase
+	domain = strings.ToLower(domain)
+
+	// Check for easy case, domain referencing *us*
+	if domain == "" || domain == config.GetAccountDomain() {
+		return nil, db.ErrNoEntries
+	}
+
+	// Check for already cached rblock
+	if block, ok := d.cache.GetByDomain(domain); ok {
+		// A 'nil' return value is a sentinel value for no block
+		if block == nil {
+			return nil, db.ErrNoEntries
+		}
+
+		// Else, this block exists
+		return block, nil
+	}
+
+	block := &gtsmodel.DomainBlock{}
+
 	q := d.conn.
 		NewSelect().
-		Model(&gtsmodel.DomainBlock{}).
-		ExcludeColumn("id", "created_at", "updated_at", "created_by_account_id", "private_comment", "public_comment", "obfuscate", "subscription_id").
+		Model(block).
 		Where("domain = ?", domain).
 		Limit(1)
 
-	return d.conn.Exists(ctx, q)
+	// Query database for domain block
+	switch err := q.Scan(ctx); err {
+	// No error, block found
+	case nil:
+		d.cache.Put(domain, block)
+		return block, nil
+
+	// No error, simply not found
+	case sql.ErrNoRows:
+		d.cache.Put(domain, nil)
+		return nil, db.ErrNoEntries
+
+	// Any other db error
+	default:
+		return nil, d.conn.ProcessError(err)
+	}
 }
 
-func (d *domainDB) AreDomainsBlocked(ctx context.Context, domains []string) (bool, db.Error) {
-	// filter out any doubles
-	uniqueDomains := util.UniqueStrings(domains)
+func (d *domainDB) DeleteDomainBlock(ctx context.Context, domain string) db.Error {
+	// Normalize to lowercase
+	domain = strings.ToLower(domain)
 
-	for _, domain := range uniqueDomains {
-		if blocked, err := d.IsDomainBlocked(ctx, strings.ToLower(domain)); err != nil {
+	// Attempt to delete domain block
+	_, err := d.conn.NewDelete().
+		Model((*gtsmodel.DomainBlock)(nil)).
+		Where("domain = ?", domain).
+		Exec(ctx, nil)
+	if err != nil {
+		return d.conn.ProcessError(err)
+	}
+
+	// Clear domain from cache
+	d.cache.InvalidateByDomain(domain)
+
+	return nil
+}
+
+func (d *domainDB) IsDomainBlocked(ctx context.Context, domain string) (bool, db.Error) {
+	block, err := d.GetDomainBlock(ctx, domain)
+	if err == nil || err == db.ErrNoEntries {
+		return (block != nil), nil
+	}
+	return false, err
+}
+
+func (d *domainDB) AreDomainsBlocked(ctx context.Context, domains []string) (bool, db.Error) {
+	for _, domain := range domains {
+		if blocked, err := d.IsDomainBlocked(ctx, domain); err != nil {
 			return false, err
 		} else if blocked {
 			return blocked, nil
 		}
 	}
-
-	// no blocks found
 	return false, nil
 }
 
 func (d *domainDB) IsURIBlocked(ctx context.Context, uri *url.URL) (bool, db.Error) {
-	domain := uri.Hostname()
-	return d.IsDomainBlocked(ctx, domain)
+	return d.IsDomainBlocked(ctx, uri.Hostname())
 }
 
 func (d *domainDB) AreURIsBlocked(ctx context.Context, uris []*url.URL) (bool, db.Error) {
-	domains := []string{}
 	for _, uri := range uris {
-		domains = append(domains, uri.Hostname())
+		if blocked, err := d.IsDomainBlocked(ctx, uri.Hostname()); err != nil {
+			return false, err
+		} else if blocked {
+			return blocked, nil
+		}
 	}
-	return d.AreDomainsBlocked(ctx, domains)
+	return false, nil
 }
diff --git a/internal/db/bundb/domain_test.go b/internal/db/bundb/domain_test.go
index 1a3fed24d..b326236ad 100644
--- a/internal/db/bundb/domain_test.go
+++ b/internal/db/bundb/domain_test.go
@@ -21,6 +21,7 @@ package bundb_test
 import (
 	"context"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/suite"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
@@ -33,10 +34,15 @@ type DomainTestSuite struct {
 func (suite *DomainTestSuite) TestIsDomainBlocked() {
 	ctx := context.Background()
 
+	now := time.Now()
+
 	domainBlock := &gtsmodel.DomainBlock{
 		ID:                 "01G204214Y9TNJEBX39C7G88SW",
 		Domain:             "some.bad.apples",
+		CreatedAt:          now,
+		UpdatedAt:          now,
 		CreatedByAccountID: suite.testAccounts["admin_account"].ID,
+		CreatedByAccount:   suite.testAccounts["admin_account"],
 	}
 
 	// no domain block exists for the given domain yet
@@ -44,7 +50,8 @@ func (suite *DomainTestSuite) TestIsDomainBlocked() {
 	suite.NoError(err)
 	suite.False(blocked)
 
-	suite.db.Put(ctx, domainBlock)
+	err = suite.db.CreateDomainBlock(ctx, *domainBlock)
+	suite.NoError(err)
 
 	// domain block now exists
 	blocked, err = suite.db.IsDomainBlocked(ctx, domainBlock.Domain)
diff --git a/internal/db/domain.go b/internal/db/domain.go
index b92705483..7b264165d 100644
--- a/internal/db/domain.go
+++ b/internal/db/domain.go
@@ -21,10 +21,21 @@ package db
 import (
 	"context"
 	"net/url"
+
+	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
 )
 
 // Domain contains DB functions related to domains and domain blocks.
 type Domain interface {
+	// CreateDomainBlock ...
+	CreateDomainBlock(ctx context.Context, block gtsmodel.DomainBlock) Error
+
+	// GetDomainBlock ...
+	GetDomainBlock(ctx context.Context, domain string) (*gtsmodel.DomainBlock, Error)
+
+	// DeleteDomainBlock ...
+	DeleteDomainBlock(ctx context.Context, domain string) Error
+
 	// IsDomainBlocked checks if an instance-level domain block exists for the given domain string (eg., `example.org`).
 	IsDomainBlocked(ctx context.Context, domain string) (bool, Error)