feat(logs): collapse large run log data and serve client manifest
- collapse run log data blocks whose pretty-printed JSON exceeds a byte or line limit, with a per-block toggle and an expand/collapse-all button next to the Logs heading - align data blocks and toggles with the context/message column - add a "Copy logs" button that copies the filtered logs as plain text with every data block expanded - add GET /manifest.json with the app name, version and run log data limits (RUN_LOG_DATA_COLLAPSE_BYTES / RUN_LOG_DATA_COLLAPSE_LINES) - load the manifest in the client stale-while-revalidate: localStorage copy first, refetched per page load and on tab focus after a while - show the server version in the sidebar footer, with a reload hint when it differs from the client build Closes #3
This commit is contained in:
25 files changed
+623
-36
No files matched your search
@@ -1,5 +1,8 @@
|
||||
import { useState } from 'react';
|
||||
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||
import { LogOutput } from '../../src/ui/LogOutput/LogOutput';
|
||||
import { expect, userEvent, within } from 'storybook/test';
|
||||
import { LogOutput, type LogOutputEntry } from '../../src/ui/LogOutput/LogOutput';
|
||||
import { formatLogText } from '../../src/ui/LogOutput/logText';
|
||||
|
||||
const meta: Meta<typeof LogOutput> = {
|
||||
title: 'UI/LogOutput',
|
||||
@@ -113,6 +116,79 @@ export const Scrollable: Story = {
|
||||
},
|
||||
};
|
||||
|
||||
const largeDataEntries: LogOutputEntry[] = [
|
||||
{
|
||||
id: 0,
|
||||
level: 'log',
|
||||
context: 'step:1',
|
||||
message: 'Small payload:',
|
||||
data: JSON.stringify({ status: 200 }),
|
||||
createdAt: secondsAgo(20),
|
||||
},
|
||||
{
|
||||
id: 1,
|
||||
level: 'log',
|
||||
context: 'step:1',
|
||||
message: 'Large payload:',
|
||||
data: JSON.stringify({
|
||||
user: { id: 42, name: 'Jane Doe', roles: ['admin', 'qa'] },
|
||||
token: 'eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0MiJ9',
|
||||
}),
|
||||
createdAt: secondsAgo(18),
|
||||
},
|
||||
{
|
||||
id: 2,
|
||||
level: 'warn',
|
||||
context: 'step:2',
|
||||
message: 'Another large payload:',
|
||||
data: JSON.stringify(Array.from({ length: 8 }, (_, i) => ({ row: i }))),
|
||||
createdAt: secondsAgo(10),
|
||||
},
|
||||
];
|
||||
|
||||
function LargeDataLog() {
|
||||
const [expanded, setExpanded] = useState(false);
|
||||
return (
|
||||
<div style={{ display: 'flex', flexDirection: 'column', gap: 8, alignItems: 'flex-start' }}>
|
||||
<button type="button" onClick={() => setExpanded((v) => !v)}>
|
||||
{expanded ? 'Collapse all' : 'Expand all'}
|
||||
</button>
|
||||
<LogOutput startTime={secondsAgo(20)} entries={largeDataEntries} dataExpanded={expanded} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
/** Data blocks over the default limits (256 bytes, 5 lines) start collapsed. */
|
||||
export const LargeData: Story = {
|
||||
render: () => <LargeDataLog />,
|
||||
play: async ({ canvasElement }) => {
|
||||
const canvas = within(canvasElement);
|
||||
// Data blocks are syntax-highlighted into separate tokens, so check the log's text
|
||||
const log = canvas.getByRole('log');
|
||||
// Only the small payload is visible initially
|
||||
await expect(log).toHaveTextContent('"status": 200');
|
||||
await expect(log).not.toHaveTextContent('Jane Doe');
|
||||
const toggles = canvas.getAllByRole('button', { name: /^Show data/ });
|
||||
await expect(toggles).toHaveLength(2);
|
||||
|
||||
await userEvent.click(toggles[0]);
|
||||
await expect(log).toHaveTextContent('Jane Doe');
|
||||
await userEvent.click(canvas.getByRole('button', { name: 'Hide data' }));
|
||||
await expect(log).not.toHaveTextContent('Jane Doe');
|
||||
|
||||
await userEvent.click(canvas.getByRole('button', { name: 'Expand all' }));
|
||||
await expect(log).toHaveTextContent('Jane Doe');
|
||||
await expect(canvas.getAllByRole('button', { name: 'Hide data' })).toHaveLength(2);
|
||||
await userEvent.click(canvas.getByRole('button', { name: 'Collapse all' }));
|
||||
await expect(log).not.toHaveTextContent('Jane Doe');
|
||||
|
||||
// The plain-text form always includes every data block
|
||||
const text = formatLogText(largeDataEntries, largeDataEntries[0].createdAt);
|
||||
await expect(text).toContain('[step:1] Large payload:\n {');
|
||||
await expect(text).toContain('"name": "Jane Doe"');
|
||||
},
|
||||
};
|
||||
|
||||
export const Empty: Story = {
|
||||
args: {
|
||||
entries: [],
|
||||
|
||||
+12
-1
@@ -6,6 +6,7 @@ import type { LucideIcon } from 'lucide-react';
|
||||
import styles from './App.module.css';
|
||||
import { SidePanel, ThemeSwitcher } from './ui';
|
||||
import liqaLogo from './assets/liqa.svg';
|
||||
import { useManifest } from './hooks/useManifest';
|
||||
|
||||
const EnvironmentsPage = lazy(() =>
|
||||
import('./pages/environment/EnvironmentsPage').then((m) => ({ default: m.EnvironmentsPage })),
|
||||
@@ -107,6 +108,7 @@ const NAV: ({ path: string; labelKey: string; Icon: LucideIcon } | { separator:
|
||||
|
||||
export default function App() {
|
||||
const { t } = useTranslation();
|
||||
const { version } = useManifest();
|
||||
|
||||
return (
|
||||
<div className={styles.shell}>
|
||||
@@ -141,7 +143,16 @@ export default function App() {
|
||||
<div className={styles.sideFooter}>
|
||||
<ThemeSwitcher />
|
||||
<div className={styles.version}>
|
||||
v{__APP_VERSION__} ·{' '}
|
||||
<span
|
||||
title={
|
||||
version !== __APP_VERSION__
|
||||
? t('nav.version_mismatch', { client: __APP_VERSION__ })
|
||||
: undefined
|
||||
}
|
||||
>
|
||||
v{version}
|
||||
</span>{' '}
|
||||
·{' '}
|
||||
<a
|
||||
className={styles.versionLink}
|
||||
href="/licenses.txt"
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
import { useSyncExternalStore } from 'react';
|
||||
import { getManifest, subscribeManifest, type Manifest } from '../lib/manifest';
|
||||
|
||||
/**
|
||||
* Public client configuration from the server's /manifest.json: the cached
|
||||
* copy (or defaults) at first, updated once the fresh one arrives.
|
||||
*/
|
||||
export function useManifest(): Manifest {
|
||||
return useSyncExternalStore(subscribeManifest, getManifest);
|
||||
}
|
||||
@@ -28,6 +28,7 @@
|
||||
},
|
||||
"nav": {
|
||||
"licenses": "Licenses",
|
||||
"version_mismatch": "Server version; this page was built for v{{client}}. Reload to update.",
|
||||
"environments": "Environments",
|
||||
"credentials": "Credentials",
|
||||
"snippets": "Snippets",
|
||||
@@ -303,6 +304,14 @@
|
||||
"log_message": "Message",
|
||||
"log_time": "Time",
|
||||
"action_download_logs": "Download logs",
|
||||
"action_copy_logs": "Copy logs",
|
||||
"logs_copied": "Logs copied to clipboard",
|
||||
"logs_copy_failed": "Could not copy logs to clipboard",
|
||||
"logs_expand_data": "Expand data",
|
||||
"logs_collapse_data": "Collapse data",
|
||||
"logs_show_data_one": "Show data ({{size}}, {{count}} line)",
|
||||
"logs_show_data_other": "Show data ({{size}}, {{count}} lines)",
|
||||
"logs_hide_data": "Hide data",
|
||||
"action_repeat": "Repeat run",
|
||||
"repeat_no_environment": "The environment used by this run no longer exists",
|
||||
"export_logs_modal_title": "Export logs",
|
||||
|
||||
@@ -0,0 +1,122 @@
|
||||
import { DEFAULT_LOG_DATA_LIMITS, type LogDataLimits } from '../ui/LogOutput/logText';
|
||||
|
||||
/** Public client configuration served by the server at /manifest.json. */
|
||||
export interface Manifest {
|
||||
name: string;
|
||||
/** Server version; can differ from the client build's __APP_VERSION__ until the page is reloaded. */
|
||||
version: string;
|
||||
runLogs: {
|
||||
dataLimits: LogDataLimits;
|
||||
};
|
||||
}
|
||||
|
||||
export const DEFAULT_MANIFEST: Manifest = {
|
||||
name: 'liqa',
|
||||
version: __APP_VERSION__,
|
||||
runLogs: { dataLimits: DEFAULT_LOG_DATA_LIMITS },
|
||||
};
|
||||
|
||||
const STORAGE_KEY = 'liqa-manifest';
|
||||
/** A tab coming back into view refetches the manifest if it is older than this. */
|
||||
const REFRESH_AFTER_MS = 5 * 60 * 1000;
|
||||
|
||||
// Served next to the API's /api/v1 (so "/manifest.json" by default, or on
|
||||
// VITE_API_URL's origin when the client talks to another server)
|
||||
const MANIFEST_URL = new URL(
|
||||
'../../manifest.json',
|
||||
new URL(
|
||||
`${(import.meta.env.VITE_API_URL ?? '/api/v1').replace(/\/$/, '')}/`,
|
||||
window.location.href,
|
||||
),
|
||||
).toString();
|
||||
|
||||
/** Fills fields missing from `raw` (e.g. a manifest cached by an older version) with defaults. */
|
||||
function normalize(raw: unknown): Manifest | null {
|
||||
if (typeof raw !== 'object' || raw === null) return null;
|
||||
const m = raw as Partial<Manifest>;
|
||||
const limits: Partial<LogDataLimits> = m.runLogs?.dataLimits ?? {};
|
||||
const num = (v: unknown, fallback: number) => (typeof v === 'number' && v >= 0 ? v : fallback);
|
||||
return {
|
||||
name: typeof m.name === 'string' ? m.name : DEFAULT_MANIFEST.name,
|
||||
version: typeof m.version === 'string' ? m.version : DEFAULT_MANIFEST.version,
|
||||
runLogs: {
|
||||
dataLimits: {
|
||||
bytes: num(limits.bytes, DEFAULT_LOG_DATA_LIMITS.bytes),
|
||||
lines: num(limits.lines, DEFAULT_LOG_DATA_LIMITS.lines),
|
||||
},
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
// Storage can be unavailable (private mode, blocked site data): the manifest
|
||||
// then just comes from the network on every page load
|
||||
function readCache(): Manifest | null {
|
||||
try {
|
||||
const stored = localStorage.getItem(STORAGE_KEY);
|
||||
return stored ? normalize(JSON.parse(stored)) : null;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function writeCache(manifest: Manifest) {
|
||||
try {
|
||||
localStorage.setItem(STORAGE_KEY, JSON.stringify(manifest));
|
||||
} catch {
|
||||
// ignore, see readCache
|
||||
}
|
||||
}
|
||||
|
||||
let current: Manifest = readCache() ?? DEFAULT_MANIFEST;
|
||||
let fetchedAt = 0;
|
||||
let inFlight: Promise<void> | null = null;
|
||||
const listeners = new Set<() => void>();
|
||||
|
||||
/**
|
||||
* Fetches the manifest and notifies subscribers if it changed. Failures are
|
||||
* silent: the cached (or default) manifest stays in use.
|
||||
*/
|
||||
export function refreshManifest(): Promise<void> {
|
||||
inFlight ??= fetch(MANIFEST_URL, { headers: { Accept: 'application/json' } })
|
||||
.then((res) => (res.ok ? res.json() : null))
|
||||
.then((raw: unknown) => {
|
||||
const next = normalize(raw);
|
||||
if (!next) return;
|
||||
fetchedAt = Date.now();
|
||||
writeCache(next);
|
||||
if (JSON.stringify(next) !== JSON.stringify(current)) {
|
||||
current = next;
|
||||
listeners.forEach((l) => l());
|
||||
}
|
||||
})
|
||||
.catch(() => undefined)
|
||||
.finally(() => {
|
||||
inFlight = null;
|
||||
});
|
||||
return inFlight;
|
||||
}
|
||||
|
||||
function onVisibilityChange() {
|
||||
if (document.visibilityState === 'visible' && Date.now() - fetchedAt > REFRESH_AFTER_MS) {
|
||||
void refreshManifest();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Stale-while-revalidate: subscribers get the localStorage copy right away,
|
||||
* and the manifest is refetched once per page load (the server answers 304
|
||||
* while it is unchanged) and when the tab becomes visible again after a while.
|
||||
*/
|
||||
export function subscribeManifest(listener: () => void): () => void {
|
||||
if (listeners.size === 0) document.addEventListener('visibilitychange', onVisibilityChange);
|
||||
listeners.add(listener);
|
||||
if (fetchedAt === 0) void refreshManifest();
|
||||
return () => {
|
||||
listeners.delete(listener);
|
||||
if (listeners.size === 0) document.removeEventListener('visibilitychange', onVisibilityChange);
|
||||
};
|
||||
}
|
||||
|
||||
export function getManifest(): Manifest {
|
||||
return current;
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
import { useEffect, useRef, useState, useCallback } from 'react';
|
||||
import { useEffect, useMemo, useRef, useState, useCallback } from 'react';
|
||||
import { useNavigate, useParams, Link } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { useManifest } from '../../hooks/useManifest';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { runs, runFiles } from '../../api';
|
||||
import type {
|
||||
@@ -25,6 +26,8 @@ import {
|
||||
Card,
|
||||
CodeBlock,
|
||||
DescriptionList,
|
||||
formatLogText,
|
||||
hasLargeData,
|
||||
LogOutput,
|
||||
Search,
|
||||
Table,
|
||||
@@ -38,6 +41,7 @@ import {
|
||||
ChevronDown,
|
||||
ChevronRight,
|
||||
ClipboardList,
|
||||
Copy,
|
||||
Activity,
|
||||
Download,
|
||||
Trash2,
|
||||
@@ -81,6 +85,7 @@ function RunDetail() {
|
||||
const { id, runId } = useParams<{ id: string; runId: string }>();
|
||||
const navigate = useNavigate();
|
||||
const toast = useToast();
|
||||
const logDataLimits = useManifest().runLogs.dataLimits;
|
||||
|
||||
const [scenario, setScenario] = useState<Scenario | null>(null);
|
||||
const [run, setRun] = useState<ScenarioRunDetail | null>(null);
|
||||
@@ -102,6 +107,7 @@ function RunDetail() {
|
||||
const [pendingDeleteFile, setPendingDeleteFile] = useState<FileMetadata | null>(null);
|
||||
const [deletingFile, setDeletingFile] = useState(false);
|
||||
const [repeating, setRepeating] = useState(false);
|
||||
const [logDataExpanded, setLogDataExpanded] = useState(false);
|
||||
const logSearchRef = useRef('');
|
||||
const pollRef = useRef<ReturnType<typeof setInterval> | null>(null);
|
||||
|
||||
@@ -144,6 +150,33 @@ function RunDetail() {
|
||||
}
|
||||
};
|
||||
|
||||
const logEntries = useMemo(
|
||||
() =>
|
||||
(run?.logs ?? []).map((l) => ({
|
||||
id: l.id,
|
||||
level: l.level,
|
||||
context: l.context,
|
||||
message: l.message,
|
||||
data: l.data,
|
||||
createdAt: l.createdAt,
|
||||
})),
|
||||
[run?.logs],
|
||||
);
|
||||
const logsHaveLargeData = useMemo(
|
||||
() => hasLargeData(logEntries, logDataLimits),
|
||||
[logEntries, logDataLimits],
|
||||
);
|
||||
|
||||
// Copies the (filtered) logs as plain text with every data block expanded
|
||||
const handleCopyLogs = async () => {
|
||||
try {
|
||||
await navigator.clipboard.writeText(formatLogText(logEntries, run?.createdAt));
|
||||
toast.success(t('runs.logs_copied'));
|
||||
} catch {
|
||||
toast.error(t('runs.logs_copy_failed'));
|
||||
}
|
||||
};
|
||||
|
||||
const handleRepeatRun = async () => {
|
||||
if (!id || !run?.environmentId) return;
|
||||
setRepeating(true);
|
||||
@@ -516,7 +549,22 @@ function RunDetail() {
|
||||
{run.logs.length > 0 && (
|
||||
<div className={styles.stepsSection}>
|
||||
<div className={styles.sectionHeadingRow}>
|
||||
<h2 className={styles.sectionHeading}>{t('runs.logs_heading')}</h2>
|
||||
<div style={{ display: 'flex', alignItems: 'center', gap: '8px' }}>
|
||||
<h2 className={styles.sectionHeading} style={{ margin: 0 }}>
|
||||
{t('runs.logs_heading')}
|
||||
</h2>
|
||||
{logsHaveLargeData && (
|
||||
<Button
|
||||
variant="ghost"
|
||||
size="sm"
|
||||
aria-expanded={logDataExpanded}
|
||||
onClick={() => setLogDataExpanded((v) => !v)}
|
||||
>
|
||||
{logDataExpanded ? <ChevronDown size={14} /> : <ChevronRight size={14} />}
|
||||
{logDataExpanded ? t('runs.logs_collapse_data') : t('runs.logs_expand_data')}
|
||||
</Button>
|
||||
)}
|
||||
</div>
|
||||
<div style={{ display: 'flex', alignItems: 'center', gap: '8px' }}>
|
||||
<Search
|
||||
value={logSearch}
|
||||
@@ -527,19 +575,25 @@ function RunDetail() {
|
||||
<Download size={14} />
|
||||
{t('runs.action_download_logs')}
|
||||
</Button>
|
||||
<Button variant="secondary" size="sm" onClick={handleCopyLogs}>
|
||||
<Copy size={14} />
|
||||
{t('runs.action_copy_logs')}
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
<LogOutput
|
||||
startTime={run.createdAt}
|
||||
maxHeight={480}
|
||||
entries={run.logs.map((l) => ({
|
||||
id: l.id,
|
||||
level: l.level,
|
||||
context: l.context,
|
||||
message: l.message,
|
||||
data: l.data,
|
||||
createdAt: l.createdAt,
|
||||
}))}
|
||||
entries={logEntries}
|
||||
dataLimits={logDataLimits}
|
||||
dataExpanded={logDataExpanded}
|
||||
showDataLabel={({ bytes, lines }) =>
|
||||
t('runs.logs_show_data', {
|
||||
size: bytes < 1024 ? `${bytes} B` : `${(bytes / 1024).toFixed(1)} KB`,
|
||||
count: lines,
|
||||
})
|
||||
}
|
||||
hideDataLabel={t('runs.logs_hide_data')}
|
||||
emptyMessage=""
|
||||
/>
|
||||
</div>
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
overflow: auto;
|
||||
font-family: var(--font-mono, ui-monospace, 'Cascadia Code', 'Fira Code', monospace);
|
||||
font-size: var(--font-size-xs);
|
||||
/* Where the context/message column starts: timestamp + level + their gaps */
|
||||
--log-body-offset: calc(7em + 4.5em + 2 * var(--space-2));
|
||||
}
|
||||
|
||||
.empty {
|
||||
@@ -36,7 +38,7 @@
|
||||
}
|
||||
|
||||
.data {
|
||||
margin: 0 0 var(--space-1) calc(7em + var(--space-2));
|
||||
margin: 0 0 var(--space-1) var(--log-body-offset);
|
||||
border: var(--border-width) solid var(--color-border);
|
||||
border-radius: var(--radius-sm);
|
||||
background: var(--color-bg);
|
||||
@@ -120,3 +122,26 @@
|
||||
.error .level {
|
||||
color: var(--color-error-fg);
|
||||
}
|
||||
|
||||
.dataToggle {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: var(--space-1);
|
||||
align-self: flex-start;
|
||||
margin-left: var(--log-body-offset);
|
||||
padding: 0;
|
||||
border: none;
|
||||
background: none;
|
||||
font: inherit;
|
||||
color: var(--color-text);
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.dataToggle svg {
|
||||
flex: 0 0 auto;
|
||||
color: var(--color-primary-text);
|
||||
}
|
||||
|
||||
.dataToggle:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
@@ -1,4 +1,14 @@
|
||||
import { useMemo, useState } from 'react';
|
||||
import { ChevronDown, ChevronRight } from 'lucide-react';
|
||||
import { CodeBlock } from '../CodeBlock/CodeBlock';
|
||||
import {
|
||||
DEFAULT_LOG_DATA_LIMITS,
|
||||
exceedsLimits,
|
||||
formatElapsed,
|
||||
measureData,
|
||||
prettyData,
|
||||
type LogDataLimits,
|
||||
} from './logText';
|
||||
import styles from './LogOutput.module.css';
|
||||
|
||||
export type LogOutputLevel = 'debug' | 'log' | 'warn' | 'error';
|
||||
@@ -22,25 +32,24 @@ export interface LogOutputProps {
|
||||
maxHeight?: string | number;
|
||||
emptyMessage?: string;
|
||||
className?: string;
|
||||
/** Data blocks whose pretty-printed JSON exceeds either limit start collapsed behind a toggle. */
|
||||
dataLimits?: LogDataLimits;
|
||||
/**
|
||||
* Expands (true) or collapses (false) every large data block. Changing it
|
||||
* discards the per-entry toggles made since the last change.
|
||||
*/
|
||||
dataExpanded?: boolean;
|
||||
/** Label of a collapsed data block's toggle, e.g. "Show data (1.2 KB, 40 lines)". */
|
||||
showDataLabel?: (size: { bytes: number; lines: number }) => string;
|
||||
hideDataLabel?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* "+12s" (or "-" if before startTime, e.g. clock skew). Log timestamps are
|
||||
* stored with second resolution, so fractions would be noise.
|
||||
*/
|
||||
function formatElapsed(deltaMs: number): string {
|
||||
const sign = deltaMs < 0 ? '-' : '+';
|
||||
return `${sign}${Math.round(Math.abs(deltaMs) / 1000)}s`;
|
||||
function formatBytes(bytes: number): string {
|
||||
return bytes < 1024 ? `${bytes} B` : `${(bytes / 1024).toFixed(1)} KB`;
|
||||
}
|
||||
|
||||
/** Pretty-prints `data` if it's valid JSON, otherwise returns it as-is. */
|
||||
function prettyData(data: string): string {
|
||||
try {
|
||||
return JSON.stringify(JSON.parse(data), null, 2);
|
||||
} catch {
|
||||
return data;
|
||||
}
|
||||
}
|
||||
const defaultShowDataLabel = ({ bytes, lines }: { bytes: number; lines: number }) =>
|
||||
`Show data (${formatBytes(bytes)}, ${lines} ${lines === 1 ? 'line' : 'lines'})`;
|
||||
|
||||
/** Terminal-style log viewer: one line per entry, color-coded by level. */
|
||||
export function LogOutput({
|
||||
@@ -49,7 +58,39 @@ export function LogOutput({
|
||||
maxHeight,
|
||||
emptyMessage = 'No logs.',
|
||||
className,
|
||||
dataLimits = DEFAULT_LOG_DATA_LIMITS,
|
||||
dataExpanded = false,
|
||||
showDataLabel = defaultShowDataLabel,
|
||||
hideDataLabel = 'Hide data',
|
||||
}: LogOutputProps) {
|
||||
// Per-entry toggles, reset whenever dataExpanded changes
|
||||
const [toggled, setToggled] = useState<Set<LogOutputEntry['id']>>(() => new Set());
|
||||
const [prevDataExpanded, setPrevDataExpanded] = useState(dataExpanded);
|
||||
if (prevDataExpanded !== dataExpanded) {
|
||||
setPrevDataExpanded(dataExpanded);
|
||||
setToggled(new Set());
|
||||
}
|
||||
|
||||
const dataBlocks = useMemo(() => {
|
||||
const blocks = new Map<
|
||||
LogOutputEntry['id'],
|
||||
{ pretty: string; bytes: number; lines: number }
|
||||
>();
|
||||
for (const entry of entries) {
|
||||
if (!entry.data) continue;
|
||||
const pretty = prettyData(entry.data);
|
||||
blocks.set(entry.id, { pretty, ...measureData(pretty) });
|
||||
}
|
||||
return blocks;
|
||||
}, [entries]);
|
||||
|
||||
const toggle = (id: LogOutputEntry['id']) =>
|
||||
setToggled((prev) => {
|
||||
const next = new Set(prev);
|
||||
if (!next.delete(id)) next.add(id);
|
||||
return next;
|
||||
});
|
||||
|
||||
if (entries.length === 0) {
|
||||
return <div className={styles.empty}>{emptyMessage}</div>;
|
||||
}
|
||||
@@ -65,6 +106,9 @@ export function LogOutput({
|
||||
>
|
||||
{entries.map((entry) => {
|
||||
const entryMs = new Date(entry.createdAt).getTime();
|
||||
const block = dataBlocks.get(entry.id);
|
||||
const large = block != null && exceedsLimits(block, dataLimits);
|
||||
const open = !large || dataExpanded !== toggled.has(entry.id);
|
||||
return (
|
||||
<div key={entry.id} className={[styles.line, styles[entry.level]].join(' ')}>
|
||||
<div className={styles.lineHeader}>
|
||||
@@ -75,9 +119,24 @@ export function LogOutput({
|
||||
{entry.context && <span className={styles.context}>{entry.context}</span>}
|
||||
<span className={styles.message}>{entry.message}</span>
|
||||
</div>
|
||||
{entry.data && (
|
||||
{block && large && (
|
||||
<button
|
||||
type="button"
|
||||
className={styles.dataToggle}
|
||||
aria-expanded={open}
|
||||
onClick={() => toggle(entry.id)}
|
||||
>
|
||||
{open ? (
|
||||
<ChevronDown size={14} strokeWidth={3} aria-hidden="true" />
|
||||
) : (
|
||||
<ChevronRight size={14} strokeWidth={3} aria-hidden="true" />
|
||||
)}
|
||||
{open ? hideDataLabel : showDataLabel(block)}
|
||||
</button>
|
||||
)}
|
||||
{block && open && (
|
||||
<div className={styles.data}>
|
||||
<CodeBlock code={prettyData(entry.data)} language="json" />
|
||||
<CodeBlock code={block.pretty} language="json" />
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
import type { LogOutputEntry } from './LogOutput';
|
||||
|
||||
/** Data blocks above either limit start collapsed. */
|
||||
export interface LogDataLimits {
|
||||
/** UTF-8 byte size of the pretty-printed data. */
|
||||
bytes: number;
|
||||
/** Line count of the pretty-printed data. */
|
||||
lines: number;
|
||||
}
|
||||
|
||||
export const DEFAULT_LOG_DATA_LIMITS: LogDataLimits = { bytes: 256, lines: 5 };
|
||||
|
||||
const encoder = new TextEncoder();
|
||||
|
||||
/**
|
||||
* "+12s" (or "-" if before startTime, e.g. clock skew). Log timestamps are
|
||||
* stored with second resolution, so fractions would be noise.
|
||||
*/
|
||||
export function formatElapsed(deltaMs: number): string {
|
||||
const sign = deltaMs < 0 ? '-' : '+';
|
||||
return `${sign}${Math.round(Math.abs(deltaMs) / 1000)}s`;
|
||||
}
|
||||
|
||||
/** Pretty-prints `data` if it's valid JSON, otherwise returns it as-is. */
|
||||
export function prettyData(data: string): string {
|
||||
try {
|
||||
return JSON.stringify(JSON.parse(data), null, 2);
|
||||
} catch {
|
||||
return data;
|
||||
}
|
||||
}
|
||||
|
||||
/** Byte size and line count of an already pretty-printed data block. */
|
||||
export function measureData(pretty: string): { bytes: number; lines: number } {
|
||||
return { bytes: encoder.encode(pretty).length, lines: pretty.split('\n').length };
|
||||
}
|
||||
|
||||
export function exceedsLimits(size: { bytes: number; lines: number }, limits: LogDataLimits) {
|
||||
return size.bytes > limits.bytes || size.lines > limits.lines;
|
||||
}
|
||||
|
||||
/** True if any entry's data block exceeds the limits (i.e. renders collapsed by default). */
|
||||
export function hasLargeData(
|
||||
entries: Pick<LogOutputEntry, 'data'>[],
|
||||
limits: LogDataLimits = DEFAULT_LOG_DATA_LIMITS,
|
||||
): boolean {
|
||||
return entries.some((e) => e.data && exceedsLimits(measureData(prettyData(e.data)), limits));
|
||||
}
|
||||
|
||||
/**
|
||||
* Plain-text rendering of the log, one entry per line with every data block
|
||||
* pretty-printed and indented below its line (e.g. for copying to the clipboard).
|
||||
*/
|
||||
export function formatLogText(
|
||||
entries: LogOutputEntry[],
|
||||
startTime?: string | number | Date,
|
||||
): string {
|
||||
if (entries.length === 0) return '';
|
||||
const startMs = new Date(startTime ?? entries[0].createdAt).getTime();
|
||||
return entries
|
||||
.map((entry) => {
|
||||
const elapsed = formatElapsed(new Date(entry.createdAt).getTime() - startMs);
|
||||
const context = entry.context ? ` [${entry.context}]` : '';
|
||||
const header = `${elapsed.padStart(6)} ${entry.level.toUpperCase().padEnd(5)}${context} ${entry.message}`;
|
||||
if (!entry.data) return header;
|
||||
const data = prettyData(entry.data)
|
||||
.split('\n')
|
||||
.map((line) => ` ${line}`)
|
||||
.join('\n');
|
||||
return `${header}\n${data}`;
|
||||
})
|
||||
.join('\n');
|
||||
}
|
||||
@@ -72,3 +72,5 @@ export type { UuidBadgeProps } from './UuidBadge/UuidBadge';
|
||||
|
||||
export { LogOutput } from './LogOutput/LogOutput';
|
||||
export type { LogOutputProps, LogOutputEntry, LogOutputLevel } from './LogOutput/LogOutput';
|
||||
export { DEFAULT_LOG_DATA_LIMITS, formatLogText, hasLargeData } from './LogOutput/logText';
|
||||
export type { LogDataLimits } from './LogOutput/logText';
|
||||
Reference in new issue
Block a user