summaryrefslogtreecommitdiff
path: root/internal/gtscontext
diff options
context:
space:
mode:
authorLibravatar kim <89579420+NyaaaWhatsUpDoc@users.noreply.github.com>2023-04-28 16:45:21 +0100
committerLibravatar GitHub <noreply@github.com>2023-04-28 17:45:21 +0200
commit6a29c5ffd40f1919cac40030c53160c19812bc8d (patch)
treef1faaa6504cdb798dfbfd1df20f1493bcdd99602 /internal/gtscontext
parent[bugfix] Fix remaining mangled URI escaping issues in statuses + accounts (#1... (diff)
downloadgotosocial-6a29c5ffd40f1919cac40030c53160c19812bc8d.tar.xz
[performance] improved request batching (removes need for queueing) (#1687)
* revamp http client to not limit requests, instead use sender worker Signed-off-by: kim <grufwub@gmail.com> * remove separate sender worker pool, spawn 2*GOMAXPROCS batch senders each time, no need for transport cache sweeping Signed-off-by: kim <grufwub@gmail.com> * improve batch senders to keep popping recipients until remote URL found Signed-off-by: kim <grufwub@gmail.com> * fix recipient looping issue Signed-off-by: kim <grufwub@gmail.com> * fix missing mutex unlock Signed-off-by: kim <grufwub@gmail.com> * move request id ctx key to gtscontext, finish filling out more code comments, add basic support for not logging client IP Signed-off-by: kim <grufwub@gmail.com> * slight code reformatting Signed-off-by: kim <grufwub@gmail.com> * a whitespace Signed-off-by: kim <grufwub@gmail.com> * remove unused code Signed-off-by: kim <grufwub@gmail.com> * add missing license headers Signed-off-by: kim <grufwub@gmail.com> * fix request backoff calculation Signed-off-by: kim <grufwub@gmail.com> --------- Signed-off-by: kim <grufwub@gmail.com>
Diffstat (limited to 'internal/gtscontext')
-rw-r--r--internal/gtscontext/context.go52
-rw-r--r--internal/gtscontext/log_hooks.go44
2 files changed, 94 insertions, 2 deletions
diff --git a/internal/gtscontext/context.go b/internal/gtscontext/context.go
index 7d4a44774..d52bf2801 100644
--- a/internal/gtscontext/context.go
+++ b/internal/gtscontext/context.go
@@ -17,7 +17,9 @@
package gtscontext
-import "context"
+import (
+ "context"
+)
// package private context key type.
type ctxkey uint
@@ -26,8 +28,54 @@ const (
// context keys.
_ ctxkey = iota
barebonesKey
+ fastFailKey
+ pubKeyIDKey
+ requestIDKey
)
+// RequestID returns the request ID associated with context. This value will usually
+// be set by the request ID middleware handler, either pulling an existing supplied
+// value from request headers, or generating a unique new entry. This is useful for
+// tying together log entries associated with an original incoming request.
+func RequestID(ctx context.Context) string {
+ id, _ := ctx.Value(requestIDKey).(string)
+ return id
+}
+
+// SetRequestID stores the given request ID value and returns the wrapped
+// context. See RequestID() for further information on the request ID value.
+func SetRequestID(ctx context.Context, id string) context.Context {
+ return context.WithValue(ctx, requestIDKey, id)
+}
+
+// PublicKeyID returns the public key ID (URI) associated with context. This
+// value is useful for logging situations in which a given public key URI is
+// relevant, e.g. for outgoing requests being signed by the given key.
+func PublicKeyID(ctx context.Context) string {
+ id, _ := ctx.Value(pubKeyIDKey).(string)
+ return id
+}
+
+// SetPublicKeyID stores the given public key ID value and returns the wrapped
+// context. See PublicKeyID() for further information on the public key ID value.
+func SetPublicKeyID(ctx context.Context, id string) context.Context {
+ return context.WithValue(ctx, pubKeyIDKey, id)
+}
+
+// IsFastFail returns whether the "fastfail" context key has been set. This
+// can be used to indicate to an http client, for example, that the result
+// of an outgoing request is time sensitive and so not to bother with retries.
+func IsFastfail(ctx context.Context) bool {
+ _, ok := ctx.Value(fastFailKey).(struct{})
+ return ok
+}
+
+// SetFastFail sets the "fastfail" context flag and returns this wrapped context.
+// See IsFastFail() for further information on the "fastfail" context flag.
+func SetFastFail(ctx context.Context) context.Context {
+ return context.WithValue(ctx, fastFailKey, struct{}{})
+}
+
// Barebones returns whether the "barebones" context key has been set. This
// can be used to indicate to the database, for example, that only a barebones
// model need be returned, Allowing it to skip populating sub models.
@@ -37,7 +85,7 @@ func Barebones(ctx context.Context) bool {
}
// SetBarebones sets the "barebones" context flag and returns this wrapped context.
-// See Barebones() for further information on the "barebones" context flag..
+// See Barebones() for further information on the "barebones" context flag.
func SetBarebones(ctx context.Context) context.Context {
return context.WithValue(ctx, barebonesKey, struct{}{})
}
diff --git a/internal/gtscontext/log_hooks.go b/internal/gtscontext/log_hooks.go
new file mode 100644
index 000000000..2fe43e488
--- /dev/null
+++ b/internal/gtscontext/log_hooks.go
@@ -0,0 +1,44 @@
+// 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 gtscontext
+
+import (
+ "context"
+
+ "codeberg.org/gruf/go-kv"
+ "github.com/superseriousbusiness/gotosocial/internal/log"
+)
+
+func init() {
+ // Add our required logging hooks on application initialization.
+ //
+ // Request ID middleware hook.
+ log.Hook(func(ctx context.Context, kvs []kv.Field) []kv.Field {
+ if id := RequestID(ctx); id != "" {
+ return append(kvs, kv.Field{K: "requestID", V: id})
+ }
+ return kvs
+ })
+ // Client IP middleware hook.
+ log.Hook(func(ctx context.Context, kvs []kv.Field) []kv.Field {
+ if id := PublicKeyID(ctx); id != "" {
+ return append(kvs, kv.Field{K: "pubKeyID", V: id})
+ }
+ return kvs
+ })
+}