Optimize inserting pending PDUs/EDUs
This optimizes the association of PDUs/EDUs to their destination by
inserting all destinations in one transaction.
MODIFY
federationapi/queue/destinationqueue.go
federationapi/queue/destinationqueue.go
@@ -76,21 +76,6 @@ func (oq *destinationQueue) sendEvent(event *gomatrixserverlib.HeaderedEvent, re
return
}
- // Create a database entry that associates the given PDU NID with
- // this destination queue. We'll then be able to retrieve the PDU
- // later.
- if err := oq.db.AssociatePDUWithDestination(
- oq.process.Context(),
- "", // TODO: remove this, as we don't need to persist the transaction ID
- oq.destination, // the destination server name
- receipt, // NIDs from federationapi_queue_json table
- ); err != nil {
- logrus.WithError(err).Errorf("failed to associate PDU %q with destination %q", event.EventID(), oq.destination)
- return
- }
- // Check if the destination is blacklisted. If it isn't then wake
- // up the queue.
- if !oq.statistics.Blacklisted() {
// If there's room in memory to hold the event then add it to the
// list.
oq.pendingMutex.Lock()
@@ -107,9 +92,6 @@ func (oq *destinationQueue) sendEvent(event *gomatrixserverlib.HeaderedEvent, re
if !oq.backingOff.Load() {
oq.wakeQueueAndNotify()
}
- } else {
- oq.overflowed.Store(true)
- }
}
// sendEDU adds the EDU event to the pending queue for the destination.
@@ -120,22 +102,7 @@ func (oq *destinationQueue) sendEDU(event *gomatrixserverlib.EDU, receipt *share
logrus.Errorf("attempt to send nil EDU with destination %q", oq.destination)
return
}
- // Create a database entry that associates the given PDU NID with
- // this destination queue. We'll then be able to retrieve the PDU
- // later.
- if err := oq.db.AssociateEDUWithDestination(
- oq.process.Context(),
- oq.destination, // the destination server name
- receipt, // NIDs from federationapi_queue_json table
- event.Type,
- nil, // this will use the default expireEDUTypes map
- ); err != nil {
- logrus.WithError(err).Errorf("failed to associate EDU with destination %q", oq.destination)
- return
- }
- // Check if the destination is blacklisted. If it isn't then wake
- // up the queue.
- if !oq.statistics.Blacklisted() {
+
// If there's room in memory to hold the event then add it to the
// list.
oq.pendingMutex.Lock()
@@ -152,9 +119,6 @@ func (oq *destinationQueue) sendEDU(event *gomatrixserverlib.EDU, receipt *share
if !oq.backingOff.Load() {
oq.wakeQueueAndNotify()
}
- } else {
- oq.overflowed.Store(true)
- }
}
// handleBackoffNotifier is registered as the backoff notification

MODIFY
federationapi/queue/queue.go
federationapi/queue/queue.go
@@ -24,6 +24,7 @@ import (
"github.com/getsentry/sentry-go"
"github.com/matrix-org/gomatrixserverlib"
"github.com/prometheus/client_golang/prometheus"
+ "github.com/sirupsen/logrus"
log "github.com/sirupsen/logrus"
"github.com/tidwall/gjson"
@@ -247,9 +248,23 @@ func (oqs *OutgoingQueues) SendEvent(
}
for destination := range destmap {
- if queue := oqs.getQueue(destination); queue != nil {
+ if queue := oqs.getQueue(destination); queue != nil && !queue.statistics.Blacklisted() {
queue.sendEvent(ev, nid)
+ } else {
+ delete(destmap, destination)
+ }
}
+
+ // Create a database entry that associates the given PDU NID with
+ // this destinations queue. We'll then be able to retrieve the PDU
+ // later.
+ if err := oqs.db.AssociatePDUWithDestinations(
+ oqs.process.Context(),
+ destmap,
+ nid, // NIDs from federationapi_queue_json table
+ ); err != nil {
+ logrus.WithError(err).Errorf("failed to associate PDUs %q with destinations", nid)
+ return err
}
return nil
@@ -321,9 +336,25 @@ func (oqs *OutgoingQueues) SendEDU(
}
for destination := range destmap {
- if queue := oqs.getQueue(destination); queue != nil {
+ if queue := oqs.getQueue(destination); queue != nil && !queue.statistics.Blacklisted() {
queue.sendEDU(e, nid)
+ } else {
+ delete(destmap, destination)
+ }
}
+
+ // Create a database entry that associates the given PDU NID with
+ // this destination queue. We'll then be able to retrieve the PDU
+ // later.
+ if err := oqs.db.AssociateEDUWithDestinations(
+ oqs.process.Context(),
+ destmap, // the destination server name
+ nid, // NIDs from federationapi_queue_json table
+ e.Type,
+ nil, // this will use the default expireEDUTypes map
+ ); err != nil {
+ logrus.WithError(err).Errorf("failed to associate EDU with destinations")
+ return err
}
return nil

MODIFY
federationapi/queue/queue_test.go
federationapi/queue/queue_test.go
@@ -25,6 +25,10 @@ import (
"go.uber.org/atomic"
"gotest.tools/v3/poll"
+ "github.com/matrix-org/gomatrixserverlib"
+ "github.com/pkg/errors"
+ "github.com/stretchr/testify/assert"
+
"github.com/matrix-org/dendrite/federationapi/api"
"github.com/matrix-org/dendrite/federationapi/statistics"
"github.com/matrix-org/dendrite/federationapi/storage"
@@ -34,9 +38,6 @@ import (
"github.com/matrix-org/dendrite/setup/process"
"github.com/matrix-org/dendrite/test"
"github.com/matrix-org/dendrite/test/testrig"
- "github.com/matrix-org/gomatrixserverlib"
- "github.com/pkg/errors"
- "github.com/stretchr/testify/assert"
)
func mustCreateFederationDatabase(t *testing.T, dbType test.DBType, realDatabase bool) (storage.Database, *process.ProcessContext, func()) {
@@ -158,30 +159,36 @@ func (d *fakeDatabase) GetPendingEDUs(ctx context.Context, serverName gomatrixse
return edus, nil
}
-func (d *fakeDatabase) AssociatePDUWithDestination(ctx context.Context, transactionID gomatrixserverlib.TransactionID, serverName gomatrixserverlib.ServerName, receipt *shared.Receipt) error {
+func (d *fakeDatabase) AssociatePDUWithDestinations(ctx context.Context, destinations map[gomatrixserverlib.ServerName]struct{}, receipt *shared.Receipt) error {
d.dbMutex.Lock()
defer d.dbMutex.Unlock()
if _, ok := d.pendingPDUs[receipt]; ok {
- if _, ok := d.associatedPDUs[serverName]; !ok {
- d.associatedPDUs[serverName] = make(map[*shared.Receipt]struct{})
+ for destination := range destinations {
+ if _, ok := d.associatedPDUs[destination]; !ok {
+ d.associatedPDUs[destination] = make(map[*shared.Receipt]struct{})
}
- d.associatedPDUs[serverName][receipt] = struct{}{}
+ d.associatedPDUs[destination][receipt] = struct{}{}
+ }
+
return nil
} else {
return errors.New("PDU doesn't exist")
}
}
-func (d *fakeDatabase) AssociateEDUWithDestination(ctx context.Context, serverName gomatrixserverlib.ServerName, receipt *shared.Receipt, eduType string, expireEDUTypes map[string]time.Duration) error {
+func (d *fakeDatabase) AssociateEDUWithDestinations(ctx context.Context, destinations map[gomatrixserverlib.ServerName]struct{}, receipt *shared.Receipt, eduType string, expireEDUTypes map[string]time.Duration) error {
d.dbMutex.Lock()
defer d.dbMutex.Unlock()
if _, ok := d.pendingEDUs[receipt]; ok {
- if _, ok := d.associatedEDUs[serverName]; !ok {
- d.associatedEDUs[serverName] = make(map[*shared.Receipt]struct{})
+ for destination := range destinations {
+ if _, ok := d.associatedEDUs[destination]; !ok {
+ d.associatedEDUs[destination] = make(map[*shared.Receipt]struct{})
+ }
+ d.associatedEDUs[destination][receipt] = struct{}{}
}
- d.associatedEDUs[serverName][receipt] = struct{}{}
+
return nil
} else {
return errors.New("EDU doesn't exist")
@@ -821,15 +828,15 @@ func TestSendPDUBatches(t *testing.T) {
<-pc.WaitForShutdown()
}()
+ destinations := map[gomatrixserverlib.ServerName]struct{}{destination: {}}
// Populate database with > maxPDUsPerTransaction
pduMultiplier := uint32(3)
for i := 0; i < maxPDUsPerTransaction*int(pduMultiplier); i++ {
ev := mustCreatePDU(t)
headeredJSON, _ := json.Marshal(ev)
nid, _ := db.StoreJSON(pc.Context(), string(headeredJSON))
- now := gomatrixserverlib.AsTimestamp(time.Now())
- transactionID := gomatrixserverlib.TransactionID(fmt.Sprintf("%d-%d", now, i))
- db.AssociatePDUWithDestination(pc.Context(), transactionID, destination, nid)
+ err := db.AssociatePDUWithDestinations(pc.Context(), destinations, nid)
+ assert.NoError(t, err, "failed to associate PDU with destinations")
}
ev := mustCreatePDU(t)
@@ -865,13 +872,15 @@ func TestSendEDUBatches(t *testing.T) {
<-pc.WaitForShutdown()
}()
+ destinations := map[gomatrixserverlib.ServerName]struct{}{destination: {}}
// Populate database with > maxEDUsPerTransaction
eduMultiplier := uint32(3)
for i := 0; i < maxEDUsPerTransaction*int(eduMultiplier); i++ {
ev := mustCreateEDU(t)
ephemeralJSON, _ := json.Marshal(ev)
nid, _ := db.StoreJSON(pc.Context(), string(ephemeralJSON))
- db.AssociateEDUWithDestination(pc.Context(), destination, nid, ev.Type, nil)
+ err := db.AssociateEDUWithDestinations(pc.Context(), destinations, nid, ev.Type, nil)
+ assert.NoError(t, err, "failed to associate EDU with destinations")
}
ev := mustCreateEDU(t)
@@ -907,23 +916,23 @@ func TestSendPDUAndEDUBatches(t *testing.T) {
<-pc.WaitForShutdown()
}()
+ destinations := map[gomatrixserverlib.ServerName]struct{}{destination: {}}
// Populate database with > maxEDUsPerTransaction
multiplier := uint32(3)
-
for i := 0; i < maxPDUsPerTransaction*int(multiplier)+1; i++ {
ev := mustCreatePDU(t)
headeredJSON, _ := json.Marshal(ev)
nid, _ := db.StoreJSON(pc.Context(), string(headeredJSON))
- now := gomatrixserverlib.AsTimestamp(time.Now())
- transactionID := gomatrixserverlib.TransactionID(fmt.Sprintf("%d-%d", now, i))
- db.AssociatePDUWithDestination(pc.Context(), transactionID, destination, nid)
+ err := db.AssociatePDUWithDestinations(pc.Context(), destinations, nid)
+ assert.NoError(t, err, "failed to associate PDU with destinations")
}
for i := 0; i < maxEDUsPerTransaction*int(multiplier); i++ {
ev := mustCreateEDU(t)
ephemeralJSON, _ := json.Marshal(ev)
nid, _ := db.StoreJSON(pc.Context(), string(ephemeralJSON))
- db.AssociateEDUWithDestination(pc.Context(), destination, nid, ev.Type, nil)
+ err := db.AssociateEDUWithDestinations(pc.Context(), destinations, nid, ev.Type, nil)
+ assert.NoError(t, err, "failed to associate EDU with destinations")
}
ev := mustCreateEDU(t)
@@ -960,13 +969,12 @@ func TestExternalFailureBackoffDoesntStartQueue(t *testing.T) {
dest := queues.getQueue(destination)
queues.statistics.ForServer(destination).Failure()
-
+ destinations := map[gomatrixserverlib.ServerName]struct{}{destination: {}}
ev := mustCreatePDU(t)
headeredJSON, _ := json.Marshal(ev)
nid, _ := db.StoreJSON(pc.Context(), string(headeredJSON))
- now := gomatrixserverlib.AsTimestamp(time.Now())
- transactionID := gomatrixserverlib.TransactionID(fmt.Sprintf("%d-%d", now, 1))
- db.AssociatePDUWithDestination(pc.Context(), transactionID, destination, nid)
+ err := db.AssociatePDUWithDestinations(pc.Context(), destinations, nid)
+ assert.NoError(t, err, "failed to associate PDU with destinations")
pollEnd := time.Now().Add(3 * time.Second)
runningCheck := func(log poll.LogT) poll.Result {
@@ -988,6 +996,7 @@ func TestQueueInteractsWithRealDatabasePDUAndEDU(t *testing.T) {
t.Parallel()
failuresUntilBlacklist := uint32(1)
destination := gomatrixserverlib.ServerName("remotehost")
+ destinations := map[gomatrixserverlib.ServerName]struct{}{destination: {}}
test.WithAllDatabases(t, func(t *testing.T, dbType test.DBType) {
db, fc, queues, pc, close := testSetup(failuresUntilBlacklist, false, t, dbType, true)
// NOTE : These defers aren't called if go test is killed so the dbs may not get cleaned up.
@@ -1009,7 +1018,8 @@ func TestQueueInteractsWithRealDatabasePDUAndEDU(t *testing.T) {
edu := mustCreateEDU(t)
ephemeralJSON, _ := json.Marshal(edu)
nid, _ := db.StoreJSON(pc.Context(), string(ephemeralJSON))
- db.AssociateEDUWithDestination(pc.Context(), destination, nid, edu.Type, nil)
+ err = db.AssociateEDUWithDestinations(pc.Context(), destinations, nid, edu.Type, nil)
+ assert.NoError(t, err, "failed to associate EDU with destinations")
checkBlacklisted := func(log poll.LogT) poll.Result {
if fc.txCount.Load() == failuresUntilBlacklist {

MODIFY
federationapi/storage/interface.go
federationapi/storage/interface.go
@@ -18,9 +18,10 @@ import (
"context"
"time"
+ "github.com/matrix-org/gomatrixserverlib"
+
"github.com/matrix-org/dendrite/federationapi/storage/shared"
"github.com/matrix-org/dendrite/federationapi/types"
- "github.com/matrix-org/gomatrixserverlib"
)
type Database interface {
@@ -38,8 +39,8 @@ type Database interface {
GetPendingPDUs(ctx context.Context, serverName gomatrixserverlib.ServerName, limit int) (pdus map[*shared.Receipt]*gomatrixserverlib.HeaderedEvent, err error)
GetPendingEDUs(ctx context.Context, serverName gomatrixserverlib.ServerName, limit int) (edus map[*shared.Receipt]*gomatrixserverlib.EDU, err error)
- AssociatePDUWithDestination(ctx context.Context, transactionID gomatrixserverlib.TransactionID, serverName gomatrixserverlib.ServerName, receipt *shared.Receipt) error
- AssociateEDUWithDestination(ctx context.Context, serverName gomatrixserverlib.ServerName, receipt *shared.Receipt, eduType string, expireEDUTypes map[string]time.Duration) error
+ AssociatePDUWithDestinations(ctx context.Context, destinations map[gomatrixserverlib.ServerName]struct{}, receipt *shared.Receipt) error
+ AssociateEDUWithDestinations(ctx context.Context, destinations map[gomatrixserverlib.ServerName]struct{}, receipt *shared.Receipt, eduType string, expireEDUTypes map[string]time.Duration) error
CleanPDUs(ctx context.Context, serverName gomatrixserverlib.ServerName, receipts []*shared.Receipt) error
CleanEDUs(ctx context.Context, serverName gomatrixserverlib.ServerName, receipts []*shared.Receipt) error

MODIFY
federationapi/storage/shared/storage_edus.go
federationapi/storage/shared/storage_edus.go
@@ -38,9 +38,9 @@ var defaultExpireEDUTypes = map[string]time.Duration{
// AssociateEDUWithDestination creates an association that the
// destination queues will use to determine which JSON blobs to send
// to which servers.
-func (d *Database) AssociateEDUWithDestination(
+func (d *Database) AssociateEDUWithDestinations(
ctx context.Context,
- serverName gomatrixserverlib.ServerName,
+ destinations map[gomatrixserverlib.ServerName]struct{},
receipt *Receipt,
eduType string,
expireEDUTypes map[string]time.Duration,
@@ -59,17 +59,18 @@ func (d *Database) AssociateEDUWithDestination(
expiresAt = 0
}
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
- if err := d.FederationQueueEDUs.InsertQueueEDU(
+ var err error
+ for destination := range destinations {
+ err = d.FederationQueueEDUs.InsertQueueEDU(
ctx, // context
txn, // SQL transaction
eduType, // EDU type for coalescing
- serverName, // destination server name
+ destination, // destination server name
receipt.nid, // NID from the federationapi_queue_json table
expiresAt, // The timestamp this EDU will expire
- ); err != nil {
- return fmt.Errorf("InsertQueueEDU: %w", err)
+ )
}
- return nil
+ return err
})
}

MODIFY
federationapi/storage/shared/storage_pdus.go
federationapi/storage/shared/storage_pdus.go
@@ -27,23 +27,23 @@ import (
// AssociatePDUWithDestination creates an association that the
// destination queues will use to determine which JSON blobs to send
// to which servers.
-func (d *Database) AssociatePDUWithDestination(
+func (d *Database) AssociatePDUWithDestinations(
ctx context.Context,
- transactionID gomatrixserverlib.TransactionID,
- serverName gomatrixserverlib.ServerName,
+ destinations map[gomatrixserverlib.ServerName]struct{},
receipt *Receipt,
) error {
return d.Writer.Do(d.DB, nil, func(txn *sql.Tx) error {
- if err := d.FederationQueuePDUs.InsertQueuePDU(
+ var err error
+ for destination := range destinations {
+ err = d.FederationQueuePDUs.InsertQueuePDU(
ctx, // context
txn, // SQL transaction
- transactionID, // transaction ID
- serverName, // destination server name
+ "", // transaction ID
+ destination, // destination server name
receipt.nid, // NID from the federationapi_queue_json table
- ); err != nil {
- return fmt.Errorf("InsertQueuePDU: %w", err)
+ )
}
- return nil
+ return err
})
}

MODIFY
federationapi/storage/storage_test.go
federationapi/storage/storage_test.go
@@ -35,6 +35,7 @@ func TestExpireEDUs(t *testing.T) {
}
ctx := context.Background()
+ destinations := map[gomatrixserverlib.ServerName]struct{}{"localhost": {}}
test.WithAllDatabases(t, func(t *testing.T, dbType test.DBType) {
db, close := mustCreateFederationDatabase(t, dbType)
defer close()
@@ -43,7 +44,7 @@ func TestExpireEDUs(t *testing.T) {
receipt, err := db.StoreJSON(ctx, "{}")
assert.NoError(t, err)
- err = db.AssociateEDUWithDestination(ctx, "localhost", receipt, gomatrixserverlib.MReceipt, expireEDUTypes)
+ err = db.AssociateEDUWithDestinations(ctx, destinations, receipt, gomatrixserverlib.MReceipt, expireEDUTypes)
assert.NoError(t, err)
}
// add data without expiry
@@ -51,7 +52,7 @@ func TestExpireEDUs(t *testing.T) {
assert.NoError(t, err)
// m.read_marker gets the default expiry of 24h, so won't be deleted further down in this test
- err = db.AssociateEDUWithDestination(ctx, "localhost", receipt, "m.read_marker", expireEDUTypes)
+ err = db.AssociateEDUWithDestinations(ctx, destinations, receipt, "m.read_marker", expireEDUTypes)
assert.NoError(t, err)
// Delete expired EDUs
@@ -67,7 +68,7 @@ func TestExpireEDUs(t *testing.T) {
receipt, err = db.StoreJSON(ctx, "{}")
assert.NoError(t, err)
- err = db.AssociateEDUWithDestination(ctx, "localhost", receipt, gomatrixserverlib.MDirectToDevice, expireEDUTypes)
+ err = db.AssociateEDUWithDestinations(ctx, destinations, receipt, gomatrixserverlib.MDirectToDevice, expireEDUTypes)
assert.NoError(t, err)
err = db.DeleteExpiredEDUs(ctx)

Optimize inserting pending PDUs/EDUs (#2821)

This optimizes the association of PDUs/EDUs to their destination by
inserting all destinations in one transaction.