Database diagrams editor that allows you to visualize and design your DB with a single query.
TypeScript databasedbdb-migrationeditorerdmariadbmssqlmysqlpostgresqlreactreact-flowschema-migrationssqlsqlitetypescriptvisualizationxyflow
fix: handle escape sequences and double-quotes in metadata JSON parsing (#1009)
Jonathan Fishnerf9c9dcf56b2d
diff --git a/src/lib/data/import-metadata/__tests__/fix-metadata-json.test.ts b/src/lib/data/import-metadata/__tests__/fix-metadata-json.test.tsnew file mode 100644index 00000000..0986ed88--- /dev/null+++ b/src/lib/data/import-metadata/__tests__/fix-metadata-json.test.ts@@ -0,0 +1,325 @@+import { describe, it, expect } from 'vitest';+import { fixMetadataJson, isStringMetadataJson } from '../utils';++describe('fixMetadataJson', () => {+ describe('escaped quotes', () => {+ it('should fix escaped double quotes (\\") to regular quotes', () => {+ const input = '{\\"name\\": \\"test\\"}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });++ it('should handle deeply nested escaped quotes', () => {+ const input =+ '{\\"fk_info\\": [], \\"pk_info\\": [{\\"schema\\": \\"public\\", \\"table\\": \\"users\\"}]}';+ const result = fixMetadataJson(input);+ expect(result).toBe(+ '{"fk_info": [], "pk_info": [{"schema": "public", "table": "users"}]}'+ );+ });+ });++ describe('literal escape sequences', () => {+ it('should remove literal \\n (backslash + n) from stringified JSON', () => {+ const input = '{\\n "name": "test"\\n}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{ "name": "test"}');+ });++ it('should remove literal \\t (backslash + t) from stringified JSON', () => {+ const input = '{\\t"name": "test"}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });++ it('should remove literal \\r (backslash + r) from stringified JSON', () => {+ const input = '{\\r"name": "test"}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });++ it('should handle combined literal escape sequences', () => {+ const input = '{\\r\\n\\t"name": "test"\\r\\n}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });++ it('should handle fully stringified JSON with \\n and \\" combined', () => {+ const input =+ '{\\n \\"fk_info\\": [],\\n \\"pk_info\\": []\\n}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{ "fk_info": [], "pk_info": []}');+ });+ });++ describe('double-double quotes', () => {+ it('should convert :""value"" to :"value" for simple values', () => {+ const input = '{"pk_def": ""PRIMARY KEY (id)""}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"pk_def": "PRIMARY KEY (id)"}');+ });++ it('should convert : ""value"" (with space) to : "value"', () => {+ const input = '{"pk_def": ""PRIMARY KEY (id)""}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"pk_def": "PRIMARY KEY (id)"}');+ });++ it('should handle double-double quotes with complex values containing commas', () => {+ const input =+ '{"pk_def": ""PRIMARY KEY (audit_type_cd, channel_type_cd)""}';+ const result = fixMetadataJson(input);+ expect(result).toBe(+ '{"pk_def": "PRIMARY KEY (audit_type_cd, channel_type_cd)"}'+ );+ });++ it('should handle multiple double-double quoted values in array', () => {+ const input = `{+ "pk_info": [+ {"pk_def": ""PRIMARY KEY (id)""},+ {"pk_def": ""PRIMARY KEY (a, b)""}+ ]+}`;+ const result = fixMetadataJson(input);+ const parsed = JSON.parse(result);+ expect(parsed.pk_info[0].pk_def).toBe('PRIMARY KEY (id)');+ expect(parsed.pk_info[1].pk_def).toBe('PRIMARY KEY (a, b)');+ });+ });++ describe('extra content removal', () => {+ it('should remove content before the first {', () => {+ const input = 'some prefix text {"name": "test"}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });++ it('should remove content after the last }', () => {+ const input = '{"name": "test"} some suffix text';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });++ it('should remove both prefix and suffix content', () => {+ const input = 'Result: {"name": "test"} -- end';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });+ });++ describe('string-wrapped JSON', () => {+ it('should remove surrounding double quotes', () => {+ const input = '"{\\"name\\": \\"test\\"}"';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });++ it('should remove surrounding single quotes', () => {+ const input = '\'{"name": "test"}\'';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });+ });++ describe('type conversions', () => {+ it('should convert "precision": "null" to "precision": null', () => {+ const input = '{"precision": "null", "scale": 2}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"precision": null, "scale": 2}');+ });++ it('should convert "nullable": "false" to "nullable": false', () => {+ const input = '{"nullable": "false"}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"nullable": false}');+ });++ it('should convert "nullable": "true" to "nullable": true', () => {+ const input = '{"nullable": "true"}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"nullable": true}');+ });+ });++ describe('quadruple and triple quotes', () => {+ it('should convert """" to ""', () => {+ const input = '{"comment": """"}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"comment": ""}');+ });++ it('should convert """value""" to "value"', () => {+ const input = '{"name": """test"""}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });+ });++ describe('real newline removal', () => {+ it('should remove actual newline characters', () => {+ const input = '{\n"name": "test"\n}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });+ });++ describe('escaped backslashes', () => {+ it('should convert \\\\\\\\ to \\\\ (double-escaped to single-escaped)', () => {+ // Input: {"path": "C:\\\\Users"} (double-escaped backslash in JSON string literal)+ // Output: {"path": "C:\\Users"} (single-escaped backslash, valid JSON for path C:\Users)+ const input = '{"path": "C:\\\\\\\\Users"}';+ const result = fixMetadataJson(input);+ // In JSON, \\ represents a single backslash, so this is correct+ expect(result).toBe('{"path": "C:\\\\Users"}');+ // Verify it parses correctly+ const parsed = JSON.parse(result);+ expect(parsed.path).toBe('C:\\Users');+ });+ });++ describe('complex real-world scenarios', () => {+ it('should handle MySQL smart query output with escaped quotes and newlines', () => {+ const input = `{\\n \\"fk_info\\": [],\\n \\"pk_info\\": [\\n {\\n \\"schema\\": \\"mydb\\",\\n \\"table\\": \\"users\\",\\n \\"column\\": \\"id\\",\\n \\"pk_def\\": \\"PRIMARY KEY (id)\\"\\n }\\n ],\\n \\"columns\\": [],\\n \\"indexes\\": [],\\n \\"tables\\": [],\\n \\"views\\": [],\\n \\"database_name\\": \\"mydb\\",\\n \\"version\\": \\"8.0.39\\"\\n}`;++ const result = fixMetadataJson(input);+ const parsed = JSON.parse(result);++ expect(parsed.fk_info).toEqual([]);+ expect(parsed.pk_info).toHaveLength(1);+ expect(parsed.pk_info[0].schema).toBe('mydb');+ expect(parsed.pk_info[0].table).toBe('users');+ expect(parsed.database_name).toBe('mydb');+ expect(parsed.version).toBe('8.0.39');+ });++ it('should handle MySQL output with double-double quoted pk_def values', () => {+ const input = `{+ "fk_info": [],+ "pk_info": [+ {+ "schema": "mydb",+ "table": "audit_status",+ "column": "audit_type_cd",+ "pk_def": ""PRIMARY KEY (audit_type_cd, channel_type_cd)""+ }+ ],+ "columns": [],+ "indexes": [],+ "tables": [],+ "views": [],+ "database_name": "mydb",+ "version": "8.0.39"+}`;++ const result = fixMetadataJson(input);+ const parsed = JSON.parse(result);++ expect(parsed.pk_info[0].pk_def).toBe(+ 'PRIMARY KEY (audit_type_cd, channel_type_cd)'+ );+ });++ it('should handle combination of escaped quotes, literal newlines, and double-double quotes', () => {+ const input = `{\\n \\"pk_info\\": [\\n {\\n \\"pk_def\\": \\"\\"PRIMARY KEY (a, b)\\"\\",\\n \\"nullable\\": \\"false\\"\\n }\\n ]\\n}`;++ const result = fixMetadataJson(input);+ const parsed = JSON.parse(result);++ expect(parsed.pk_info[0].pk_def).toBe('PRIMARY KEY (a, b)');+ expect(parsed.pk_info[0].nullable).toBe(false);+ });+ });++ describe('edge cases', () => {+ it('should handle empty objects', () => {+ const input = '{}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{}');+ });++ it('should handle empty arrays in objects', () => {+ const input = '{"items": []}';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"items": []}');+ });++ it('should handle whitespace-only prefix/suffix', () => {+ const input = ' {"name": "test"} ';+ const result = fixMetadataJson(input);+ expect(result).toBe('{"name": "test"}');+ });++ it('should handle already valid JSON', () => {+ const validJson =+ '{"fk_info": [], "pk_info": [], "columns": [], "indexes": [], "tables": [], "views": [], "database_name": "test", "version": "1.0"}';+ const result = fixMetadataJson(validJson);+ expect(JSON.parse(result)).toEqual(JSON.parse(validJson));+ });+ });+});++describe('isStringMetadataJson', () => {+ it('should return true for valid database metadata JSON', () => {+ const validMetadata = JSON.stringify({+ fk_info: [],+ pk_info: [],+ columns: [],+ indexes: [],+ tables: [],+ views: [],+ database_name: 'test_db',+ version: '1.0',+ });++ expect(isStringMetadataJson(validMetadata)).toBe(true);+ });++ it('should return false for invalid JSON string', () => {+ expect(isStringMetadataJson('not json')).toBe(false);+ });++ it('should return false for valid JSON but missing required fields', () => {+ const incompleteMetadata = JSON.stringify({+ fk_info: [],+ pk_info: [],+ // missing other required fields+ });++ expect(isStringMetadataJson(incompleteMetadata)).toBe(false);+ });++ it('should return false for empty string', () => {+ expect(isStringMetadataJson('')).toBe(false);+ });++ it('should return false for null-like values', () => {+ expect(isStringMetadataJson('null')).toBe(false);+ expect(isStringMetadataJson('undefined')).toBe(false);+ });+});++describe('fixMetadataJson + isStringMetadataJson integration', () => {+ it('should fix and validate MySQL smart query output', () => {+ const brokenInput = `{\\n \\"fk_info\\": [],\\n \\"pk_info\\": [],\\n \\"columns\\": [],\\n \\"indexes\\": [],\\n \\"tables\\": [],\\n \\"views\\": [],\\n \\"database_name\\": \\"testdb\\",\\n \\"version\\": \\"8.0.39\\"\\n}`;++ const fixed = fixMetadataJson(brokenInput);+ expect(isStringMetadataJson(fixed)).toBe(true);+ });++ it('should fix and validate output with double-double quoted values', () => {+ const brokenInput = `{+ "fk_info": [],+ "pk_info": [{"schema": "db", "table": "t", "column": "c", "pk_def": ""PRIMARY KEY (a, b)""}],+ "columns": [],+ "indexes": [],+ "tables": [],+ "views": [],+ "database_name": "testdb",+ "version": "8.0"+}`;++ const fixed = fixMetadataJson(brokenInput);+ expect(isStringMetadataJson(fixed)).toBe(true);+ });+});diff --git a/src/lib/data/import-metadata/utils.ts b/src/lib/data/import-metadata/utils.tsindex fe690176..daac9b1a 100644--- a/src/lib/data/import-metadata/utils.ts+++ b/src/lib/data/import-metadata/utils.ts@@ -18,11 +18,15 @@ export const fixMetadataJson = (metadataJson: string): string => {metadataJson.trim()// First unescape the JSON string+ .replace(/\\n/g, '') // Remove literal \n (backslash + n) from stringified JSON+ .replace(/\\t/g, '') // Remove literal \t (backslash + t) from stringified JSON+ .replace(/\\r/g, '') // Remove literal \r (backslash + r) from stringified JSON.replace(/\\"/g, '"').replace(/\\\\/g, '\\').replace(/^[^{]*/, '') // Remove everything before the first '{'.replace(/}[^}]*$/, '}') // Remove everything after the last '}'- .replace(/:""([^"]+)""/g, ':"$1"') // Convert :""value"" to :"value"+ .replace(/: ""([^"]*)""/g, ': "$1"') // Convert : ""value"" to : "value" (handles values with any content)+ .replace(/:""([^"]*)""/g, ':"$1"') // Convert :""value"" to :"value" (no space variant).replace(/""(\w+)""/g, '"$1"') // Convert ""key"" to "key".replace(/^\s+|\s+$/g, '').replace(/^"|"$/g, '')