Skip to content

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

refactor: remove dedicated DBML import dialog (#907)

Jonathan Fishnere6783a89cc8e
diff --git a/src/context/dialog-context/dialog-context.tsx b/src/context/dialog-context/dialog-context.tsx
index a574e4c7..0992b21a 100644
--- a/src/context/dialog-context/dialog-context.tsx
+++ b/src/context/dialog-context/dialog-context.tsx
@@ -7,7 +7,6 @@ import type { ExportImageDialogProps } from '@/dialogs/export-image-dialog/expor
import type { ExportDiagramDialogProps } from '@/dialogs/export-diagram-dialog/export-diagram-dialog';
import type { ImportDiagramDialogProps } from '@/dialogs/import-diagram-dialog/import-diagram-dialog';
import type { CreateRelationshipDialogProps } from '@/dialogs/create-relationship-dialog/create-relationship-dialog';
-import type { ImportDBMLDialogProps } from '@/dialogs/import-dbml-dialog/import-dbml-dialog';
import type { OpenDiagramDialogProps } from '@/dialogs/open-diagram-dialog/open-diagram-dialog';
import type { CreateDiagramDialogProps } from '@/dialogs/create-diagram-dialog/create-diagram-dialog';
@@ -67,12 +66,6 @@ export interface DialogContext {
params: Omit<ImportDiagramDialogProps, 'dialog'>
) => void;
closeImportDiagramDialog: () => void;
-
- // Import DBML dialog
- openImportDBMLDialog: (
- params?: Omit<ImportDBMLDialogProps, 'dialog'>
- ) => void;
- closeImportDBMLDialog: () => void;
}
export const dialogContext = createContext<DialogContext>({
@@ -96,6 +89,4 @@ export const dialogContext = createContext<DialogContext>({
closeExportDiagramDialog: emptyFn,
openImportDiagramDialog: emptyFn,
closeImportDiagramDialog: emptyFn,
- openImportDBMLDialog: emptyFn,
- closeImportDBMLDialog: emptyFn,
});
diff --git a/src/context/dialog-context/dialog-provider.tsx b/src/context/dialog-context/dialog-provider.tsx
index 35a834c5..00745bde 100644
--- a/src/context/dialog-context/dialog-provider.tsx
+++ b/src/context/dialog-context/dialog-provider.tsx
@@ -20,8 +20,6 @@ import type { ExportImageDialogProps } from '@/dialogs/export-image-dialog/expor
import { ExportImageDialog } from '@/dialogs/export-image-dialog/export-image-dialog';
import { ExportDiagramDialog } from '@/dialogs/export-diagram-dialog/export-diagram-dialog';
import { ImportDiagramDialog } from '@/dialogs/import-diagram-dialog/import-diagram-dialog';
-import type { ImportDBMLDialogProps } from '@/dialogs/import-dbml-dialog/import-dbml-dialog';
-import { ImportDBMLDialog } from '@/dialogs/import-dbml-dialog/import-dbml-dialog';
export const DialogProvider: React.FC<React.PropsWithChildren> = ({
children,
@@ -132,11 +130,6 @@ export const DialogProvider: React.FC<React.PropsWithChildren> = ({
const [openImportDiagramDialog, setOpenImportDiagramDialog] =
useState(false);
- // Import DBML dialog
- const [openImportDBMLDialog, setOpenImportDBMLDialog] = useState(false);
- const [importDBMLDialogParams, setImportDBMLDialogParams] =
- useState<Omit<ImportDBMLDialogProps, 'dialog'>>();
-
return (
<dialogContext.Provider
value={{
@@ -165,11 +158,6 @@ export const DialogProvider: React.FC<React.PropsWithChildren> = ({
openImportDiagramDialog: () => setOpenImportDiagramDialog(true),
closeImportDiagramDialog: () =>
setOpenImportDiagramDialog(false),
- openImportDBMLDialog: (params) => {
- setImportDBMLDialogParams(params);
- setOpenImportDBMLDialog(true);
- },
- closeImportDBMLDialog: () => setOpenImportDBMLDialog(false),
}}
>
{children}
@@ -204,10 +192,6 @@ export const DialogProvider: React.FC<React.PropsWithChildren> = ({
/>
<ExportDiagramDialog dialog={{ open: openExportDiagramDialog }} />
<ImportDiagramDialog dialog={{ open: openImportDiagramDialog }} />
- <ImportDBMLDialog
- dialog={{ open: openImportDBMLDialog }}
- {...importDBMLDialogParams}
- />
</dialogContext.Provider>
);
};
diff --git a/src/dialogs/common/import-database/import-database.tsx b/src/dialogs/common/import-database/import-database.tsx
index 3382350a..e69a8162 100644
--- a/src/dialogs/common/import-database/import-database.tsx
+++ b/src/dialogs/common/import-database/import-database.tsx
@@ -46,6 +46,10 @@ import { setupDBMLLanguage } from '@/components/code-snippet/languages/dbml-lang
import type { ImportMethod } from '@/lib/import-method/import-method';
import { detectImportMethod } from '@/lib/import-method/detect-import-method';
import { verifyDBML } from '@/lib/dbml/dbml-import/verify-dbml';
+import {
+ clearErrorHighlight,
+ highlightErrorLine,
+} from '@/components/code-snippet/dbml/utils';
const calculateContentSizeMB = (content: string): number => {
return content.length / (1024 * 1024); // Convert to MB
@@ -93,6 +97,7 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
const { effectiveTheme } = useTheme();
const [errorMessage, setErrorMessage] = useState('');
const editorRef = useRef<editor.IStandaloneCodeEditor | null>(null);
+ const decorationsCollection = useRef<editor.IEditorDecorationsCollection>();
const pasteDisposableRef = useRef<IDisposable | null>(null);
const { t } = useTranslation();
@@ -107,6 +112,10 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
const [isAutoFixing, setIsAutoFixing] = useState(false);
const [showAutoFixButton, setShowAutoFixButton] = useState(false);
+ const clearDecorations = useCallback(() => {
+ clearErrorHighlight(decorationsCollection.current);
+ }, []);
+
useEffect(() => {
setScriptResult('');
setErrorMessage('');
@@ -115,6 +124,7 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
// Check if the ddl or dbml is valid
useEffect(() => {
+ clearDecorations();
if (importMethod === 'query') {
setSqlValidation(null);
setShowAutoFixButton(false);
@@ -145,6 +155,12 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
if (validateResponse.parsedError) {
errorMsg = validateResponse.parsedError.message;
line = validateResponse.parsedError.line;
+ highlightErrorLine({
+ error: validateResponse.parsedError,
+ model: editorRef.current?.getModel(),
+ editorDecorationsCollection:
+ decorationsCollection.current,
+ });
}
setSqlValidation({
@@ -192,7 +208,7 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
setErrorMessage(result.error);
}
});
- }, [importMethod, scriptResult, databaseType]);
+ }, [importMethod, scriptResult, databaseType, clearDecorations]);
// Check if the script result is a valid JSON
useEffect(() => {
@@ -320,6 +336,8 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
const handleEditorDidMount = useCallback(
(editor: editor.IStandaloneCodeEditor) => {
editorRef.current = editor;
+ decorationsCollection.current =
+ editor.createDecorationsCollection();
// Cleanup previous disposable if it exists
if (pasteDisposableRef.current) {
diff --git a/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx b/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx
index ffc92875..5faee166 100644
--- a/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx
+++ b/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx
@@ -39,7 +39,7 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
const [databaseType, setDatabaseType] = useState<DatabaseType>(
DatabaseType.GENERIC
);
- const { closeCreateDiagramDialog, openImportDBMLDialog } = useDialog();
+ const { closeCreateDiagramDialog } = useDialog();
const { updateConfig } = useConfig();
const [scriptResult, setScriptResult] = useState('');
const [databaseEdition, setDatabaseEdition] = useState<
@@ -165,10 +165,6 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
await updateConfig({ config: { defaultDiagramId: diagram.id } });
closeCreateDiagramDialog();
navigate(`/diagrams/${diagram.id}`);
- setTimeout(
- () => openImportDBMLDialog({ withCreateEmptyDiagram: true }),
- 700
- );
}, [
databaseType,
addDiagram,
@@ -177,7 +173,6 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
navigate,
updateConfig,
diagramNumber,
- openImportDBMLDialog,
]);
const importNewDiagramOrFilterTables = useCallback(async () => {
diff --git a/src/dialogs/import-dbml-dialog/import-dbml-dialog.tsx b/src/dialogs/import-dbml-dialog/import-dbml-dialog.tsx
deleted file mode 100644
index 1bfd2be8..00000000
--- a/src/dialogs/import-dbml-dialog/import-dbml-dialog.tsx
+++ /dev/null
@@ -1,355 +0,0 @@
-import React, {
- useCallback,
- useEffect,
- useState,
- Suspense,
- useRef,
-} from 'react';
-import type * as monaco from 'monaco-editor';
-import { useDialog } from '@/hooks/use-dialog';
-import {
- Dialog,
- DialogClose,
- DialogContent,
- DialogDescription,
- DialogFooter,
- DialogHeader,
- DialogInternalContent,
- DialogTitle,
-} from '@/components/dialog/dialog';
-import { Button } from '@/components/button/button';
-import type { BaseDialogProps } from '../common/base-dialog-props';
-import { useTranslation } from 'react-i18next';
-import { Editor } from '@/components/code-snippet/code-snippet';
-import { useTheme } from '@/hooks/use-theme';
-import { AlertCircle } from 'lucide-react';
-import { importDBMLToDiagram } from '@/lib/dbml/dbml-import/dbml-import';
-import { useChartDB } from '@/hooks/use-chartdb';
-import { useCanvas } from '@/hooks/use-canvas';
-import { setupDBMLLanguage } from '@/components/code-snippet/languages/dbml-language';
-import type { DBTable } from '@/lib/domain/db-table';
-import { useToast } from '@/components/toast/use-toast';
-import { Spinner } from '@/components/spinner/spinner';
-import { debounce } from '@/lib/utils';
-import {
- clearErrorHighlight,
- highlightErrorLine,
-} from '@/components/code-snippet/dbml/utils';
-import { verifyDBML } from '@/lib/dbml/dbml-import/verify-dbml';
-
-export interface ImportDBMLDialogProps extends BaseDialogProps {
- withCreateEmptyDiagram?: boolean;
-}
-
-export const ImportDBMLDialog: React.FC<ImportDBMLDialogProps> = ({
- dialog,
- withCreateEmptyDiagram,
-}) => {
- const { t } = useTranslation();
- const initialDBML = `// Use DBML to define your database structure
-// Simple Blog System with Comments Example
-
-Table users {
- id integer [primary key]
- name varchar
- email varchar
-}
-
-Table posts {
- id integer [primary key]
- title varchar
- content text
- user_id integer
- created_at timestamp
-}
-
-Table comments {
- id integer [primary key]
- content text
- post_id integer
- user_id integer
- created_at timestamp
-}
-
-// Relationships
-Ref: posts.user_id > users.id // Each post belongs to one user
-Ref: comments.post_id > posts.id // Each comment belongs to one post
-Ref: comments.user_id > users.id // Each comment is written by one user`;
-
- const [dbmlContent, setDBMLContent] = useState<string>(initialDBML);
- const { closeImportDBMLDialog } = useDialog();
- const [errorMessage, setErrorMessage] = useState<string | undefined>();
- const { effectiveTheme } = useTheme();
- const { toast } = useToast();
- const {
- addTables,
- addRelationships,
- tables,
- relationships,
- removeTables,
- removeRelationships,
- databaseType,
- } = useChartDB();
- const { reorderTables } = useCanvas();
- const [reorder, setReorder] = useState(false);
- const editorRef = useRef<monaco.editor.IStandaloneCodeEditor>();
- const decorationsCollection =
- useRef<monaco.editor.IEditorDecorationsCollection>();
-
- const handleEditorDidMount = (
- editor: monaco.editor.IStandaloneCodeEditor
- ) => {
- editorRef.current = editor;
- decorationsCollection.current = editor.createDecorationsCollection();
- };
-
- useEffect(() => {
- if (reorder) {
- reorderTables({
- updateHistory: false,
- });
- setReorder(false);
- }
- }, [reorder, reorderTables]);
-
- const clearDecorations = useCallback(() => {
- clearErrorHighlight(decorationsCollection.current);
- }, []);
-
- const validateDBML = useCallback(
- async (content: string) => {
- // Clear previous errors
- setErrorMessage(undefined);
- clearDecorations();
-
- if (!content.trim()) {
- return;
- }
-
- const validateResponse = verifyDBML(content);
-
- if (validateResponse.hasError) {
- if (validateResponse.parsedError) {
- const parsedError = validateResponse.parsedError;
- setErrorMessage(
- t('import_dbml_dialog.error.description') +
- ` (1 error found - in line ${parsedError.line})`
- );
- highlightErrorLine({
- error: parsedError,
- model: editorRef.current?.getModel(),
- editorDecorationsCollection:
- decorationsCollection.current,
- });
- } else {
- setErrorMessage(validateResponse.errorText);
- }
- }
- },
- [clearDecorations, t]
- );
-
- const debouncedValidateRef = useRef<((value: string) => void) | null>(null);
-
- // Set up debounced validation
- useEffect(() => {
- debouncedValidateRef.current = debounce((value: string) => {
- validateDBML(value);
- }, 500);
-
- return () => {
- debouncedValidateRef.current = null;
- };
- }, [validateDBML]);
-
- // Trigger validation when content changes
- useEffect(() => {
- if (debouncedValidateRef.current) {
- debouncedValidateRef.current(dbmlContent);
- }
- }, [dbmlContent]);
-
- useEffect(() => {
- if (!dialog.open) {
- setErrorMessage(undefined);
- clearDecorations();
- setDBMLContent(initialDBML);
- }
- }, [dialog.open, initialDBML, clearDecorations]);
-
- const handleImport = useCallback(async () => {
- if (!dbmlContent.trim() || errorMessage) return;
-
- try {
- const importedDiagram = await importDBMLToDiagram(dbmlContent, {
- databaseType,
- });
- const tableIdsToRemove = tables
- .filter((table) =>
- importedDiagram.tables?.some(
- (t: DBTable) =>
- t.name === table.name && t.schema === table.schema
- )
- )
- .map((table) => table.id);
- // Find relationships that need to be removed
- const relationshipIdsToRemove = relationships
- .filter((relationship) => {
- const sourceTable = tables.find(
- (table: DBTable) =>
- table.id === relationship.sourceTableId
- );
- const targetTable = tables.find(
- (table: DBTable) =>
- table.id === relationship.targetTableId
- );
- if (!sourceTable || !targetTable) return true;
- const replacementSourceTable = importedDiagram.tables?.find(
- (table: DBTable) =>
- table.name === sourceTable.name &&
- table.schema === sourceTable.schema
- );
- const replacementTargetTable = importedDiagram.tables?.find(
- (table: DBTable) =>
- table.name === targetTable.name &&
- table.schema === targetTable.schema
- );
- return replacementSourceTable || replacementTargetTable;
- })
- .map((relationship) => relationship.id);
-
- // Remove existing items
- await Promise.all([
- removeTables(tableIdsToRemove, { updateHistory: false }),
- removeRelationships(relationshipIdsToRemove, {
- updateHistory: false,
- }),
- ]);
-
- // Add new items
- await Promise.all([
- addTables(importedDiagram.tables ?? [], {
- updateHistory: false,
- }),
- addRelationships(importedDiagram.relationships ?? [], {
- updateHistory: false,
- }),
- ]);
- setReorder(true);
- closeImportDBMLDialog();
- } catch (e) {
- toast({
- title: t('import_dbml_dialog.error.title'),
- variant: 'destructive',
- description: (
- <>
- <div>{t('import_dbml_dialog.error.description')}</div>
- {e instanceof Error ? e.message : JSON.stringify(e)}
- </>
- ),
- });
- }
- }, [
- dbmlContent,
- closeImportDBMLDialog,
- tables,
- relationships,
- removeTables,
- removeRelationships,
- addTables,
- addRelationships,
- errorMessage,
- toast,
- setReorder,
- t,
- databaseType,
- ]);
-
- return (
- <Dialog
- {...dialog}
- onOpenChange={(open) => {
- if (!open) {
- closeImportDBMLDialog();
- }
- }}
- >
- <DialogContent
- className="flex h-[80vh] max-h-screen w-full flex-col md:max-w-[900px]"
- showClose
- >
- <DialogHeader>
- <DialogTitle>
- {withCreateEmptyDiagram
- ? t('import_dbml_dialog.example_title')
- : t('import_dbml_dialog.title')}
- </DialogTitle>
- <DialogDescription>
- {t('import_dbml_dialog.description')}
- </DialogDescription>
- </DialogHeader>
- <DialogInternalContent>
- <Suspense fallback={<Spinner />}>
- <Editor
- value={dbmlContent}
- onChange={(value) => setDBMLContent(value || '')}
- language="dbml"
- onMount={handleEditorDidMount}
- theme={
- effectiveTheme === 'dark'
- ? 'dbml-dark'
- : 'dbml-light'
- }
- beforeMount={setupDBMLLanguage}
- options={{
- minimap: { enabled: false },
- scrollBeyondLastLine: false,
- automaticLayout: true,
- glyphMargin: true,
- lineNumbers: 'on',
- scrollbar: {
- vertical: 'visible',
- horizontal: 'visible',
- },
- }}
- className="size-full"
- />
- </Suspense>
- </DialogInternalContent>
- <DialogFooter>
- <div className="flex w-full items-center justify-between">
- <div className="flex items-center gap-4">
- <DialogClose asChild>
- <Button variant="secondary">
- {withCreateEmptyDiagram
- ? t('import_dbml_dialog.skip_and_empty')
- : t('import_dbml_dialog.cancel')}
- </Button>
- </DialogClose>
- {errorMessage ? (
- <div className="flex items-center gap-1">
- <AlertCircle className="size-4 text-destructive" />
-
- <span className="text-xs text-destructive">
- {errorMessage ||
- t(
- 'import_dbml_dialog.error.description'
- )}
- </span>
- </div>
- ) : null}
- </div>
- <Button
- onClick={handleImport}
- disabled={!dbmlContent.trim() || !!errorMessage}
- >
- {withCreateEmptyDiagram
- ? t('import_dbml_dialog.show_example')
- : t('import_dbml_dialog.import')}
- </Button>
- </div>
- </DialogFooter>
- </DialogContent>
- </Dialog>
- );
-};
diff --git a/src/pages/editor-page/top-navbar/menu/menu.tsx b/src/pages/editor-page/top-navbar/menu/menu.tsx
index 1ffef392..f7f9dcd9 100644
--- a/src/pages/editor-page/top-navbar/menu/menu.tsx
+++ b/src/pages/editor-page/top-navbar/menu/menu.tsx
@@ -46,7 +46,6 @@ export const Menu: React.FC<MenuProps> = () => {
openExportImageDialog,
openExportDiagramDialog,
openImportDiagramDialog,
- openImportDBMLDialog,
} = useDialog();
const { showAlert } = useAlert();
const { setTheme, theme } = useTheme();
@@ -185,9 +184,6 @@ export const Menu: React.FC<MenuProps> = () => {
<MenubarItem onClick={openImportDiagramDialog}>
.json
</MenubarItem>
- <MenubarItem onClick={() => openImportDBMLDialog()}>
- .dbml
- </MenubarItem>
<MenubarSeparator />
<MenubarItem
onClick={() =>