Better handling of large responses

This commit is contained in:
Gregory Schier
2024-07-23 08:59:15 -07:00
parent ac8b1c018b
commit 38e0882dd1
5 changed files with 66 additions and 8 deletions

View File

@@ -0,0 +1,24 @@
import { useClipboardText } from '../hooks/useClipboardText';
import { useTimedBoolean } from '../hooks/useTimedBoolean';
import type { ButtonProps } from './core/Button';
import { Button } from './core/Button';
interface Props extends ButtonProps {
text: string;
}
export function CopyButton({ text, ...props }: Props) {
const [, copy] = useClipboardText({ disableToast: true });
const [copied, setCopied] = useTimedBoolean();
return (
<Button
{...props}
onClick={() => {
copy(text);
setCopied();
}}
>
{copied ? 'Copied' : 'Copy'}
</Button>
);
}

View File

@@ -6,16 +6,24 @@ import { useContentTypeFromHeaders } from '../../hooks/useContentTypeFromHeaders
import { useDebouncedValue } from '../../hooks/useDebouncedValue';
import { useFilterResponse } from '../../hooks/useFilterResponse';
import { useResponseBodyText } from '../../hooks/useResponseBodyText';
import { useSaveResponse } from '../../hooks/useSaveResponse';
import { useToggle } from '../../hooks/useToggle';
import { tryFormatJson, tryFormatXml } from '../../lib/formatters';
import type { HttpResponse } from '../../lib/models';
import { CopyButton } from '../CopyButton';
import { Banner } from '../core/Banner';
import { Button } from '../core/Button';
import { Editor } from '../core/Editor';
import { hyperlink } from '../core/Editor/hyperlink/extension';
import { IconButton } from '../core/IconButton';
import { InlineCode } from '../core/InlineCode';
import { Input } from '../core/Input';
import { EmptyStateText } from '../EmptyStateText';
import { SizeTag } from '../core/SizeTag';
import { HStack } from '../core/Stacks';
import { BinaryViewer } from './BinaryViewer';
const extraExtensions = [hyperlink];
const LARGE_RESPONSE_BYTES = 2 * 1000 * 1000;
interface Props {
response: HttpResponse;
@@ -27,6 +35,7 @@ const useFilterText = createGlobalState<Record<string, string | null>>({});
export function TextViewer({ response, pretty, className }: Props) {
const [filterTextMap, setFilterTextMap] = useFilterText();
const [showLargeResponse, toggleShowLargeResponse] = useToggle();
const filterText = filterTextMap[response.id] ?? null;
const debouncedFilterText = useDebouncedValue(filterText, 200);
const setFilterText = useCallback(
@@ -36,6 +45,7 @@ export function TextViewer({ response, pretty, className }: Props) {
[setFilterTextMap, response],
);
const saveResponse = useSaveResponse(response);
const contentType = useContentTypeFromHeaders(response.headers);
const rawBody = useResponseBodyText(response);
const isSearching = filterText != null;
@@ -117,8 +127,32 @@ export function TextViewer({ response, pretty, className }: Props) {
return <BinaryViewer response={response} />;
}
if ((response.contentLength ?? 0) > 2 * 1000 * 1000) {
return <EmptyStateText>Cannot preview text responses larger than 2MB</EmptyStateText>;
if (!showLargeResponse && (response.contentLength ?? 0) > LARGE_RESPONSE_BYTES / 1000) {
return (
<Banner color="primary" className="h-full flex flex-col gap-3">
<p>
Showing responses over{' '}
<InlineCode>
<SizeTag contentLength={LARGE_RESPONSE_BYTES} />
</InlineCode>{' '}
may impact performance
</p>
<HStack space={2}>
<Button color="primary" size="xs" onClick={toggleShowLargeResponse}>
Reveal Response
</Button>
<Button variant="border" size="xs" onClick={() => saveResponse.mutate()}>
Save to File
</Button>
<CopyButton
variant="border"
size="xs"
onClick={() => saveResponse.mutate()}
text={rawBody.data}
/>
</HStack>
</Banner>
);
}
const formattedBody =

View File

@@ -6,7 +6,7 @@ import { createGlobalState } from 'react-use';
const useClipboardTextState = createGlobalState<string>('');
export function useClipboardText() {
export function useClipboardText({ disableToast }: { disableToast?: boolean } = {}) {
const [value, setValue] = useClipboardTextState();
const focused = useWindowFocus();
const toast = useToast();
@@ -18,7 +18,7 @@ export function useClipboardText() {
const setText = useCallback(
(text: string) => {
writeText(text).catch(console.error);
if (text != '') {
if (text != '' && !disableToast) {
toast.show({
id: 'copied',
variant: 'copied',
@@ -27,7 +27,7 @@ export function useClipboardText() {
}
setValue(text);
},
[setValue, toast],
[disableToast, setValue, toast],
);
return [value, setText] as const;

View File

@@ -20,7 +20,7 @@ export function useSaveResponse(response: HttpResponse) {
const contentType = getContentTypeHeader(response.headers) ?? 'unknown';
const ext = mime.getExtension(contentType);
const slug = slugify(request.name ?? 'response', { lower: true });
const slug = slugify(request.name || 'response', { lower: true });
const filepath = await save({
defaultPath: ext ? `${slug}.${ext}` : slug,
title: 'Save Response',

View File

@@ -2,7 +2,7 @@ import { useRef, useState } from 'react';
import { useUnmount } from 'react-use';
/** Returns a boolean that is true for a given number of milliseconds. */
export function useTimedBoolean(millis = 1000): [boolean, () => void] {
export function useTimedBoolean(millis = 1500): [boolean, () => void] {
const [value, setValue] = useState(false);
const timeout = useRef<NodeJS.Timeout | null>(null);
const reset = () => timeout.current && clearTimeout(timeout.current);