WIP

mtojek · mtojek · commit 3cf35ebad20f · 2023-11-13T13:32:25.000+01:00
diff --git a/coderd/healthcheck/healthcheck.go b/coderd/healthcheck/healthcheck.go
@@ -30,7 +30,7 @@ type Checker interface {
 	Database(ctx context.Context, opts *DatabaseReportOptions) DatabaseReport
 }
 
-// @typescript-generate Report
+// @typescript-generate DerphealthReport
 type Report struct {
 	// Time is the time the report was generated at.
 	Time time.Time `json:"time"`
diff --git a/scripts/apitypings/main_test.go b/scripts/apitypings/main_test.go
@@ -41,3 +41,9 @@ func TestGeneration(t *testing.T) {
 		})
 	}
 }
+
+func TestFoo(t *testing.T) {
+	output, err := Generate("/Users/mtojek/code/coder/coderd/healthcheck")
+	require.NoError(t, err)
+	require.Equal(t, "a", output)
+}
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -1555,17 +1555,7 @@ export const getInsightsTemplate = async (
   return response.data;
 };
 
-export interface Health {
-  healthy: boolean;
-  time: string;
-  coder_version: string;
-  access_url: { healthy: boolean };
-  database: { healthy: boolean };
-  derp: { healthy: boolean };
-  websocket: { healthy: boolean };
-}
-
 export const getHealth = async () => {
-  const response = await axios.get<Health>("/api/v2/debug/health");
+  const response = await axios.get<TypesGen.HealthcheckReport>("/api/v2/debug/health");
   return response.data;
 };
diff --git a/site/src/components/Dashboard/DeploymentBanner/DeploymentBannerView.tsx b/site/src/components/Dashboard/DeploymentBanner/DeploymentBannerView.tsx
@@ -1,5 +1,4 @@
-import type { Health } from "api/api";
-import type { DeploymentStats, WorkspaceStatus } from "api/typesGenerated";
+import type { DeploymentStats, HealthcheckReport, WorkspaceStatus } from "api/typesGenerated";
 import {
   type FC,
   useMemo,
@@ -67,7 +66,7 @@ const styles = {
 } satisfies Record<string, Interpolation<Theme>>;
 
 export interface DeploymentBannerViewProps {
-  health?: Health;
+  health?: HealthcheckReport;
   stats?: DeploymentStats;
   fetchStats?: () => void;
 }
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -1,8 +1,7 @@
 import {
   withDefaultFeatures,
   type GetLicensesResponse,
-  type DeploymentConfig,
-  type Health,
+  type DeploymentConfig
 } from "api/api";
 import { FieldError } from "api/errors";
 import * as TypesGen from "api/typesGenerated";
@@ -2385,10 +2384,10 @@ export const MockLicenseResponse: GetLicensesResponse[] = [
   },
 ];
 
-export const MockHealth = {
+export const MockHealth: TypesGen.HealthcheckReport = {
   time: "2023-08-01T16:51:03.29792825Z",
   healthy: true,
-  failing_sections: null,
+  failing_sections: [],
   derp: {
     healthy: true,
     regions: {
@@ -2785,21 +2784,17 @@ export const MockHealth = {
     reachable: true,
     status_code: 200,
     healthz_response: "OK",
-    error: null,
   },
   websocket: {
     healthy: true,
-    response: {
-      body: "",
-      code: 101,
-    },
-    error: null,
+    body: "",
+    code: 101
   },
   database: {
     healthy: true,
     reachable: true,
-    latency: 92570,
-    error: null,
+    latency: "92570",
+    latency_ms: 92570,
   },
   coder_version: "v0.27.1-devel+c575292",
 };
@@ -2813,12 +2808,32 @@ export const MockListeningPortsResponse: TypesGen.WorkspaceAgentListeningPortsRe
     ],
   };
 
-export const DeploymentHealthUnhealthy: Health = {
+export const DeploymentHealthUnhealthy: TypesGen.HealthcheckReport = {
   healthy: false,
+  failing_sections: [], // apparently this property is not used at all?
   time: "2023-10-12T23:15:00.000000000Z",
   coder_version: "v2.3.0-devel+8cca4915a",
-  access_url: { healthy: true },
-  database: { healthy: false },
-  derp: { healthy: false },
-  websocket: { healthy: false },
+  access_url: {
+    healthy: true,
+    access_url: "",
+    healthz_response: "",
+    reachable: true,
+    status_code: 0,
+  },
+  database: {
+    healthy: false,
+    latency: "",
+    latency_ms: 0,
+    reachable: true,
+  },
+  derp: {
+    healthy: false,
+    regions: [],
+    netcheck_logs: [],
+  },
+  websocket: {
+    healthy: false,
+    body: "",
+    code: 0,
+  },
 };

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ type Checker interface {`
`30`	`30`	`Database(ctx context.Context, opts *DatabaseReportOptions) DatabaseReport`
`31`	`31`	`}`
`32`	`32`
`33`		`-// @typescript-generate Report`
	`33`	`+// @typescript-generate DerphealthReport`
`34`	`34`	`type Report struct {`
`35`	`35`	`// Time is the time the report was generated at.`
`36`	`36`	Time time.Time `json:"time"`
Original file line number	Diff line number	Diff line change
`@@ -41,3 +41,9 @@ func TestGeneration(t *testing.T) {`
`41`	`41`	`})`
`42`	`42`	`}`
`43`	`43`	`}`
	`44`	`+`
	`45`	`+func TestFoo(t *testing.T) {`
	`46`	`+ output, err := Generate("/Users/mtojek/code/coder/coderd/healthcheck")`
	`47`	`+ require.NoError(t, err)`
	`48`	`+ require.Equal(t, "a", output)`
	`49`	`+}`