@contember/schema-migrations 2.1.0-beta.2 → 2.2.0-alpha.2

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 
 describe('make relation not null', () =>
 	testMigrations({

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 
 describe('make relation nullable', () =>
 	testMigrations({

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 
 describe('patch acl', () =>
 	testMigrations({

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

@@ -1,7 +1,7 @@
 import { Actions } from '@contember/schema'
 import { emptySchema } from '@contember/schema-utils'
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { c, createSchema } from '@contember/schema-definition'
 namespace Schema {
 	export class Post {

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { createSchema, SchemaBuilder } from '@contember/schema-definition'
 import { Acl, Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 import { SchemaDefinition as def } from '@contember/schema-definition'
 
 describe('remove an entity', () =>

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 
 describe('remove enum', () =>
 	testMigrations({

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

@@ -1,11 +1,11 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { createSchema, SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 import { SchemaDefinition as def } from '@contember/schema-definition'
 import { createDatabaseMetadata } from '@contember/database'
-import { removeUniqueConstraintModification } from '../../../src'
+import { removeUniqueConstraintModification } from '../../../src/index.js'
 
 describe('remove relation (many has one)', () =>
 	testMigrations({

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

@@ -0,0 +1,97 @@
+import { describe, expect, test } from 'bun:test'
+import { ModificationHandlerFactory, SchemaDiffer, SchemaMigrator } from '../../../src/index.js'
+import { SchemaBuilder } from '@contember/schema-definition'
+import { Acl, Model, Schema } from '@contember/schema'
+import { emptySchema } from '@contember/schema-utils'
+
+const schemaDiffer = new SchemaDiffer(
+	new SchemaMigrator(new ModificationHandlerFactory(ModificationHandlerFactory.defaultFactoryMap)),
+)
+
+// Modifications produced by the non-model differs (acl/validation/actions/settings).
+// In schema state mode these are skipped because those parts live in state/*.json instead of migrations.
+const nonModelModifications = [
+	'patchAclSchema',
+	'updateAclSchema',
+	'patchValidationSchema',
+	'updateValidationSchema',
+	'updateSettings',
+	'createTrigger',
+	'updateTrigger',
+	'removeTrigger',
+	'createTarget',
+	'updateTarget',
+	'removeTarget',
+]
+
+const model = (extraColumn = false) =>
+	new SchemaBuilder()
+		.entity('Article', entity => {
+			let built = entity.column('title', c => c.type(Model.ColumnType.String))
+			if (extraColumn) {
+				built = built.column('slug', c => c.type(Model.ColumnType.String))
+			}
+			return built
+		})
+		.buildSchema()
+
+const acl: Acl.Schema = {
+	roles: {
+		admin: {
+			variables: {},
+			stages: '*',
+			entities: {
+				Article: {
+					predicates: {},
+					operations: { read: { id: true, title: true } },
+				},
+			},
+		},
+	},
+}
+
+const withSchema = (partial: Partial<Schema>): Schema => ({ ...emptySchema, ...partial })
+
+describe('skipNonModelDiffers', () => {
+	test('produces empty diff when only non-model parts (acl + settings) change', () => {
+		const original = withSchema({ model: model() })
+		const updated = withSchema({
+			model: model(),
+			acl,
+			settings: { content: { useExistsInHasManyFilter: true } },
+		})
+
+		const diff = schemaDiffer.diffSchemas(original, updated, { skipNonModelDiffers: true })
+
+		expect(diff).toStrictEqual([])
+	})
+
+	test('emits only model modifications when both model and acl change', () => {
+		const original = withSchema({ model: model() })
+		const updated = withSchema({ model: model(true), acl })
+
+		const diff = schemaDiffer.diffSchemas(original, updated, { skipNonModelDiffers: true })
+
+		expect(diff.length).toBeGreaterThan(0)
+		for (const modification of diff) {
+			expect(nonModelModifications).not.toContain(modification.modification)
+		}
+	})
+
+	test('default behavior (without skip) still emits the acl modification', () => {
+		const original = withSchema({ model: model() })
+		const updated = withSchema({ model: model(), acl })
+
+		const diff = schemaDiffer.diffSchemas(original, updated, { skipInitialSchemaValidation: true })
+
+		expect(diff.map(it => it.modification)).toContain('patchAclSchema')
+	})
+
+	test('recreate validation passes for model+acl change with skip (non-model parts are neutralized)', () => {
+		const original = withSchema({ model: model() })
+		const updated = withSchema({ model: model(true), acl })
+
+		// skipRecreateValidation defaults to false here, so this exercises the targetForCompare neutralization path.
+		expect(() => schemaDiffer.diffSchemas(original, updated, { skipNonModelDiffers: true })).not.toThrow()
+	})
+})

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

@@ -1,7 +1,7 @@
 import { createSchema, SchemaDefinition as def } from '@contember/schema-definition'
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
-import { SQL } from '../../src/tags'
+import { testMigrations } from '../../src/tests.js'
+import { SQL } from '../../src/tags.js'
 
 namespace EventLogNoConfig {
 	export class Author {

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

@@ -1,7 +1,7 @@
 import { createSchema, SchemaDefinition as def } from '@contember/schema-definition'
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
-import { SQL } from '../../src/tags'
+import { testMigrations } from '../../src/tests.js'
+import { SQL } from '../../src/tags.js'
 
 namespace EventLogNoConfig {
 	export class Author {

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

@@ -1,9 +1,9 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { createSchema, SchemaBuilder, SchemaDefinition as def } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
-import { updateColumnDefinitionModification } from '../../../src'
+import { SQL } from '../../src/tags.js'
+import { updateColumnDefinitionModification } from '../../../src/index.js'
 
 describe('update column definition', () =>
 	testMigrations({

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { c, createSchema, SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 
 describe('rename entity without renaming a table', () =>
 	testMigrations({

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { createSchema, SchemaBuilder, SchemaDefinition as def } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 
 namespace SchemaWithoutOrderBy {
 	export class Article {

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { c, createSchema, SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 
 describe('update enum', () =>
 	testMigrations({

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

@@ -1,8 +1,25 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
-import { SchemaBuilder } from '@contember/schema-definition'
+import { testMigrations } from '../../src/tests.js'
+import { createSchema, SchemaBuilder, SchemaDefinition as def } from '@contember/schema-definition'
 import { Acl, Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
+
+namespace IndexColumnOptionsRenameOriginal {
+	@def.Index({ fields: [{ field: 'rank', order: 'desc' }] })
+	export class Article {
+		rank = def.intColumn()
+		title = def.stringColumn()
+	}
+}
+
+namespace IndexColumnOptionsRenameUpdated {
+	@def.Index({ fields: [{ field: 'score', order: 'desc' }] })
+	export class Article {
+		// keep the DB column name so this is a pure field rename (no column-rename SQL)
+		score = def.intColumn().columnName('rank')
+		title = def.stringColumn()
+	}
+}
 
 describe('rename a field', () =>
 	testMigrations({
@@ -229,3 +246,21 @@ describe('rename relation with acl', () =>
 		sql: SQL``,
 		noDiff: true,
 	}))
+
+// Renaming a field that carries per-column index options must move the columnOptions entry to the new
+// name (it is keyed by field name) — otherwise the options are lost and the schema fails validation.
+describe('rename a field carrying per-column index options', () =>
+	testMigrations({
+		original: { model: createSchema(IndexColumnOptionsRenameOriginal).model },
+		updated: { model: createSchema(IndexColumnOptionsRenameUpdated).model },
+		diff: [
+			{
+				modification: 'updateFieldName',
+				entityName: 'Article',
+				fieldName: 'rank',
+				newFieldName: 'score',
+			},
+		],
+		sql: SQL``,
+		noDiff: true,
+	}))

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 import { createDatabaseMetadata, ForeignKeyDeleteAction } from '@contember/database'
 import {} from 'bun:test'
 

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

@@ -1,8 +1,8 @@
 import { describe } from 'bun:test'
-import { testMigrations } from '../../src/tests'
+import { testMigrations } from '../../src/tests.js'
 import { SchemaBuilder } from '@contember/schema-definition'
 import { Model } from '@contember/schema'
-import { SQL } from '../../src/tags'
+import { SQL } from '../../src/tags.js'
 
 describe('update relation order by', () =>
 	testMigrations({