fix: Use app slugs instead of the display name to report health

kylecarbs · kylecarbs · commit b0455f7a1106 · 2022-11-07T23:09:52.000Z
All applications without display names were reporting broken health.
diff --git a/agent/apphealth.go b/agent/apphealth.go
@@ -33,7 +33,7 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, apps []codersdk.Workspace
 		hasHealthchecksEnabled := false
 		health := make(map[string]codersdk.WorkspaceAppHealth, 0)
 		for _, app := range apps {
-			health[app.DisplayName] = app.Health
+			health[app.Slug] = app.Health
 			if !hasHealthchecksEnabled && app.Health != codersdk.WorkspaceAppHealthDisabled {
 				hasHealthchecksEnabled = true
 			}
@@ -85,21 +85,21 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, apps []codersdk.Workspace
 					}()
 					if err != nil {
 						mu.Lock()
-						if failures[app.DisplayName] < int(app.Healthcheck.Threshold) {
+						if failures[app.Slug] < int(app.Healthcheck.Threshold) {
 							// increment the failure count and keep status the same.
 							// we will change it when we hit the threshold.
-							failures[app.DisplayName]++
+							failures[app.Slug]++
 						} else {
 							// set to unhealthy if we hit the failure threshold.
 							// we stop incrementing at the threshold to prevent the failure value from increasing forever.
-							health[app.DisplayName] = codersdk.WorkspaceAppHealthUnhealthy
+							health[app.Slug] = codersdk.WorkspaceAppHealthUnhealthy
 						}
 						mu.Unlock()
 					} else {
 						mu.Lock()
 						// we only need one successful health check to be considered healthy.
-						health[app.DisplayName] = codersdk.WorkspaceAppHealthHealthy
-						failures[app.DisplayName] = 0
+						health[app.Slug] = codersdk.WorkspaceAppHealthHealthy
+						failures[app.Slug] = 0
 						mu.Unlock()
 					}
 
diff --git a/agent/apphealth_test.go b/agent/apphealth_test.go
@@ -27,12 +27,12 @@ func TestAppHealth(t *testing.T) {
 		defer cancel()
 		apps := []codersdk.WorkspaceApp{
 			{
-				DisplayName: "app1",
+				Slug:        "app1",
 				Healthcheck: codersdk.Healthcheck{},
 				Health:      codersdk.WorkspaceAppHealthDisabled,
 			},
 			{
-				DisplayName: "app2",
+				Slug: "app2",
 				Healthcheck: codersdk.Healthcheck{
 					// URL: We don't set the URL for this test because the setup will
 					// create a httptest server for us and set it for us.
@@ -69,7 +69,7 @@ func TestAppHealth(t *testing.T) {
 		defer cancel()
 		apps := []codersdk.WorkspaceApp{
 			{
-				DisplayName: "app2",
+				Slug: "app2",
 				Healthcheck: codersdk.Healthcheck{
 					// URL: We don't set the URL for this test because the setup will
 					// create a httptest server for us and set it for us.
@@ -102,7 +102,7 @@ func TestAppHealth(t *testing.T) {
 		defer cancel()
 		apps := []codersdk.WorkspaceApp{
 			{
-				DisplayName: "app2",
+				Slug: "app2",
 				Healthcheck: codersdk.Healthcheck{
 					// URL: We don't set the URL for this test because the setup will
 					// create a httptest server for us and set it for us.
@@ -137,7 +137,7 @@ func TestAppHealth(t *testing.T) {
 		defer cancel()
 		apps := []codersdk.WorkspaceApp{
 			{
-				DisplayName: "app2",
+				Slug: "app2",
 				Healthcheck: codersdk.Healthcheck{
 					// URL: We don't set the URL for this test because the setup will
 					// create a httptest server for us and set it for us.
@@ -187,7 +187,7 @@ func setupAppReporter(ctx context.Context, t *testing.T, apps []codersdk.Workspa
 		mu.Lock()
 		for name, health := range req.Healths {
 			for i, app := range apps {
-				if app.DisplayName != name {
+				if app.Slug != name {
 					continue
 				}
 				app.Health = health
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -916,7 +916,7 @@ func (api *API) postWorkspaceAppHealth(rw http.ResponseWriter, r *http.Request)
 	for name, newHealth := range req.Healths {
 		old := func() *database.WorkspaceApp {
 			for _, app := range apps {
-				if app.DisplayName == name {
+				if app.Slug == name {
 					return &app
 				}
 			}
diff --git a/coderd/workspaceagents_test.go b/coderd/workspaceagents_test.go
@@ -555,9 +555,8 @@ func TestWorkspaceAgentListeningPorts(t *testing.T) {
 			// should not exist in the response.
 			_, appLPort := generateUnfilteredPort(t)
 			app := &proto.App{
-				Slug:        "test-app",
-				DisplayName: "test-app",
-				Url:         fmt.Sprintf("http://localhost:%d", appLPort),
+				Slug: "test-app",
+				Url:  fmt.Sprintf("http://localhost:%d", appLPort),
 			}
 
 			// Generate a filtered port that should not exist in the response.
@@ -624,11 +623,10 @@ func TestWorkspaceAgentAppHealth(t *testing.T) {
 	authToken := uuid.NewString()
 	apps := []*proto.App{
 		{
-			Slug:        "code-server",
-			DisplayName: "code-server",
-			Command:     "some-command",
-			Url:         "http://localhost:3000",
-			Icon:        "/code.svg",
+			Slug:    "code-server",
+			Command: "some-command",
+			Url:     "http://localhost:3000",
+			Icon:    "/code.svg",
 		},
 		{
 			Slug:        "code-server-2",

Original file line number	Diff line number	Diff line change
`@@ -916,7 +916,7 @@ func (api API) postWorkspaceAppHealth(rw http.ResponseWriter, r http.Request)`
`916`	`916`	`for name, newHealth := range req.Healths {`
`917`	`917`	`old := func() *database.WorkspaceApp {`
`918`	`918`	`for _, app := range apps {`
`919`		`- if app.DisplayName == name {`
	`919`	`+ if app.Slug == name {`
`920`	`920`	`return &app`
`921`	`921`	`}`
`922`	`922`	`}`