Skip to content

Git designed for AI agents.

4.6 KB
Raw Blame
package sidechannel

import (
	"context"
	"errors"
	"fmt"
	"io"

	"github.com/feder-cr/git-ai/internal/grpc/metadata"
	"github.com/feder-cr/git-ai/internal/log"
	"google.golang.org/grpc"
	grpcMetadata "google.golang.org/grpc/metadata"
)

// NewUnaryProxy creates a gRPC client middleware that proxies sidechannels.
func NewUnaryProxy(registry *Registry, log log.Logger) grpc.UnaryClientInterceptor {
	return func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) (err error) {
		if !hasSidechannelMetadata(ctx) {
			return invoker(ctx, method, req, reply, cc, opts...)
		}

		ctx, waiter := RegisterSidechannel(ctx, registry, proxy(ctx))
		defer func() {
			if waiterErr := waiter.Close(); waiterErr != nil && !errors.Is(waiterErr, ErrCallbackDidNotRun) {
				if err == nil {
					err = fmt.Errorf("sidechannel: proxy callback: %w", waiterErr)
				} else {
					// If upstream returns non-successful error and the waiter fails to close, we should
					// prioritize the returned error because that error is propagated back to downstream.
					// The waiter error (most likely unexpected close) is logged instead.
					log.WithError(waiterErr).Warn("failed proxying callback on sidechannel")
				}
			}
		}()

		return invoker(ctx, method, req, reply, cc, opts...)
	}
}

// NewStreamProxy creates a gRPC client middleware that proxies sidechannels.
func NewStreamProxy(registry *Registry, log log.Logger) grpc.StreamClientInterceptor {
	return func(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) {
		if !hasSidechannelMetadata(ctx) {
			return streamer(ctx, desc, cc, method, opts...)
		}

		ctx, waiter := RegisterSidechannel(ctx, registry, proxy(ctx))
		go func() {
			<-ctx.Done()
			// The Close() error is checked and bubbled up in
			// streamWrapper.RecvMsg(). This call is just for cleanup.
			_ = waiter.Close()
		}()

		cs, err := streamer(ctx, desc, cc, method, opts...)
		if err != nil {
			return nil, err
		}

		return &streamWrapper{ClientStream: cs, waiter: waiter, log: log}, nil
	}
}

type streamWrapper struct {
	grpc.ClientStream
	waiter *Waiter
	log    log.Logger
}

func (sw *streamWrapper) RecvMsg(m interface{}) (err error) {
	defer func() {
		// We should always close the waiter, which waits for the connection to be fully teared down before move
		// on. Otherwise, when upstream returns an error, there is a race between the gRPC handler and
		// Sidechannel connection. This race sometimes makes the error message not fully flushed.
		// For more information: https://gitlab.com/gitlab-org/gitaly/-/issues/5552
		if waiterErr := sw.waiter.Close(); waiterErr != nil && !errors.Is(waiterErr, ErrCallbackDidNotRun) {
			if err == nil {
				err = fmt.Errorf("sidechannel: proxy callback: %w", waiterErr)
			} else {
				// If upstream returns non-successful error and the waiter fails to close, we should
				// prioritize the returned error because that error is propagated back to downstream.
				// The waiter error (most likely unexpected close) is logged instead.
				sw.log.WithError(waiterErr).Error("sidechannel proxying failed")
			}
		}
	}()

	return sw.ClientStream.RecvMsg(m)
}

func hasSidechannelMetadata(ctx context.Context) bool {
	md, ok := grpcMetadata.FromOutgoingContext(ctx)
	return ok && len(md.Get(sidechannelMetadataKey)) > 0
}

func proxy(ctx context.Context) func(*ClientConn) error {
	return func(upstream *ClientConn) error {
		downstream, err := OpenSidechannel(metadata.OutgoingToIncoming(ctx))
		if err != nil {
			return err
		}
		defer downstream.Close()

		fromDownstream := make(chan error, 1)
		go func() {
			fromDownstream <- func() error {
				if _, err := io.Copy(upstream, downstream); err != nil {
					return fmt.Errorf("copy to upstream: %w", err)
				}

				if err := upstream.CloseWrite(); err != nil {
					return fmt.Errorf("closewrite upstream: %w", err)
				}

				return nil
			}()
		}()

		fromUpstream := make(chan error, 1)
		go func() {
			fromUpstream <- func() error {
				if _, err := io.Copy(downstream, upstream); err != nil {
					return fmt.Errorf("copy to downstream: %w", err)
				}

				return nil
			}()
		}()

	waitForUpstream:
		for {
			select {
			case err := <-fromUpstream:
				if err != nil {
					return err
				}

				break waitForUpstream
			case err := <-fromDownstream:
				if err != nil {
					return err
				}
			case <-ctx.Done():
				return ctx.Err()
			}
		}

		if err := downstream.Close(); err != nil {
			return fmt.Errorf("close downstream: %w", err)
		}

		return nil
	}
}