From 95363c9041d805e03b1be422a7dd64cfe7ec1603 Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Thu, 27 Feb 2025 09:08:08 +0000 Subject: [PATCH] fix(enterprise/coderd): remove useless provisioner daemon id from request (#16723) `ServeProvisionerDaemonRequest` has had an ID field for quite a while now. This field is only used for telemetry purposes; the actual daemon ID is created upon insertion in the database. There's no reason to set it, and it's confusing to do so. Deprecating the field and removing references to it. --- codersdk/provisionerdaemons.go | 2 +- enterprise/cli/provisionerdaemonstart.go | 1 - enterprise/coderd/coderdenttest/coderdenttest.go | 1 - enterprise/coderd/provisionerdaemons.go | 7 +------ enterprise/coderd/provisionerdaemons_test.go | 11 ----------- 5 files changed, 2 insertions(+), 20 deletions(-) diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go index f6130f3b82..2a9472f1cb 100644 --- a/codersdk/provisionerdaemons.go +++ b/codersdk/provisionerdaemons.go @@ -239,6 +239,7 @@ func (c *Client) provisionerJobLogsAfter(ctx context.Context, path string, after // @typescript-ignore ServeProvisionerDaemonRequest type ServeProvisionerDaemonRequest struct { // ID is a unique ID for a provisioner daemon. + // Deprecated: this field has always been ignored. ID uuid.UUID `json:"id" format:"uuid"` // Name is the human-readable unique identifier for the daemon. Name string `json:"name" example:"my-cool-provisioner-daemon"` @@ -270,7 +271,6 @@ func (c *Client) ServeProvisionerDaemon(ctx context.Context, req ServeProvisione } query := serverURL.Query() query.Add("version", proto.CurrentVersion.String()) - query.Add("id", req.ID.String()) query.Add("name", req.Name) query.Add("version", proto.CurrentVersion.String()) diff --git a/enterprise/cli/provisionerdaemonstart.go b/enterprise/cli/provisionerdaemonstart.go index 8d7d319d39..e0b3e00c63 100644 --- a/enterprise/cli/provisionerdaemonstart.go +++ b/enterprise/cli/provisionerdaemonstart.go @@ -225,7 +225,6 @@ func (r *RootCmd) provisionerDaemonStart() *serpent.Command { } srv := provisionerd.New(func(ctx context.Context) (provisionerdproto.DRPCProvisionerDaemonClient, error) { return client.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: name, Provisioners: []codersdk.ProvisionerType{ codersdk.ProvisionerTypeTerraform, diff --git a/enterprise/coderd/coderdenttest/coderdenttest.go b/enterprise/coderd/coderdenttest/coderdenttest.go index d76722b5ba..a72c8c0199 100644 --- a/enterprise/coderd/coderdenttest/coderdenttest.go +++ b/enterprise/coderd/coderdenttest/coderdenttest.go @@ -388,7 +388,6 @@ func newExternalProvisionerDaemon(t testing.TB, client *codersdk.Client, org uui daemon := provisionerd.New(func(ctx context.Context) (provisionerdproto.DRPCProvisionerDaemonClient, error) { return client.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: testutil.GetRandomName(t), Organization: org, Provisioners: []codersdk.ProvisionerType{provisionerType}, diff --git a/enterprise/coderd/provisionerdaemons.go b/enterprise/coderd/provisionerdaemons.go index f433543865..5b0f0ca197 100644 --- a/enterprise/coderd/provisionerdaemons.go +++ b/enterprise/coderd/provisionerdaemons.go @@ -175,11 +175,6 @@ func (api *API) provisionerDaemonServe(rw http.ResponseWriter, r *http.Request) return } - id, _ := uuid.Parse(r.URL.Query().Get("id")) - if id == uuid.Nil { - id = uuid.New() - } - provisionersMap := map[codersdk.ProvisionerType]struct{}{} for _, provisioner := range r.URL.Query()["provisioner"] { switch provisioner { @@ -295,7 +290,7 @@ func (api *API) provisionerDaemonServe(rw http.ResponseWriter, r *http.Request) api.AGPL.WebsocketWaitMutex.Unlock() defer api.AGPL.WebsocketWaitGroup.Done() - tep := telemetry.ConvertExternalProvisioner(id, tags, provisioners) + tep := telemetry.ConvertExternalProvisioner(daemon.ID, tags, provisioners) api.Telemetry.Report(&telemetry.Snapshot{ExternalProvisioners: []telemetry.ExternalProvisioner{tep}}) defer func() { tep.ShutdownAt = ptr.Ref(time.Now()) diff --git a/enterprise/coderd/provisionerdaemons_test.go b/enterprise/coderd/provisionerdaemons_test.go index 0cd812b45c..a84213f718 100644 --- a/enterprise/coderd/provisionerdaemons_test.go +++ b/enterprise/coderd/provisionerdaemons_test.go @@ -50,7 +50,6 @@ func TestProvisionerDaemonServe(t *testing.T) { defer cancel() daemonName := testutil.MustRandString(t, 63) srv, err := templateAdminClient.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: daemonName, Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -180,7 +179,6 @@ func TestProvisionerDaemonServe(t *testing.T) { defer cancel() daemonName := testutil.MustRandString(t, 63) _, err := templateAdminClient.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: daemonName, Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -205,7 +203,6 @@ func TestProvisionerDaemonServe(t *testing.T) { ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong) defer cancel() _, err := another.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: testutil.MustRandString(t, 63), Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -229,7 +226,6 @@ func TestProvisionerDaemonServe(t *testing.T) { ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong) defer cancel() _, err := another.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: testutil.MustRandString(t, 63), Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -360,7 +356,6 @@ func TestProvisionerDaemonServe(t *testing.T) { ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong) defer cancel() req := codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: testutil.MustRandString(t, 63), Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -425,7 +420,6 @@ func TestProvisionerDaemonServe(t *testing.T) { another := codersdk.New(client.URL) pd := provisionerd.New(func(ctx context.Context) (proto.DRPCProvisionerDaemonClient, error) { return another.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: testutil.MustRandString(t, 63), Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -503,7 +497,6 @@ func TestProvisionerDaemonServe(t *testing.T) { ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong) defer cancel() _, err := another.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: testutil.MustRandString(t, 32), Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -538,7 +531,6 @@ func TestProvisionerDaemonServe(t *testing.T) { defer cancel() another := codersdk.New(client.URL) _, err := another.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: testutil.MustRandString(t, 63), Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -571,7 +563,6 @@ func TestProvisionerDaemonServe(t *testing.T) { defer cancel() another := codersdk.New(client.URL) _, err := another.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: testutil.MustRandString(t, 63), Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -698,7 +689,6 @@ func TestProvisionerDaemonServe(t *testing.T) { another := codersdk.New(client.URL) srv, err := another.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: testutil.MustRandString(t, 63), Organization: user.OrganizationID, Provisioners: []codersdk.ProvisionerType{ @@ -758,7 +748,6 @@ func TestGetProvisionerDaemons(t *testing.T) { defer cancel() daemonName := testutil.MustRandString(t, 63) srv, err := orgAdmin.ServeProvisionerDaemon(ctx, codersdk.ServeProvisionerDaemonRequest{ - ID: uuid.New(), Name: daemonName, Organization: org.ID, Provisioners: []codersdk.ProvisionerType{