constellation/internal/grpc/grpclog/grpclog.go

/*
Copyright (c) Edgeless Systems GmbH

SPDX-License-Identifier: AGPL-3.0-only
*/

// grpclog provides a logging utilities for gRPC.
package grpclog

import (
	"context"
	"fmt"
	"sync"

	"google.golang.org/grpc/connectivity"
	"google.golang.org/grpc/peer"
)

// PeerAddrFromContext returns a peer's address from context, or "unknown" if not found.
func PeerAddrFromContext(ctx context.Context) string {
	p, ok := peer.FromContext(ctx)
	if !ok {
		return "unknown"
	}
	return p.Addr.String()
}

// LogStateChangesUntilReady logs the state changes of a gRPC connection.
func LogStateChangesUntilReady(ctx context.Context, conn getStater, log debugLog, wg *sync.WaitGroup, isReadyCallback func()) {
	wg.Add(1)
	go func() {
		defer wg.Done()
		state := conn.GetState()
		log.Debug(fmt.Sprintf("Connection state started as %q", state))
		for ; state != connectivity.Ready && conn.WaitForStateChange(ctx, state); state = conn.GetState() {
			log.Debug(fmt.Sprintf("Connection state changed to %q", state))
		}
		if state == connectivity.Ready {
			log.Debug("Connection ready")
			isReadyCallback()
		} else {
			log.Debug(fmt.Sprintf("Connection state ended with %q", state))
		}
	}()
}

type getStater interface {
	GetState() connectivity.State
	WaitForStateChange(context.Context, connectivity.State) bool
}

type debugLog interface {
	Debug(msg string, args ...any)
}