mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-11-22 11:46:40 +00:00
a483bd9e38
* add delivery worker type that pulls from queue to httpclient package * finish up some code commenting, bodge a vendored activity library change, integrate the deliverypool changes into transportcontroller * hook up queue deletion logic * support deleting queued http requests by target ID * don't index APRequest by hostname in the queue * use gorun * use the original context's values when wrapping msg type as delivery{} * actually log in the AP delivery worker ... * add uncommitted changes * use errors.AsV2() * use errorsv2.AsV2() * finish adding some code comments, add bad host handling to delivery workers * slightly tweak deliveryworkerpool API, use advanced sender multiplier * remove PopCtx() method, let others instead rely on Wait() * shuffle things around to move delivery stuff into transport/ subpkg * remove dead code * formatting * validate request before queueing for delivery * finish adding code comments, fix up backoff code * finish adding more code comments * clamp minimum no. senders to 1 * add start/stop logging to delivery worker, some slight changes * remove double logging * use worker ptrs * expose the embedded log fields in httpclient.Request{} * ensure request context values are preserved when updating ctx * add delivery worker tests * fix linter issues * ensure delivery worker gets inited in testrig * fix tests to delivering messages to check worker delivery queue * update error type to use ptr instead of value receiver * fix test calling Workers{}.Start() instead of testrig.StartWorkers() * update docs for advanced-sender-multiplier * update to the latest activity library version * add comment about not using httptest.Server{}
132 lines
4.3 KiB
Go
132 lines
4.3 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package workers
|
|
|
|
import (
|
|
"context"
|
|
"log"
|
|
"runtime"
|
|
|
|
"codeberg.org/gruf/go-runners"
|
|
"github.com/superseriousbusiness/gotosocial/internal/config"
|
|
"github.com/superseriousbusiness/gotosocial/internal/messages"
|
|
"github.com/superseriousbusiness/gotosocial/internal/scheduler"
|
|
"github.com/superseriousbusiness/gotosocial/internal/transport/delivery"
|
|
)
|
|
|
|
type Workers struct {
|
|
// Main task scheduler instance.
|
|
Scheduler scheduler.Scheduler
|
|
|
|
// Delivery provides a worker pool that
|
|
// handles outgoing ActivityPub deliveries.
|
|
// It contains an embedded (but accessible)
|
|
// indexed queue of Delivery{} objects.
|
|
Delivery delivery.WorkerPool
|
|
|
|
// ClientAPI provides a worker pool that handles both
|
|
// incoming client actions, and our own side-effects.
|
|
ClientAPI runners.WorkerPool
|
|
|
|
// Federator provides a worker pool that handles both
|
|
// incoming federated actions, and our own side-effects.
|
|
Federator runners.WorkerPool
|
|
|
|
// Enqueue functions for clientAPI / federator worker pools,
|
|
// these are pointers to Processor{}.Enqueue___() msg functions.
|
|
// This prevents dependency cycling as Processor depends on Workers.
|
|
EnqueueClientAPI func(context.Context, ...messages.FromClientAPI)
|
|
EnqueueFediAPI func(context.Context, ...messages.FromFediAPI)
|
|
|
|
// Blocking processing functions for clientAPI / federator.
|
|
// These are pointers to Processor{}.Process___() msg functions.
|
|
// This prevents dependency cycling as Processor depends on Workers.
|
|
//
|
|
// Rather than queueing messages for asynchronous processing, these
|
|
// functions will process immediately and in a blocking manner, and
|
|
// will not use up a worker slot.
|
|
//
|
|
// As such, you should only call them in special cases where something
|
|
// synchronous needs to happen before you can do something else.
|
|
ProcessFromClientAPI func(context.Context, messages.FromClientAPI) error
|
|
ProcessFromFediAPI func(context.Context, messages.FromFediAPI) error
|
|
|
|
// Media manager worker pools.
|
|
Media runners.WorkerPool
|
|
|
|
// prevent pass-by-value.
|
|
_ nocopy
|
|
}
|
|
|
|
// Start will start all of the contained
|
|
// worker pools (and global scheduler).
|
|
func (w *Workers) Start() {
|
|
// Get currently set GOMAXPROCS.
|
|
maxprocs := runtime.GOMAXPROCS(0)
|
|
|
|
tryUntil("starting scheduler", 5, w.Scheduler.Start)
|
|
|
|
tryUntil("start delivery workerpool", 5, func() bool {
|
|
n := config.GetAdvancedSenderMultiplier()
|
|
if n < 1 {
|
|
// clamp min senders to 1.
|
|
return w.Delivery.Start(1)
|
|
}
|
|
return w.Delivery.Start(n * maxprocs)
|
|
})
|
|
|
|
tryUntil("starting client API workerpool", 5, func() bool {
|
|
return w.ClientAPI.Start(4*maxprocs, 400*maxprocs)
|
|
})
|
|
|
|
tryUntil("starting federator workerpool", 5, func() bool {
|
|
return w.Federator.Start(4*maxprocs, 400*maxprocs)
|
|
})
|
|
|
|
tryUntil("starting media workerpool", 5, func() bool {
|
|
return w.Media.Start(8*maxprocs, 80*maxprocs)
|
|
})
|
|
}
|
|
|
|
// Stop will stop all of the contained worker pools (and global scheduler).
|
|
func (w *Workers) Stop() {
|
|
tryUntil("stopping scheduler", 5, w.Scheduler.Stop)
|
|
tryUntil("stopping delivery workerpool", 5, w.Delivery.Stop)
|
|
tryUntil("stopping client API workerpool", 5, w.ClientAPI.Stop)
|
|
tryUntil("stopping federator workerpool", 5, w.Federator.Stop)
|
|
tryUntil("stopping media workerpool", 5, w.Media.Stop)
|
|
}
|
|
|
|
// nocopy when embedded will signal linter to
|
|
// error on pass-by-value of parent struct.
|
|
type nocopy struct{}
|
|
|
|
func (*nocopy) Lock() {}
|
|
|
|
func (*nocopy) Unlock() {}
|
|
|
|
// tryUntil will attempt to call 'do' for 'count' attempts, before panicking with 'msg'.
|
|
func tryUntil(msg string, count int, do func() bool) {
|
|
for i := 0; i < count; i++ {
|
|
if do() {
|
|
return
|
|
}
|
|
}
|
|
log.Panicf("failed %s after %d tries", msg, count)
|
|
}
|