mirror of
https://github.com/matrix-org/dendrite
synced 2024-09-08 20:25:36 +02:00
* Add housekeeping function to delete old/expired EDUs * Add migrations * Evict EDUs from cache * Fix queries * Fix upgrade * Use map[string]time.Duration to specify different expiry times * Fix copy & paste mistake * Set expires_at to tomorrow * Don't allow NULL * Add comment * Add tests * Use new testrig package * Fix migrations * Never expire m.direct_to_device Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com> Co-authored-by: kegsay <kegan@matrix.org>
265 lines
7.8 KiB
Go
265 lines
7.8 KiB
Go
// Copyright 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 sqlite3
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
|
|
"github.com/matrix-org/dendrite/federationapi/storage/sqlite3/deltas"
|
|
"github.com/matrix-org/dendrite/internal"
|
|
"github.com/matrix-org/dendrite/internal/sqlutil"
|
|
)
|
|
|
|
const queueEDUsSchema = `
|
|
CREATE TABLE IF NOT EXISTS federationsender_queue_edus (
|
|
-- The type of the event (informational).
|
|
edu_type TEXT NOT NULL,
|
|
-- The domain part of the user ID the EDU event is for.
|
|
server_name TEXT NOT NULL,
|
|
-- The JSON NID from the federationsender_queue_edus_json table.
|
|
json_nid BIGINT NOT NULL,
|
|
-- The expiry time of this edu, if any.
|
|
expires_at BIGINT NOT NULL DEFAULT 0
|
|
);
|
|
|
|
CREATE UNIQUE INDEX IF NOT EXISTS federationsender_queue_edus_json_nid_idx
|
|
ON federationsender_queue_edus (json_nid, server_name);
|
|
CREATE INDEX IF NOT EXISTS federationsender_queue_edus_nid_idx
|
|
ON federationsender_queue_edus (json_nid);
|
|
CREATE INDEX IF NOT EXISTS federationsender_queue_edus_server_name_idx
|
|
ON federationsender_queue_edus (server_name);
|
|
`
|
|
|
|
const insertQueueEDUSQL = "" +
|
|
"INSERT INTO federationsender_queue_edus (edu_type, server_name, json_nid, expires_at)" +
|
|
" VALUES ($1, $2, $3, $4)"
|
|
|
|
const deleteQueueEDUsSQL = "" +
|
|
"DELETE FROM federationsender_queue_edus WHERE server_name = $1 AND json_nid IN ($2)"
|
|
|
|
const selectQueueEDUSQL = "" +
|
|
"SELECT json_nid FROM federationsender_queue_edus" +
|
|
" WHERE server_name = $1" +
|
|
" LIMIT $2"
|
|
|
|
const selectQueueEDUReferenceJSONCountSQL = "" +
|
|
"SELECT COUNT(*) FROM federationsender_queue_edus" +
|
|
" WHERE json_nid = $1"
|
|
|
|
const selectQueueEDUCountSQL = "" +
|
|
"SELECT COUNT(*) FROM federationsender_queue_edus" +
|
|
" WHERE server_name = $1"
|
|
|
|
const selectQueueServerNamesSQL = "" +
|
|
"SELECT DISTINCT server_name FROM federationsender_queue_edus"
|
|
|
|
const selectExpiredEDUsSQL = "" +
|
|
"SELECT DISTINCT json_nid FROM federationsender_queue_edus WHERE expires_at > 0 AND expires_at <= $1"
|
|
|
|
const deleteExpiredEDUsSQL = "" +
|
|
"DELETE FROM federationsender_queue_edus WHERE expires_at > 0 AND expires_at <= $1"
|
|
|
|
type queueEDUsStatements struct {
|
|
db *sql.DB
|
|
insertQueueEDUStmt *sql.Stmt
|
|
// deleteQueueEDUStmt *sql.Stmt - prepared at runtime due to variadic
|
|
selectQueueEDUStmt *sql.Stmt
|
|
selectQueueEDUReferenceJSONCountStmt *sql.Stmt
|
|
selectQueueEDUCountStmt *sql.Stmt
|
|
selectQueueEDUServerNamesStmt *sql.Stmt
|
|
selectExpiredEDUsStmt *sql.Stmt
|
|
deleteExpiredEDUsStmt *sql.Stmt
|
|
}
|
|
|
|
func NewSQLiteQueueEDUsTable(db *sql.DB) (s *queueEDUsStatements, err error) {
|
|
s = &queueEDUsStatements{
|
|
db: db,
|
|
}
|
|
_, err = db.Exec(queueEDUsSchema)
|
|
if err != nil {
|
|
return s, err
|
|
}
|
|
|
|
m := sqlutil.NewMigrator(db)
|
|
m.AddMigrations(
|
|
sqlutil.Migration{
|
|
Version: "federationapi: add expiresat column",
|
|
Up: deltas.UpAddexpiresat,
|
|
},
|
|
)
|
|
if err := m.Up(context.Background()); err != nil {
|
|
return s, err
|
|
}
|
|
|
|
return s, nil
|
|
}
|
|
|
|
func (s *queueEDUsStatements) Prepare() error {
|
|
return sqlutil.StatementList{
|
|
{&s.insertQueueEDUStmt, insertQueueEDUSQL},
|
|
{&s.selectQueueEDUStmt, selectQueueEDUSQL},
|
|
{&s.selectQueueEDUReferenceJSONCountStmt, selectQueueEDUReferenceJSONCountSQL},
|
|
{&s.selectQueueEDUCountStmt, selectQueueEDUCountSQL},
|
|
{&s.selectQueueEDUServerNamesStmt, selectQueueServerNamesSQL},
|
|
{&s.selectExpiredEDUsStmt, selectExpiredEDUsSQL},
|
|
{&s.deleteExpiredEDUsStmt, deleteExpiredEDUsSQL},
|
|
}.Prepare(s.db)
|
|
}
|
|
|
|
func (s *queueEDUsStatements) InsertQueueEDU(
|
|
ctx context.Context,
|
|
txn *sql.Tx,
|
|
eduType string,
|
|
serverName gomatrixserverlib.ServerName,
|
|
nid int64,
|
|
expiresAt gomatrixserverlib.Timestamp,
|
|
) error {
|
|
stmt := sqlutil.TxStmt(txn, s.insertQueueEDUStmt)
|
|
_, err := stmt.ExecContext(
|
|
ctx,
|
|
eduType, // the EDU type
|
|
serverName, // destination server name
|
|
nid, // JSON blob NID
|
|
expiresAt, // timestamp of expiry
|
|
)
|
|
return err
|
|
}
|
|
|
|
func (s *queueEDUsStatements) DeleteQueueEDUs(
|
|
ctx context.Context, txn *sql.Tx,
|
|
serverName gomatrixserverlib.ServerName,
|
|
jsonNIDs []int64,
|
|
) error {
|
|
deleteSQL := strings.Replace(deleteQueueEDUsSQL, "($2)", sqlutil.QueryVariadicOffset(len(jsonNIDs), 1), 1)
|
|
deleteStmt, err := txn.Prepare(deleteSQL)
|
|
if err != nil {
|
|
return fmt.Errorf("s.deleteQueueJSON s.db.Prepare: %w", err)
|
|
}
|
|
|
|
params := make([]interface{}, len(jsonNIDs)+1)
|
|
params[0] = serverName
|
|
for k, v := range jsonNIDs {
|
|
params[k+1] = v
|
|
}
|
|
|
|
stmt := sqlutil.TxStmt(txn, deleteStmt)
|
|
_, err = stmt.ExecContext(ctx, params...)
|
|
return err
|
|
}
|
|
|
|
func (s *queueEDUsStatements) SelectQueueEDUs(
|
|
ctx context.Context, txn *sql.Tx,
|
|
serverName gomatrixserverlib.ServerName,
|
|
limit int,
|
|
) ([]int64, error) {
|
|
stmt := sqlutil.TxStmt(txn, s.selectQueueEDUStmt)
|
|
rows, err := stmt.QueryContext(ctx, serverName, limit)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "queueFromStmt: rows.close() failed")
|
|
var result []int64
|
|
for rows.Next() {
|
|
var nid int64
|
|
if err = rows.Scan(&nid); err != nil {
|
|
return nil, err
|
|
}
|
|
result = append(result, nid)
|
|
}
|
|
return result, rows.Err()
|
|
}
|
|
|
|
func (s *queueEDUsStatements) SelectQueueEDUReferenceJSONCount(
|
|
ctx context.Context, txn *sql.Tx, jsonNID int64,
|
|
) (int64, error) {
|
|
var count int64
|
|
stmt := sqlutil.TxStmt(txn, s.selectQueueEDUReferenceJSONCountStmt)
|
|
err := stmt.QueryRowContext(ctx, jsonNID).Scan(&count)
|
|
if err == sql.ErrNoRows {
|
|
return -1, nil
|
|
}
|
|
return count, err
|
|
}
|
|
|
|
func (s *queueEDUsStatements) SelectQueueEDUCount(
|
|
ctx context.Context, txn *sql.Tx, serverName gomatrixserverlib.ServerName,
|
|
) (int64, error) {
|
|
var count int64
|
|
stmt := sqlutil.TxStmt(txn, s.selectQueueEDUCountStmt)
|
|
err := stmt.QueryRowContext(ctx, serverName).Scan(&count)
|
|
if err == sql.ErrNoRows {
|
|
// It's acceptable for there to be no rows referencing a given
|
|
// JSON NID but it's not an error condition. Just return as if
|
|
// there's a zero count.
|
|
return 0, nil
|
|
}
|
|
return count, err
|
|
}
|
|
|
|
func (s *queueEDUsStatements) SelectQueueEDUServerNames(
|
|
ctx context.Context, txn *sql.Tx,
|
|
) ([]gomatrixserverlib.ServerName, error) {
|
|
stmt := sqlutil.TxStmt(txn, s.selectQueueEDUServerNamesStmt)
|
|
rows, err := stmt.QueryContext(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "queueFromStmt: rows.close() failed")
|
|
var result []gomatrixserverlib.ServerName
|
|
for rows.Next() {
|
|
var serverName gomatrixserverlib.ServerName
|
|
if err = rows.Scan(&serverName); err != nil {
|
|
return nil, err
|
|
}
|
|
result = append(result, serverName)
|
|
}
|
|
|
|
return result, rows.Err()
|
|
}
|
|
|
|
func (s *queueEDUsStatements) SelectExpiredEDUs(
|
|
ctx context.Context, txn *sql.Tx,
|
|
expiredBefore gomatrixserverlib.Timestamp,
|
|
) ([]int64, error) {
|
|
stmt := sqlutil.TxStmt(txn, s.selectExpiredEDUsStmt)
|
|
rows, err := stmt.QueryContext(ctx, expiredBefore)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "SelectExpiredEDUs: rows.close() failed")
|
|
var result []int64
|
|
var nid int64
|
|
for rows.Next() {
|
|
if err = rows.Scan(&nid); err != nil {
|
|
return nil, err
|
|
}
|
|
result = append(result, nid)
|
|
}
|
|
return result, rows.Err()
|
|
}
|
|
|
|
func (s *queueEDUsStatements) DeleteExpiredEDUs(
|
|
ctx context.Context, txn *sql.Tx,
|
|
expiredBefore gomatrixserverlib.Timestamp,
|
|
) error {
|
|
stmt := sqlutil.TxStmt(txn, s.deleteExpiredEDUsStmt)
|
|
_, err := stmt.ExecContext(ctx, expiredBefore)
|
|
return err
|
|
}
|