1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
|
package tunclient
import (
"context"
"fmt"
"io"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/grpctool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/logz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/retry"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tunnel/info"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tunnel/rpc"
"go.uber.org/zap"
"golang.org/x/sync/errgroup"
"google.golang.org/grpc"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/reflect/protoreflect"
)
const (
requestInfoNumber protoreflect.FieldNumber = 1
messageNumber protoreflect.FieldNumber = 2
closeSendNumber protoreflect.FieldNumber = 3
)
var (
proxyStreamDesc = grpc.StreamDesc{
ServerStreams: true,
ClientStreams: true,
}
)
type ConnectionInterface interface {
Run(attemptCtx, pollCtx context.Context)
}
type Connection struct {
Log *zap.Logger
Descriptor *info.APIDescriptor
Client rpc.ReverseTunnelClient
InternalServerConn grpc.ClientConnInterface
PollConfig retry.PollConfigFactory
OnActive func(ConnectionInterface)
OnIdle func(ConnectionInterface)
}
func (c *Connection) Run(attemptCtx, pollCtx context.Context) {
_ = retry.PollWithBackoff(pollCtx, c.PollConfig(), func(_ context.Context) (error, retry.AttemptResult) {
err := c.attempt(attemptCtx)
if err != nil {
if grpctool.RequestCanceledOrTimedOut(err) {
c.Log.Debug("Canceled connection", logz.Error(err))
return nil, retry.ContinueImmediately // handled a connection with a timeout/cancel, re-establish it immediately
}
c.Log.Error("Error handling a connection", logz.Error(err))
return nil, retry.Backoff
}
c.Log.Debug("Handled a connection successfully")
return nil, retry.ContinueImmediately // successfully handled a connection, re-establish it immediately
})
c.Log.Debug("Connection done")
}
func (c *Connection) attempt(ctx context.Context) (retErr error) {
defer c.OnIdle(c)
ctx, cancel, stopPropagation := propagateUntil(ctx)
defer cancel()
tunnel, err := c.Client.Connect(ctx, grpc.WaitForReady(true))
if err != nil {
return fmt.Errorf("Connect(): %w", err) // wrap
}
err = tunnel.Send(&rpc.ConnectRequest{
Msg: &rpc.ConnectRequest_Descriptor_{
Descriptor_: &rpc.Descriptor{
ApiDescriptor: c.Descriptor,
},
},
})
if err != nil {
if err == io.EOF { //nolint:errorlint
_, err = tunnel.Recv() // get the actual error
}
return fmt.Errorf("Send(descriptor): %w", err) // wrap
}
var (
clientStream grpc.ClientStream
g errgroup.Group
)
// pipe tunnel -> internal client
err1 := rpc.ConnectResponseVisitor().Visit(tunnel,
grpctool.WithCallback(requestInfoNumber, func(reqInfo *rpc.RequestInfo) error {
c.OnActive(c)
outgoingCtx := metadata.NewOutgoingContext(ctx, reqInfo.Metadata())
clientStream, err = c.InternalServerConn.NewStream(outgoingCtx, &proxyStreamDesc, reqInfo.MethodName)
if err != nil {
return fmt.Errorf("NewStream(): %w", err)
}
// After this point we don't want context cancellation to interrupt request handling since this would
// break a running request. We are calling stopPropagation() to ignore the passed context and let the
// request finish properly.
stopPropagation()
g.Go(func() error {
// pipe internal client -> tunnel
return pipeInternalClientIntoTunnel(tunnel, clientStream)
})
return nil
}),
grpctool.WithCallback(messageNumber, func(message *rpc.Message) error {
err = clientStream.SendMsg(&grpctool.RawFrame{
Data: message.Data,
})
if err != nil {
if err == io.EOF { //nolint:errorlint
return nil // the other goroutine will receive the error in RecvMsg()
}
return fmt.Errorf("SendMsg(): %w", err)
}
return nil
}),
grpctool.WithCallback(closeSendNumber, func(closeSend *rpc.CloseSend) error {
err = clientStream.CloseSend()
if err != nil {
return fmt.Errorf("CloseSend(): %w", err)
}
return nil
}),
)
if err1 != nil {
cancel()
}
err2 := g.Wait()
if err1 == nil {
err1 = err2
}
return err1
}
func pipeInternalClientIntoTunnel(tunnel rpc.ReverseTunnel_ConnectClient, clientStream grpc.ClientStream) error {
header, err := clientStream.Header()
if err != nil {
return sendErrorToTunnel(err, tunnel)
}
err = tunnel.Send(&rpc.ConnectRequest{
Msg: &rpc.ConnectRequest_Header{
Header: &rpc.Header{
Meta: grpctool.MetaToValuesMap(header),
},
},
})
if err != nil {
if err == io.EOF { //nolint:errorlint
return nil // the other goroutine will receive the error in RecvMsg()
}
return fmt.Errorf("Send(header): %w", err) // wrap
}
var frame grpctool.RawFrame
for {
recvErr := clientStream.RecvMsg(&frame)
if recvErr != nil {
// Trailer becomes available after RecvMsg() returns an error
err = tunnel.Send(&rpc.ConnectRequest{
Msg: &rpc.ConnectRequest_Trailer{
Trailer: &rpc.Trailer{
Meta: grpctool.MetaToValuesMap(clientStream.Trailer()),
},
},
})
if err != nil {
if recvErr == io.EOF { //nolint:errorlint
if err == io.EOF { //nolint:errorlint
return nil // the other goroutine will receive the error in RecvMsg()
}
return fmt.Errorf("Send(trailer): %w", err) // wrap
}
return fmt.Errorf("Recv(RawFrame): %w", recvErr) // return recvErr as it happened first
}
if recvErr == io.EOF { //nolint:errorlint
break
}
return sendErrorToTunnel(recvErr, tunnel)
}
err = tunnel.Send(&rpc.ConnectRequest{
Msg: &rpc.ConnectRequest_Message{
Message: &rpc.Message{
Data: frame.Data,
},
},
})
if err != nil {
if err == io.EOF { //nolint:errorlint
return nil // the other goroutine will receive the error in RecvMsg()
}
return fmt.Errorf("Send(message): %w", err) // wrap
}
}
err = tunnel.CloseSend()
if err != nil {
return fmt.Errorf("CloseSend(): %w", err) // wrap
}
return nil
}
func sendErrorToTunnel(errToSend error, tunnel rpc.ReverseTunnel_ConnectClient) error {
err := tunnel.Send(&rpc.ConnectRequest{
Msg: &rpc.ConnectRequest_Error{
Error: &rpc.Error{
Status: status.Convert(errToSend).Proto(),
},
},
})
if err != nil {
if err == io.EOF { //nolint:errorlint
return nil // the other goroutine will receive the error in RecvMsg()
}
return fmt.Errorf("Send(error): %w", err) // wrap
}
err = tunnel.CloseSend()
if err != nil {
return fmt.Errorf("CloseSend(): %w", err) // wrap
}
return nil
}
// propagateUntil propagates cancellation from ctx to the returned context.
// When stop is called, ctx cancellation will no longer be propagated to the returned context.
// To cancel the returned context use the returned context.CancelFunc.
func propagateUntil(ctx context.Context) (context.Context, context.CancelFunc, func() /* stop */) {
ctxInternal, cancel := context.WithCancel(context.WithoutCancel(ctx))
stopPropagation := context.AfterFunc(ctx, func() {
cancel()
})
return ctxInternal, cancel, func() {
stopPropagation()
}
}
|