@checkstack/healthcheck-frontend 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,74 +1,30 @@
1
1
  import { ExtensionSlot } from "@checkstack/frontend-api";
2
- import { LoadingSpinner, InfoBanner } from "@checkstack/ui";
3
- import { useHealthCheckData } from "../hooks/useHealthCheckData";
4
- import { HealthCheckDiagramSlot } from "../slots";
2
+ import { InfoBanner } from "@checkstack/ui";
3
+ import {
4
+ HealthCheckDiagramSlot,
5
+ type HealthCheckDiagramSlotContext,
6
+ } from "../slots";
5
7
  import { AggregatedDataBanner } from "./AggregatedDataBanner";
6
8
 
7
9
  interface HealthCheckDiagramProps {
8
- systemId: string;
9
- configurationId: string;
10
- strategyId: string;
11
- dateRange: {
12
- startDate: Date;
13
- endDate: Date;
14
- };
15
- limit?: number;
16
- offset?: number;
10
+ /** The context from useHealthCheckData - handles both raw and aggregated modes */
11
+ context: HealthCheckDiagramSlotContext;
12
+ /** Whether the data is aggregated (for showing the info banner) */
13
+ isAggregated?: boolean;
14
+ /** Raw retention days (for the info banner) */
15
+ rawRetentionDays?: number;
17
16
  }
18
17
 
19
18
  /**
20
- * Wrapper component that handles loading health check data and rendering
21
- * the diagram extension slot with the appropriate context (raw or aggregated).
22
- *
23
- * Automatically determines whether to use raw or aggregated data based on
24
- * the date range and the configured rawRetentionDays.
19
+ * Component that renders the diagram extension slot with the provided context.
20
+ * Expects parent component to fetch data via useHealthCheckData and pass context.
25
21
  */
26
22
  export function HealthCheckDiagram({
27
- systemId,
28
- configurationId,
29
- strategyId,
30
- dateRange,
31
- limit,
32
- offset,
23
+ context,
24
+ isAggregated = false,
25
+ rawRetentionDays = 7,
33
26
  }: HealthCheckDiagramProps) {
34
- const {
35
- context,
36
- loading,
37
- hasPermission,
38
- permissionLoading,
39
- isAggregated,
40
- retentionConfig,
41
- } = useHealthCheckData({
42
- systemId,
43
- configurationId,
44
- strategyId,
45
- dateRange,
46
- limit,
47
- offset,
48
- });
49
-
50
- if (permissionLoading) {
51
- return <LoadingSpinner />;
52
- }
53
-
54
- if (!hasPermission) {
55
- return (
56
- <InfoBanner variant="info">
57
- Additional strategy-specific visualizations are available with the
58
- &quot;Read Health Check Details&quot; permission.
59
- </InfoBanner>
60
- );
61
- }
62
-
63
- if (loading) {
64
- return <LoadingSpinner />;
65
- }
66
-
67
- if (!context) {
68
- return;
69
- }
70
-
71
- // Determine bucket size from context for aggregated data
27
+ // Determine bucket size from context for aggregated data info banner
72
28
  const bucketSize =
73
29
  context.type === "aggregated" && context.buckets.length > 0
74
30
  ? context.buckets[0].bucketSize
@@ -79,10 +35,31 @@ export function HealthCheckDiagram({
79
35
  {isAggregated && (
80
36
  <AggregatedDataBanner
81
37
  bucketSize={bucketSize}
82
- rawRetentionDays={retentionConfig.rawRetentionDays}
38
+ rawRetentionDays={rawRetentionDays}
83
39
  />
84
40
  )}
85
41
  <ExtensionSlot slot={HealthCheckDiagramSlot} context={context} />
86
42
  </>
87
43
  );
88
44
  }
45
+
46
+ /**
47
+ * Wrapper that shows permission message when user lacks access.
48
+ */
49
+ export function HealthCheckDiagramPermissionGate({
50
+ hasPermission,
51
+ children,
52
+ }: {
53
+ hasPermission: boolean;
54
+ children: React.ReactNode;
55
+ }) {
56
+ if (!hasPermission) {
57
+ return (
58
+ <InfoBanner variant="info">
59
+ Additional strategy-specific visualizations are available with the
60
+ &quot;Read Health Check Details&quot; permission.
61
+ </InfoBanner>
62
+ );
63
+ }
64
+ return <>{children}</>;
65
+ }
@@ -8,50 +8,130 @@ import {
8
8
  ReferenceLine,
9
9
  } from "recharts";
10
10
  import { format } from "date-fns";
11
+ import type { HealthCheckDiagramSlotContext } from "../slots";
11
12
 
12
- export interface LatencyDataPoint {
13
- timestamp: Date;
14
- latencyMs: number;
15
- status: "healthy" | "degraded" | "unhealthy";
16
- }
17
-
18
- export interface AggregatedLatencyDataPoint {
19
- bucketStart: Date;
20
- avgLatencyMs: number;
21
- minLatencyMs?: number;
22
- maxLatencyMs?: number;
23
- bucketSize: "hourly" | "daily";
24
- }
25
-
26
- type RawLatencyChartProps = {
27
- type: "raw";
28
- data: LatencyDataPoint[];
29
- height?: number;
30
- showAverage?: boolean;
31
- };
32
-
33
- type AggregatedLatencyChartProps = {
34
- type: "aggregated";
35
- data: AggregatedLatencyDataPoint[];
13
+ interface HealthCheckLatencyChartProps {
14
+ context: HealthCheckDiagramSlotContext;
36
15
  height?: number;
37
16
  showAverage?: boolean;
38
- };
39
-
40
- type HealthCheckLatencyChartProps =
41
- | RawLatencyChartProps
42
- | AggregatedLatencyChartProps;
17
+ }
43
18
 
44
19
  /**
45
20
  * Area chart showing health check latency over time.
46
21
  * Supports both raw per-run data and aggregated bucket data.
47
22
  * Uses HSL CSS variables for theming consistency.
48
23
  */
49
- export const HealthCheckLatencyChart: React.FC<HealthCheckLatencyChartProps> = (
50
- props
51
- ) => {
52
- const { height = 200, showAverage = true } = props;
24
+ export const HealthCheckLatencyChart: React.FC<
25
+ HealthCheckLatencyChartProps
26
+ > = ({ context, height = 200, showAverage = true }) => {
27
+ if (context.type === "aggregated") {
28
+ const buckets = context.buckets.filter((b) => b.avgLatencyMs !== undefined);
29
+
30
+ if (buckets.length === 0) {
31
+ return (
32
+ <div
33
+ className="flex items-center justify-center text-muted-foreground"
34
+ style={{ height }}
35
+ >
36
+ No latency data available
37
+ </div>
38
+ );
39
+ }
40
+
41
+ const chartData = buckets.map((d) => ({
42
+ timestamp: new Date(d.bucketStart).getTime(),
43
+ latencyMs: d.avgLatencyMs!,
44
+ minLatencyMs: d.minLatencyMs,
45
+ maxLatencyMs: d.maxLatencyMs,
46
+ }));
47
+
48
+ const avgLatency =
49
+ chartData.length > 0
50
+ ? chartData.reduce((sum, d) => sum + d.latencyMs, 0) / chartData.length
51
+ : 0;
52
+
53
+ const timeFormat =
54
+ buckets[0]?.bucketSize === "daily" ? "MMM d" : "MMM d HH:mm";
53
55
 
54
- if (props.data.length === 0) {
56
+ return (
57
+ <ResponsiveContainer width="100%" height={height}>
58
+ <AreaChart data={chartData}>
59
+ <defs>
60
+ <linearGradient id="latencyGradient" x1="0" y1="0" x2="0" y2="1">
61
+ <stop
62
+ offset="5%"
63
+ stopColor="hsl(var(--primary))"
64
+ stopOpacity={0.3}
65
+ />
66
+ <stop
67
+ offset="95%"
68
+ stopColor="hsl(var(--primary))"
69
+ stopOpacity={0}
70
+ />
71
+ </linearGradient>
72
+ </defs>
73
+ <XAxis
74
+ dataKey="timestamp"
75
+ type="number"
76
+ domain={["auto", "auto"]}
77
+ tickFormatter={(ts: number) => format(new Date(ts), timeFormat)}
78
+ stroke="hsl(var(--muted-foreground))"
79
+ fontSize={12}
80
+ />
81
+ <YAxis
82
+ stroke="hsl(var(--muted-foreground))"
83
+ fontSize={12}
84
+ tickFormatter={(v: number) => `${v}ms`}
85
+ />
86
+ <Tooltip<number, "latencyMs">
87
+ content={({ active, payload }) => {
88
+ if (!active || !payload?.length) return;
89
+ const data = payload[0].payload as (typeof chartData)[number];
90
+ return (
91
+ <div
92
+ className="rounded-md border bg-popover p-2 text-sm shadow-md"
93
+ style={{
94
+ backgroundColor: "hsl(var(--popover))",
95
+ border: "1px solid hsl(var(--border))",
96
+ }}
97
+ >
98
+ <p className="text-muted-foreground">
99
+ {format(new Date(data.timestamp), "MMM d, HH:mm:ss")}
100
+ </p>
101
+ <p className="font-medium">{data.latencyMs}ms</p>
102
+ </div>
103
+ );
104
+ }}
105
+ />
106
+ {showAverage && (
107
+ <ReferenceLine
108
+ y={avgLatency}
109
+ stroke="hsl(var(--muted-foreground))"
110
+ strokeDasharray="3 3"
111
+ label={{
112
+ value: `Avg: ${avgLatency.toFixed(0)}ms`,
113
+ position: "right",
114
+ fill: "hsl(var(--muted-foreground))",
115
+ fontSize: 12,
116
+ }}
117
+ />
118
+ )}
119
+ <Area
120
+ type="monotone"
121
+ dataKey="latencyMs"
122
+ stroke="hsl(var(--primary))"
123
+ fill="url(#latencyGradient)"
124
+ strokeWidth={2}
125
+ />
126
+ </AreaChart>
127
+ </ResponsiveContainer>
128
+ );
129
+ }
130
+
131
+ // Raw data path
132
+ const runs = context.runs.filter((r) => r.latencyMs !== undefined);
133
+
134
+ if (runs.length === 0) {
55
135
  return (
56
136
  <div
57
137
  className="flex items-center justify-center text-muted-foreground"
@@ -62,34 +142,16 @@ export const HealthCheckLatencyChart: React.FC<HealthCheckLatencyChartProps> = (
62
142
  );
63
143
  }
64
144
 
65
- // Transform data based on type
66
- const isAggregated = props.type === "aggregated";
67
-
68
- const chartData = isAggregated
69
- ? (props.data as AggregatedLatencyDataPoint[]).map((d) => ({
70
- timestamp: d.bucketStart.getTime(),
71
- latencyMs: d.avgLatencyMs,
72
- minLatencyMs: d.minLatencyMs,
73
- maxLatencyMs: d.maxLatencyMs,
74
- }))
75
- : (props.data as LatencyDataPoint[]).toReversed().map((d) => ({
76
- timestamp: d.timestamp.getTime(),
77
- latencyMs: d.latencyMs,
78
- }));
145
+ const chartData = runs.toReversed().map((d) => ({
146
+ timestamp: new Date(d.timestamp).getTime(),
147
+ latencyMs: d.latencyMs!,
148
+ }));
79
149
 
80
- // Calculate average latency
81
150
  const avgLatency =
82
151
  chartData.length > 0
83
152
  ? chartData.reduce((sum, d) => sum + d.latencyMs, 0) / chartData.length
84
153
  : 0;
85
154
 
86
- // Format based on bucket size for aggregated data
87
- const timeFormat = isAggregated
88
- ? (props.data as AggregatedLatencyDataPoint[])[0]?.bucketSize === "daily"
89
- ? "MMM d"
90
- : "MMM d HH:mm"
91
- : "HH:mm";
92
-
93
155
  return (
94
156
  <ResponsiveContainer width="100%" height={height}>
95
157
  <AreaChart data={chartData}>
@@ -111,7 +173,7 @@ export const HealthCheckLatencyChart: React.FC<HealthCheckLatencyChartProps> = (
111
173
  dataKey="timestamp"
112
174
  type="number"
113
175
  domain={["auto", "auto"]}
114
- tickFormatter={(ts: number) => format(new Date(ts), timeFormat)}
176
+ tickFormatter={(ts: number) => format(new Date(ts), "HH:mm")}
115
177
  stroke="hsl(var(--muted-foreground))"
116
178
  fontSize={12}
117
179
  />
@@ -123,8 +185,6 @@ export const HealthCheckLatencyChart: React.FC<HealthCheckLatencyChartProps> = (
123
185
  <Tooltip<number, "latencyMs">
124
186
  content={({ active, payload }) => {
125
187
  if (!active || !payload?.length) return;
126
- // Note: payload[0].payload is typed as `any` in recharts - this is a recharts limitation.
127
- // The Payload.payload property holds our data row but recharts can't infer its shape.
128
188
  const data = payload[0].payload as (typeof chartData)[number];
129
189
  return (
130
190
  <div
@@ -7,36 +7,12 @@ import {
7
7
  Cell,
8
8
  } from "recharts";
9
9
  import { format } from "date-fns";
10
+ import type { HealthCheckDiagramSlotContext } from "../slots";
10
11
 
11
- export interface StatusDataPoint {
12
- timestamp: Date;
13
- status: "healthy" | "degraded" | "unhealthy";
14
- }
15
-
16
- export interface AggregatedStatusDataPoint {
17
- bucketStart: Date;
18
- healthyCount: number;
19
- degradedCount: number;
20
- unhealthyCount: number;
21
- runCount: number;
22
- bucketSize: "hourly" | "daily";
23
- }
24
-
25
- type RawStatusTimelineProps = {
26
- type: "raw";
27
- data: StatusDataPoint[];
12
+ interface HealthCheckStatusTimelineProps {
13
+ context: HealthCheckDiagramSlotContext;
28
14
  height?: number;
29
- };
30
-
31
- type AggregatedStatusTimelineProps = {
32
- type: "aggregated";
33
- data: AggregatedStatusDataPoint[];
34
- height?: number;
35
- };
36
-
37
- type HealthCheckStatusTimelineProps =
38
- | RawStatusTimelineProps
39
- | AggregatedStatusTimelineProps;
15
+ }
40
16
 
41
17
  const statusColors = {
42
18
  healthy: "hsl(var(--success))",
@@ -51,28 +27,23 @@ const statusColors = {
51
27
  */
52
28
  export const HealthCheckStatusTimeline: React.FC<
53
29
  HealthCheckStatusTimelineProps
54
- > = (props) => {
55
- const { height = 60 } = props;
30
+ > = ({ context, height = 60 }) => {
31
+ if (context.type === "aggregated") {
32
+ const buckets = context.buckets;
56
33
 
57
- if (props.data.length === 0) {
58
- return (
59
- <div
60
- className="flex items-center justify-center text-muted-foreground"
61
- style={{ height }}
62
- >
63
- No status data available
64
- </div>
65
- );
66
- }
67
-
68
- const isAggregated = props.type === "aggregated";
34
+ if (buckets.length === 0) {
35
+ return (
36
+ <div
37
+ className="flex items-center justify-center text-muted-foreground"
38
+ style={{ height }}
39
+ >
40
+ No status data available
41
+ </div>
42
+ );
43
+ }
69
44
 
70
- // For raw data: transform to chart format
71
- // For aggregated data: use stacked bar format
72
- if (isAggregated) {
73
- const aggData = props.data as AggregatedStatusDataPoint[];
74
- const chartData = aggData.map((d) => ({
75
- timestamp: d.bucketStart.getTime(),
45
+ const chartData = buckets.map((d) => ({
46
+ timestamp: new Date(d.bucketStart).getTime(),
76
47
  healthy: d.healthyCount,
77
48
  degraded: d.degradedCount,
78
49
  unhealthy: d.unhealthyCount,
@@ -80,7 +51,7 @@ export const HealthCheckStatusTimeline: React.FC<
80
51
  }));
81
52
 
82
53
  const timeFormat =
83
- aggData[0]?.bucketSize === "daily" ? "MMM d" : "MMM d HH:mm";
54
+ buckets[0]?.bucketSize === "daily" ? "MMM d" : "MMM d HH:mm";
84
55
 
85
56
  return (
86
57
  <ResponsiveContainer width="100%" height={height}>
@@ -137,9 +108,21 @@ export const HealthCheckStatusTimeline: React.FC<
137
108
  }
138
109
 
139
110
  // Raw data path
140
- const rawData = props.data as StatusDataPoint[];
141
- const chartData = rawData.toReversed().map((d) => ({
142
- timestamp: d.timestamp.getTime(),
111
+ const runs = context.runs;
112
+
113
+ if (runs.length === 0) {
114
+ return (
115
+ <div
116
+ className="flex items-center justify-center text-muted-foreground"
117
+ style={{ height }}
118
+ >
119
+ No status data available
120
+ </div>
121
+ );
122
+ }
123
+
124
+ const chartData = runs.toReversed().map((d) => ({
125
+ timestamp: new Date(d.timestamp).getTime(),
143
126
  value: 1, // Fixed height for visibility
144
127
  status: d.status,
145
128
  }));