Skip to content

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

fix broken import json for pgAdmin (#289)

Jonathan Fishnerdf85301bf63c
diff --git a/src/components/zoomable-image/zoomable-image.tsx b/src/components/zoomable-image/zoomable-image.tsx
index ef981a4a..2d5ee1ca 100644
--- a/src/components/zoomable-image/zoomable-image.tsx
+++ b/src/components/zoomable-image/zoomable-image.tsx
@@ -1,5 +1,5 @@
import React from 'react';
-import { DialogTrigger } from '../command/dialog';
+import { DialogTrigger } from '@/components/command/dialog';
import {
Dialog,
DialogContent,
diff --git a/src/dialogs/common/import-database/import-database.tsx b/src/dialogs/common/import-database/import-database.tsx
index c42e8802..0d92d998 100644
--- a/src/dialogs/common/import-database/import-database.tsx
+++ b/src/dialogs/common/import-database/import-database.tsx
@@ -31,10 +31,14 @@ import {
databaseClientToLabelMap,
databaseTypeToClientsMap,
} from '@/lib/domain/database-clients';
-import { isDatabaseMetadata } from '@/lib/data/import-metadata/metadata-types/database-metadata';
import type { ImportMetadataScripts } from '@/lib/data/import-metadata/scripts/scripts';
import { ZoomableImage } from '@/components/zoomable-image/zoomable-image';
import { useBreakpoint } from '@/hooks/use-breakpoint';
+import { Spinner } from '@/components/spinner/spinner';
+import {
+ fixMetadataJson,
+ isStringMetadataJson,
+} from '@/lib/data/import-metadata/utils';
const errorScriptOutputMessage =
'Invalid JSON. Please correct it or contact us at [email protected] for help.';
@@ -77,6 +81,9 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
const { isSm: isDesktop } = useBreakpoint('sm');
+ const [showCheckJsonButton, setShowCheckJsonButton] = useState(false);
+ const [isCheckingJson, setIsCheckingJson] = useState(false);
+
useEffect(() => {
const loadScripts = async () => {
const { importMetadataScripts } = await import(
@@ -90,19 +97,22 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
useEffect(() => {
if (scriptResult.trim().length === 0) {
setErrorMessage('');
+ setShowCheckJsonButton(false);
return;
}
- try {
- const parsedResult = JSON.parse(scriptResult);
-
- if (isDatabaseMetadata(parsedResult)) {
- setErrorMessage('');
- } else {
- setErrorMessage(errorScriptOutputMessage);
- }
- } catch (error) {
+ if (isStringMetadataJson(scriptResult)) {
+ setErrorMessage('');
+ setShowCheckJsonButton(false);
+ } else if (
+ scriptResult.trim().includes('{') &&
+ scriptResult.trim().includes('}')
+ ) {
+ setShowCheckJsonButton(true);
+ setErrorMessage('');
+ } else {
setErrorMessage(errorScriptOutputMessage);
+ setShowCheckJsonButton(false);
}
}, [scriptResult]);
@@ -120,6 +130,22 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
[setScriptResult]
);
+ const handleCheckJson = useCallback(async () => {
+ setIsCheckingJson(true);
+
+ const fixedJson = await fixMetadataJson(scriptResult);
+
+ if (isStringMetadataJson(fixedJson)) {
+ setScriptResult(fixedJson);
+ setErrorMessage('');
+ } else {
+ setErrorMessage(errorScriptOutputMessage);
+ }
+
+ setShowCheckJsonButton(false);
+ setIsCheckingJson(false);
+ }, [scriptResult, setScriptResult]);
+
const renderHeader = useCallback(() => {
return (
<DialogHeader>
@@ -286,11 +312,31 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
value={scriptResult}
onChange={handleInputChange}
/>
- {errorMessage && (
- <p className="mt-2 text-sm text-red-700">
- {errorMessage}
- </p>
- )}
+ {showCheckJsonButton || errorMessage ? (
+ <div className="mt-2 flex items-center gap-2">
+ {showCheckJsonButton ? (
+ <Button
+ type="button"
+ variant="outline"
+ size="sm"
+ onClick={handleCheckJson}
+ disabled={isCheckingJson}
+ >
+ {isCheckingJson ? (
+ <Spinner size="small" />
+ ) : (
+ t(
+ 'new_diagram_dialog.import_database.check_script_result'
+ )
+ )}
+ </Button>
+ ) : (
+ <p className="text-sm text-red-700">
+ {errorMessage}
+ </p>
+ )}
+ </div>
+ ) : null}
</div>
</div>
);
@@ -305,6 +351,9 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
databaseClient,
importMetadataScripts,
t,
+ showCheckJsonButton,
+ isCheckingJson,
+ handleCheckJson,
]);
const renderFooter = useCallback(() => {
@@ -361,6 +410,7 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
type="button"
variant="default"
disabled={
+ showCheckJsonButton ||
scriptResult.trim().length === 0 ||
errorMessage.length > 0
}
@@ -390,6 +440,7 @@ export const ImportDatabase: React.FC<ImportDatabaseProps> = ({
onCreateEmptyDiagram,
errorMessage.length,
scriptResult,
+ showCheckJsonButton,
goBack,
t,
]);
diff --git a/src/i18n/locales/de.ts b/src/i18n/locales/de.ts
index 62c8e98f..0f339f0d 100644
--- a/src/i18n/locales/de.ts
+++ b/src/i18n/locales/de.ts
@@ -226,6 +226,7 @@ export const de: LanguageTranslation = {
},
// TODO: Translate
instructions_link: 'Need help? Watch how',
+ check_script_result: 'Check Script Result',
},
cancel: 'Abbrechen',
diff --git a/src/i18n/locales/en.ts b/src/i18n/locales/en.ts
index 09e1c76a..b21519b0 100644
--- a/src/i18n/locales/en.ts
+++ b/src/i18n/locales/en.ts
@@ -220,6 +220,7 @@ export const en = {
step_2: 'If you\'re using "Results to Grid," change the Maximum Characters Retrieved for Non-XML data (set to 9999999).',
},
instructions_link: 'Need help? Watch how',
+ check_script_result: 'Check Script Result',
},
cancel: 'Cancel',
diff --git a/src/i18n/locales/es.ts b/src/i18n/locales/es.ts
index d71877aa..ad5e707d 100644
--- a/src/i18n/locales/es.ts
+++ b/src/i18n/locales/es.ts
@@ -216,6 +216,7 @@ export const es: LanguageTranslation = {
},
// TODO: Translate
instructions_link: 'Need help? Watch how',
+ check_script_result: 'Check Script Result',
},
cancel: 'Cancelar',
diff --git a/src/i18n/locales/fr.ts b/src/i18n/locales/fr.ts
index 98636d28..f71a8db9 100644
--- a/src/i18n/locales/fr.ts
+++ b/src/i18n/locales/fr.ts
@@ -212,6 +212,8 @@ export const fr: LanguageTranslation = {
step_2: 'Si vous utilisez "Résultats en Grille", changez le nombre maximum de caractères récupérés pour les données non-XML (définir à 9999999).',
},
instructions_link: "Besoin d'aide ? Regardez comment",
+ // TODO: Translate
+ check_script_result: 'Check Script Result',
},
cancel: 'Annuler',
diff --git a/src/i18n/locales/hi.ts b/src/i18n/locales/hi.ts
index aa4d611d..ca41572b 100644
--- a/src/i18n/locales/hi.ts
+++ b/src/i18n/locales/hi.ts
@@ -222,6 +222,8 @@ export const hi: LanguageTranslation = {
step_2: 'यदि आप "ग्रिड में परिणाम" का उपयोग कर रहे हैं, तो Non-XML डेटा के लिए अधिकतम वर्ण प्राप्ति (9999999 पर सेट करें)।',
},
instructions_link: 'मदद चाहिए? देखें कैसे',
+ // TODO: Translate
+ check_script_result: 'Check Script Result',
},
cancel: 'रद्द करें',
diff --git a/src/i18n/locales/ja.ts b/src/i18n/locales/ja.ts
index f59c9470..388f099d 100644
--- a/src/i18n/locales/ja.ts
+++ b/src/i18n/locales/ja.ts
@@ -225,6 +225,7 @@ export const ja: LanguageTranslation = {
},
// TODO: Translate
instructions_link: 'Need help? Watch how',
+ check_script_result: 'Check Script Result',
},
cancel: 'キャンセル',
diff --git a/src/lib/data/import-metadata/utils.ts b/src/lib/data/import-metadata/utils.ts
new file mode 100644
index 00000000..d48add41
--- /dev/null
+++ b/src/lib/data/import-metadata/utils.ts
@@ -0,0 +1,27 @@
+import { waitFor } from '@/lib/utils';
+import { isDatabaseMetadata } from './metadata-types/database-metadata';
+
+export const fixMetadataJson = async (
+ metadataJson: string
+): Promise<string> => {
+ await waitFor(1000);
+ return metadataJson
+ .trim()
+ .replace(/^\s+|\s+$/g, '')
+ .replace(/^"|"$/g, '')
+ .replace(/""/g, '"')
+ .replace(/\n/g, '');
+};
+
+export const isStringMetadataJson = (metadataJsonString: string): boolean => {
+ let result = false;
+ try {
+ const parsedResult = JSON.parse(metadataJsonString);
+
+ result = isDatabaseMetadata(parsedResult);
+ } catch {
+ result = false;
+ }
+
+ return result;
+};
diff --git a/src/lib/domain/db-relationship.ts b/src/lib/domain/db-relationship.ts
index b1a6ec86..b9e232da 100644
--- a/src/lib/domain/db-relationship.ts
+++ b/src/lib/domain/db-relationship.ts
@@ -42,6 +42,15 @@ export const shouldShowRelationshipBySchemaFilter = (
schemaNameToSchemaId(relationship.targetSchema)
));
+const determineCardinality = (
+ field: DBField,
+ isTablePKComplex: boolean
+): Cardinality => {
+ return field.unique || (field.primaryKey && !isTablePKComplex)
+ ? 'one'
+ : 'many';
+};
+
export const createRelationshipsFromMetadata = ({
foreignKeys,
tables,
@@ -50,7 +59,7 @@ export const createRelationshipsFromMetadata = ({
tables: DBTable[];
}): DBRelationship[] => {
return foreignKeys
- .map((fk: ForeignKeyInfo) => {
+ .map((fk: ForeignKeyInfo): DBRelationship | null => {
const schema = schemaNameToDomainSchemaName(fk.schema);
const sourceTable = tables.find(
(table) => table.name === fk.table && table.schema === schema
@@ -88,10 +97,6 @@ export const createRelationshipsFromMetadata = ({
targetField,
isTargetTablePKComplex
);
- const type = determineRelationshipType({
- sourceCardinality,
- targetCardinality,
- });
return {
id: generateId(),
@@ -102,11 +107,10 @@ export const createRelationshipsFromMetadata = ({
targetTableId: targetTable.id,
sourceFieldId: sourceField.id,
targetFieldId: targetField.id,
- type,
sourceCardinality,
targetCardinality,
createdAt: Date.now(),
- } as DBRelationship;
+ };
}
return null;
@@ -114,15 +118,6 @@ export const createRelationshipsFromMetadata = ({
.filter((rel) => rel !== null) as DBRelationship[];
};
-const determineCardinality = (
- field: DBField,
- isTablePKComplex: boolean
-): Cardinality => {
- return field.unique || (field.primaryKey && !isTablePKComplex)
- ? 'one'
- : 'many';
-};
-
export const determineRelationshipType = ({
sourceCardinality,
targetCardinality,
diff --git a/src/lib/domain/db-schema.ts b/src/lib/domain/db-schema.ts
index b82bea15..b446459a 100644
--- a/src/lib/domain/db-schema.ts
+++ b/src/lib/domain/db-schema.ts
@@ -7,7 +7,7 @@ export interface DBSchema {
}
export const schemaNameToSchemaId = (schema: string): string =>
- schema.toLowerCase().split(' ').join('_');
+ schema.trim().toLowerCase().split(' ').join('_');
export const schemaNameToDomainSchemaName = (
schema: string | null | undefined
@@ -16,7 +16,7 @@ export const schemaNameToDomainSchemaName = (
? undefined
: (schema ?? '').trim() === ''
? undefined
- : schema;
+ : schema?.trim();
export const databasesWithSchemas: DatabaseType[] = [
DatabaseType.POSTGRESQL,
diff --git a/src/lib/utils.ts b/src/lib/utils.ts
index 5f317112..56a8fb5b 100644
--- a/src/lib/utils.ts
+++ b/src/lib/utils.ts
@@ -84,3 +84,7 @@ export const decodeBase64ToUtf8 = (base64: string) => {
const decoder = new TextDecoder('utf-8');
return decoder.decode(bytes);
};
+
+export const waitFor = async (ms: number): Promise<void> => {
+ return new Promise((resolve) => setTimeout(resolve, ms));
+};