2020-07-20 15:55:20 +00:00
|
|
|
// 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 shared
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"database/sql"
|
|
|
|
"encoding/json"
|
|
|
|
"errors"
|
|
|
|
"fmt"
|
|
|
|
|
2023-01-23 17:55:12 +00:00
|
|
|
"github.com/matrix-org/dendrite/federationapi/storage/shared/receipt"
|
2023-04-27 11:54:20 +00:00
|
|
|
"github.com/matrix-org/dendrite/roomserver/types"
|
2023-04-19 14:50:33 +00:00
|
|
|
"github.com/matrix-org/gomatrixserverlib/spec"
|
2020-07-20 15:55:20 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// AssociatePDUWithDestination creates an association that the
|
|
|
|
// destination queues will use to determine which JSON blobs to send
|
|
|
|
// to which servers.
|
2022-10-21 10:50:51 +00:00
|
|
|
func (d *Database) AssociatePDUWithDestinations(
|
2020-07-20 15:55:20 +00:00
|
|
|
ctx context.Context,
|
2023-04-19 14:50:33 +00:00
|
|
|
destinations map[spec.ServerName]struct{},
|
2023-01-23 17:55:12 +00:00
|
|
|
dbReceipt *receipt.Receipt,
|
2020-07-20 15:55:20 +00:00
|
|
|
) error {
|
2020-08-27 10:05:41 +00:00
|
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
2022-10-21 10:50:51 +00:00
|
|
|
var err error
|
|
|
|
for destination := range destinations {
|
|
|
|
err = d.FederationQueuePDUs.InsertQueuePDU(
|
2023-01-23 17:55:12 +00:00
|
|
|
ctx, // context
|
|
|
|
txn, // SQL transaction
|
|
|
|
"", // transaction ID
|
|
|
|
destination, // destination server name
|
|
|
|
dbReceipt.GetNID(), // NID from the federationapi_queue_json table
|
2022-10-21 10:50:51 +00:00
|
|
|
)
|
2020-07-20 15:55:20 +00:00
|
|
|
}
|
2022-10-21 10:50:51 +00:00
|
|
|
return err
|
2020-07-20 15:55:20 +00:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetNextTransactionPDUs retrieves events from the database for
|
|
|
|
// the next pending transaction, up to the limit specified.
|
2020-12-09 10:03:22 +00:00
|
|
|
func (d *Database) GetPendingPDUs(
|
2020-07-20 15:55:20 +00:00
|
|
|
ctx context.Context,
|
2023-04-19 14:50:33 +00:00
|
|
|
serverName spec.ServerName,
|
2020-07-20 15:55:20 +00:00
|
|
|
limit int,
|
|
|
|
) (
|
2023-04-27 11:54:20 +00:00
|
|
|
events map[*receipt.Receipt]*types.HeaderedEvent,
|
2020-07-20 15:55:20 +00:00
|
|
|
err error,
|
|
|
|
) {
|
2020-08-27 14:27:12 +00:00
|
|
|
// Strictly speaking this doesn't need to be using the writer
|
|
|
|
// since we are only performing selects, but since we don't have
|
|
|
|
// a guarantee of transactional isolation, it's actually useful
|
|
|
|
// to know in SQLite mode that nothing else is trying to modify
|
|
|
|
// the database.
|
2023-04-27 11:54:20 +00:00
|
|
|
events = make(map[*receipt.Receipt]*types.HeaderedEvent)
|
2020-08-27 14:27:12 +00:00
|
|
|
err = d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
2021-11-24 10:45:23 +00:00
|
|
|
nids, err := d.FederationQueuePDUs.SelectQueuePDUs(ctx, txn, serverName, limit)
|
2020-07-20 15:55:20 +00:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("SelectQueuePDUs: %w", err)
|
|
|
|
}
|
|
|
|
|
2020-12-04 14:52:10 +00:00
|
|
|
retrieve := make([]int64, 0, len(nids))
|
|
|
|
for _, nid := range nids {
|
2021-11-24 10:45:23 +00:00
|
|
|
if event, ok := d.Cache.GetFederationQueuedPDU(nid); ok {
|
2023-01-23 17:55:12 +00:00
|
|
|
newReceipt := receipt.NewReceipt(nid)
|
|
|
|
events[&newReceipt] = event
|
2020-12-04 14:52:10 +00:00
|
|
|
} else {
|
|
|
|
retrieve = append(retrieve, nid)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-11-24 10:45:23 +00:00
|
|
|
blobs, err := d.FederationQueueJSON.SelectQueueJSON(ctx, txn, retrieve)
|
2020-07-20 15:55:20 +00:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("SelectQueueJSON: %w", err)
|
|
|
|
}
|
|
|
|
|
2020-12-04 14:52:10 +00:00
|
|
|
for nid, blob := range blobs {
|
2023-04-27 11:54:20 +00:00
|
|
|
var event types.HeaderedEvent
|
2020-07-20 15:55:20 +00:00
|
|
|
if err := json.Unmarshal(blob, &event); err != nil {
|
|
|
|
return fmt.Errorf("json.Unmarshal: %w", err)
|
|
|
|
}
|
2023-01-23 17:55:12 +00:00
|
|
|
newReceipt := receipt.NewReceipt(nid)
|
|
|
|
events[&newReceipt] = &event
|
2021-11-24 10:45:23 +00:00
|
|
|
d.Cache.StoreFederationQueuedPDU(nid, &event)
|
2020-07-20 15:55:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
})
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// CleanTransactionPDUs cleans up all associated events for a
|
|
|
|
// given transaction. This is done when the transaction was sent
|
|
|
|
// successfully.
|
|
|
|
func (d *Database) CleanPDUs(
|
|
|
|
ctx context.Context,
|
2023-04-19 14:50:33 +00:00
|
|
|
serverName spec.ServerName,
|
2023-01-23 17:55:12 +00:00
|
|
|
receipts []*receipt.Receipt,
|
2020-07-20 15:55:20 +00:00
|
|
|
) error {
|
2020-12-09 10:03:22 +00:00
|
|
|
if len(receipts) == 0 {
|
2020-07-20 15:55:20 +00:00
|
|
|
return errors.New("expected receipt")
|
|
|
|
}
|
|
|
|
|
2020-12-09 10:03:22 +00:00
|
|
|
nids := make([]int64, len(receipts))
|
|
|
|
for i := range receipts {
|
2023-01-23 17:55:12 +00:00
|
|
|
nids[i] = receipts[i].GetNID()
|
2020-12-09 10:03:22 +00:00
|
|
|
}
|
|
|
|
|
2020-08-27 10:05:41 +00:00
|
|
|
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
|
2021-11-24 10:45:23 +00:00
|
|
|
if err := d.FederationQueuePDUs.DeleteQueuePDUs(ctx, txn, serverName, nids); err != nil {
|
2020-07-20 15:55:20 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
var deleteNIDs []int64
|
2020-12-09 10:03:22 +00:00
|
|
|
for _, nid := range nids {
|
2021-11-24 10:45:23 +00:00
|
|
|
count, err := d.FederationQueuePDUs.SelectQueuePDUReferenceJSONCount(ctx, txn, nid)
|
2020-07-20 15:55:20 +00:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("SelectQueuePDUReferenceJSONCount: %w", err)
|
|
|
|
}
|
|
|
|
if count == 0 {
|
|
|
|
deleteNIDs = append(deleteNIDs, nid)
|
2021-11-24 10:45:23 +00:00
|
|
|
d.Cache.EvictFederationQueuedPDU(nid)
|
2020-07-20 15:55:20 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(deleteNIDs) > 0 {
|
2021-11-24 10:45:23 +00:00
|
|
|
if err := d.FederationQueueJSON.DeleteQueueJSON(ctx, txn, deleteNIDs); err != nil {
|
2020-07-20 15:55:20 +00:00
|
|
|
return fmt.Errorf("DeleteQueueJSON: %w", err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetPendingServerNames returns the server names that have PDUs
|
|
|
|
// waiting to be sent.
|
|
|
|
func (d *Database) GetPendingPDUServerNames(
|
|
|
|
ctx context.Context,
|
2023-04-19 14:50:33 +00:00
|
|
|
) ([]spec.ServerName, error) {
|
2021-11-24 10:45:23 +00:00
|
|
|
return d.FederationQueuePDUs.SelectQueuePDUServerNames(ctx, nil)
|
2020-07-20 15:55:20 +00:00
|
|
|
}
|