d5dbe546e4
* Always defer *sql.Rows.Close and consult with Err database/sql.Rows.Next() makes sure to call Close only after exhausting result rows which would NOT happen when returning early from a bad Scan. Close being idempotent makes it a great candidate to get always deferred regardless of what happens later on the result set. This change also makes sure call Err() after exhausting Next() and propagate non-nil results from it as the documentation advises. Closes #764 Signed-off-by: Kiril Vladimiroff <kiril@vladimiroff.org> * Override named result parameters in last returns Signed-off-by: Kiril Vladimiroff <kiril@vladimiroff.org> * Do the same over new changes that got merged Signed-off-by: Kiril Vladimiroff <kiril@vladimiroff.org> Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com>
122 lines
4.3 KiB
Go
122 lines
4.3 KiB
Go
// Copyright 2017-2018 New Vector Ltd
|
|
// Copyright 2019-2020 The Matrix.org Foundation C.I.C.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package postgres
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
|
|
"github.com/lib/pq"
|
|
"github.com/matrix-org/dendrite/roomserver/types"
|
|
)
|
|
|
|
const stateSnapshotSchema = `
|
|
-- The state of a room before an event.
|
|
-- Stored as a list of state_block entries stored in a separate table.
|
|
-- The actual state is constructed by combining all the state_block entries
|
|
-- referenced by state_block_nids together. If the same state key tuple appears
|
|
-- multiple times then the entry from the later state_block clobbers the earlier
|
|
-- entries.
|
|
-- This encoding format allows us to implement a delta encoding which is useful
|
|
-- because room state tends to accumulate small changes over time. Although if
|
|
-- the list of deltas becomes too long it becomes more efficient to encode
|
|
-- the full state under single state_block_nid.
|
|
CREATE SEQUENCE IF NOT EXISTS roomserver_state_snapshot_nid_seq;
|
|
CREATE TABLE IF NOT EXISTS roomserver_state_snapshots (
|
|
-- Local numeric ID for the state.
|
|
state_snapshot_nid bigint PRIMARY KEY DEFAULT nextval('roomserver_state_snapshot_nid_seq'),
|
|
-- Local numeric ID of the room this state is for.
|
|
-- Unused in normal operation, but useful for background work or ad-hoc debugging.
|
|
room_nid bigint NOT NULL,
|
|
-- List of state_block_nids, stored sorted by state_block_nid.
|
|
state_block_nids bigint[] NOT NULL
|
|
);
|
|
`
|
|
|
|
const insertStateSQL = "" +
|
|
"INSERT INTO roomserver_state_snapshots (room_nid, state_block_nids)" +
|
|
" VALUES ($1, $2)" +
|
|
" RETURNING state_snapshot_nid"
|
|
|
|
// Bulk state data NID lookup.
|
|
// Sorting by state_snapshot_nid means we can use binary search over the result
|
|
// to lookup the state data NIDs for a state snapshot NID.
|
|
const bulkSelectStateBlockNIDsSQL = "" +
|
|
"SELECT state_snapshot_nid, state_block_nids FROM roomserver_state_snapshots" +
|
|
" WHERE state_snapshot_nid = ANY($1) ORDER BY state_snapshot_nid ASC"
|
|
|
|
type stateSnapshotStatements struct {
|
|
insertStateStmt *sql.Stmt
|
|
bulkSelectStateBlockNIDsStmt *sql.Stmt
|
|
}
|
|
|
|
func (s *stateSnapshotStatements) prepare(db *sql.DB) (err error) {
|
|
_, err = db.Exec(stateSnapshotSchema)
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
return statementList{
|
|
{&s.insertStateStmt, insertStateSQL},
|
|
{&s.bulkSelectStateBlockNIDsStmt, bulkSelectStateBlockNIDsSQL},
|
|
}.prepare(db)
|
|
}
|
|
|
|
func (s *stateSnapshotStatements) insertState(
|
|
ctx context.Context, roomNID types.RoomNID, stateBlockNIDs []types.StateBlockNID,
|
|
) (stateNID types.StateSnapshotNID, err error) {
|
|
nids := make([]int64, len(stateBlockNIDs))
|
|
for i := range stateBlockNIDs {
|
|
nids[i] = int64(stateBlockNIDs[i])
|
|
}
|
|
err = s.insertStateStmt.QueryRowContext(ctx, int64(roomNID), pq.Int64Array(nids)).Scan(&stateNID)
|
|
return
|
|
}
|
|
|
|
func (s *stateSnapshotStatements) bulkSelectStateBlockNIDs(
|
|
ctx context.Context, stateNIDs []types.StateSnapshotNID,
|
|
) ([]types.StateBlockNIDList, error) {
|
|
nids := make([]int64, len(stateNIDs))
|
|
for i := range stateNIDs {
|
|
nids[i] = int64(stateNIDs[i])
|
|
}
|
|
rows, err := s.bulkSelectStateBlockNIDsStmt.QueryContext(ctx, pq.Int64Array(nids))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer rows.Close() // nolint: errcheck
|
|
results := make([]types.StateBlockNIDList, len(stateNIDs))
|
|
i := 0
|
|
for ; rows.Next(); i++ {
|
|
result := &results[i]
|
|
var stateBlockNIDs pq.Int64Array
|
|
if err = rows.Scan(&result.StateSnapshotNID, &stateBlockNIDs); err != nil {
|
|
return nil, err
|
|
}
|
|
result.StateBlockNIDs = make([]types.StateBlockNID, len(stateBlockNIDs))
|
|
for k := range stateBlockNIDs {
|
|
result.StateBlockNIDs[k] = types.StateBlockNID(stateBlockNIDs[k])
|
|
}
|
|
}
|
|
if err = rows.Err(); err != nil {
|
|
return nil, err
|
|
}
|
|
if i != len(stateNIDs) {
|
|
return nil, fmt.Errorf("storage: state NIDs missing from the database (%d != %d)", i, len(stateNIDs))
|
|
}
|
|
return results, nil
|
|
}
|