mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2026-01-11 16:13:10 -06:00
Code Issues Packages Projects Releases Wiki Activity

PR review comments, return existing key on conflict

Browse source
This commit is contained in:
Till Faelligen 2023-06-02 16:41:11 +02:00
parent acdb93b489
commit 0b70eead27
No known key found for this signature in database
GPG key ID: ACCDC9606D472758
7 changed files with 63 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
roomserver/storage/interface.go
View file

@ -190,7 +190,7 @@ type Database interface {
ctx context.Context, roomInfo *types.RoomInfo, eventNID types.EventNID, event gomatrixserverlib.PDU, plResolver state.PowerLevelResolver,
) (gomatrixserverlib.PDU, gomatrixserverlib.PDU, error)
InsertUserRoomKey(ctx context.Context, userNID types.EventStateKeyNID, roomNID types.RoomNID, key ed25519.PrivateKey) error
InsertUserRoomKey(ctx context.Context, userNID types.EventStateKeyNID, roomNID types.RoomNID, key ed25519.PrivateKey) (result ed25519.PrivateKey, err error)
SelectUserRoomKey(ctx context.Context, userNID types.EventStateKeyNID, roomNID types.RoomNID) (key ed25519.PrivateKey, err error)
}

19
roomserver/storage/postgres/user_room_keys_table.go
View file

@ -18,8 +18,8 @@ import (
"context"
"crypto/ed25519"
"database/sql"
"errors"
"github.com/matrix-org/dendrite/internal"
"github.com/matrix-org/dendrite/internal/sqlutil"
"github.com/matrix-org/dendrite/roomserver/storage/tables"
"github.com/matrix-org/dendrite/roomserver/types"
@ -34,7 +34,11 @@ CREATE TABLE IF NOT EXISTS roomserver_user_room_keys (
);
`
const insertUserRoomKeySQL = `INSERT INTO roomserver_user_room_keys (user_nid, room_nid, pseudo_id_key) VALUES ($1, $2, $3)`
const insertUserRoomKeySQL = `
INSERT INTO roomserver_user_room_keys (user_nid, room_nid, pseudo_id_key) VALUES ($1, $2, $3)
ON CONFLICT ON CONSTRAINT roomserver_user_room_keys_pk DO UPDATE SET pseudo_id_key = roomserver_user_room_keys.pseudo_id_key
RETURNING (pseudo_id_key)
`
const selectUserRoomKeySQL = `SELECT pseudo_id_key FROM roomserver_user_room_keys WHERE user_nid = $1 AND room_nid = $2`
type userRoomKeysStatements struct {
@ -61,11 +65,10 @@ func (s *userRoomKeysStatements) InsertUserRoomKey(
userNID types.EventStateKeyNID,
roomNID types.RoomNID,
key ed25519.PrivateKey,
) error {
) (result ed25519.PrivateKey, err error) {
stmt := sqlutil.TxStmtContext(ctx, txn, s.insertUserRoomKeyStmt)
defer internal.CloseAndLogIfError(ctx, stmt, "failed to close statement")
_, err := stmt.ExecContext(ctx, userNID, roomNID, key)
return err
err = stmt.QueryRowContext(ctx, userNID, roomNID, key).Scan(&result)
return result, err
}
func (s *userRoomKeysStatements) SelectUserRoomKey(
@ -75,8 +78,10 @@ func (s *userRoomKeysStatements) SelectUserRoomKey(
roomNID types.RoomNID,
) (ed25519.PrivateKey, error) {
stmt := sqlutil.TxStmtContext(ctx, txn, s.selectUserRoomKeyStmt)
defer internal.CloseAndLogIfError(ctx, stmt, "failed to close statement")
var result ed25519.PrivateKey
err := stmt.QueryRowContext(ctx, userNID, roomNID).Scan(&result)
if errors.Is(err, sql.ErrNoRows) {
return nil, nil
}
return result, err
}

21
roomserver/storage/shared/storage.go
View file

@ -5,6 +5,7 @@ import (
"crypto/ed25519"
"database/sql"
"encoding/json"
"errors"
"fmt"
"sort"
@ -1592,21 +1593,25 @@ func (d *Database) UpgradeRoom(ctx context.Context, oldRoomID, newRoomID, eventS
}
// InsertUserRoomKey inserts a new user room key for the given user and room.
// Returns an error if a database error occurred, also if the primary constraint was violated.
func (d *Database) InsertUserRoomKey(ctx context.Context, userNID types.EventStateKeyNID, roomNID types.RoomNID, key ed25519.PrivateKey) error {
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
return d.UserRoomKeyTable.InsertUserRoomKey(ctx, txn, userNID, roomNID, key)
// Returns the newly inserted private key or an existing private key. If there is
// an error talking to the database, returns that error.
func (d *Database) InsertUserRoomKey(ctx context.Context, userNID types.EventStateKeyNID, roomNID types.RoomNID, key ed25519.PrivateKey) (result ed25519.PrivateKey, err error) {
err = d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
var iErr error
result, iErr = d.UserRoomKeyTable.InsertUserRoomKey(ctx, txn, userNID, roomNID, key)
return iErr
})
return result, err
}
// SelectUserRoomKey queries the user room key for a given user.
// Returns the key and an error.
// TODO: should we handle absent keys (sql.ErrNoRows) as non-fatal?
// SelectUserRoomKey queries the users room private key.
// If no key exists, returns no key and no error. Otherwise returns
// the key and a database error, if any.
func (d *Database) SelectUserRoomKey(ctx context.Context, userNID types.EventStateKeyNID, roomNID types.RoomNID) (key ed25519.PrivateKey, err error) {
err = d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
var sErr error
key, sErr = d.UserRoomKeyTable.SelectUserRoomKey(ctx, txn, userNID, roomNID)
if sErr != nil {
if !errors.Is(sErr, sql.ErrNoRows) {
return sErr
}
return nil

20
roomserver/storage/shared/storage_test.go
View file

@ -120,19 +120,23 @@ func TestUserRoomKeys(t *testing.T) {
_, key, err := ed25519.GenerateKey(nil)
assert.NoError(t, err)
err = db.InsertUserRoomKey(ctx, userNID, roomNID, key)
gotKey, err := db.InsertUserRoomKey(ctx, userNID, roomNID, key)
assert.NoError(t, err)
assert.Equal(t, gotKey, key)
// again, this should result in an error now, due to the primary key on userNID/roomNID
err = db.InsertUserRoomKey(context.Background(), userNID, roomNID, key)
assert.Error(t, err)
// again, this shouldn't result in an error, but return the existing key
_, key2, err := ed25519.GenerateKey(nil)
gotKey, err = db.InsertUserRoomKey(context.Background(), userNID, roomNID, key2)
assert.NoError(t, err)
assert.Equal(t, gotKey, key)
gotKey, err := db.SelectUserRoomKey(context.Background(), userNID, roomNID)
gotKey, err = db.SelectUserRoomKey(context.Background(), userNID, roomNID)
assert.NoError(t, err)
assert.Equal(t, key, gotKey)
// Key doesn't exist
_, err = db.SelectUserRoomKey(context.Background(), userNID, 2)
assert.Error(t, err)
// Key doesn't exist, we shouldn't get anything back
gotKey, err = db.SelectUserRoomKey(context.Background(), userNID, 2)
assert.NoError(t, err)
assert.Nil(t, gotKey)
})
}

19
roomserver/storage/sqlite3/user_room_keys_table.go
View file

@ -18,8 +18,8 @@ import (
"context"
"crypto/ed25519"
"database/sql"
"errors"
"github.com/matrix-org/dendrite/internal"
"github.com/matrix-org/dendrite/internal/sqlutil"
"github.com/matrix-org/dendrite/roomserver/storage/tables"
"github.com/matrix-org/dendrite/roomserver/types"
@ -34,7 +34,11 @@ CREATE TABLE IF NOT EXISTS roomserver_user_room_keys (
);
`
const insertUserRoomKeySQL = `INSERT INTO roomserver_user_room_keys (user_nid, room_nid, pseudo_id_key) VALUES ($1, $2, $3)`
const insertUserRoomKeySQL = `
INSERT INTO roomserver_user_room_keys (user_nid, room_nid, pseudo_id_key) VALUES ($1, $2, $3)
ON CONFLICT DO UPDATE SET pseudo_id_key = roomserver_user_room_keys.pseudo_id_key
RETURNING (pseudo_id_key)
`
const selectUserRoomKeySQL = `SELECT pseudo_id_key FROM roomserver_user_room_keys WHERE user_nid = $1 AND room_nid = $2`
type userRoomKeysStatements struct {
@ -61,11 +65,10 @@ func (s *userRoomKeysStatements) InsertUserRoomKey(
userNID types.EventStateKeyNID,
roomNID types.RoomNID,
key ed25519.PrivateKey,
) error {
) (result ed25519.PrivateKey, err error) {
stmt := sqlutil.TxStmtContext(ctx, txn, s.insertUserRoomKeyStmt)
defer internal.CloseAndLogIfError(ctx, stmt, "failed to close statement")
_, err := stmt.ExecContext(ctx, userNID, roomNID, key)
return err
err = stmt.QueryRowContext(ctx, userNID, roomNID, key).Scan(&result)
return result, err
}
func (s *userRoomKeysStatements) SelectUserRoomKey(
@ -75,8 +78,10 @@ func (s *userRoomKeysStatements) SelectUserRoomKey(
roomNID types.RoomNID,
) (ed25519.PrivateKey, error) {
stmt := sqlutil.TxStmtContext(ctx, txn, s.selectUserRoomKeyStmt)
defer internal.CloseAndLogIfError(ctx, stmt, "failed to close statement")
var result ed25519.PrivateKey
err := stmt.QueryRowContext(ctx, userNID, roomNID).Scan(&result)
if errors.Is(err, sql.ErrNoRows) {
return nil, nil
}
return result, err
}

2
roomserver/storage/tables/interface.go
View file

@ -186,7 +186,7 @@ type Purge interface {
}
type UserRoomKeys interface {
InsertUserRoomKey(ctx context.Context, txn *sql.Tx, userNID types.EventStateKeyNID, roomNID types.RoomNID, key ed25519.PrivateKey) error
InsertUserRoomKey(ctx context.Context, txn *sql.Tx, userNID types.EventStateKeyNID, roomNID types.RoomNID, key ed25519.PrivateKey) (ed25519.PrivateKey, error)
SelectUserRoomKey(ctx context.Context, txn *sql.Tx, userNID types.EventStateKeyNID, roomNID types.RoomNID) (ed25519.PrivateKey, error)
}

19
roomserver/storage/tables/user_room_keys_table_test.go
View file

@ -45,18 +45,23 @@ func TestUserRoomKeysTable(t *testing.T) {
roomNID := types.RoomNID(1)
_, key, err := ed25519.GenerateKey(nil)
assert.NoError(t, err)
err = tab.InsertUserRoomKey(context.Background(), nil, userNID, roomNID, key)
gotKey, err := tab.InsertUserRoomKey(context.Background(), nil, userNID, roomNID, key)
assert.NoError(t, err)
// again, this should result in an error now, due to the primary key on userNID/roomNID
err = tab.InsertUserRoomKey(context.Background(), nil, userNID, roomNID, key)
assert.Error(t, err)
assert.Equal(t, gotKey, key)
gotKey, err := tab.SelectUserRoomKey(context.Background(), nil, userNID, roomNID)
// again, this shouldn't result in an error, but return the existing key
_, key2, err := ed25519.GenerateKey(nil)
gotKey, err = tab.InsertUserRoomKey(context.Background(), nil, userNID, roomNID, key2)
assert.NoError(t, err)
assert.Equal(t, gotKey, key)
gotKey, err = tab.SelectUserRoomKey(context.Background(), nil, userNID, roomNID)
assert.NoError(t, err)
assert.Equal(t, key, gotKey)
// Key doesn't exist
_, err = tab.SelectUserRoomKey(context.Background(), nil, userNID, 2)
assert.Error(t, err)
gotKey, err = tab.SelectUserRoomKey(context.Background(), nil, userNID, 2)
assert.NoError(t, err)
assert.Nil(t, gotKey)
})
}