@contember/schema-migrations 1.3.0-alpha.8 → 1.3.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contember/schema-migrations",
-  "version": "1.3.0-alpha.8",
+  "version": "1.3.0-beta.2",
   "license": "Apache-2.0",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.ts",
@@ -9,20 +9,20 @@
     "default": "./dist/src/index.js"
   },
   "scripts": {
-    "test": "vitest"
+    "test": "vitest --dir ./tests/cases"
   },
   "dependencies": {
-    "@contember/database-migrations": "^1.3.0-alpha.8",
-    "@contember/engine-common": "^1.3.0-alpha.8",
-    "@contember/schema": "^1.3.0-alpha.8",
-    "@contember/schema-utils": "^1.3.0-alpha.8",
+    "@contember/database-migrations": "1.3.0-beta.2",
+    "@contember/engine-common": "1.3.0-beta.2",
+    "@contember/schema": "1.3.0-beta.2",
+    "@contember/schema-utils": "1.3.0-beta.2",
     "fast-deep-equal": "^3.1.3",
     "rfc6902": "^5.0.1"
   },
   "devDependencies": {
-    "@contember/schema-definition": "^1.3.0-alpha.8"
+    "@contember/schema-definition": "1.3.0-beta.2"
   },
   "peerDependencies": {
     "pg": "^8.9.0"
   }
-}
+}

package/src/SchemaDiffer.ts

@@ -1,12 +1,5 @@
 import { Schema } from '@contember/schema'
-import {
-	deepCompare,
-	isInverseRelation,
-	isOwningRelation,
-	isRelation,
-	SchemaValidator,
-	ValidationError,
-} from '@contember/schema-utils'
+import { compareArraysIgnoreOrder, deepCompare, isInverseRelation, isOwningRelation, isRelation, SchemaValidator, ValidationError } from '@contember/schema-utils'
 import { SchemaMigrator } from './SchemaMigrator'
 import { Migration } from './Migration'
 import { ImplementationException } from './exceptions'
@@ -34,11 +27,11 @@ import {
 	UpdateAclSchemaDiffer,
 	UpdateColumnDefinitionDiffer,
 	UpdateColumnNameDiffer,
+	UpdateEntityOrderByDiffer,
 	UpdateEntityTableNameDiffer,
 	UpdateEnumDiffer,
 	UpdateRelationOnDeleteDiffer,
 	UpdateRelationOrderByDiffer,
-	UpdateEntityOrderByDiffer,
 	UpdateValidationSchemaDiffer,
 	VERSION_LATEST,
 } from './modifications'
@@ -124,9 +117,15 @@ export class SchemaDiffer {
 			diffs.push(...differDiffs)
 		}
 
-
 		if (!skipRecreateValidation) {
-			const errors = deepCompare(updatedSchema, appliedDiffsSchema, [])
+			const errors = deepCompare(updatedSchema, appliedDiffsSchema, [], path => {
+				if (path[0] === 'model' && path[1] === 'entities' && (path[3] === 'unique' || path[3] === 'index')) {
+					return (a, b) => {
+						return compareArraysIgnoreOrder(a, b, path)
+					}
+				}
+				return null
+			})
 			if (errors.length === 0) {
 				return diffs
 			}

package/src/modifications/columns/CreateColumnModification.ts

@@ -1,12 +1,11 @@
-import { escapeValue, MigrationBuilder } from '@contember/database-migrations'
-import { Model, Schema } from '@contember/schema'
+import { MigrationBuilder } from '@contember/database-migrations'
+import { JSONValue, Model, Schema } from '@contember/schema'
 import { addField, SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'
 import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
-import { wrapIdentifier } from '../../utils/dbHelpers'
-import { getColumnName, isColumn } from '@contember/schema-utils'
-import { ImplementationException } from '../../exceptions'
+import { isColumn } from '@contember/schema-utils'
 import { createFields } from '../utils/diffUtils'
 import { getColumnSqlType } from '../utils/columnUtils'
+import { fillSeed } from './columnUtils'
 
 export class CreateColumnModificationHandler implements ModificationHandler<CreateColumnModificationData> {
 	constructor(private readonly data: CreateColumnModificationData, private readonly schema: Schema) {}
@@ -18,34 +17,27 @@ export class CreateColumnModificationHandler implements ModificationHandler<Crea
 		}
 		const column = this.data.field
 		const hasSeed = this.data.fillValue !== undefined || this.data.copyValue !== undefined
+		const columnType = getColumnSqlType(column)
 		builder.addColumn(entity.tableName, {
 			[column.columnName]: {
-				type: getColumnSqlType(column),
+				type: columnType,
 				notNull: !column.nullable && !hasSeed,
 				sequenceGenerated: column.sequence,
 			},
 		})
-		if (hasSeed) {
-			if (this.data.fillValue !== undefined) {
-				builder.sql(`UPDATE ${wrapIdentifier(entity.tableName)}
-	  SET ${wrapIdentifier(column.columnName)} = ${escapeValue(this.data.fillValue)}`)
-			} else if (this.data.copyValue !== undefined) {
-				const copyFrom = getColumnName(this.schema.model, entity, this.data.copyValue)
-				builder.sql(`UPDATE ${wrapIdentifier(entity.tableName)}
-	  SET ${wrapIdentifier(column.columnName)} = ${wrapIdentifier(copyFrom)}::${getColumnSqlType(column)}`)
-			} else {
-				throw new ImplementationException()
-			}
-
-			// event applier defers constraint check, we need to fire them before ALTER
-			builder.sql(`SET CONSTRAINTS ALL IMMEDIATE`)
-			builder.sql(`SET CONSTRAINTS ALL DEFERRED`)
 
-			if (!column.nullable) {
-				builder.alterColumn(entity.tableName, column.columnName, {
-					notNull: true,
-				})
-			}
+		if (hasSeed) {
+			fillSeed({
+				builder,
+				type: 'creating',
+				model: this.schema.model,
+				entity,
+				columnName: column.columnName,
+				nullable: column.nullable,
+				columnType,
+				copyValue: this.data.copyValue,
+				fillValue: this.data.fillValue,
+			})
 		}
 	}
 
@@ -67,7 +59,7 @@ export class CreateColumnModificationHandler implements ModificationHandler<Crea
 export interface CreateColumnModificationData {
 	entityName: string
 	field: Model.AnyColumn
-	fillValue?: any
+	fillValue?: JSONValue
 	copyValue?: string
 }
 

package/src/modifications/columns/UpdateColumnDefinitionModification.ts

@@ -1,11 +1,12 @@
 import { escapeValue, MigrationBuilder } from '@contember/database-migrations'
-import { Model, Schema } from '@contember/schema'
+import { JSONValue, Model, Schema } from '@contember/schema'
 import { SchemaUpdater, updateEntity, updateField, updateModel } from '../utils/schemaUpdateUtils'
 import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
 import deepEqual from 'fast-deep-equal'
 import { updateColumns } from '../utils/diffUtils'
 import { wrapIdentifier } from '../../utils/dbHelpers'
 import { getColumnSqlType } from '../utils/columnUtils'
+import { fillSeed } from './columnUtils'
 
 export class UpdateColumnDefinitionModificationHandler implements ModificationHandler<UpdateColumnDefinitionModificationData>  {
 	constructor(private readonly data: UpdateColumnDefinitionModificationData, private readonly schema: Schema) {}
@@ -24,9 +25,11 @@ export class UpdateColumnDefinitionModificationHandler implements ModificationHa
 
 		const usingCast = `${wrapIdentifier(oldColumn.columnName)}::${columnType}`
 
+		const hasSeed = this.data.fillValue !== undefined || this.data.copyValue !== undefined
+
 		builder.alterColumn(entity.tableName, oldColumn.columnName, {
 			type: hasNewSequence || hasNewType ? columnType : undefined,
-			notNull: oldColumn.nullable !== newColumn.nullable ? !newColumn.nullable : undefined,
+			notNull: oldColumn.nullable !== newColumn.nullable && (!hasSeed || newColumn.nullable) ? !newColumn.nullable : undefined,
 			using: hasNewSequence
 				? `COALESCE(${usingCast}, nextval(PG_GET_SERIAL_SEQUENCE(${escapeValue(entity.tableName)}, ${escapeValue(oldColumn.columnName)})))`
 				: hasNewType
@@ -35,6 +38,20 @@ export class UpdateColumnDefinitionModificationHandler implements ModificationHa
 			sequenceGenerated: oldColumn.sequence && !newColumn.sequence ? false : (!oldColumn.sequence ? newColumn.sequence : undefined),
 		})
 
+		if (hasSeed) {
+			fillSeed({
+				builder,
+				type: 'updating',
+				model: this.schema.model,
+				entity,
+				columnName: oldColumn.columnName,
+				nullable: newColumn.nullable,
+				columnType,
+				copyValue: this.data.copyValue,
+				fillValue: this.data.fillValue,
+			})
+		}
+
 		const seqAlter = []
 		if (oldColumn.sequence && newColumn.sequence) {
 			if (oldColumn.sequence.precedence !== newColumn.sequence.precedence) {
@@ -95,6 +112,8 @@ export interface UpdateColumnDefinitionModificationData {
 	entityName: string
 	fieldName: string
 	definition: ColumnDefinitionAlter
+	fillValue?: JSONValue
+	copyValue?: string
 }
 
 export const updateColumnDefinitionModification = createModificationType({

package/src/modifications/columns/columnUtils.ts

@@ -0,0 +1,35 @@
+import { wrapIdentifier } from '../../utils/dbHelpers'
+import { ImplementationException } from '../../exceptions'
+import { JSONValue, Model } from '@contember/schema'
+import { escapeValue, MigrationBuilder } from '@contember/database-migrations'
+import { getColumnName } from '@contember/schema-utils'
+
+export const fillSeed = ({ builder, fillValue, copyValue, entity, columnName, nullable, model, columnType, type }: {
+	model: Model.Schema
+	entity: Model.Entity
+	columnName: string
+	columnType: string
+	nullable: boolean
+	builder: MigrationBuilder
+	fillValue?: JSONValue
+	copyValue?: string
+	type: 'creating' | 'updating'
+}) => {
+	const where = type === 'updating' ? ` WHERE ${wrapIdentifier(columnName)} IS NULL` : ''
+	if (fillValue !== undefined) {
+		builder.sql(`UPDATE ${wrapIdentifier(entity.tableName)}
+                     SET ${wrapIdentifier(columnName)} = ${escapeValue(fillValue)}${where}`)
+	} else if (copyValue !== undefined) {
+		const copyFrom = getColumnName(model, entity, copyValue)
+		builder.sql(`UPDATE ${wrapIdentifier(entity.tableName)}
+                     SET ${wrapIdentifier(columnName)} = ${wrapIdentifier(copyFrom)}::${columnType}${where}`)
+	} else {
+		throw new ImplementationException()
+	}
+
+	if (!nullable) {
+		builder.alterColumn(entity.tableName, columnName, {
+			notNull: true,
+		})
+	}
+}

package/tests/cases/integration/createColumn.test.ts

@@ -32,7 +32,6 @@ testMigrations('create a column with default value', {
 	],
 	sql: SQL`ALTER TABLE "author" ADD "name" text;
 UPDATE "author" SET "name" = $pga$unnamed author$pga$;
-SET CONSTRAINTS ALL IMMEDIATE; SET CONSTRAINTS ALL DEFERRED;
 ALTER TABLE "author" ALTER "name" SET NOT NULL;`,
 })
 
@@ -65,6 +64,5 @@ testMigrations('create a column with copy value', {
 	noDiff: true,
 	sql: SQL`ALTER TABLE "author" ADD "name" text;
 UPDATE "author" SET "name" = "email"::text;
-SET CONSTRAINTS ALL IMMEDIATE; SET CONSTRAINTS ALL DEFERRED;
 ALTER TABLE "author" ALTER "name" SET NOT NULL;`,
 })

package/tests/cases/integration/updateColumnDefinition.test.ts

@@ -168,3 +168,35 @@ ALTER TABLE "author"
 CREATE VIEW "author_meta_x" AS SELECT * FROM author;
 CREATE VIEW "author_meta_y" AS SELECT * FROM author_meta_x;`,
 })
+
+
+namespace NotNullOrig {
+	export class Author {
+		name = def.stringColumn()
+	}
+}
+namespace NotNullUpdated {
+	export class Author {
+		name = def.stringColumn().notNull()
+	}
+}
+testMigrations('set not null and fill', {
+	originalSchema: createSchema(NotNullOrig).model,
+	updatedSchema: createSchema(NotNullUpdated).model,
+	noDiff: true,
+	diff: [
+		updateColumnDefinitionModification.createModification({
+			entityName: 'Author',
+			fieldName: 'name',
+			definition: {
+				type: Model.ColumnType.String,
+				columnType: 'text',
+				nullable: false,
+			},
+			fillValue: 'unnamed',
+		}),
+	],
+	sql: SQL`
+UPDATE "author" SET "name" = $pga$unnamed$pga$ WHERE "name" IS NULL; 
+ALTER TABLE "author" ALTER "name" SET NOT NULL;`,
+})