fix: render node-update changelog notes as formatted markdown (#1474)

The Changelog tab in the Node Updates sheet rendered GitHub release notes
as raw markdown inside a preformatted block, so headings, bullet lists,
and issue/commit links showed as literal markup and were hard to read.

Render the notes with a small react-markdown wrapper styled to the design
tokens (raw HTML is intentionally not rendered, keeping it safe). Also:

- Replace the bare loading spinner with a content-shaped skeleton.
- Add a graceful empty state when no notes are available, with a link to
  the online changelog.
- Add a "View on Sencho" link next to "View on GitHub".
- Stop the release-notes fetch from re-firing on every failure by tracking
  whether a fetch has settled, so a null result lands on the empty state
  instead of looping; Recheck resets it to force a fresh fetch.
This commit is contained in:
Anso
2026-06-26 17:23:19 -04:00
committed by GitHub
parent 1de49f8b1a
commit 6256131dc6
6 changed files with 1672 additions and 57 deletions
@@ -1,12 +1,14 @@
import { useState, useEffect } from 'react';
import {
Search, Loader2, Check, CircleCheck, CircleAlert, AlertTriangle,
Download, RefreshCw, Monitor, Globe, ExternalLink, Ban,
Download, RefreshCw, Monitor, Globe, ExternalLink, Ban, ScrollText,
} from 'lucide-react';
import { SystemSheet, SheetSection } from '@/components/ui/system-sheet';
import { Input } from '@/components/ui/input';
import { Badge } from '@/components/ui/badge';
import { Button } from '@/components/ui/button';
import { MarkdownContent } from '@/components/ui/MarkdownContent';
import { Skeleton } from '@/components/ui/skeleton';
import { apiFetch } from '@/lib/api';
import { toast } from '@/components/ui/toast-store';
import { formatVersion, isValidVersion } from '@/lib/version';
@@ -43,6 +45,9 @@ export function NodeUpdatesSheet({
const [releaseNotes, setReleaseNotes] = useState<string | null>(null);
const [releaseHtmlUrl, setReleaseHtmlUrl] = useState<string | null>(null);
const [loadingRelease, setLoadingRelease] = useState(false);
// Tracks whether a release-notes fetch has settled (success or failure), so a
// null result lands on the empty state instead of re-triggering the effect.
const [releaseLoaded, setReleaseLoaded] = useState(false);
const [hasSeenChangelog, setHasSeenChangelog] = useState(false);
useEffect(() => {
@@ -53,7 +58,7 @@ export function NodeUpdatesSheet({
// release regardless of update availability). Pass recheck when the user
// forced a version recheck so the changelog stays in sync.
useEffect(() => {
if (open && releaseNotes === null && !loadingRelease) {
if (open && !releaseLoaded && !loadingRelease) {
setLoadingRelease(true);
const recheck = recheckingUpdates ? '?recheck=true' : '';
apiFetch(`/fleet/update-status/release-notes${recheck}`, { localOnly: true })
@@ -64,10 +69,18 @@ export function NodeUpdatesSheet({
setReleaseHtmlUrl(data.htmlUrl);
}
})
.catch(() => { /* silent */ })
.finally(() => setLoadingRelease(false));
.catch((err) => {
// Informational panel: a failure falls through to the empty
// state (with an online changelog link) rather than a toast,
// but leave a breadcrumb so the failure is diagnosable.
console.warn('[Fleet] Release-notes fetch failed:', err);
})
.finally(() => {
setLoadingRelease(false);
setReleaseLoaded(true);
});
}
}, [open, releaseNotes, loadingRelease, recheckingUpdates]);
}, [open, releaseLoaded, loadingRelease, recheckingUpdates]);
// Clear the changelog dot when user opens that tab.
useEffect(() => {
@@ -87,7 +100,10 @@ export function NodeUpdatesSheet({
const handleRecheck = async () => {
setRecheckingUpdates(true);
setReleaseNotes(null); // force re-fetch with fresh release notes
// Force a fresh release-notes fetch with the rechecked version.
setReleaseNotes(null);
setReleaseHtmlUrl(null);
setReleaseLoaded(false);
try {
const res = await apiFetch('/fleet/update-status?recheck=true', { method: 'DELETE', localOnly: true });
if (res.ok) {
@@ -195,6 +211,17 @@ export function NodeUpdatesSheet({
{ id: 'changelog', label: 'Changelog', dot: showChangelogDot },
];
const senchoChangelogLink = (
<a
href="https://sencho.io/changelog"
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1 text-xs text-brand hover:underline"
>
View on Sencho <ExternalLink className="w-3 h-3" strokeWidth={1.5} />
</a>
);
return (
<SystemSheet
open={open}
@@ -227,28 +254,45 @@ export function NodeUpdatesSheet({
) : activeTab === 'changelog' ? (
<div className="flex min-h-0 flex-1 flex-col overflow-y-auto px-6 py-5">
{loadingRelease ? (
<div className="flex items-center justify-center py-12">
<Loader2 className="w-6 h-6 animate-spin text-muted-foreground" strokeWidth={1.5} />
<div className="space-y-3">
<Skeleton className="h-5 w-2/5" />
<Skeleton className="h-3 w-1/4" />
<div className="space-y-2 pt-2">
<Skeleton className="h-3 w-full" />
<Skeleton className="h-3 w-11/12" />
<Skeleton className="h-3 w-4/5" />
</div>
<div className="space-y-2 pt-3">
<Skeleton className="h-3 w-1/4" />
<Skeleton className="h-3 w-full" />
<Skeleton className="h-3 w-3/4" />
</div>
</div>
) : releaseNotes ? (
<div className="space-y-4">
<pre className="whitespace-pre-wrap text-sm font-sans text-stat-value leading-relaxed">
{releaseNotes}
</pre>
{releaseHtmlUrl && (
<a
href={releaseHtmlUrl}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1 text-xs text-brand hover:underline"
>
View on GitHub <ExternalLink className="w-3 h-3" strokeWidth={1.5} />
</a>
)}
<MarkdownContent>{releaseNotes}</MarkdownContent>
<div className="flex flex-wrap items-center gap-x-4 gap-y-2 border-t border-card-border/40 pt-3">
{releaseHtmlUrl && (
<a
href={releaseHtmlUrl}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1 text-xs text-brand hover:underline"
>
View on GitHub <ExternalLink className="w-3 h-3" strokeWidth={1.5} />
</a>
)}
{senchoChangelogLink}
</div>
</div>
) : (
<div className="flex items-center justify-center py-12 text-muted-foreground text-sm">
Release notes could not be loaded.
<div className="flex flex-1 flex-col items-center justify-center gap-3 py-12 text-center">
<ScrollText className="w-8 h-8 text-muted-foreground/40" strokeWidth={1.25} />
<div className="space-y-1">
<p className="text-sm text-stat-value">No release notes to show</p>
<p className="text-xs text-muted-foreground">Read the full changelog online.</p>
</div>
{senchoChangelogLink}
</div>
)}
</div>
@@ -50,6 +50,64 @@ describe('NodeUpdatesSheet', () => {
expect(screen.getByText('Db')).toBeInTheDocument();
});
it('renders the changelog release notes as formatted markdown, not raw text', async () => {
apiFetchMock.mockResolvedValue({
ok: true,
json: async () => ({
releaseNotes: '## [0.92.0](https://example.com/compare) (2026-06-19)\n\n### Added\n\n* add a toggle ([#1363](https://example.com/issues/1363))\n',
htmlUrl: 'https://example.com/releases/v0.92.0',
}),
});
render(<NodeUpdatesSheet {...baseProps({ initialTab: 'changelog' })} />);
// The "### Added" section becomes a real heading element, not literal text.
const heading = await screen.findByRole('heading', { name: 'Added' });
expect(heading.tagName).toBe('H3');
// The issue reference becomes a link to GitHub, not raw "[#1363](...)".
const link = screen.getByRole('link', { name: '#1363' });
expect(link).toHaveAttribute('href', 'https://example.com/issues/1363');
expect(link).toHaveAttribute('target', '_blank');
// No markdown markers leak through as visible text.
expect(screen.queryByText(/### Added/)).not.toBeInTheDocument();
// Both external changelog links render.
expect(screen.getByRole('link', { name: /View on GitHub/ })).toHaveAttribute('href', 'https://example.com/releases/v0.92.0');
expect(screen.getByRole('link', { name: /View on Sencho/ })).toHaveAttribute('href', 'https://sencho.io/changelog');
});
it('settles on a graceful empty state with a Sencho link when no notes are returned', async () => {
apiFetchMock.mockResolvedValue({ ok: true, json: async () => ({ releaseNotes: null, htmlUrl: null }) });
render(<NodeUpdatesSheet {...baseProps({ initialTab: 'changelog' })} />);
// The fetch settles (no perpetual spinner) and shows the empty message.
expect(await screen.findByText('No release notes to show')).toBeInTheDocument();
expect(screen.getByRole('link', { name: /View on Sencho/ })).toHaveAttribute('href', 'https://sencho.io/changelog');
});
it('fetches release notes once and does not refetch on re-render when notes are null', async () => {
apiFetchMock.mockResolvedValue({ ok: true, json: async () => ({ releaseNotes: null, htmlUrl: null }) });
const releaseCalls = () => apiFetchMock.mock.calls.filter(c => String(c[0]).includes('release-notes')).length;
const { rerender } = render(<NodeUpdatesSheet {...baseProps({ initialTab: 'changelog' })} />);
await screen.findByText('No release notes to show');
expect(releaseCalls()).toBe(1);
rerender(<NodeUpdatesSheet {...baseProps({ initialTab: 'changelog' })} />);
// The releaseLoaded latch keeps a null result from re-triggering the fetch.
await waitFor(() => expect(releaseCalls()).toBe(1));
});
it('Recheck resets and refetches release notes with the recheck flag', async () => {
apiFetchMock.mockImplementation((url: string) =>
String(url).includes('release-notes')
? Promise.resolve({ ok: true, json: async () => ({ releaseNotes: '## v1', htmlUrl: null }) })
: Promise.resolve({ ok: true, json: async () => ({ rechecked: true }) }),
);
render(<NodeUpdatesSheet {...baseProps({ isAdmin: true, initialTab: 'changelog' })} />);
await screen.findByRole('heading', { name: 'v1' });
apiFetchMock.mockClear();
fireEvent.click(screen.getByRole('button', { name: 'Recheck' }));
await waitFor(() => {
const call = apiFetchMock.mock.calls.find(c => String(c[0]).includes('release-notes'));
expect(call?.[0]).toBe('/fleet/update-status/release-notes?recheck=true');
});
});
it('shows a checking spinner state', () => {
render(<NodeUpdatesSheet {...baseProps({ checkingUpdates: true })} />);
expect(screen.getByText('Checking for updates...')).toBeInTheDocument();