@contember/schema-migrations 1.2.0-alpha.1 → 1.2.0-alpha.12

package/src/SchemaDiffer.ts

@@ -10,40 +10,39 @@ import {
 import { SchemaMigrator } from './SchemaMigrator'
 import { Migration } from './Migration'
 import { ImplementationException } from './exceptions'
-import { VERSION_LATEST } from './modifications/ModificationVersions'
-import { CreateUniqueConstraintModification, RemoveUniqueConstraintModification } from './modifications/constraints'
-import { RemoveFieldModification } from './modifications/fields'
 import {
-	CreateEntityModification,
-	CreateViewModification,
-	RemoveEntityModification,
-	ToggleEventLogModification,
-	UpdateEntityTableNameModification,
-} from './modifications/entities'
-import { CreateEnumModification, RemoveEnumModification, UpdateEnumModification } from './modifications/enums'
-import {
-	CreateColumnModification,
-	UpdateColumnDefinitionModification,
-	UpdateColumnNameModification,
-} from './modifications/columns'
-import {
-	ConvertOneHasManyToManyHasManyRelationModification,
-	ConvertOneToManyRelationModification,
-	CreateRelationInverseSideModification,
-	CreateRelationModification,
-	DisableOrphanRemovalModification,
-	EnableOrphanRemovalModification,
-	MakeRelationNotNullModification,
-	MakeRelationNullableModification,
-	ToggleJunctionEventLogModification,
-	UpdateRelationOnDeleteModification,
-	UpdateRelationOrderByModification,
-} from './modifications/relations'
-import { PatchAclSchemaModification, UpdateAclSchemaModification } from './modifications/acl'
-import { PatchValidationSchemaModification, UpdateValidationSchemaModification } from './modifications/validation'
-import { CreateDiff, Differ } from './modifications/ModificationHandler'
-import { isDefined } from './utils/isDefined'
+	ConvertOneHasManyToManyHasManyRelationDiffer,
+	ConvertOneToManyRelationDiffer,
+	CreateColumnDiffer,
+	CreateEntityDiffer,
+	CreateEnumDiffer,
+	CreateRelationDiffer,
+	CreateRelationInverseSideDiffer,
+	CreateUniqueConstraintDiffer,
+	CreateViewDiffer,
+	Differ,
+	DisableOrphanRemovalDiffer,
+	EnableOrphanRemovalDiffer,
+	MakeRelationNotNullDiffer,
+	MakeRelationNullableDiffer,
+	RemoveEntityDiffer,
+	RemoveEnumDiffer,
+	RemoveFieldDiffer,
+	RemoveUniqueConstraintDiffer,
+	ToggleEventLogDiffer,
+	ToggleJunctionEventLogDiffer,
+	UpdateAclSchemaDiffer,
+	UpdateColumnDefinitionDiffer,
+	UpdateColumnNameDiffer,
+	UpdateEntityTableNameDiffer,
+	UpdateEnumDiffer,
+	UpdateRelationOnDeleteDiffer,
+	UpdateRelationOrderByDiffer,
+	UpdateValidationSchemaDiffer,
+	VERSION_LATEST,
+} from './modifications'
 import { ChangeViewNonViewDiffer, RemoveChangedFieldDiffer, RemoveChangedViewDiffer } from './modifications/differs'
+import { CreateIndexDiffer, RemoveIndexDiffer } from './modifications/indexes'
 
 export class SchemaDiffer {
 	constructor(private readonly schemaMigrator: SchemaMigrator) {}
@@ -58,56 +57,46 @@ export class SchemaDiffer {
 			throw new InvalidSchemaException('updated schema is not valid', updatedErrors)
 		}
 
-		const differs: (CreateDiff | Differ)[] = [
-			ConvertOneToManyRelationModification.createDiff,
-			ConvertOneHasManyToManyHasManyRelationModification.createDiff,
-
-			RemoveUniqueConstraintModification.createDiff,
-			new ChangeViewNonViewDiffer().createDiff,
-			new RemoveChangedViewDiffer().createDiff,
-			RemoveEntityModification.createDiff,
-			RemoveFieldModification.createDiff,
-			CreateEnumModification.createDiff,
-
-			UpdateEntityTableNameModification.createDiff,
-			ToggleEventLogModification.createDiff,
-			ToggleJunctionEventLogModification.createDiff,
-			UpdateColumnDefinitionModification.createDiff,
-			UpdateColumnNameModification.createDiff,
-			UpdateRelationOnDeleteModification.createDiff,
-			MakeRelationNotNullModification.createDiff,
-			MakeRelationNullableModification.createDiff,
-			EnableOrphanRemovalModification.createDiff,
-			DisableOrphanRemovalModification.createDiff,
-			UpdateRelationOrderByModification.createDiff,
-			UpdateEnumModification.createDiff,
-
+		const differs: Differ[] = [
+			new ConvertOneToManyRelationDiffer(),
+			new ConvertOneHasManyToManyHasManyRelationDiffer(),
+			new RemoveUniqueConstraintDiffer(),
+			new RemoveIndexDiffer(),
+			new ChangeViewNonViewDiffer(),
+			new RemoveChangedViewDiffer(),
+			new RemoveEntityDiffer(),
+			new RemoveFieldDiffer(),
+			new CreateEnumDiffer(),
+			new UpdateEntityTableNameDiffer(),
+			new ToggleEventLogDiffer(),
+			new ToggleJunctionEventLogDiffer(),
+			new UpdateColumnDefinitionDiffer(),
+			new UpdateColumnNameDiffer(),
+			new UpdateRelationOnDeleteDiffer(),
+			new MakeRelationNotNullDiffer(),
+			new MakeRelationNullableDiffer(),
+			new EnableOrphanRemovalDiffer(),
+			new DisableOrphanRemovalDiffer(),
+			new UpdateRelationOrderByDiffer(),
+			new UpdateEnumDiffer(),
 			new RemoveChangedFieldDiffer(it => !isRelation(it) || isOwningRelation(it)),
 			new RemoveChangedFieldDiffer(it => isRelation(it) && isInverseRelation(it)),
-			CreateEntityModification.createDiff,
-			CreateColumnModification.createDiff,
-			CreateViewModification.createDiff,
-
-			CreateRelationModification.createDiff,
-			CreateRelationInverseSideModification.createDiff,
-
-			CreateUniqueConstraintModification.createDiff,
-
-			RemoveEnumModification.createDiff,
-
-			UpdateAclSchemaModification.createDiff,
-			PatchAclSchemaModification.createDiff,
-
-			UpdateValidationSchemaModification.createDiff,
-			PatchValidationSchemaModification.createDiff,
-		].filter(isDefined)
+			new CreateEntityDiffer(),
+			new CreateColumnDiffer(),
+			new CreateViewDiffer(),
+			new CreateRelationDiffer(),
+			new CreateRelationInverseSideDiffer(),
+			new CreateUniqueConstraintDiffer(),
+			new CreateIndexDiffer(),
+			new RemoveEnumDiffer(),
+			new UpdateAclSchemaDiffer(),
+			new UpdateValidationSchemaDiffer(),
+		]
 
 		const diffs: Migration.Modification[] = []
 		let appliedDiffsSchema = originalSchema
 		for (const differ of differs) {
-			const differDiffs = 'createDiff' in differ
-				? differ.createDiff(appliedDiffsSchema, updatedSchema)
-				: differ(appliedDiffsSchema, updatedSchema)
+			const differDiffs = differ.createDiff(appliedDiffsSchema, updatedSchema)
 			appliedDiffsSchema = this.schemaMigrator.applyModifications(appliedDiffsSchema, differDiffs, VERSION_LATEST)
 			diffs.push(...differDiffs)
 		}

package/src/SchemaMigrator.ts

@@ -1,5 +1,5 @@
 import { Schema } from '@contember/schema'
-import ModificationHandlerFactory from './modifications/ModificationHandlerFactory'
+import { ModificationHandlerFactory } from './modifications'
 import { Migration } from './Migration'
 
 export class SchemaMigrator {

package/src/index.ts

@@ -6,10 +6,6 @@ export * from './SchemaMigrator'
 export * from './SchemaDiffer'
 export * from './MigrationCreator'
 export * from './MigrationDescriber'
-export { default as ModificationHandlerFactory } from './modifications/ModificationHandlerFactory'
-export * from './modifications/ModificationVersions'
-export * from './modifications/ModificationHandler'
-export * from './modifications/utils/sqlUpdateUtils'
+export * from './modifications'
 export * from './MigrationFilesManager'
 export * from './MigrationVersionHelper'
-export { SchemaUpdateError } from './modifications/exceptions'

package/src/modifications/ModificationHandler.ts

@@ -20,21 +20,33 @@ export interface ModificationHandler<Data> {
 	describe(context: ModificationDescriptionContext): ModificationDescription
 }
 
-export type CreateDiff = (originalSchema: Schema, updatedSchema: Schema) => Migration.Modification[]
-
 export interface ModificationHandlerOptions {
 	formatVersion: number
 	systemSchema: string
 }
 
-export interface ModificationHandlerStatic<Data> {
-	id: string
-	createModification: (data: Data) => Migration.Modification<Data>
-	createDiff?: CreateDiff
-
+export interface ModificationHandlerConstructor<Data> {
 	new(data: Data, schema: Schema, options: ModificationHandlerOptions): ModificationHandler<Data>
 }
 
 export interface Differ {
-	createDiff: CreateDiff
+	createDiff: (originalSchema: Schema, updatedSchema: Schema) => Migration.Modification[]
+}
+
+
+export interface ModificationType<Id extends String, Data> {
+	id: Id
+	createModification: (data: Data) => Migration.Modification<Data>
+	createHandler: (data: Data, schema: Schema, options: ModificationHandlerOptions) => ModificationHandler<Data>
+}
+
+export const createModificationType = <Data, Id extends string>({ handler, id }: {
+	id: Id
+	handler: ModificationHandlerConstructor<Data>
+}): ModificationType<Id, Data> => {
+	return {
+		id,
+		createModification: data => ({ modification: id, ...data }),
+		createHandler: (data, schema, options) => new handler(data, schema, options),
+	}
 }

package/src/modifications/ModificationHandlerFactory.ts

@@ -1,84 +1,88 @@
 import { Schema } from '@contember/schema'
-import { ModificationHandler, ModificationHandlerOptions, ModificationHandlerStatic } from './ModificationHandler'
-import { CreateColumnModification, UpdateColumnDefinitionModification, UpdateColumnNameModification } from './columns'
-import { PatchValidationSchemaModification, UpdateValidationSchemaModification } from './validation'
-import { PatchAclSchemaModification, UpdateAclSchemaModification } from './acl'
-import { CreateUniqueConstraintModification, RemoveUniqueConstraintModification } from './constraints'
+import { ModificationHandler, ModificationHandlerOptions, ModificationType } from './ModificationHandler'
+import { patchAclSchemaModification, updateAclSchemaModification } from './acl'
+import { createColumnModification, updateColumnDefinitionModification, updateColumnNameModification } from './columns'
+import { createUniqueConstraintModification, removeUniqueConstraintModification } from './constraints'
 import {
-	CreateEntityModification,
-	CreateViewModification,
-	RemoveEntityModification,
-	ToggleEventLogModification,
-	UpdateEntityNameModification,
-	UpdateEntityTableNameModification,
+	createEntityModification, createViewModification,
+	removeEntityModification, toggleEventLogModification,
+	updateEntityNameModification,
+	updateEntityTableNameModification,
 } from './entities'
-import { CreateEnumModification, RemoveEnumModification, UpdateEnumModification } from './enums'
-import { RemoveFieldModification, UpdateFieldNameModification } from './fields'
+import { updateViewModification } from './entities/UpdateViewModification'
 import {
-	ConvertOneHasManyToManyHasManyRelationModification,
-	ConvertOneToManyRelationModification,
-	CreateRelationInverseSideModification,
-	CreateRelationModification,
-	DisableOrphanRemovalModification,
-	EnableOrphanRemovalModification,
-	MakeRelationNotNullModification,
-	MakeRelationNullableModification,
-	ToggleJunctionEventLogModification,
-	UpdateRelationOnDeleteModification,
-	UpdateRelationOrderByModification,
+	createEnumModification,
+	removeEnumModification,
+	updateEnumModification,
+} from './enums'
+import { removeFieldModification, updateFieldNameModification } from './fields'
+import {
+	convertOneHasManyToManyHasManyRelationModification,
+	convertOneToManyRelationModification,
+	createRelationInverseSideModification,
+	createRelationModification, disableOrphanRemovalModification,
+	enableOrphanRemovalModification,
+	makeRelationNotNullModification,
+	makeRelationNullableModification, toggleJunctionEventLogModification,
+	updateRelationOnDeleteModification,
+	updateRelationOrderByModification,
 } from './relations'
-import { UpdateViewModification } from './entities/UpdateViewModification'
+import { patchValidationSchemaModification, updateValidationSchemaModification } from './validation'
+import { createIndexModification, removeIndexModification } from './indexes'
+
 
 class ModificationHandlerFactory {
-	constructor(private readonly map: Record<string, ModificationHandlerStatic<any>>) {}
+	constructor(private readonly map: Record<string, ModificationType<string, any>>) {}
 
 	public create<D>(name: string, data: D, schema: Schema, options: ModificationHandlerOptions): ModificationHandler<D> {
 		if (!this.map[name]) {
 			throw new Error(`Undefined modification handler for ${name}`)
 		}
-		return new this.map[name](data, schema, options)
+		return this.map[name].createHandler(data, schema, options)
 	}
 }
 
 namespace ModificationHandlerFactory {
-	export type HandlerMap<D> = { [modificationName: string]: ModificationHandlerStatic<D> }
+	type HandlerMap<D> = { [modificationName: string]: ModificationType<string, D> }
 
 	const handlers = [
-		UpdateAclSchemaModification,
-		PatchAclSchemaModification,
-		CreateColumnModification,
-		UpdateColumnDefinitionModification,
-		UpdateColumnNameModification,
-		CreateUniqueConstraintModification,
-		RemoveUniqueConstraintModification,
-		CreateEntityModification,
-		RemoveEntityModification,
-		UpdateEntityNameModification,
-		UpdateEntityTableNameModification,
-		UpdateViewModification,
-		CreateViewModification,
-		CreateEnumModification,
-		RemoveEnumModification,
-		UpdateEnumModification,
-		RemoveFieldModification,
-		UpdateFieldNameModification,
-		CreateRelationInverseSideModification,
-		CreateRelationModification,
-		UpdateRelationOnDeleteModification,
-		UpdateRelationOrderByModification,
-		MakeRelationNotNullModification,
-		MakeRelationNullableModification,
-		EnableOrphanRemovalModification,
-		DisableOrphanRemovalModification,
-		UpdateValidationSchemaModification,
-		PatchValidationSchemaModification,
-		ConvertOneToManyRelationModification,
-		ToggleEventLogModification,
-		ToggleJunctionEventLogModification,
-		ConvertOneHasManyToManyHasManyRelationModification,
+		updateAclSchemaModification,
+		patchAclSchemaModification,
+		createColumnModification,
+		updateColumnDefinitionModification,
+		updateColumnNameModification,
+		createUniqueConstraintModification,
+		removeUniqueConstraintModification,
+		createIndexModification,
+		removeIndexModification,
+		createEntityModification,
+		removeEntityModification,
+		updateEntityNameModification,
+		updateEntityTableNameModification,
+		updateViewModification,
+		createViewModification,
+		createEnumModification,
+		removeEnumModification,
+		updateEnumModification,
+		removeFieldModification,
+		updateFieldNameModification,
+		createRelationInverseSideModification,
+		createRelationModification,
+		updateRelationOnDeleteModification,
+		updateRelationOrderByModification,
+		makeRelationNotNullModification,
+		makeRelationNullableModification,
+		enableOrphanRemovalModification,
+		disableOrphanRemovalModification,
+		updateValidationSchemaModification,
+		patchValidationSchemaModification,
+		convertOneToManyRelationModification,
+		toggleEventLogModification,
+		toggleJunctionEventLogModification,
+		convertOneHasManyToManyHasManyRelationModification,
 	]
 
 	export const defaultFactoryMap: HandlerMap<any> = Object.fromEntries(handlers.map(it => [it.id, it]))
 }
 
-export default ModificationHandlerFactory
+export { ModificationHandlerFactory }

package/src/modifications/acl/PatchAclSchemaModification.ts

@@ -1,12 +1,10 @@
 import { MigrationBuilder } from '@contember/database-migrations'
 import { SchemaUpdater } from '../utils/schemaUpdateUtils'
-import { ModificationHandlerStatic } from '../ModificationHandler'
+import { createModificationType, ModificationHandler } from '../ModificationHandler'
 import { applyPatch, Operation } from 'rfc6902'
 import deepCopy from '../../utils/deepCopy'
 
-export const PatchAclSchemaModification: ModificationHandlerStatic<PatchAclSchemaModificationData> = class {
-	static id = 'patchAclSchema'
-
+export class PatchAclSchemaModificationHandler implements ModificationHandler<PatchAclSchemaModificationData>{
 	constructor(private readonly data: PatchAclSchemaModificationData) {}
 
 	public createSql(builder: MigrationBuilder): void {}
@@ -29,12 +27,13 @@ export const PatchAclSchemaModification: ModificationHandlerStatic<PatchAclSchem
 	describe() {
 		return { message: 'Update ACL schema' }
 	}
-
-	static createModification(data: PatchAclSchemaModificationData) {
-		return { modification: this.id, ...data }
-	}
 }
 
+export const patchAclSchemaModification = createModificationType({
+	id: 'patchAclSchema',
+	handler: PatchAclSchemaModificationHandler,
+})
+
 export interface PatchAclSchemaModificationData {
 	patch: Operation[]
 }

package/src/modifications/acl/UpdateAclSchemaModification.ts

@@ -1,14 +1,12 @@
 import { MigrationBuilder } from '@contember/database-migrations'
 import { Acl, Schema } from '@contember/schema'
 import { SchemaUpdater } from '../utils/schemaUpdateUtils'
-import { ModificationHandlerStatic } from '../ModificationHandler'
+import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
 import deepEqual from 'fast-deep-equal'
 import { createPatch } from 'rfc6902'
-import { PatchAclSchemaModification } from './PatchAclSchemaModification'
-
-export const UpdateAclSchemaModification: ModificationHandlerStatic<UpdateAclSchemaModificationData> = class {
-	public static id = 'updateAclSchema'
+import { patchAclSchemaModification } from './PatchAclSchemaModification'
 
+export class UpdateAclSchemaModificationHandler implements ModificationHandler<UpdateAclSchemaModificationData>{
 	constructor(private readonly data: UpdateAclSchemaModificationData) {}
 
 	public createSql(builder: MigrationBuilder): void {}
@@ -23,23 +21,26 @@ export const UpdateAclSchemaModification: ModificationHandlerStatic<UpdateAclSch
 	describe() {
 		return { message: 'Update ACL schema' }
 	}
+}
 
-	static createModification(data: UpdateAclSchemaModificationData) {
-		return { modification: this.id, ...data }
-	}
+export interface UpdateAclSchemaModificationData {
+	schema: Acl.Schema
+}
 
-	static createDiff(originalSchema: Schema, updatedSchema: Schema) {
+export const updateAclSchemaModification = createModificationType({
+	id: 'updateAclSchema',
+	handler: UpdateAclSchemaModificationHandler,
+})
+
+export class UpdateAclSchemaDiffer implements Differ {
+	createDiff(originalSchema: Schema, updatedSchema: Schema) {
 		if (deepEqual(originalSchema.acl, updatedSchema.acl)) {
 			return []
 		}
 		const patch = createPatch(originalSchema.acl, updatedSchema.acl)
 		if (patch.length <= 100) {
-			return [PatchAclSchemaModification.createModification({ patch })]
+			return [patchAclSchemaModification.createModification({ patch })]
 		}
-		return [UpdateAclSchemaModification.createModification({ schema: updatedSchema.acl })]
+		return [updateAclSchemaModification.createModification({ schema: updatedSchema.acl })]
 	}
 }
-
-export interface UpdateAclSchemaModificationData {
-	schema: Acl.Schema
-}

package/src/modifications/columns/CreateColumnModification.ts

@@ -1,15 +1,14 @@
 import { escapeValue, MigrationBuilder } from '@contember/database-migrations'
 import { Model, Schema } from '@contember/schema'
 import { addField, SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'
-import { ModificationHandlerStatic } from '../ModificationHandler'
+import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
 import { wrapIdentifier } from '../../utils/dbHelpers'
 import { getColumnName, isColumn } from '@contember/schema-utils'
 import { ImplementationException } from '../../exceptions'
 import { createFields } from '../utils/diffUtils'
+import { getColumnSqlType } from '../utils/columnUtils'
 
-export const CreateColumnModification: ModificationHandlerStatic<CreateColumnModificationData> = class {
-	static id = 'createColumn'
-
+export class CreateColumnModificationHandler implements ModificationHandler<CreateColumnModificationData> {
 	constructor(private readonly data: CreateColumnModificationData, private readonly schema: Schema) {}
 
 	public createSql(builder: MigrationBuilder): void {
@@ -21,7 +20,7 @@ export const CreateColumnModification: ModificationHandlerStatic<CreateColumnMod
 		const hasSeed = this.data.fillValue !== undefined || this.data.copyValue !== undefined
 		builder.addColumn(entity.tableName, {
 			[column.columnName]: {
-				type: column.type === Model.ColumnType.Enum ? `"${column.columnType}"` : column.columnType,
+				type: getColumnSqlType(column),
 				notNull: !column.nullable && !hasSeed,
 				sequenceGenerated: column.sequence,
 			},
@@ -33,7 +32,7 @@ export const CreateColumnModification: ModificationHandlerStatic<CreateColumnMod
 			} 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)}`)
+	  SET ${wrapIdentifier(column.columnName)} = ${wrapIdentifier(copyFrom)}::${getColumnSqlType(column)}`)
 			} else {
 				throw new ImplementationException()
 			}
@@ -63,17 +62,28 @@ export const CreateColumnModification: ModificationHandlerStatic<CreateColumnMod
 				: undefined
 		return { message: `Add field ${this.data.entityName}.${this.data.field.name}`, failureWarning }
 	}
+}
 
-	static createModification(data: CreateColumnModificationData) {
-		return { modification: this.id, ...data }
-	}
+export interface CreateColumnModificationData {
+	entityName: string
+	field: Model.AnyColumn
+	fillValue?: any
+	copyValue?: string
+}
 
-	static createDiff(originalSchema: Schema, updatedSchema: Schema) {
+
+export const createColumnModification = createModificationType({
+	id: 'createColumn',
+	handler: CreateColumnModificationHandler,
+})
+
+export class CreateColumnDiffer implements Differ {
+	createDiff(originalSchema: Schema, updatedSchema: Schema) {
 		return createFields(originalSchema, updatedSchema, ({ newField, updatedEntity }) => {
 			if (!isColumn(newField)) {
 				return undefined
 			}
-			return CreateColumnModification.createModification({
+			return createColumnModification.createModification({
 				entityName: updatedEntity.name,
 				field: newField,
 				...(newField.default !== undefined ? { fillValue: newField.default } : {}),
@@ -81,10 +91,3 @@ export const CreateColumnModification: ModificationHandlerStatic<CreateColumnMod
 		})
 	}
 }
-
-export interface CreateColumnModificationData {
-	entityName: string
-	field: Model.AnyColumn
-	fillValue?: any
-	copyValue?: string
-}