Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better error handling and styles in generate srcbook modal #147

Merged
merged 2 commits into from
Jul 19, 2024
Merged

Better error handling and styles in generate srcbook modal #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a920c5f
Better error handling and styles in generate srcbook modal
benjreinhart Jul 19, 2024
075a77b
Better language for invalid api key
benjreinhart Jul 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 70 additions & 26 deletions packages/web/src/components/generate-srcbook-modal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import { useState } from 'react';
import { useHotkeys } from 'react-hotkeys-hook';
import { useNavigate } from 'react-router-dom';
import { Link } from 'react-router-dom';
import { cn } from '@/lib/utils';
import { Button } from '@/components/ui/button';
import { Textarea } from '@/components/ui/textarea';
import { Sparkles, Loader2 } from 'lucide-react';
import { Dialog, DialogContent, DialogHeader, DialogTitle } from '@/components/ui/dialog';
import { generateSrcbook } from '@/lib/server';

const EXAMPLES = [
'Cover the basics of using Prisma, the popular TypeScript database ORM, with example code',
Expand All @@ -16,19 +17,17 @@ const EXAMPLES = [
export default function GenerateSrcbookModal({
open,
setOpen,
onGenerate,
openSrcbook,
hasOpenaiKey,
}: {
open: boolean;
setOpen: (open: boolean) => void;
onGenerate: (query: string) => Promise<void | string>;
openSrcbook: (path: string) => void;
hasOpenaiKey: boolean;
}) {
const [query, setQuery] = useState('');
const [status, setStatus] = useState<'idle' | 'loading'>('idle');
const [error, setError] = useState('');

const navigate = useNavigate();
const [error, setError] = useState<'generic' | 'api_key' | null>(null);

useHotkeys(
'mod+enter',
Expand All @@ -40,13 +39,31 @@ export default function GenerateSrcbookModal({
);

const generate = async () => {
if (!query) return;
if (!query) {
return;
}

setError(null);
setStatus('loading');
const result = await onGenerate(query);
if (result) {

// Some errors will be handled by the API handler and return with
// {error: true, result: {message: string}}}
// Some example errors that we expect are:
// - the generated text from the LLM did not parse correctly into Srcbook format
// - the API key is invalid
// - rate limits or out-of-credits issues
const { result, error } = await generateSrcbook({ query });

if (error) {
console.error(result);
setError(result);
setStatus('idle');
if (/Incorrect API key provided/.test(result)) {
setError('api_key');
} else {
setError('generic');
}
} else {
openSrcbook(result.dir);
}
};

Expand Down Expand Up @@ -77,22 +94,8 @@ export default function GenerateSrcbookModal({
<p>Generate</p>
)}
</Button>
{error.length > 0 && (
<div className="bg-sb-red-30 text-sb-red-80 rounded-sm text-sm px-3 py-2">
Something went wrong, please try again.
</div>
)}
{!hasOpenaiKey && (
<div className="flex w-full items-center justify-between bg-sb-yellow-20 text-sb-yellow-80 rounded-sm text-sm p-1">
<p className="px-2">API key required</p>
<button
className="border border-sb-yellow-70 rounded-sm px-2 py-1 hover:border-sb-yellow-80 animate-all"
onClick={() => navigate('/settings')}
>
Settings
</button>
</div>
)}
{error !== null && <ErrorMessage type={error} onRetry={generate} />}
{!hasOpenaiKey && <APIKeyWarning />}
<div className="w-full border-t"></div>
<p className="font-bold">Examples</p>
{EXAMPLES.map((example) => (
Expand All @@ -110,3 +113,44 @@ export default function GenerateSrcbookModal({
</Dialog>
);
}

function APIKeyWarning() {
return (
<div className="flex items-center justify-between bg-sb-yellow-20 text-sb-yellow-80 rounded-sm text-sm font-medium px-3 py-2">
<p>API key is invalid</p>
<Link to="/settings" className="underline">
Settings
</Link>
</div>
);
}

function ErrorMessage({ type, onRetry }: { type: 'api_key' | 'generic'; onRetry: () => void }) {
return (
<div className="bg-error text-error-foreground rounded-sm text-sm font-medium px-3 py-2">
{type === 'api_key' ? <APIKeyError /> : <GenericError onRetry={onRetry} />}
</div>
);
}

function APIKeyError() {
return (
<div className="flex items-center justify-between">
<p>Invalid API key</p>
<Link to="/settings" className="underline">
Settings
</Link>
</div>
);
}

function GenericError(props: { onRetry: () => void }) {
return (
<div className="flex items-center justify-between">
<p>Something went wrong</p>
<button onClick={props.onRetry} className="underline">
Try again
</button>
</div>
);
}
31 changes: 8 additions & 23 deletions packages/web/src/routes/home.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import {
loadSessions,
createSrcbook,
importSrcbook,
generateSrcbook,
loadSrcbookExamples,
} from '@/lib/server';
import type { ExampleSrcbookType, SessionType } from '@/types';
Expand Down Expand Up @@ -61,33 +60,19 @@ export default function Home() {
setShowDelete(true);
}

async function openSrcbook(path: string) {
const { result: srcbook } = await createSession({ path });
navigate(`/srcbooks/${srcbook.id}`);
}

async function onCreateSrcbook(language: CodeLanguageType) {
const { result } = await createSrcbook({ path: baseDir, name: 'Untitled', language: language });
const { result: srcbook } = await createSession({ path: result.path });
return navigate(`/srcbooks/${srcbook.id}`);
openSrcbook(result.path);
}

async function openExampleSrcbook(example: ExampleSrcbookType) {
const { result } = await importSrcbook({ path: example.path });
const { result: srcbook } = await createSession({ path: result.dir });
return navigate(`/srcbooks/${srcbook.id}`);
}

// Some errors will be handled by the API handler and return with
// {error: true, result: {message: string}}}
// Some example errors that we expect are:
// - the generated text from the LLM didn't not parse correctly into Srcbook format
// - the API key is invalid
// - rate limits or out-of-credits issues
async function onGenerateSrcbook(query: string) {
const { result, error } = await generateSrcbook({ query });
if (error === true) {
return result;
}

// We know at this point that we have a valid Srcbook from the LLM
const { result: srcbook } = await createSession({ path: result.dir });
return navigate(`/srcbooks/${srcbook.id}`);
openSrcbook(result.dir);
}

return (
Expand All @@ -100,7 +85,7 @@ export default function Home() {
<GenerateSrcbookModal
open={showGenSrcbookModal}
setOpen={setShowGenSrcbookModal}
onGenerate={onGenerateSrcbook}
openSrcbook={openSrcbook}
hasOpenaiKey={hasOpenAiKey}
/>
<ImportSrcbookModal open={showImportSrcbookModal} onOpenChange={setShowImportSrcbookModal} />
Expand Down
Loading