feat(GODT-2829): Store connector settings in database

benchmarks/gluon_bench/gluon_benchmarks/sync.go

@@ -156,6 +156,14 @@ func init() {
 
 type nullIMAPStateWriter struct{}
 
+func (n nullIMAPStateWriter) GetSettings(ctx context.Context) (string, bool, error) {
+	return "", false, nil
+}
+
+func (n nullIMAPStateWriter) StoreSettings(ctx context.Context, value string) error {
+	panic("implement me")
+}
+
 func (n nullIMAPStateWriter) GetMailboxCount(_ context.Context) (int, error) {
 	return 0, nil
 }

connector/state.go

@@ -37,6 +37,7 @@ func IMAPStateWriteType[T any](ctx context.Context, state IMAPState, f func(cont
 }
 
 type IMAPStateRead interface {
+	GetSettings(ctx context.Context) (string, bool, error)
 	GetMailboxCount(ctx context.Context) (int, error)
 }
 
@@ -46,4 +47,6 @@ type IMAPStateWrite interface {
 	CreateMailbox(ctx context.Context, mailbox imap.Mailbox) error
 
 	UpdateMessageFlags(ctx context.Context, id imap.MessageID, flags imap.FlagSet) error
+
+	StoreSettings(ctx context.Context, value string) error
 }

db/ops.go

@@ -1,14 +1,21 @@
 package db
 
+import "context"
+
 type ReadOnly interface {
 	MailboxReadOps
 	MessageReadOps
 	SubscriptionReadOps
+
+	// GetConnectorSettings returns true if no previous setting was ever stored before.
+	GetConnectorSettings(ctx context.Context) (string, bool, error)
 }
 
 type Transaction interface {
 	ReadOnly
 	MailboxWriteOps
 	MessageWriteOps
 	SubscriptionWriteOps
+
+	StoreConnectorSettings(ctx context.Context, settings string) error
 }

internal/backend/connector_state_read.go

@@ -9,6 +9,10 @@ type DBIMAPStateRead struct {
 	rd db.ReadOnly
 }
 
+func (d *DBIMAPStateRead) GetSettings(ctx context.Context) (string, bool, error) {
+	return d.rd.GetConnectorSettings(ctx)
+}
+
 func (d *DBIMAPStateRead) GetMailboxCount(ctx context.Context) (int, error) {
 	return d.rd.GetMailboxCount(ctx)
 }

internal/backend/connector_state_write.go

@@ -79,6 +79,10 @@ func (d *DBIMAPStateWrite) UpdateMessageFlags(ctx context.Context, id imap.Messa
 	})
 }
 
+func (d *DBIMAPStateWrite) StoreSettings(ctx context.Context, settings string) error {
+	return d.tx.StoreConnectorSettings(ctx, settings)
+}
+
 func (d *DBIMAPStateWrite) wrapStateUpdates(ctx context.Context, f func(ctx context.Context, tx db.Transaction) ([]state.Update, error)) error {
 	updates, err := f(ctx, d.tx)
 	if err == nil {

internal/db_impl/sqlite3/migration_test.go

@@ -73,6 +73,52 @@ func TestRunMigrations(t *testing.T) {
 	runAndValidateDB(t, testDir, "foo", testData, uidGenerator)
 }
 
+func TestMigration_ConnectorSettingsEmtpyOnFirstUse(t *testing.T) {
+	testDir := t.TempDir()
+
+	client, _, err := NewClient(testDir, "foo", false, false)
+	require.NoError(t, err)
+
+	defer func() {
+		require.NoError(t, client.Close())
+	}()
+
+	err = client.Init(context.Background(), imap.DefaultEpochUIDValidityGenerator())
+	require.NoError(t, err)
+
+	err = client.Write(context.Background(), func(ctx context.Context, tx db.Transaction) error {
+		{
+			settings, hasValue, err := tx.GetConnectorSettings(ctx)
+			require.NoError(t, err)
+			require.Empty(t, settings)
+			require.False(t, hasValue)
+		}
+
+		// Store empty value
+		require.NoError(t, tx.StoreConnectorSettings(ctx, ""))
+		{
+			settings, hasValue, err := tx.GetConnectorSettings(ctx)
+			require.NoError(t, err)
+			require.Empty(t, settings)
+			require.True(t, hasValue)
+		}
+
+		newSettings := "Some random settings string"
+		require.NoError(t, tx.StoreConnectorSettings(ctx, newSettings))
+
+		{
+			settings, hasValue, err := tx.GetConnectorSettings(ctx)
+			require.NoError(t, err)
+			require.Equal(t, newSettings, settings)
+			require.True(t, hasValue)
+		}
+
+		return nil
+	})
+
+	require.NoError(t, err)
+}
+
 func runAndValidateDB(t *testing.T, testDir, user string, testData *testData, uidGenerator imap.UIDValidityGenerator) {
 	// create client and run all migrations.
 	client, _, err := NewClient(testDir, "foo", false, false)

internal/db_impl/sqlite3/migrations.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	v2 "github.com/ProtonMail/gluon/internal/db_impl/sqlite3/v2"
 
 	"github.com/ProtonMail/gluon/db"
 	"github.com/ProtonMail/gluon/imap"
@@ -20,6 +21,7 @@ type Migration interface {
 var migrationList = []Migration{
 	&v0.Migration{},
 	&v1.Migration{},
+	&v2.Migration{},
 }
 
 func RunMigrations(ctx context.Context, tx utils.QueryWrapper, generator imap.UIDValidityGenerator) error {

internal/db_impl/sqlite3/read_ops.go

@@ -5,6 +5,7 @@ import (
 	"database/sql"
 	"errors"
 	"fmt"
+	v2 "github.com/ProtonMail/gluon/internal/db_impl/sqlite3/v2"
 	"strings"
 	"time"
 
@@ -606,3 +607,30 @@ func (r readOps) GetDeletedSubscriptionSet(ctx context.Context) (map[imap.Mailbo
 
 	return result, nil
 }
+
+func (r readOps) GetConnectorSettings(ctx context.Context) (string, bool, error) {
+	query := fmt.Sprintf("SELECT `%v` FROM %v WHERE `%v` = ?",
+		v2.ConnectorSettingsFieldValue,
+		v2.ConnectorSettingsTableName,
+		v2.ConnectorSettingsFieldID,
+	)
+
+	var hasValue bool
+
+	value, err := utils.MapQueryRowFn(ctx, r.qw, query, func(scanner utils.RowScanner) (string, error) {
+		var value sql.NullString
+
+		if err := scanner.Scan(&value); err != nil {
+			return "", err
+		}
+
+		if !value.Valid {
+			return "", nil
+		}
+
+		hasValue = true
+		return value.String, nil
+	}, v2.ConnectorSettingsDefaultID)
+
+	return value, hasValue, err
+}

internal/db_impl/sqlite3/utils/tracer.go

@@ -243,6 +243,12 @@ func (r ReadTracer) GetDeletedSubscriptionSet(ctx context.Context) (map[imap.Mai
 	return r.RD.GetDeletedSubscriptionSet(ctx)
 }
 
+func (r ReadTracer) GetConnectorSettings(ctx context.Context) (string, bool, error) {
+	r.Entry.Tracef("GetConnectorSettings")
+
+	return r.RD.GetConnectorSettings(ctx)
+}
+
 // WriteTracer prints all method names to a trace log.
 type WriteTracer struct {
 	ReadTracer
@@ -442,3 +448,9 @@ func (w WriteTracer) RemoveDeletedSubscriptionWithName(ctx context.Context, mbox
 
 	return w.TX.RemoveDeletedSubscriptionWithName(ctx, mboxName)
 }
+
+func (w WriteTracer) StoreConnectorSettings(ctx context.Context, settings string) error {
+	w.Entry.Tracef("StoreConnectorSettings")
+
+	return w.TX.StoreConnectorSettings(ctx, settings)
+}

internal/db_impl/sqlite3/v2/constants.go

@@ -0,0 +1,6 @@
+package v2
+
+const ConnectorSettingsTableName = "connector_settings"
+const ConnectorSettingsFieldID = "id"
+const ConnectorSettingsFieldValue = "value"
+const ConnectorSettingsDefaultID = 0

internal/db_impl/sqlite3/v2/migration.go

@@ -0,0 +1,35 @@
+package v2
+
+import (
+	"context"
+	"fmt"
+	"github.com/ProtonMail/gluon/imap"
+	"github.com/ProtonMail/gluon/internal/db_impl/sqlite3/utils"
+)
+
+type Migration struct{}
+
+func (m Migration) Run(ctx context.Context, tx utils.QueryWrapper, _ imap.UIDValidityGenerator) error {
+	query := fmt.Sprintf("CREATE TABLE `%v` (`%v` INTEGER NOT NULL PRIMARY KEY , `%v` TEXT)",
+		ConnectorSettingsTableName,
+		ConnectorSettingsFieldID,
+		ConnectorSettingsFieldValue,
+	)
+
+	if _, err := utils.ExecQuery(ctx, tx, query); err != nil {
+		return fmt.Errorf("failed to create connector settings table: %w", err)
+	}
+
+	query = fmt.Sprintf(
+		"INSERT INTO %v (`%v`, `%v`) VALUES (?,NULL)",
+		ConnectorSettingsTableName,
+		ConnectorSettingsFieldID,
+		ConnectorSettingsFieldValue,
+	)
+
+	if _, err := utils.ExecQuery(ctx, tx, query, ConnectorSettingsDefaultID); err != nil {
+		return fmt.Errorf("failed to create default connector settings entry: %w", err)
+	}
+
+	return nil
+}

internal/db_impl/sqlite3/write_ops.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	v2 "github.com/ProtonMail/gluon/internal/db_impl/sqlite3/v2"
 	"strings"
 
 	"github.com/ProtonMail/gluon/db"
@@ -656,3 +657,15 @@ func (w writeOps) RemoveDeletedSubscriptionWithName(ctx context.Context, mboxNam
 
 	return utils.ExecQuery(ctx, w.qw, query, mboxName)
 }
+
+func (w writeOps) StoreConnectorSettings(ctx context.Context, settings string) error {
+	query := fmt.Sprintf("UPDATE `%v` SET `%v`=? WHERE `%v`=?",
+		v2.ConnectorSettingsTableName,
+		v2.ConnectorSettingsFieldValue,
+		v2.ConnectorSettingsFieldID,
+	)
+
+	_, err := utils.ExecQuery(ctx, w.qw, query, settings, v2.ConnectorSettingsDefaultID)
+
+	return err
+}