Database diagrams editor that allows you to visualize and design your DB with a single query.
TypeScript databasedbdb-migrationeditorerdmariadbmssqlmysqlpostgresqlreactreact-flowschema-migrationssqlsqlitetypescriptvisualizationxyflow
fix: normalize index type comparison using database defaults (#1029)
Guy Ben-Aharond210319c3b55
diff --git a/src/lib/domain/db-index.ts b/src/lib/domain/db-index.tsindex cebcc295..84045a0f 100644--- a/src/lib/domain/db-index.ts+++ b/src/lib/domain/db-index.ts@@ -45,6 +45,12 @@ export const databaseIndexTypes: { [key in DatabaseType]?: IndexType[] } = {[DatabaseType.POSTGRESQL]: ['btree', 'hash'],};+export const defaultIndexTypeForDatabase: {+ [key in DatabaseType]?: IndexType;+} = {+ [DatabaseType.POSTGRESQL]: 'btree',+};+export const getTablePrimaryKeyIndex = ({table,}: {diff --git a/src/lib/domain/diff/diff-check/__tests__/diff-check.test.ts b/src/lib/domain/diff/diff-check/__tests__/diff-check.test.tsindex b04ae0b1..3eb5bfed 100644--- a/src/lib/domain/diff/diff-check/__tests__/diff-check.test.ts+++ b/src/lib/domain/diff/diff-check/__tests__/diff-check.test.ts@@ -510,6 +510,90 @@ describe('generateDiff', () => {expect((diff as IndexDiffChanged)?.newValue).toBe('hash');});+ it('should not detect index type change when both are undefined/null (use database default)', () => {+ const oldDiagram = createMockDiagram({+ databaseType: DatabaseType.POSTGRESQL,+ tables: [+ createMockTable({+ indexes: [createMockIndex({ type: undefined })],+ }),+ ],+ });+ const newDiagram = createMockDiagram({+ databaseType: DatabaseType.POSTGRESQL,+ tables: [+ createMockTable({+ indexes: [createMockIndex({ type: null })],+ }),+ ],+ });++ const result = generateDiff({+ diagram: oldDiagram,+ newDiagram,+ });++ expect(result.diffMap.has('index-type-index-1')).toBe(false);+ });++ it('should not detect index type change when one is undefined and the other is the database default', () => {+ const oldDiagram = createMockDiagram({+ databaseType: DatabaseType.POSTGRESQL,+ tables: [+ createMockTable({+ indexes: [createMockIndex({ type: undefined })],+ }),+ ],+ });+ const newDiagram = createMockDiagram({+ databaseType: DatabaseType.POSTGRESQL,+ tables: [+ createMockTable({+ indexes: [createMockIndex({ type: 'btree' })],+ }),+ ],+ });++ const result = generateDiff({+ diagram: oldDiagram,+ newDiagram,+ });++ // btree is the default for PostgreSQL, so undefined vs 'btree' should be equal+ expect(result.diffMap.has('index-type-index-1')).toBe(false);+ });++ it('should detect index type change when one is undefined and the other differs from database default', () => {+ const oldDiagram = createMockDiagram({+ databaseType: DatabaseType.POSTGRESQL,+ tables: [+ createMockTable({+ indexes: [createMockIndex({ type: undefined })],+ }),+ ],+ });+ const newDiagram = createMockDiagram({+ databaseType: DatabaseType.POSTGRESQL,+ tables: [+ createMockTable({+ indexes: [createMockIndex({ type: 'hash' })],+ }),+ ],+ });++ const result = generateDiff({+ diagram: oldDiagram,+ newDiagram,+ });++ // undefined defaults to 'btree' for PostgreSQL, so undefined vs 'hash' should be different+ expect(result.diffMap.size).toBe(1);+ const diff = result.diffMap.get('index-type-index-1');+ expect(diff).toBeDefined();+ expect(diff?.type).toBe('changed');+ expect((diff as IndexDiffChanged)?.attribute).toBe('type');+ });+it('should detect multiple index attribute changes', () => {const oldDiagram = createMockDiagram({tables: [diff --git a/src/lib/domain/diff/diff-check/diff-check.ts b/src/lib/domain/diff/diff-check/diff-check.tsindex f5ea48ae..6b519b25 100644--- a/src/lib/domain/diff/diff-check/diff-check.ts+++ b/src/lib/domain/diff/diff-check/diff-check.ts@@ -1,6 +1,9 @@import type { Diagram } from '@/lib/domain/diagram';import type { DBField } from '@/lib/domain/db-field';-import type { DBIndex } from '@/lib/domain/db-index';+import {+ defaultIndexTypeForDatabase,+ type DBIndex,+} from '@/lib/domain/db-index';import type { DBTable } from '@/lib/domain/db-table';import type { DBRelationship } from '@/lib/domain/db-relationship';import type { Area } from '@/lib/domain/area';@@ -16,6 +19,7 @@ import type { NoteDiff, NoteDiffAttribute } from '../note-diff';import type { IndexDiff, IndexDiffAttribute } from '../index-diff';import type { RelationshipDiff } from '../relationship-diff';import { areBooleansEqual } from '@/lib/utils';+import type { DatabaseType } from '../../database-type';export function getDiffMapKey({diffObject,@@ -225,6 +229,7 @@ export function generateDiff({tableMatcher,fieldMatcher,indexMatcher,+ databaseType: diagram.databaseType,});// Compare relationships@@ -533,6 +538,7 @@ function compareTableContents({tableMatcher,fieldMatcher,indexMatcher,+ databaseType,}: {diagram: Diagram;newDiagram: Diagram;@@ -547,6 +553,7 @@ function compareTableContents({tableMatcher: (table: DBTable, tables: DBTable[]) => DBTable | undefined;fieldMatcher: (field: DBField, fields: DBField[]) => DBField | undefined;indexMatcher: (index: DBIndex, indexes: DBIndex[]) => DBIndex | undefined;+ databaseType: DatabaseType;}) {const oldTables = diagram.tables || [];const newTables = newDiagram.tables || [];@@ -587,6 +594,7 @@ function compareTableContents({changedIndexesAttributes,changeTypes: options?.changeTypes?.indexes,indexMatcher,+ databaseType,});}}@@ -869,6 +877,7 @@ function compareIndexes({changedIndexesAttributes,changeTypes,indexMatcher,+ databaseType,}: {tableId: string;oldIndexes: DBIndex[];@@ -881,6 +890,7 @@ function compareIndexes({changedIndexesAttributes?: IndexDiffAttribute[];changeTypes?: IndexDiff['type'][];indexMatcher: (index: DBIndex, indexes: DBIndex[]) => DBIndex | undefined;+ databaseType: DatabaseType;}) {// If changeTypes is empty array, don't check any changesif (changeTypes && changeTypes.length === 0) {@@ -960,6 +970,7 @@ function compareIndexes({attributes,changedTablesAttributes,changedIndexesAttributes,+ databaseType,});}}@@ -992,6 +1003,7 @@ function compareIndexProperties({attributes,changedTablesAttributes,changedIndexesAttributes,+ databaseType,}: {tableId: string;oldIndex: DBIndex;@@ -1002,6 +1014,7 @@ function compareIndexProperties({attributes?: IndexDiffAttribute[];changedTablesAttributes?: TableDiffAttribute[];changedIndexesAttributes?: IndexDiffAttribute[];+ databaseType: DatabaseType;}) {// If attributes are specified, only check those attributesconst attributesToCheck: IndexDiffAttribute[] = attributes ?? [@@ -1031,8 +1044,16 @@ function compareIndexProperties({changedAttributes.push('fieldIds');}- if (attributesToCheck.includes('type') && oldIndex.type !== newIndex.type) {- changedAttributes.push('type');+ if (attributesToCheck.includes('type')) {+ const oldType =+ oldIndex.type ?? defaultIndexTypeForDatabase[databaseType];+ const newType =+ newIndex.type ?? defaultIndexTypeForDatabase[databaseType];++ // if both null/undefined, consider equal+ if (oldType !== newType) {+ changedAttributes.push('type');+ }}if (changedAttributes.length > 0) {