Convert room_aliases and previous_events tables

roomserver/storage/postgres/previous_events_table.go

@@ -20,6 +20,7 @@ import (
 	"database/sql"
 
 	"github.com/matrix-org/dendrite/internal"
+	"github.com/matrix-org/dendrite/roomserver/storage/tables"
 	"github.com/matrix-org/dendrite/roomserver/types"
 )
 
@@ -63,19 +64,20 @@ type previousEventStatements struct {
 	selectPreviousEventExistsStmt *sql.Stmt
 }
 
-func (s *previousEventStatements) prepare(db *sql.DB) (err error) {
+func NewPostgresPreviousEventsTable(db *sql.DB) (tables.PreviousEvents, error) {
-	_, err = db.Exec(previousEventSchema)
+	s := &previousEventStatements{}
+	_, err := db.Exec(previousEventSchema)
 	if err != nil {
-		return
+		return nil, err
 	}
 
-	return statementList{
+	return s, statementList{
 		{&s.insertPreviousEventStmt, insertPreviousEventSQL},
 		{&s.selectPreviousEventExistsStmt, selectPreviousEventExistsSQL},
 	}.prepare(db)
 }
 
-func (s *previousEventStatements) insertPreviousEvent(
+func (s *previousEventStatements) InsertPreviousEvent(
 	ctx context.Context,
 	txn *sql.Tx,
 	previousEventID string,
@@ -91,7 +93,7 @@ func (s *previousEventStatements) insertPreviousEvent(
 
 // Check if the event reference exists
 // Returns sql.ErrNoRows if the event reference doesn't exist.
-func (s *previousEventStatements) selectPreviousEventExists(
+func (s *previousEventStatements) SelectPreviousEventExists(
 	ctx context.Context, txn *sql.Tx, eventID string, eventReferenceSHA256 []byte,
 ) error {
 	var ok int64

roomserver/storage/postgres/room_aliases_table.go

@@ -20,6 +20,7 @@ import (
 	"database/sql"
 
 	"github.com/matrix-org/dendrite/internal"
+	"github.com/matrix-org/dendrite/roomserver/storage/tables"
 )
 
 const roomAliasesSchema = `
@@ -59,12 +60,13 @@ type roomAliasesStatements struct {
 	deleteRoomAliasStmt          *sql.Stmt
 }
 
-func (s *roomAliasesStatements) prepare(db *sql.DB) (err error) {
+func NewPostgresRoomAliasesTable(db *sql.DB) (tables.RoomAliases, error) {
-	_, err = db.Exec(roomAliasesSchema)
+	s := &roomAliasesStatements{}
+	_, err := db.Exec(roomAliasesSchema)
 	if err != nil {
-		return
+		return nil, err
 	}
-	return statementList{
+	return s, statementList{
 		{&s.insertRoomAliasStmt, insertRoomAliasSQL},
 		{&s.selectRoomIDFromAliasStmt, selectRoomIDFromAliasSQL},
 		{&s.selectAliasesFromRoomIDStmt, selectAliasesFromRoomIDSQL},
@@ -73,14 +75,14 @@ func (s *roomAliasesStatements) prepare(db *sql.DB) (err error) {
 	}.prepare(db)
 }
 
-func (s *roomAliasesStatements) insertRoomAlias(
+func (s *roomAliasesStatements) InsertRoomAlias(
 	ctx context.Context, alias string, roomID string, creatorUserID string,
 ) (err error) {
 	_, err = s.insertRoomAliasStmt.ExecContext(ctx, alias, roomID, creatorUserID)
 	return
 }
 
-func (s *roomAliasesStatements) selectRoomIDFromAlias(
+func (s *roomAliasesStatements) SelectRoomIDFromAlias(
 	ctx context.Context, alias string,
 ) (roomID string, err error) {
 	err = s.selectRoomIDFromAliasStmt.QueryRowContext(ctx, alias).Scan(&roomID)
@@ -90,7 +92,7 @@ func (s *roomAliasesStatements) selectRoomIDFromAlias(
 	return
 }
 
-func (s *roomAliasesStatements) selectAliasesFromRoomID(
+func (s *roomAliasesStatements) SelectAliasesFromRoomID(
 	ctx context.Context, roomID string,
 ) ([]string, error) {
 	rows, err := s.selectAliasesFromRoomIDStmt.QueryContext(ctx, roomID)
@@ -111,7 +113,7 @@ func (s *roomAliasesStatements) selectAliasesFromRoomID(
 	return aliases, rows.Err()
 }
 
-func (s *roomAliasesStatements) selectCreatorIDFromAlias(
+func (s *roomAliasesStatements) SelectCreatorIDFromAlias(
 	ctx context.Context, alias string,
 ) (creatorID string, err error) {
 	err = s.selectCreatorIDFromAliasStmt.QueryRowContext(ctx, alias).Scan(&creatorID)
@@ -121,7 +123,7 @@ func (s *roomAliasesStatements) selectCreatorIDFromAlias(
 	return
 }
 
-func (s *roomAliasesStatements) deleteRoomAlias(
+func (s *roomAliasesStatements) DeleteRoomAlias(
 	ctx context.Context, alias string,
 ) (err error) {
 	_, err = s.deleteRoomAliasStmt.ExecContext(ctx, alias)

roomserver/storage/postgres/sql.go

@@ -38,8 +38,6 @@ func (s *statements) prepare(db *sql.DB) error {
 	var err error
 
 	for _, prepare := range []func(db *sql.DB) error{
-		s.previousEventStatements.prepare,
-		s.roomAliasesStatements.prepare,
 		s.inviteStatements.prepare,
 		s.membershipStatements.prepare,
 	} {

roomserver/storage/postgres/storage.go

@@ -40,10 +40,12 @@ type Database struct {
 	eventJSON      tables.EventJSON
 	rooms          tables.Rooms
 	transactions   tables.Transactions
+	prevEvents     tables.PreviousEvents
 	db             *sql.DB
 }
 
 // Open a postgres database.
+// nolint: gocyclo
 func Open(dataSourceName string, dbProperties internal.DbProperties) (*Database, error) {
 	var d Database
 	var err error
@@ -85,6 +87,10 @@ func Open(dataSourceName string, dbProperties internal.DbProperties) (*Database,
 	if err != nil {
 		return nil, err
 	}
+	d.prevEvents, err = NewPostgresPreviousEventsTable(d.db)
+	if err != nil {
+		return nil, err
+	}
 	d.Database = shared.Database{
 		DB:                  d.db,
 		EventTypesTable:     d.eventTypes,
@@ -95,6 +101,7 @@ func Open(dataSourceName string, dbProperties internal.DbProperties) (*Database,
 		TransactionsTable:   d.transactions,
 		StateBlockTable:     stateBlock,
 		StateSnapshotTable:  stateSnapshot,
+		PrevEventsTable:     d.prevEvents,
 	}
 	return &d, nil
 }
@@ -197,7 +204,7 @@ func (u *roomRecentEventsUpdater) CurrentStateSnapshotNID() types.StateSnapshotN
 // StorePreviousEvents implements types.RoomRecentEventsUpdater
 func (u *roomRecentEventsUpdater) StorePreviousEvents(eventNID types.EventNID, previousEventReferences []gomatrixserverlib.EventReference) error {
 	for _, ref := range previousEventReferences {
-		if err := u.d.statements.insertPreviousEvent(u.ctx, u.txn, ref.EventID, ref.EventSHA256, eventNID); err != nil {
+		if err := u.d.prevEvents.InsertPreviousEvent(u.ctx, u.txn, ref.EventID, ref.EventSHA256, eventNID); err != nil {
 			return err
 		}
 	}
@@ -206,7 +213,7 @@ func (u *roomRecentEventsUpdater) StorePreviousEvents(eventNID types.EventNID, p
 
 // IsReferenced implements types.RoomRecentEventsUpdater
 func (u *roomRecentEventsUpdater) IsReferenced(eventReference gomatrixserverlib.EventReference) (bool, error) {
-	err := u.d.statements.selectPreviousEventExists(u.ctx, u.txn, eventReference.EventID, eventReference.EventSHA256)
+	err := u.d.prevEvents.SelectPreviousEventExists(u.ctx, u.txn, eventReference.EventID, eventReference.EventSHA256)
 	if err == nil {
 		return true, nil
 	}
@@ -251,33 +258,6 @@ func (d *Database) GetInvitesForUser(
 	return d.statements.selectInviteActiveForUserInRoom(ctx, targetUserNID, roomNID)
 }
 
-// SetRoomAlias implements alias.RoomserverAliasAPIDB
-func (d *Database) SetRoomAlias(ctx context.Context, alias string, roomID string, creatorUserID string) error {
-	return d.statements.insertRoomAlias(ctx, alias, roomID, creatorUserID)
-}
-
-// GetRoomIDForAlias implements alias.RoomserverAliasAPIDB
-func (d *Database) GetRoomIDForAlias(ctx context.Context, alias string) (string, error) {
-	return d.statements.selectRoomIDFromAlias(ctx, alias)
-}
-
-// GetAliasesForRoomID implements alias.RoomserverAliasAPIDB
-func (d *Database) GetAliasesForRoomID(ctx context.Context, roomID string) ([]string, error) {
-	return d.statements.selectAliasesFromRoomID(ctx, roomID)
-}
-
-// GetCreatorIDForAlias implements alias.RoomserverAliasAPIDB
-func (d *Database) GetCreatorIDForAlias(
-	ctx context.Context, alias string,
-) (string, error) {
-	return d.statements.selectCreatorIDFromAlias(ctx, alias)
-}
-
-// RemoveRoomAlias implements alias.RoomserverAliasAPIDB
-func (d *Database) RemoveRoomAlias(ctx context.Context, alias string) error {
-	return d.statements.deleteRoomAlias(ctx, alias)
-}
-
 // MembershipUpdater implements input.RoomEventDatabase
 func (d *Database) MembershipUpdater(
 	ctx context.Context, roomID, targetUserID string,

roomserver/storage/shared/storage.go

@@ -22,6 +22,8 @@ type Database struct {
 	TransactionsTable   tables.Transactions
 	StateSnapshotTable  tables.StateSnapshot
 	StateBlockTable     tables.StateBlock
+	RoomAliasesTable    tables.RoomAliases
+	PrevEventsTable     tables.PreviousEvents
 }
 
 // EventTypeNIDs implements state.RoomStateDatabase
@@ -218,6 +220,33 @@ func (d *Database) GetRoomVersionForRoomNID(
 	)
 }
 
+// SetRoomAlias implements alias.RoomserverAliasAPIDB
+func (d *Database) SetRoomAlias(ctx context.Context, alias string, roomID string, creatorUserID string) error {
+	return d.RoomAliasesTable.InsertRoomAlias(ctx, alias, roomID, creatorUserID)
+}
+
+// GetRoomIDForAlias implements alias.RoomserverAliasAPIDB
+func (d *Database) GetRoomIDForAlias(ctx context.Context, alias string) (string, error) {
+	return d.RoomAliasesTable.SelectRoomIDFromAlias(ctx, alias)
+}
+
+// GetAliasesForRoomID implements alias.RoomserverAliasAPIDB
+func (d *Database) GetAliasesForRoomID(ctx context.Context, roomID string) ([]string, error) {
+	return d.RoomAliasesTable.SelectAliasesFromRoomID(ctx, roomID)
+}
+
+// GetCreatorIDForAlias implements alias.RoomserverAliasAPIDB
+func (d *Database) GetCreatorIDForAlias(
+	ctx context.Context, alias string,
+) (string, error) {
+	return d.RoomAliasesTable.SelectCreatorIDFromAlias(ctx, alias)
+}
+
+// RemoveRoomAlias implements alias.RoomserverAliasAPIDB
+func (d *Database) RemoveRoomAlias(ctx context.Context, alias string) error {
+	return d.RoomAliasesTable.DeleteRoomAlias(ctx, alias)
+}
+
 // Events implements input.EventDatabase
 func (d *Database) Events(
 	ctx context.Context, eventNIDs []types.EventNID,

roomserver/storage/sqlite3/previous_events_table.go

@@ -20,6 +20,7 @@ import (
 	"database/sql"
 
 	"github.com/matrix-org/dendrite/internal"
+	"github.com/matrix-org/dendrite/roomserver/storage/tables"
 	"github.com/matrix-org/dendrite/roomserver/types"
 )
 
@@ -55,19 +56,20 @@ type previousEventStatements struct {
 	selectPreviousEventExistsStmt *sql.Stmt
 }
 
-func (s *previousEventStatements) prepare(db *sql.DB) (err error) {
+func NewSqlitePrevEventsTable(db *sql.DB) (tables.PreviousEvents, error) {
-	_, err = db.Exec(previousEventSchema)
+	s := &previousEventStatements{}
+	_, err := db.Exec(previousEventSchema)
 	if err != nil {
-		return
+		return nil, err
 	}
 
-	return statementList{
+	return s, statementList{
 		{&s.insertPreviousEventStmt, insertPreviousEventSQL},
 		{&s.selectPreviousEventExistsStmt, selectPreviousEventExistsSQL},
 	}.prepare(db)
 }
 
-func (s *previousEventStatements) insertPreviousEvent(
+func (s *previousEventStatements) InsertPreviousEvent(
 	ctx context.Context,
 	txn *sql.Tx,
 	previousEventID string,
@@ -83,7 +85,7 @@ func (s *previousEventStatements) insertPreviousEvent(
 
 // Check if the event reference exists
 // Returns sql.ErrNoRows if the event reference doesn't exist.
-func (s *previousEventStatements) selectPreviousEventExists(
+func (s *previousEventStatements) SelectPreviousEventExists(
 	ctx context.Context, txn *sql.Tx, eventID string, eventReferenceSHA256 []byte,
 ) error {
 	var ok int64

roomserver/storage/sqlite3/room_aliases_table.go

@@ -20,6 +20,7 @@ import (
 	"database/sql"
 
 	"github.com/matrix-org/dendrite/internal"
+	"github.com/matrix-org/dendrite/roomserver/storage/tables"
 )
 
 const roomAliasesSchema = `
@@ -60,12 +61,13 @@ type roomAliasesStatements struct {
 	deleteRoomAliasStmt          *sql.Stmt
 }
 
-func (s *roomAliasesStatements) prepare(db *sql.DB) (err error) {
+func NewSqliteRoomAliasesTable(db *sql.DB) (tables.RoomAliases, error) {
-	_, err = db.Exec(roomAliasesSchema)
+	s := &roomAliasesStatements{}
+	_, err := db.Exec(roomAliasesSchema)
 	if err != nil {
-		return
+		return nil, err
 	}
-	return statementList{
+	return s, statementList{
 		{&s.insertRoomAliasStmt, insertRoomAliasSQL},
 		{&s.selectRoomIDFromAliasStmt, selectRoomIDFromAliasSQL},
 		{&s.selectAliasesFromRoomIDStmt, selectAliasesFromRoomIDSQL},
@@ -74,31 +76,28 @@ func (s *roomAliasesStatements) prepare(db *sql.DB) (err error) {
 	}.prepare(db)
 }
 
-func (s *roomAliasesStatements) insertRoomAlias(
+func (s *roomAliasesStatements) InsertRoomAlias(
-	ctx context.Context, txn *sql.Tx, alias string, roomID string, creatorUserID string,
+	ctx context.Context, alias string, roomID string, creatorUserID string,
 ) (err error) {
-	insertStmt := internal.TxStmt(txn, s.insertRoomAliasStmt)
+	_, err = s.insertRoomAliasStmt.ExecContext(ctx, alias, roomID, creatorUserID)
-	_, err = insertStmt.ExecContext(ctx, alias, roomID, creatorUserID)
 	return
 }
 
-func (s *roomAliasesStatements) selectRoomIDFromAlias(
+func (s *roomAliasesStatements) SelectRoomIDFromAlias(
-	ctx context.Context, txn *sql.Tx, alias string,
+	ctx context.Context, alias string,
 ) (roomID string, err error) {
-	selectStmt := internal.TxStmt(txn, s.selectRoomIDFromAliasStmt)
+	err = s.selectRoomIDFromAliasStmt.QueryRowContext(ctx, alias).Scan(&roomID)
-	err = selectStmt.QueryRowContext(ctx, alias).Scan(&roomID)
 	if err == sql.ErrNoRows {
 		return "", nil
 	}
 	return
 }
 
-func (s *roomAliasesStatements) selectAliasesFromRoomID(
+func (s *roomAliasesStatements) SelectAliasesFromRoomID(
-	ctx context.Context, txn *sql.Tx, roomID string,
+	ctx context.Context, roomID string,
 ) (aliases []string, err error) {
 	aliases = []string{}
-	selectStmt := internal.TxStmt(txn, s.selectAliasesFromRoomIDStmt)
+	rows, err := s.selectAliasesFromRoomIDStmt.QueryContext(ctx, roomID)
-	rows, err := selectStmt.QueryContext(ctx, roomID)
 	if err != nil {
 		return
 	}
@@ -117,21 +116,19 @@ func (s *roomAliasesStatements) selectAliasesFromRoomID(
 	return
 }
 
-func (s *roomAliasesStatements) selectCreatorIDFromAlias(
+func (s *roomAliasesStatements) SelectCreatorIDFromAlias(
-	ctx context.Context, txn *sql.Tx, alias string,
+	ctx context.Context, alias string,
 ) (creatorID string, err error) {
-	selectStmt := internal.TxStmt(txn, s.selectCreatorIDFromAliasStmt)
+	err = s.selectCreatorIDFromAliasStmt.QueryRowContext(ctx, alias).Scan(&creatorID)
-	err = selectStmt.QueryRowContext(ctx, alias).Scan(&creatorID)
 	if err == sql.ErrNoRows {
 		return "", nil
 	}
 	return
 }
 
-func (s *roomAliasesStatements) deleteRoomAlias(
+func (s *roomAliasesStatements) DeleteRoomAlias(
-	ctx context.Context, txn *sql.Tx, alias string,
+	ctx context.Context, alias string,
 ) (err error) {
-	deleteStmt := internal.TxStmt(txn, s.deleteRoomAliasStmt)
+	_, err = s.deleteRoomAliasStmt.ExecContext(ctx, alias)
-	_, err = deleteStmt.ExecContext(ctx, alias)
 	return
 }

roomserver/storage/sqlite3/sql.go

@@ -38,8 +38,6 @@ func (s *statements) prepare(db *sql.DB) error {
 	var err error
 
 	for _, prepare := range []func(db *sql.DB) error{
-		s.previousEventStatements.prepare,
-		s.roomAliasesStatements.prepare,
 		s.inviteStatements.prepare,
 		s.membershipStatements.prepare,
 	} {

roomserver/storage/sqlite3/storage.go

@@ -41,10 +41,12 @@ type Database struct {
 	eventStateKeys tables.EventStateKeys
 	rooms          tables.Rooms
 	transactions   tables.Transactions
+	prevEvents     tables.PreviousEvents
 	db             *sql.DB
 }
 
 // Open a sqlite database.
+// nolint: gocyclo
 func Open(dataSourceName string) (*Database, error) {
 	var d Database
 	uri, err := url.Parse(dataSourceName)
@@ -105,6 +107,10 @@ func Open(dataSourceName string) (*Database, error) {
 	if err != nil {
 		return nil, err
 	}
+	d.prevEvents, err = NewSqlitePrevEventsTable(d.db)
+	if err != nil {
+		return nil, err
+	}
 	d.Database = shared.Database{
 		DB:                  d.db,
 		EventsTable:         d.events,
@@ -115,6 +121,7 @@ func Open(dataSourceName string) (*Database, error) {
 		TransactionsTable:   d.transactions,
 		StateBlockTable:     stateBlock,
 		StateSnapshotTable:  stateSnapshot,
+		PrevEventsTable:     d.prevEvents,
 	}
 	return &d, nil
 }
@@ -227,7 +234,7 @@ func (u *roomRecentEventsUpdater) CurrentStateSnapshotNID() types.StateSnapshotN
 func (u *roomRecentEventsUpdater) StorePreviousEvents(eventNID types.EventNID, previousEventReferences []gomatrixserverlib.EventReference) error {
 	err := internal.WithTransaction(u.d.db, func(txn *sql.Tx) error {
 		for _, ref := range previousEventReferences {
-			if err := u.d.statements.insertPreviousEvent(u.ctx, txn, ref.EventID, ref.EventSHA256, eventNID); err != nil {
+			if err := u.d.prevEvents.InsertPreviousEvent(u.ctx, txn, ref.EventID, ref.EventSHA256, eventNID); err != nil {
 				return err
 			}
 		}
@@ -239,7 +246,7 @@ func (u *roomRecentEventsUpdater) StorePreviousEvents(eventNID types.EventNID, p
 // IsReferenced implements types.RoomRecentEventsUpdater
 func (u *roomRecentEventsUpdater) IsReferenced(eventReference gomatrixserverlib.EventReference) (res bool, err error) {
 	err = internal.WithTransaction(u.d.db, func(txn *sql.Tx) error {
-		err := u.d.statements.selectPreviousEventExists(u.ctx, txn, eventReference.EventID, eventReference.EventSHA256)
+		err := u.d.prevEvents.SelectPreviousEventExists(u.ctx, txn, eventReference.EventID, eventReference.EventSHA256)
 		if err == nil {
 			res = true
 			err = nil
@@ -302,33 +309,6 @@ func (d *Database) GetInvitesForUser(
 	return d.statements.selectInviteActiveForUserInRoom(ctx, targetUserNID, roomNID)
 }
 
-// SetRoomAlias implements alias.RoomserverAliasAPIDB
-func (d *Database) SetRoomAlias(ctx context.Context, alias string, roomID string, creatorUserID string) error {
-	return d.statements.insertRoomAlias(ctx, nil, alias, roomID, creatorUserID)
-}
-
-// GetRoomIDForAlias implements alias.RoomserverAliasAPIDB
-func (d *Database) GetRoomIDForAlias(ctx context.Context, alias string) (string, error) {
-	return d.statements.selectRoomIDFromAlias(ctx, nil, alias)
-}
-
-// GetAliasesForRoomID implements alias.RoomserverAliasAPIDB
-func (d *Database) GetAliasesForRoomID(ctx context.Context, roomID string) ([]string, error) {
-	return d.statements.selectAliasesFromRoomID(ctx, nil, roomID)
-}
-
-// GetCreatorIDForAlias implements alias.RoomserverAliasAPIDB
-func (d *Database) GetCreatorIDForAlias(
-	ctx context.Context, alias string,
-) (string, error) {
-	return d.statements.selectCreatorIDFromAlias(ctx, nil, alias)
-}
-
-// RemoveRoomAlias implements alias.RoomserverAliasAPIDB
-func (d *Database) RemoveRoomAlias(ctx context.Context, alias string) error {
-	return d.statements.deleteRoomAlias(ctx, nil, alias)
-}
-
 // MembershipUpdater implements input.RoomEventDatabase
 func (d *Database) MembershipUpdater(
 	ctx context.Context, roomID, targetUserID string,

roomserver/storage/tables/interface.go

@@ -81,3 +81,18 @@ type StateBlock interface {
 	BulkSelectStateBlockEntries(ctx context.Context, stateBlockNIDs []types.StateBlockNID) ([]types.StateEntryList, error)
 	BulkSelectFilteredStateBlockEntries(ctx context.Context, stateBlockNIDs []types.StateBlockNID, stateKeyTuples []types.StateKeyTuple) ([]types.StateEntryList, error)
 }
+
+type RoomAliases interface {
+	InsertRoomAlias(ctx context.Context, alias string, roomID string, creatorUserID string) (err error)
+	SelectRoomIDFromAlias(ctx context.Context, alias string) (roomID string, err error)
+	SelectAliasesFromRoomID(ctx context.Context, roomID string) ([]string, error)
+	SelectCreatorIDFromAlias(ctx context.Context, alias string) (creatorID string, err error)
+	DeleteRoomAlias(ctx context.Context, alias string) (err error)
+}
+
+type PreviousEvents interface {
+	InsertPreviousEvent(ctx context.Context, txn *sql.Tx, previousEventID string, previousEventReferenceSHA256 []byte, eventNID types.EventNID) error
+	// Check if the event reference exists
+	// Returns sql.ErrNoRows if the event reference doesn't exist.
+	SelectPreviousEventExists(ctx context.Context, txn *sql.Tx, eventID string, eventReferenceSHA256 []byte) error
+}