Skip to content

Database diagrams editor that allows you to visualize and design your DB with a single query.

fix(sql export): make loading for export interactive (#388)

Guy Ben-Aharon125a39fb5be8
diff --git a/src/components/code-snippet/code-snippet.tsx b/src/components/code-snippet/code-snippet.tsx
index d4f402f5..89bd3f19 100644
--- a/src/components/code-snippet/code-snippet.tsx
+++ b/src/components/code-snippet/code-snippet.tsx
@@ -16,6 +16,8 @@ export interface CodeSnippetProps {
code: string;
language?: 'sql' | 'shell';
loading?: boolean;
+ autoScroll?: boolean;
+ isComplete?: boolean;
}
export const Editor = lazy(() =>
@@ -25,7 +27,14 @@ export const Editor = lazy(() =>
);
export const CodeSnippet: React.FC<CodeSnippetProps> = React.memo(
- ({ className, code, loading, language = 'sql' }) => {
+ ({
+ className,
+ code,
+ loading,
+ language = 'sql',
+ autoScroll = false,
+ isComplete = true,
+ }) => {
const { t } = useTranslation();
const monaco = useMonaco();
const { effectiveTheme } = useTheme();
@@ -47,6 +56,16 @@ export const CodeSnippet: React.FC<CodeSnippetProps> = React.memo(
}, 1500);
}, [isCopied]);
+ useEffect(() => {
+ if (monaco) {
+ const editor = monaco.editor.getModels()[0];
+ if (editor && autoScroll) {
+ const lineCount = editor.getLineCount();
+ monaco.editor.getEditors()[0]?.revealLine(lineCount);
+ }
+ }
+ }, [code, monaco, autoScroll]);
+
const copyToClipboard = useCallback(() => {
navigator.clipboard.writeText(code);
setIsCopied(true);
@@ -63,32 +82,38 @@ export const CodeSnippet: React.FC<CodeSnippetProps> = React.memo(
<Spinner />
) : (
<Suspense fallback={<Spinner />}>
- <Tooltip
- onOpenChange={setTooltipOpen}
- open={isCopied || tooltipOpen}
- >
- <TooltipTrigger
- asChild
- className="absolute right-1 top-1 z-10"
+ {isComplete ? (
+ <Tooltip
+ onOpenChange={setTooltipOpen}
+ open={isCopied || tooltipOpen}
>
- <span>
- <Button
- className=" h-fit p-1.5"
- variant="outline"
- onClick={copyToClipboard}
- >
- {isCopied ? (
- <CopyCheck size={16} />
- ) : (
- <Copy size={16} />
- )}
- </Button>
- </span>
- </TooltipTrigger>
- <TooltipContent>
- {t(isCopied ? 'copied' : 'copy_to_clipboard')}
- </TooltipContent>
- </Tooltip>
+ <TooltipTrigger
+ asChild
+ className="absolute right-1 top-1 z-10"
+ >
+ <span>
+ <Button
+ className=" h-fit p-1.5"
+ variant="outline"
+ onClick={copyToClipboard}
+ >
+ {isCopied ? (
+ <CopyCheck size={16} />
+ ) : (
+ <Copy size={16} />
+ )}
+ </Button>
+ </span>
+ </TooltipTrigger>
+ <TooltipContent>
+ {t(
+ isCopied
+ ? 'copied'
+ : 'copy_to_clipboard'
+ )}
+ </TooltipContent>
+ </Tooltip>
+ ) : null}
<Editor
value={code}
@@ -118,6 +143,9 @@ export const CodeSnippet: React.FC<CodeSnippetProps> = React.memo(
contextmenu: false,
}}
/>
+ {!isComplete ? (
+ <div className="absolute bottom-2 right-2 size-2 animate-blink rounded-full bg-pink-600" />
+ ) : null}
</Suspense>
)}
</div>
diff --git a/src/dialogs/export-sql-dialog/export-sql-dialog.tsx b/src/dialogs/export-sql-dialog/export-sql-dialog.tsx
index 01ad8598..d999c70f 100644
--- a/src/dialogs/export-sql-dialog/export-sql-dialog.tsx
+++ b/src/dialogs/export-sql-dialog/export-sql-dialog.tsx
@@ -20,7 +20,7 @@ import {
import { databaseTypeToLabelMap } from '@/lib/databases';
import { DatabaseType } from '@/lib/domain/database-type';
import { Annoyed, Sparkles } from 'lucide-react';
-import React, { useCallback, useEffect } from 'react';
+import React, { useCallback, useEffect, useRef } from 'react';
import { Trans, useTranslation } from 'react-i18next';
import type { BaseDialogProps } from '../common/base-dialog-props';
@@ -37,28 +37,47 @@ export const ExportSQLDialog: React.FC<ExportSQLDialogProps> = ({
const { t } = useTranslation();
const [script, setScript] = React.useState<string>();
const [error, setError] = React.useState<boolean>(false);
+ const [isScriptLoading, setIsScriptLoading] =
+ React.useState<boolean>(false);
+ const abortControllerRef = useRef<AbortController | null>(null);
const exportSQLScript = useCallback(async () => {
if (targetDatabaseType === DatabaseType.GENERIC) {
return Promise.resolve(exportBaseSQL(currentDiagram));
} else {
- return exportSQL(currentDiagram, targetDatabaseType);
+ return exportSQL(currentDiagram, targetDatabaseType, {
+ stream: true,
+ onResultStream: (text) =>
+ setScript((prev) => (prev ? prev + text : text)),
+ signal: abortControllerRef.current?.signal,
+ });
}
}, [targetDatabaseType, currentDiagram]);
useEffect(() => {
- if (!dialog.open) return;
+ if (!dialog.open) {
+ abortControllerRef.current?.abort();
+
+ return;
+ }
+ abortControllerRef.current = new AbortController();
setScript(undefined);
setError(false);
const fetchScript = async () => {
try {
+ setIsScriptLoading(true);
const script = await exportSQLScript();
setScript(script);
+ setIsScriptLoading(false);
} catch (e) {
setError(true);
}
};
fetchScript();
+
+ return () => {
+ abortControllerRef.current?.abort();
+ };
}, [dialog.open, setScript, exportSQLScript, setError]);
const renderError = useCallback(
@@ -156,7 +175,12 @@ export const ExportSQLDialog: React.FC<ExportSQLDialogProps> = ({
) : script.length === 0 ? (
renderError()
) : (
- <CodeSnippet className="h-96 w-full" code={script!} />
+ <CodeSnippet
+ className="h-96 w-full"
+ code={script!}
+ autoScroll={true}
+ isComplete={!isScriptLoading}
+ />
)}
</div>
diff --git a/src/lib/data/export-metadata/export-sql-script.ts b/src/lib/data/export-metadata/export-sql-script.ts
index 97cffea8..a4b2f06a 100644
--- a/src/lib/data/export-metadata/export-sql-script.ts
+++ b/src/lib/data/export-metadata/export-sql-script.ts
@@ -190,16 +190,39 @@ export const exportBaseSQL = (diagram: Diagram): string => {
export const exportSQL = async (
diagram: Diagram,
- databaseType: DatabaseType
+ databaseType: DatabaseType,
+ options?: {
+ stream: boolean;
+ onResultStream: (text: string) => void;
+ signal?: AbortSignal;
+ }
): Promise<string> => {
- const { generateText } = await import('ai');
- const { createOpenAI } = await import('@ai-sdk/openai');
+ const [{ streamText, generateText }, { createOpenAI }] = await Promise.all([
+ import('ai'),
+ import('@ai-sdk/openai'),
+ ]);
const openai = createOpenAI({
apiKey: OPENAI_API_KEY,
});
const sqlScript = exportBaseSQL(diagram);
const prompt = generateSQLPrompt(databaseType, sqlScript);
+ if (options?.stream) {
+ const { textStream, text } = await streamText({
+ model: openai('gpt-4o-mini-2024-07-18'),
+ prompt: prompt,
+ });
+
+ for await (const textPart of textStream) {
+ if (options.signal?.aborted) {
+ return '';
+ }
+ options.onResultStream(textPart);
+ }
+
+ return text;
+ }
+
const { text } = await generateText({
model: openai('gpt-4o-mini-2024-07-18'),
prompt: prompt,
diff --git a/tailwind.config.js b/tailwind.config.js
index 145dbf2f..49010889 100644
--- a/tailwind.config.js
+++ b/tailwind.config.js
@@ -77,12 +77,17 @@ module.exports = {
'50%': { transform: 'scale(1.05)' },
'100%': { transform: 'scale(1)' },
},
+ blink: {
+ '0%, 100%': { opacity: '1' },
+ '50%': { opacity: '0' },
+ },
},
animation: {
'accordion-down': 'accordion-down 0.2s ease-out',
'accordion-up': 'accordion-up 0.2s ease-out',
scale: 'scale 1s ease-in-out 1',
'scale-2': 'scale-2 1s ease-in-out 2',
+ blink: 'blink 1s infinite',
},
},
},