add healthcheck type

coder · f0ssel · Sep 23, 2022 · Sep 19, 2022 · Sep 19, 2022 · Sep 19, 2022
commit bb5aa3e9264ddd57f83dd9d0ca544d7aaa3daf93
diff --git a/agent/apphealth.go b/agent/apphealth.go
@@ -40,7 +40,7 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, client *codersdk.Client)
 				tickers := make(chan string)
 				for _, app := range apps {
 					if shouldStartTicker(app) {
-						t := time.NewTicker(time.Duration(app.HealthcheckInterval) * time.Second)
+						t := time.NewTicker(time.Duration(app.Healthcheck.Interval) * time.Second)
 						go func() {
 							for {
 								select {
@@ -67,10 +67,10 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, client *codersdk.Client)
 								}
 
 								client := &http.Client{
-									Timeout: time.Duration(app.HealthcheckInterval),
+									Timeout: time.Duration(app.Healthcheck.Interval),
 								}
 								err := func() error {
-									req, err := http.NewRequestWithContext(ctx, http.MethodGet, app.HealthcheckURL, nil)
+									req, err := http.NewRequestWithContext(ctx, http.MethodGet, app.Healthcheck.URL, nil)
 									if err != nil {
 										return err
 									}
@@ -88,7 +88,7 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, client *codersdk.Client)
 								if err == nil {
 									mu.Lock()
 									failures[app.Name]++
-									if failures[app.Name] > int(app.HealthcheckThreshold) {
+									if failures[app.Name] > int(app.Healthcheck.Threshold) {
 										health[app.Name] = codersdk.WorkspaceAppHealthUnhealthy
 									}
 									mu.Unlock()
@@ -139,7 +139,7 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, client *codersdk.Client)
 }
 
 func shouldStartTicker(app codersdk.WorkspaceApp) bool {
-	return app.HealthcheckURL != "" && app.HealthcheckInterval > 0 && app.HealthcheckThreshold > 0
+	return app.Healthcheck.URL != "" && app.Healthcheck.Interval > 0 && app.Healthcheck.Threshold > 0
 }
 
 func healthChanged(old map[string]codersdk.WorkspaceAppHealth, new map[string]codersdk.WorkspaceAppHealth) bool {

diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -813,7 +813,10 @@ func insertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 
 		for _, app := range prAgent.Apps {
 			health := database.WorkspaceAppHealthDisabled
-			if app.HealthcheckUrl != "" {
+			if app.Healthcheck == nil {
+				app.Healthcheck = &sdkproto.Healthcheck{}
+			}
+			if app.Healthcheck.Url != "" {
 				health = database.WorkspaceAppHealthInitializing
 			}
 
@@ -832,9 +835,9 @@ func insertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 					Valid:  app.Url != "",
 				},
 				RelativePath:         app.RelativePath,
-				HealthcheckUrl:       app.HealthcheckUrl,
-				HealthcheckInterval:  app.HealthcheckInterval,
-				HealthcheckThreshold: app.HealthcheckThreshold,
+				HealthcheckUrl:       app.Healthcheck.Url,
+				HealthcheckInterval:  app.Healthcheck.Interval,
+				HealthcheckThreshold: app.Healthcheck.Threshold,
 				Health:               health,
 			})
 			if err != nil {

diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -448,14 +448,16 @@ func convertApps(dbApps []database.WorkspaceApp) []codersdk.WorkspaceApp {
 	apps := make([]codersdk.WorkspaceApp, 0)
 	for _, dbApp := range dbApps {
 		apps = append(apps, codersdk.WorkspaceApp{
-			ID:                   dbApp.ID,
-			Name:                 dbApp.Name,
-			Command:              dbApp.Command.String,
-			Icon:                 dbApp.Icon,
-			HealthcheckURL:       dbApp.HealthcheckUrl,
-			HealthcheckInterval:  dbApp.HealthcheckInterval,
-			HealthcheckThreshold: dbApp.HealthcheckThreshold,
-			Health:               codersdk.WorkspaceAppHealth(dbApp.Health),
+			ID:      dbApp.ID,
+			Name:    dbApp.Name,
+			Command: dbApp.Command.String,
+			Icon:    dbApp.Icon,
+			Healthcheck: codersdk.Healthcheck{
+				URL:       dbApp.HealthcheckUrl,
+				Interval:  dbApp.HealthcheckInterval,
+				Threshold: dbApp.HealthcheckThreshold,
+			},
+			Health: codersdk.WorkspaceAppHealth(dbApp.Health),
 		})
 	}
 	return apps

diff --git a/coderd/workspaceagents_test.go b/coderd/workspaceagents_test.go
@@ -379,13 +379,15 @@ func TestWorkspaceAgentAppHealth(t *testing.T) {
 			Icon:    "/code.svg",
 		},
 		{
-			Name:                 "code-server-2",
-			Command:              "some-command",
-			Url:                  "http://localhost:3000",
-			Icon:                 "/code.svg",
-			HealthcheckUrl:       "http://localhost:3000",
-			HealthcheckInterval:  5,
-			HealthcheckThreshold: 6,
+			Name:    "code-server-2",
+			Command: "some-command",
+			Url:     "http://localhost:3000",
+			Icon:    "/code.svg",
+			Healthcheck: &proto.Healthcheck{
+				Url:       "http://localhost:3000",
+				Interval:  5,
+				Threshold: 6,
+			},
 		},
 	}
 	version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{

diff --git a/coderd/workspaceresources_test.go b/coderd/workspaceresources_test.go
@@ -82,13 +82,15 @@ func TestWorkspaceResource(t *testing.T) {
 				Icon:    "/code.svg",
 			},
 			{
-				Name:                 "code-server-2",
-				Command:              "some-command",
-				Url:                  "http://localhost:3000",
-				Icon:                 "/code.svg",
-				HealthcheckUrl:       "http://localhost:3000",
-				HealthcheckInterval:  5,
-				HealthcheckThreshold: 6,
+				Name:    "code-server-2",
+				Command: "some-command",
+				Url:     "http://localhost:3000",
+				Icon:    "/code.svg",
+				Healthcheck: &proto.Healthcheck{
+					Url:       "http://localhost:3000",
+					Interval:  5,
+					Threshold: 6,
+				},
 			},
 		}
 		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
@@ -130,18 +132,18 @@ func TestWorkspaceResource(t *testing.T) {
 		require.EqualValues(t, app.Icon, got.Icon)
 		require.EqualValues(t, app.Name, got.Name)
 		require.EqualValues(t, codersdk.WorkspaceAppHealthDisabled, got.Health)
-		require.EqualValues(t, app.HealthcheckUrl, got.HealthcheckURL)
-		require.EqualValues(t, app.HealthcheckInterval, got.HealthcheckInterval)
-		require.EqualValues(t, app.HealthcheckThreshold, got.HealthcheckThreshold)
+		require.EqualValues(t, "", got.Healthcheck.URL)
+		require.EqualValues(t, 0, got.Healthcheck.Interval)
+		require.EqualValues(t, 0, got.Healthcheck.Threshold)
 		got = agent.Apps[1]
 		app = apps[1]
 		require.EqualValues(t, app.Command, got.Command)
 		require.EqualValues(t, app.Icon, got.Icon)
 		require.EqualValues(t, app.Name, got.Name)
 		require.EqualValues(t, codersdk.WorkspaceAppHealthInitializing, got.Health)
-		require.EqualValues(t, app.HealthcheckUrl, got.HealthcheckURL)
-		require.EqualValues(t, app.HealthcheckInterval, got.HealthcheckInterval)
-		require.EqualValues(t, app.HealthcheckThreshold, got.HealthcheckThreshold)
+		require.EqualValues(t, app.Healthcheck.Url, got.Healthcheck.URL)
+		require.EqualValues(t, app.Healthcheck.Interval, got.Healthcheck.Interval)
+		require.EqualValues(t, app.Healthcheck.Threshold, got.Healthcheck.Threshold)
 	})
 
 	t.Run("Metadata", func(t *testing.T) {

diff --git a/codersdk/workspaceapps.go b/codersdk/workspaceapps.go
@@ -21,14 +21,18 @@ type WorkspaceApp struct {
 	// Icon is a relative path or external URL that specifies
 	// an icon to be displayed in the dashboard.
 	Icon string `json:"icon,omitempty"`
-	// HealthcheckURL specifies the url to check for the app health.
-	HealthcheckURL string `json:"healthcheck_url"`
-	// HealthcheckInterval specifies the seconds between each health check.
-	HealthcheckInterval int32 `json:"healthcheck_interval"`
-	// HealthcheckThreshold specifies the number of consecutive failed health checks before returning "unhealthy".
-	HealthcheckThreshold int32 `json:"healthcheck_threshold"`
-	// Health specifies the current status of the app's health.
-	Health WorkspaceAppHealth `json:"health"`
+	// Healthcheck specifies the configuration for checking app health.
+	Healthcheck Healthcheck        `json:"healthcheck"`
+	Health      WorkspaceAppHealth `json:"health"`
+}
+
+type Healthcheck struct {
+	// URL specifies the url to check for the app health.
+	URL string `json:"url"`
+	// Interval specifies the seconds between each health check.
+	Interval int32 `json:"interval"`
+	// Threshold specifies the number of consecutive failed health checks before returning "unhealthy".
+	Threshold int32 `json:"threshold"`
 }
 
 // @typescript-ignore PostWorkspaceAppHealthsRequest

diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -228,14 +228,16 @@ func ConvertResources(module *tfjson.StateModule, rawGraph string) ([]*proto.Res
 					continue
 				}
 				agent.Apps = append(agent.Apps, &proto.App{
-					Name:                 attrs.Name,
-					Command:              attrs.Command,
-					Url:                  attrs.URL,
-					Icon:                 attrs.Icon,
-					RelativePath:         attrs.RelativePath,
-					HealthcheckUrl:       attrs.HealthcheckURL,
-					HealthcheckInterval:  attrs.HealthcheckInterval,
-					HealthcheckThreshold: attrs.HealthcheckThreshold,
+					Name:         attrs.Name,
+					Command:      attrs.Command,
+					Url:          attrs.URL,
+					Icon:         attrs.Icon,
+					RelativePath: attrs.RelativePath,
+					Healthcheck: &proto.Healthcheck{
+						Url:       attrs.HealthcheckURL,
+						Interval:  attrs.HealthcheckInterval,
+						Threshold: attrs.HealthcheckThreshold,
+					},
 				})
 			}
 		}