feat: add ConnectRPC variants for older Agent API versions

spikecurtis · spikecurtis · commit ad9ab2f32e1d · 2024-07-03T15:58:09.000+04:00
diff --git a/agent/proto/agent_drpc_old.go b/agent/proto/agent_drpc_old.go
@@ -0,0 +1,38 @@
+package proto
+
+import (
+	"context"
+
+	"storj.io/drpc"
+)
+
+// DRPCAgentClient20 is the Agent API at v2.0.  Notably, it is missing GetAnnouncementBanners, but
+// is useful when you want to be maximally compatible with Coderd Release Versions from 2.9+
+type DRPCAgentClient20 interface {
+	DRPCConn() drpc.Conn
+
+	GetManifest(ctx context.Context, in *GetManifestRequest) (*Manifest, error)
+	GetServiceBanner(ctx context.Context, in *GetServiceBannerRequest) (*ServiceBanner, error)
+	UpdateStats(ctx context.Context, in *UpdateStatsRequest) (*UpdateStatsResponse, error)
+	UpdateLifecycle(ctx context.Context, in *UpdateLifecycleRequest) (*Lifecycle, error)
+	BatchUpdateAppHealths(ctx context.Context, in *BatchUpdateAppHealthRequest) (*BatchUpdateAppHealthResponse, error)
+	UpdateStartup(ctx context.Context, in *UpdateStartupRequest) (*Startup, error)
+	BatchUpdateMetadata(ctx context.Context, in *BatchUpdateMetadataRequest) (*BatchUpdateMetadataResponse, error)
+	BatchCreateLogs(ctx context.Context, in *BatchCreateLogsRequest) (*BatchCreateLogsResponse, error)
+}
+
+// DRPCAgentClient21 is the Agent API at v2.1. It is useful if you want to be maximally compatible
+// with Coderd Release Versions from 2.12+
+type DRPCAgentClient21 interface {
+	DRPCConn() drpc.Conn
+
+	GetManifest(ctx context.Context, in *GetManifestRequest) (*Manifest, error)
+	GetServiceBanner(ctx context.Context, in *GetServiceBannerRequest) (*ServiceBanner, error)
+	UpdateStats(ctx context.Context, in *UpdateStatsRequest) (*UpdateStatsResponse, error)
+	UpdateLifecycle(ctx context.Context, in *UpdateLifecycleRequest) (*Lifecycle, error)
+	BatchUpdateAppHealths(ctx context.Context, in *BatchUpdateAppHealthRequest) (*BatchUpdateAppHealthResponse, error)
+	UpdateStartup(ctx context.Context, in *UpdateStartupRequest) (*Startup, error)
+	BatchUpdateMetadata(ctx context.Context, in *BatchUpdateMetadataRequest) (*BatchUpdateMetadataResponse, error)
+	BatchCreateLogs(ctx context.Context, in *BatchCreateLogsRequest) (*BatchCreateLogsResponse, error)
+	GetAnnouncementBanners(ctx context.Context, in *GetAnnouncementBannersRequest) (*GetAnnouncementBannersResponse, error)
+}
diff --git a/apiversion/apiversion.go b/apiversion/apiversion.go
@@ -70,6 +70,19 @@ func (v *APIVersion) Validate(version string) error {
 	return xerrors.Errorf("version %s is no longer supported", version)
 }
 
+func (v *APIVersion) Newer(other *APIVersion) bool {
+	if v.supportedMajor > other.supportedMajor {
+		return true
+	}
+	if v.supportedMajor == other.supportedMajor {
+		if v.supportedMinor > other.supportedMinor {
+			return true
+		}
+		return false
+	}
+	return false
+}
+
 // Parse parses a valid major.minor version string into (major, minor).
 // Both major and minor must be valid integers separated by a period '.'.
 func Parse(version string) (major int, minor int, err error) {
diff --git a/apiversion/apiversion_test.go b/apiversion/apiversion_test.go
@@ -88,3 +88,47 @@ func TestAPIVersionValidate(t *testing.T) {
 		})
 	}
 }
+
+func TestAPIVersion_Newer(t *testing.T) {
+	t.Parallel()
+
+	v := apiversion.New(2, 1)
+
+	for _, tc := range []struct {
+		name    string
+		version *apiversion.APIVersion
+		newer   bool
+	}{
+		{
+			name:    "Same",
+			version: apiversion.New(2, 1),
+			newer:   false,
+		},
+		{
+			name:    "MinorNewer",
+			version: apiversion.New(2, 0),
+			newer:   true,
+		},
+		{
+			name:    "MinorOlder",
+			version: apiversion.New(2, 2),
+			newer:   false,
+		},
+		{
+			name:    "MajorNewer",
+			version: apiversion.New(1, 3),
+			newer:   true,
+		},
+		{
+			name:    "MajorOlder",
+			version: apiversion.New(3, 0),
+			newer:   false,
+		},
+	} {
+		tc := tc
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+			require.Equal(t, tc.newer, v.Newer(tc.version))
+		})
+	}
+}
diff --git a/codersdk/agentsdk/agentsdk.go b/codersdk/agentsdk/agentsdk.go
@@ -21,6 +21,7 @@ import (
 
 	"cdr.dev/slog"
 	"github.com/coder/coder/v2/agent/proto"
+	"github.com/coder/coder/v2/apiversion"
 	"github.com/coder/coder/v2/codersdk"
 	drpcsdk "github.com/coder/coder/v2/codersdk/drpc"
 )
@@ -155,14 +156,39 @@ func (c *Client) RewriteDERPMap(derpMap *tailcfg.DERPMap) {
 	}
 }
 
+// ConnectRPC20 returns a dRPC client to the Agent API v2.0.  Notably, it is missing
+// GetAnnouncementBanners, but is useful when you want to be maximally compatible with Coderd
+// Release Versions from 2.9+
+func (c *Client) ConnectRPC20(ctx context.Context) (proto.DRPCAgentClient20, error) {
+	conn, err := c.connectRPCVersion(ctx, apiversion.New(2, 0))
+	if err != nil {
+		return nil, err
+	}
+	return proto.NewDRPCAgentClient(conn), nil
+}
+
+// ConnectRPC21 returns a dRPC client to the Agent API v2.1.  It is useful when you want to be
+// maximally compatible with Coderd Release Versions from 2.12+
+func (c *Client) ConnectRPC21(ctx context.Context) (proto.DRPCAgentClient21, error) {
+	conn, err := c.connectRPCVersion(ctx, apiversion.New(2, 1))
+	if err != nil {
+		return nil, err
+	}
+	return proto.NewDRPCAgentClient(conn), nil
+}
+
 // ConnectRPC connects to the workspace agent API and tailnet API
 func (c *Client) ConnectRPC(ctx context.Context) (drpc.Conn, error) {
+	return c.connectRPCVersion(ctx, proto.CurrentVersion)
+}
+
+func (c *Client) connectRPCVersion(ctx context.Context, version *apiversion.APIVersion) (drpc.Conn, error) {
 	rpcURL, err := c.SDK.URL.Parse("/api/v2/workspaceagents/me/rpc")
 	if err != nil {
 		return nil, xerrors.Errorf("parse url: %w", err)
 	}
 	q := rpcURL.Query()
-	q.Add("version", proto.CurrentVersion.String())
+	q.Add("version", version.String())
 	rpcURL.RawQuery = q.Encode()
 
 	jar, err := cookiejar.New(nil)
