fix: race on warned flag in versioncheck pkg, make consistent use of client/server terms

This commit is contained in:
Pasha Sviderski
2026-04-08 20:42:27 +10:00
parent 883f184e37
commit ab644f6a47
8 changed files with 122 additions and 138 deletions
+3 -3
View File
@@ -7,9 +7,9 @@ import (
"net"
"strings"
"github.com/psviderski/uncloud/internal/grpcversion"
"github.com/psviderski/uncloud/internal/machine"
"github.com/psviderski/uncloud/internal/sshexec"
"github.com/psviderski/uncloud/pkg/versioncheck"
"golang.org/x/crypto/ssh"
"golang.org/x/net/proxy"
"google.golang.org/grpc"
@@ -75,8 +75,8 @@ func (c *SSHConnector) Connect(ctx context.Context) (*grpc.ClientConn, error) {
"unix://"+sockPath,
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithDefaultServiceConfig(defaultServiceConfig),
grpc.WithUnaryInterceptor(versioncheck.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(versioncheck.ClientStreamInterceptor),
grpc.WithUnaryInterceptor(grpcversion.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(grpcversion.ClientStreamInterceptor),
grpc.WithContextDialer(
func(ctx context.Context, addr string) (net.Conn, error) {
addr = strings.TrimPrefix(addr, "unix://")
+3 -3
View File
@@ -11,7 +11,7 @@ import (
"strings"
"github.com/docker/cli/cli/connhelper/commandconn"
"github.com/psviderski/uncloud/pkg/versioncheck"
"github.com/psviderski/uncloud/internal/grpcversion"
"golang.org/x/net/proxy"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
@@ -78,8 +78,8 @@ func (c *SSHCLIConnector) Connect(ctx context.Context) (*grpc.ClientConn, error)
"passthrough:///", // Dummy target since we're using a custom dialer.
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithDefaultServiceConfig(defaultServiceConfig),
grpc.WithUnaryInterceptor(versioncheck.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(versioncheck.ClientStreamInterceptor),
grpc.WithUnaryInterceptor(grpcversion.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(grpcversion.ClientStreamInterceptor),
grpc.WithContextDialer(func(ctx context.Context, _ string) (net.Conn, error) {
dialArgs := append(c.buildSSHArgs(), "uncloudd", "dial-stdio")
if c.config.SockPath != "" {
+3 -3
View File
@@ -5,7 +5,7 @@ import (
"fmt"
"net/netip"
"github.com/psviderski/uncloud/pkg/versioncheck"
"github.com/psviderski/uncloud/internal/grpcversion"
"golang.org/x/net/proxy"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
@@ -25,8 +25,8 @@ func (c *TCPConnector) Connect(_ context.Context) (*grpc.ClientConn, error) {
c.apiAddr.String(),
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithDefaultServiceConfig(defaultServiceConfig),
grpc.WithUnaryInterceptor(versioncheck.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(versioncheck.ClientStreamInterceptor),
grpc.WithUnaryInterceptor(grpcversion.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(grpcversion.ClientStreamInterceptor),
)
if err != nil {
return nil, fmt.Errorf("create machine API client: %w", err)
+3 -3
View File
@@ -4,7 +4,7 @@ import (
"context"
"fmt"
"github.com/psviderski/uncloud/pkg/versioncheck"
"github.com/psviderski/uncloud/internal/grpcversion"
"golang.org/x/net/proxy"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
@@ -27,8 +27,8 @@ func (c *UnixConnector) Connect(_ context.Context) (*grpc.ClientConn, error) {
target,
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithDefaultServiceConfig(defaultServiceConfig),
grpc.WithUnaryInterceptor(versioncheck.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(versioncheck.ClientStreamInterceptor),
grpc.WithUnaryInterceptor(grpcversion.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(grpcversion.ClientStreamInterceptor),
)
if err != nil {
return nil, fmt.Errorf("create machine API client: %w", err)
+3 -3
View File
@@ -8,11 +8,11 @@ import (
"strconv"
"github.com/psviderski/uncloud/internal/cli/config"
"github.com/psviderski/uncloud/internal/grpcversion"
"github.com/psviderski/uncloud/internal/machine/constants"
"github.com/psviderski/uncloud/internal/machine/network"
"github.com/psviderski/uncloud/internal/machine/network/tunnel"
"github.com/psviderski/uncloud/pkg/client"
"github.com/psviderski/uncloud/pkg/versioncheck"
"golang.org/x/net/proxy"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
@@ -71,8 +71,8 @@ func (c *WireGuardConnector) Connect(ctx context.Context) (*grpc.ClientConn, err
grpc.WithContextDialer(func(ctx context.Context, addr string) (net.Conn, error) {
return c.tun.DialContext(ctx, "tcp", addr)
}),
grpc.WithUnaryInterceptor(versioncheck.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(versioncheck.ClientStreamInterceptor),
grpc.WithUnaryInterceptor(grpcversion.ClientUnaryInterceptor),
grpc.WithStreamInterceptor(grpcversion.ClientStreamInterceptor),
)
if err != nil {
return nil, fmt.Errorf("connect to machine API through WireGuard tunnel: %w", err)
-179
View File
@@ -1,179 +0,0 @@
package versioncheck
import (
"context"
"fmt"
"os"
"github.com/Masterminds/semver"
internalVersion "github.com/psviderski/uncloud/internal/version"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
)
const (
MetadataKeyCLIVersion = "uncloud-client-version"
MetadataKeyMinDaemonVersion = "uncloud-min-server-version"
MetadataKeyDaemonVersion = "uncloud-server-version"
// MinCLIVersion is the minimum client version the daemon accepts. The daemon
// rejects requests from older clients, forcing them to upgrade. This provides
// a clean cut-off for dropping support for old clients.
//
// MinDaemonVersion is the minimum daemon version the client requires. The client
// sends this with each request so the daemon can immediately reject if it's too old,
// avoiding the need for a preflight request. This is useful when a new client feature
// requires daemon capabilities that didn't exist in older versions.
//
// The two minimums are independent: a client might require a newer daemon for new
// features, while that same daemon could still handle requests from older clients.
MinCLIVersion = "0.0.0"
MinDaemonVersion = "0.0.0"
ReleaseURL = "https://github.com/psviderski/uncloud/releases/latest"
)
var (
// currentVersion is the version of this binary (CLI or daemon)
currentVersion = semver.MustParse(internalVersion.String())
// zeroVersion is used when no version is specified (treated as 0.0.0)
zeroVersion = semver.MustParse("0.0.0")
// Pre-parsed minimum versions for comparison
minCLIVersion = semver.MustParse(MinCLIVersion)
minDaemonVersion = semver.MustParse(MinDaemonVersion)
// warned tracks if we've already printed the daemon version warning
// TODO: remove when checkDaemonVersionInResponse is no longer needed (see below)
warned bool
)
func extractVersion(md metadata.MD, key string) *semver.Version {
if md == nil {
return zeroVersion
}
values := md.Get(key)
if len(values) == 0 || values[0] == "" {
return zeroVersion
}
sv, err := semver.NewVersion(values[0])
if err != nil {
return zeroVersion
}
return sv
}
func checkClientVersionHeaders(ctx context.Context) error {
md, _ := metadata.FromIncomingContext(ctx)
actualCLIVersion := extractVersion(md, MetadataKeyCLIVersion)
if actualCLIVersion.LessThan(minCLIVersion) {
return status.Errorf(codes.FailedPrecondition,
"version check failed: client version is below minimum %s. Please upgrade: %s",
minCLIVersion, ReleaseURL)
}
requiredMinDaemon := extractVersion(md, MetadataKeyMinDaemonVersion)
if currentVersion.LessThan(requiredMinDaemon) {
return status.Errorf(codes.FailedPrecondition,
"version check failed: daemon version %s is below client's minimum required version %s. Please upgrade the daemon: %s",
currentVersion, requiredMinDaemon, ReleaseURL)
}
return nil
}
func ServerUnaryInterceptor(ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (any, error) {
if err := checkClientVersionHeaders(ctx); err != nil {
return nil, err
}
if err := grpc.SetHeader(ctx, metadata.Pairs(MetadataKeyDaemonVersion, currentVersion.String())); err != nil {
return nil, err
}
return handler(ctx, req)
}
func ServerStreamInterceptor(srv any, ss grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
if err := checkClientVersionHeaders(ss.Context()); err != nil {
return err
}
if err := ss.SetHeader(metadata.Pairs(MetadataKeyDaemonVersion, currentVersion.String())); err != nil {
return err
}
return handler(srv, ss)
}
func ClientUnaryInterceptor(ctx context.Context, method string, req, reply any, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
ctx = metadata.AppendToOutgoingContext(ctx,
MetadataKeyCLIVersion, currentVersion.String(),
MetadataKeyMinDaemonVersion, MinDaemonVersion,
)
// TODO: remove when checkDaemonVersionInResponse is no longer needed,
// as we'll no longer need to extract headers from the response here.
var respMD metadata.MD
opts = append(opts, grpc.Header(&respMD))
err := invoker(ctx, method, req, reply, cc, opts...)
if err != nil {
return err
}
// TODO: Remove eventually (see note on method below)
checkDaemonVersionInResponse(respMD)
return nil
}
// This is just needed as a warning during the transition to version checking
// releases. It warns the user when they just communicated with a daemon that did
// not check the version requirements.
// TODO: Remove this in some later release, after users have upgraded.
func checkDaemonVersionInResponse(md metadata.MD) {
daemonVersion := extractVersion(md, MetadataKeyDaemonVersion)
if daemonVersion.LessThan(minDaemonVersion) {
if warned {
return
}
warned = true
msg := fmt.Sprintf("daemon version is below minimum required version %s. The daemon did not verify this CLI's minimum version requirement, so the operation may not have behaved as intended. Please upgrade the daemon: %s",
minDaemonVersion, ReleaseURL)
fmt.Fprintf(os.Stderr, "WARNING: %s\n", msg)
}
}
func ClientStreamInterceptor(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) {
ctx = metadata.AppendToOutgoingContext(ctx,
MetadataKeyCLIVersion, currentVersion.String(),
MetadataKeyMinDaemonVersion, MinDaemonVersion,
)
stream, err := streamer(ctx, desc, cc, method, opts...)
if err != nil {
return nil, err
}
// TODO: Wrapping the stream in versionedClientStream will no longer
// be necessary when we are ready to remove the temporary, transition
// safety check checkDaemonVersionInResponse (see note on method above)
return &versionedClientStream{ClientStream: stream}, nil
}
// TODO: remove when checkDaemonVersionInResponse is no longer needed
type versionedClientStream struct {
grpc.ClientStream
}
// TODO: remove when checkDaemonVersionInResponse is no longer needed
func (s *versionedClientStream) Header() (metadata.MD, error) {
md, err := s.ClientStream.Header()
if err != nil {
return nil, err
}
checkDaemonVersionInResponse(md)
return md, nil
}
-216
View File
@@ -1,216 +0,0 @@
package versioncheck
import (
"bytes"
"context"
"io"
"os"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
)
func TestExtractVersion(t *testing.T) {
tests := []struct {
name string
md metadata.MD
key string
expected string
}{
{
name: "nil metadata",
md: nil,
key: MetadataKeyCLIVersion,
expected: "0.0.0",
},
{
name: "missing key",
md: metadata.MD{},
key: MetadataKeyCLIVersion,
expected: "0.0.0",
},
{
name: "empty value",
md: metadata.Pairs(MetadataKeyCLIVersion, ""),
key: MetadataKeyCLIVersion,
expected: "0.0.0",
},
{
name: "invalid version",
md: metadata.Pairs(MetadataKeyCLIVersion, "not-a-version"),
key: MetadataKeyCLIVersion,
expected: "0.0.0",
},
{
name: "valid version",
md: metadata.Pairs(MetadataKeyCLIVersion, "1.2.3"),
key: MetadataKeyCLIVersion,
expected: "1.2.3",
},
{
name: "version with prerelease",
md: metadata.Pairs(MetadataKeyCLIVersion, "0.0.0-dev"),
key: MetadataKeyCLIVersion,
expected: "0.0.0-dev",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := extractVersion(tt.md, tt.key)
assert.Equal(t, tt.expected, got.String())
})
}
}
func TestCheckClientVersionHeaders(t *testing.T) {
tests := []struct {
name string
md metadata.MD
wantErr bool
errCode codes.Code
errContain string
}{
{
name: "cli version below minimum",
md: metadata.Pairs(
MetadataKeyCLIVersion, "0.0.0-dev",
),
wantErr: true,
errCode: codes.FailedPrecondition,
errContain: "client version is below minimum",
},
{
name: "cli version above minimum",
md: metadata.Pairs(
MetadataKeyCLIVersion, "999.0.0",
),
wantErr: false,
},
{
name: "min daemon version above current daemon",
md: metadata.Pairs(
MetadataKeyCLIVersion, "999.0.0",
MetadataKeyMinDaemonVersion, "999.0.0",
),
wantErr: true,
errCode: codes.FailedPrecondition,
errContain: "daemon version",
},
{
name: "min daemon version below current daemon",
md: metadata.Pairs(
MetadataKeyCLIVersion, "999.0.0",
MetadataKeyMinDaemonVersion, "0.0.1",
),
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ctx := context.Background()
if tt.md != nil {
ctx = metadata.NewIncomingContext(ctx, tt.md)
}
err := checkClientVersionHeaders(ctx)
if tt.wantErr {
require.Error(t, err)
st, ok := status.FromError(err)
require.True(t, ok, "expected gRPC status error, got %T", err)
assert.Equal(t, tt.errCode, st.Code())
assert.True(t, strings.Contains(st.Message(), tt.errContain),
"error message = %q, want to contain %q", st.Message(), tt.errContain)
} else {
assert.NoError(t, err)
}
})
}
}
func TestCheckDaemonVersionInResponse(t *testing.T) {
tests := []struct {
name string
md metadata.MD
wantWarning bool
}{
{
name: "daemon version below minimum",
md: metadata.Pairs(MetadataKeyDaemonVersion, "0.0.0-dev"),
wantWarning: true,
},
{
name: "daemon version above minimum",
md: metadata.Pairs(MetadataKeyDaemonVersion, "999.0.0"),
wantWarning: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Reset warned flag for each test
warned = false
// Capture stderr
old := os.Stderr
r, w, _ := os.Pipe()
os.Stderr = w
checkDaemonVersionInResponse(tt.md)
w.Close()
var buf bytes.Buffer
io.Copy(&buf, r)
os.Stderr = old
output := buf.String()
if tt.wantWarning {
assert.True(t, strings.Contains(output, "WARNING"), "expected warning output, got none")
} else {
assert.Equal(t, "", output)
}
})
}
}
func TestCheckDaemonVersionInResponse_WarnOnce(t *testing.T) {
// Reset warned flag
warned = false
md := metadata.Pairs(MetadataKeyDaemonVersion, "0.0.0-dev")
// First call - should warn
old := os.Stderr
r, w, _ := os.Pipe()
os.Stderr = w
checkDaemonVersionInResponse(md)
w.Close()
var buf bytes.Buffer
io.Copy(&buf, r)
os.Stderr = old
assert.True(t, strings.Contains(buf.String(), "WARNING"), "first call should warn")
// Second call - should NOT warn (warned flag is now true)
r2, w2, _ := os.Pipe()
os.Stderr = w2
checkDaemonVersionInResponse(md)
w2.Close()
var buf2 bytes.Buffer
io.Copy(&buf2, r2)
os.Stderr = old
assert.Equal(t, "", buf2.String(), "second call should not warn")
}