Skip to content

Open-source status page, incident response and uptime monitoring

fix: components impact minor inconsistencies (#2265)

Maximilian Kaskea557cf92b083
diff --git a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/[reportId]/page.tsx b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/[reportId]/page.tsx
index 9b0ef3cf6..a9ba537d2 100644
--- a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/[reportId]/page.tsx
+++ b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/[reportId]/page.tsx
@@ -81,6 +81,7 @@ export default function Page() {
(u) => u.componentImpacts.length > 0,
);
const currentImpacts = currentImpactsFromUpdates(statusReport.updates);
+ const nextStatus = getNextStatus(statusReport.status);
return (
<SectionGroup>
@@ -102,10 +103,13 @@ export default function Page() {
<EmptyStateDescription>Status Page Report</EmptyStateDescription>
<FormSheetStatusReportUpdate
defaultValues={{
- status: getNextStatus(statusReport.status),
+ status: nextStatus,
componentImpacts: statusReport.pageComponents.map((c) => ({
pageComponentId: c.id,
- impact: currentImpacts.get(c.id) ?? "operational",
+ impact:
+ nextStatus === "resolved"
+ ? "operational"
+ : (currentImpacts.get(c.id) ?? "operational"),
})),
}}
components={statusReport.pageComponents.map((c) => ({
diff --git a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/page.tsx b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/page.tsx
index 883f40cea..0cd1b7c58 100644
--- a/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/page.tsx
+++ b/apps/dashboard/src/app/(dashboard)/status-pages/[id]/status-reports/page.tsx
@@ -2,10 +2,12 @@
import { Button } from "@openstatus/ui/components/ui/button";
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
-import { Plus } from "lucide-react";
+import { Gauge, Plus } from "lucide-react";
+import NextLink from "next/link";
import { useParams } from "next/navigation";
import { Link } from "@/components/common/link";
+import { Note, NoteButton } from "@/components/common/note";
import {
Section,
SectionDescription,
@@ -60,6 +62,18 @@ export default function Page() {
return (
<SectionGroup>
+ <Note>
+ <Gauge />
+ Status reports now support per-component impacts.
+ <NoteButton variant="default" asChild>
+ <NextLink
+ href="https://www.openstatus.dev/changelog/status-page-components-impact"
+ target="_blank"
+ >
+ Learn more
+ </NextLink>
+ </NoteButton>
+ </Note>
<Section>
<SectionHeaderRow>
<SectionHeader>
@@ -92,14 +106,15 @@ export default function Page() {
// because of the union type
if ("date" in values) {
// every selected component gets an impact row — fresh
- // reports are never legacy (untouched pickers ⇒ operational)
+ // reports are never legacy; fallback must match the
+ // picker's defaultImpact
const componentImpacts = values.pageComponents.map(
(pageComponentId) => ({
pageComponentId,
impact:
values.componentImpacts?.find(
(ci) => ci.pageComponentId === pageComponentId,
- )?.impact ?? ("operational" as const),
+ )?.impact ?? ("degraded_performance" as const),
}),
);
await createStatusReportMutation.mutateAsync({
diff --git a/apps/dashboard/src/components/data-table/status-reports/columns.tsx b/apps/dashboard/src/components/data-table/status-reports/columns.tsx
index ab97fe26b..03aad1d53 100644
--- a/apps/dashboard/src/components/data-table/status-reports/columns.tsx
+++ b/apps/dashboard/src/components/data-table/status-reports/columns.tsx
@@ -2,7 +2,6 @@
import type { RouterOutputs } from "@openstatus/api";
import {
- currentImpactsFromUpdates,
type PageComponentImpact,
worstImpact,
} from "@openstatus/db/src/schema/page_components/constants";
@@ -27,12 +26,15 @@ import { DataTableRowActions } from "./data-table-row-actions";
type StatusReport = RouterOutputs["statusReport"]["list"][number];
-// derived top-level impact = worst current impact across components;
+// derived top-level impact = worst impact set by any update, not the
+// current one (a resolved report would always read "Operational");
// legacy reports (no impact rows) read "Untriaged"
-function worstCurrentImpact(report: StatusReport) {
- const current = currentImpactsFromUpdates(report.updates);
- if (current.size === 0) return null;
- return worstImpact(current.values());
+function worstReportImpact(report: StatusReport) {
+ const impacts = report.updates.flatMap((u) =>
+ u.componentImpacts.map((ci) => ci.impact),
+ );
+ if (impacts.length === 0) return null;
+ return worstImpact(impacts);
}
export const columns: ColumnDef<StatusReport>[] = [
@@ -112,7 +114,7 @@ export const columns: ColumnDef<StatusReport>[] = [
},
{
id: "impact",
- accessorFn: (row) => worstCurrentImpact(row),
+ accessorFn: (row) => worstReportImpact(row),
header: "Impact",
cell: ({ row }) => {
const impact = row.getValue<PageComponentImpact | null>("impact");
diff --git a/apps/dashboard/src/components/data-table/status-reports/data-table-row-actions.tsx b/apps/dashboard/src/components/data-table/status-reports/data-table-row-actions.tsx
index a554d39cb..34f19eb9f 100644
--- a/apps/dashboard/src/components/data-table/status-reports/data-table-row-actions.tsx
+++ b/apps/dashboard/src/components/data-table/status-reports/data-table-row-actions.tsx
@@ -1,6 +1,7 @@
"use client";
import type { RouterOutputs } from "@openstatus/api";
+import { currentImpactsFromUpdates } from "@openstatus/db/src/schema/page_components/constants";
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import type { Row } from "@tanstack/react-table";
import { useRef } from "react";
@@ -46,6 +47,13 @@ export function DataTableRowActions({ row }: DataTableRowActionsProps) {
const { data: page } = useQuery(
trpc.page.get.queryOptions({ id: row.original.pageId }),
);
+ const reportComponents =
+ row.original.pageComponents?.map((c) => ({ id: c.id, name: c.name })) ?? [];
+ const reportHasImpacts = row.original.updates.some(
+ (u) => u.componentImpacts.length > 0,
+ );
+ const currentImpacts = currentImpactsFromUpdates(row.original.updates);
+ const nextStatus = getNextStatus(row.original.status);
const sendStatusReportUpdateMutation = useMutation(
trpc.emailRouter.sendStatusReport.mutationOptions(),
);
@@ -72,7 +80,7 @@ export function DataTableRowActions({ row }: DataTableRowActionsProps) {
trpc.statusReport.createStatusReportUpdate.mutationOptions({
onSuccess: (update) => {
// TODO: move to server
- if (update) {
+ if (update?.notifySubscribers) {
sendStatusReportUpdateMutation.mutateAsync({ id: update.id });
}
//
@@ -153,14 +161,29 @@ export function DataTableRowActions({ row }: DataTableRowActionsProps) {
</FormSheetStatusReport>
<FormSheetStatusReportUpdate
defaultValues={{
- status: getNextStatus(row.original.status),
+ status: nextStatus,
+ componentImpacts: reportComponents.map((c) => ({
+ pageComponentId: c.id,
+ impact:
+ nextStatus === "resolved"
+ ? "operational"
+ : (currentImpacts.get(c.id) ?? "operational"),
+ })),
}}
+ components={reportComponents}
onSubmit={async (values) => {
+ // a legacy report stays legacy unless the operator actively
+ // sets a non-operational impact
+ const sendImpacts =
+ reportHasImpacts ||
+ values.componentImpacts?.some((ci) => ci.impact !== "operational");
await createStatusReportUpdateMutation.mutateAsync({
statusReportId: row.original.id,
message: values.message,
status: values.status,
+ componentImpacts: sendImpacts ? values.componentImpacts : undefined,
date: values.date,
+ notifySubscribers: values.notifySubscribers,
});
}}
>
diff --git a/apps/dashboard/src/components/forms/status-report-update/form-status-report.tsx b/apps/dashboard/src/components/forms/status-report-update/form-status-report.tsx
index b47595868..dd6312e42 100644
--- a/apps/dashboard/src/components/forms/status-report-update/form-status-report.tsx
+++ b/apps/dashboard/src/components/forms/status-report-update/form-status-report.tsx
@@ -187,9 +187,23 @@ export function FormStatusReportUpdateCard({
<FormControl>
<Select
defaultValue={field.value}
- onValueChange={field.onChange}
+ onValueChange={(value) => {
+ field.onChange(value);
+ // resolved implies components are back up — prefill, still editable
+ if (value === "resolved" && components?.length) {
+ form.setValue(
+ "componentImpacts",
+ components.map((c) => ({
+ pageComponentId: c.id,
+ impact: "operational" as const,
+ })),
+ { shouldDirty: true },
+ );
+ }
+ }}
>
<SelectTrigger
+ size="sm"
className={cn(
colors[field.value],
"w-full font-mono capitalize",
@@ -231,7 +245,7 @@ export function FormStatusReportUpdateCard({
variant="outline"
size="sm"
className={cn(
- "h-9 w-full pl-3 text-left font-normal sm:w-[240px]",
+ "w-full pl-3 text-left font-normal sm:w-[240px]",
!field.value && "text-muted-foreground",
)}
>
diff --git a/apps/dashboard/src/components/forms/status-report-update/form.tsx b/apps/dashboard/src/components/forms/status-report-update/form.tsx
index 00633f05a..798728df7 100644
--- a/apps/dashboard/src/components/forms/status-report-update/form.tsx
+++ b/apps/dashboard/src/components/forms/status-report-update/form.tsx
@@ -151,9 +151,23 @@ export function FormStatusReportUpdate({
<FormControl>
<Select
defaultValue={field.value}
- onValueChange={field.onChange}
+ onValueChange={(value) => {
+ field.onChange(value);
+ // resolved implies components are back up — prefill, still editable
+ if (value === "resolved" && components?.length) {
+ form.setValue(
+ "componentImpacts",
+ components.map((c) => ({
+ pageComponentId: c.id,
+ impact: "operational" as const,
+ })),
+ { shouldDirty: true },
+ );
+ }
+ }}
>
<SelectTrigger
+ size="sm"
className={cn(
colors[field.value],
"font-mono capitalize",
diff --git a/apps/dashboard/src/components/forms/status-report/component-impact-field.tsx b/apps/dashboard/src/components/forms/status-report/component-impact-field.tsx
index 3c061523e..451021a3c 100644
--- a/apps/dashboard/src/components/forms/status-report/component-impact-field.tsx
+++ b/apps/dashboard/src/components/forms/status-report/component-impact-field.tsx
@@ -25,19 +25,22 @@ export function ComponentImpactList({
value,
onValueChange,
allowUnset = false,
+ defaultImpact = "operational",
placeholder = "No change",
}: {
components: { id: number; name: string }[];
value: ComponentImpactValue[];
onValueChange: (value: ComponentImpactValue[]) => void;
- /** Components without an entry show the placeholder instead of defaulting to operational. */
+ /** Components without an entry show the placeholder instead of defaulting to `defaultImpact`. */
allowUnset?: boolean;
+ /** Shown for components without an entry; the caller must apply the same fallback on submit. */
+ defaultImpact?: PageComponentImpact;
placeholder?: string;
}) {
function impactFor(id: number): PageComponentImpact | undefined {
const found = value.find((v) => v.pageComponentId === id)?.impact;
if (found) return found;
- return allowUnset ? undefined : "operational";
+ return allowUnset ? undefined : defaultImpact;
}
function setImpact(id: number, impact: PageComponentImpact) {
diff --git a/apps/dashboard/src/components/forms/status-report/form.tsx b/apps/dashboard/src/components/forms/status-report/form.tsx
index 924456e34..b17eff8b3 100644
--- a/apps/dashboard/src/components/forms/status-report/form.tsx
+++ b/apps/dashboard/src/components/forms/status-report/form.tsx
@@ -191,6 +191,7 @@ export function FormStatusReport({
onValueChange={field.onChange}
>
<SelectTrigger
+ size="sm"
className={cn(
colors[field.value],
"font-mono capitalize",
@@ -411,9 +412,6 @@ export function FormStatusReport({
How badly is each affected component impacted?
</FormDescription>
<FormControl>
- {/* unset must stay visibly unset — a fake "Operational"
- default would submit no impact rows (legacy report)
- while the bar renders orange, not the green shown */}
<ComponentImpactList
components={selectedComponents.map((c) => ({
id: c.id,
@@ -421,8 +419,7 @@ export function FormStatusReport({
}))}
value={field.value ?? []}
onValueChange={field.onChange}
- allowUnset
- placeholder="No impact set"
+ defaultImpact="degraded_performance"
/>
</FormControl>
<FormMessage />
diff --git a/apps/web/src/content/pages/changelog/status-page-components-impact.mdx b/apps/web/src/content/pages/changelog/status-page-components-impact.mdx
index 63f8ef452..ed173676b 100644
--- a/apps/web/src/content/pages/changelog/status-page-components-impact.mdx
+++ b/apps/web/src/content/pages/changelog/status-page-components-impact.mdx
@@ -18,4 +18,6 @@ On the public status page:
In the dashboard, pick an impact per component when creating a report or posting an update; you can also edit impacts on existing updates. Impacts are available on the API and importers from Atlassian Statuspage and Better Stack preserve per-update impacts on migration.
+Check out the [status report reference](https://www.openstatus.dev/docs/reference/status-report#component-impacts) for more details.
+
Existing reports are untouched — they keep today's behavior until you set impacts on a new one.
diff --git a/packages/api/src/router/statusReport.ts b/packages/api/src/router/statusReport.ts
index 7015a2571..156df7f44 100644
--- a/packages/api/src/router/statusReport.ts
+++ b/packages/api/src/router/statusReport.ts
@@ -27,7 +27,8 @@ const createStatusReportTRPCInput = z.object({
status: CreateStatusReportInput.shape.status,
pageId: z.number(),
pageComponents: z.array(z.number()),
- componentImpacts: componentImpactsSchema.optional(),
+ // nullish like notifySubscribers: clients may send null for "absent"
+ componentImpacts: componentImpactsSchema.nullish(),
date: z.coerce.date(),
message: z.string(),
notifySubscribers: z.boolean().nullish(),
@@ -38,7 +39,7 @@ const createStatusReportUpdateTRPCInput = z.object({
statusReportId: z.number(),
status: AddStatusReportUpdateInput.shape.status,
message: z.string(),
- componentImpacts: componentImpactsSchema.optional(),
+ componentImpacts: componentImpactsSchema.nullish(),
date: z.coerce.date().optional(),
notifySubscribers: z.boolean().nullish(),
});
@@ -48,7 +49,7 @@ const updateStatusReportUpdateTRPCInput = z.object({
statusReportId: z.number().optional(),
status: AddStatusReportUpdateInput.shape.status.optional(),
message: z.string().optional(),
- componentImpacts: componentImpactsSchema.optional(),
+ componentImpacts: componentImpactsSchema.nullish(),
date: z.coerce.date().optional(),
});
@@ -72,7 +73,7 @@ export const statusReportRouter = createTRPCRouter({
status: input.status,
pageId: input.pageId,
pageComponentIds: input.pageComponents,
- componentImpacts: input.componentImpacts,
+ componentImpacts: input.componentImpacts ?? undefined,
date: input.date,
message: input.message,
},
@@ -96,7 +97,7 @@ export const statusReportRouter = createTRPCRouter({
statusReportId: input.statusReportId,
status: input.status,
message: input.message,
- componentImpacts: input.componentImpacts,
+ componentImpacts: input.componentImpacts ?? undefined,
date: input.date,
},
});
@@ -120,7 +121,7 @@ export const statusReportRouter = createTRPCRouter({
id: input.id,
status: input.status,
message: input.message,
- componentImpacts: input.componentImpacts,
+ componentImpacts: input.componentImpacts ?? undefined,
date: input.date,
},
});