@contember/schema-migrations 2.1.0-alpha.24 → 2.1.0-alpha.26

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contember/schema-migrations",
-  "version": "2.1.0-alpha.24",
+  "version": "2.1.0-alpha.26",
   "license": "Apache-2.0",
   "main": "./dist/production/index.js",
   "typings": "./dist/types/index.d.ts",
@@ -23,16 +23,16 @@
     }
   },
   "dependencies": {
-    "@contember/database": "2.1.0-alpha.24",
-    "@contember/database-migrations": "2.1.0-alpha.24",
-    "@contember/engine-common": "2.1.0-alpha.24",
-    "@contember/schema": "2.1.0-alpha.24",
-    "@contember/schema-utils": "2.1.0-alpha.24",
+    "@contember/database": "2.1.0-alpha.26",
+    "@contember/database-migrations": "2.1.0-alpha.26",
+    "@contember/engine-common": "2.1.0-alpha.26",
+    "@contember/schema": "2.1.0-alpha.26",
+    "@contember/schema-utils": "2.1.0-alpha.26",
     "fast-deep-equal": "^3.1.3",
     "rfc6902": "^5.1.1"
   },
   "devDependencies": {
-    "@contember/schema-definition": "2.1.0-alpha.24"
+    "@contember/schema-definition": "2.1.0-alpha.26"
   },
   "peerDependencies": {
     "pg": "^8.9.0"

package/src/SchemaDiffer.ts

@@ -109,7 +109,7 @@ export class SchemaDiffer {
 			new UpdateEntityOrderByDiffer(),
 			new UpdateTargetDiffer(),
 			new CreateTargetDiffer(),
-			new UpdateTriggerDiffer(),
+			new UpdateTriggerDiffer(this.options),
 			new CreateTriggerDiffer(),
 			new RemoveTriggerDiffer(),
 			new RemoveTargetDiffer(),

package/src/modifications/ModificationHandlerFactory.ts

@@ -30,7 +30,7 @@ import {
 import { patchValidationSchemaModification, updateValidationSchemaModification } from './validation'
 import { createIndexModification, removeIndexModification } from './indexes'
 import { updateSettingsModification } from './settings'
-import { createTriggerModification, removeTriggerModification, updateTriggerModification } from './actions'
+import { createTriggerModification, patchTriggerModification, removeTriggerModification, updateTriggerModification } from './actions'
 import { createTargetModification } from './actions/CreateTargetModification'
 import { removeTargetModification } from './actions/RemoveTargetModification'
 import { updateTargetModification } from './actions/UpdateTargetModification'
@@ -94,6 +94,7 @@ namespace ModificationHandlerFactory {
 		updateEntityOrderByModification,
 		createTriggerModification,
 		updateTriggerModification,
+		patchTriggerModification,
 		removeTriggerModification,
 		createTargetModification,
 		updateTargetModification,

package/src/modifications/actions/PatchTriggerModification.ts

@@ -0,0 +1,51 @@
+import { Actions } from '@contember/schema'
+import { SchemaUpdater } from '../utils/schemaUpdateUtils'
+import { createModificationType, ModificationHandler } from '../ModificationHandler'
+import { applyPatch, Operation } from 'rfc6902'
+import deepCopy from '../../utils/deepCopy'
+
+export class PatchTriggerModificationHandler implements ModificationHandler<PatchTriggerModificationData> {
+	constructor(private readonly data: PatchTriggerModificationData) {}
+
+	public createSql(): void {}
+
+	public getSchemaUpdater(): SchemaUpdater {
+		return ({ schema }) => {
+			const trigger = deepCopy(schema.actions.triggers[this.data.triggerName])
+
+			if (!trigger) {
+				throw new Error(`Trigger ${this.data.triggerName} not found`)
+			}
+
+			const result = applyPatch(trigger, this.data.patch).filter(it => it !== null)
+			if (result.length > 0) {
+				throw result[0]
+			}
+
+			return {
+				...schema,
+				actions: {
+					...schema.actions,
+					triggers: {
+						...schema.actions.triggers,
+						[this.data.triggerName]: trigger,
+					},
+				},
+			}
+		}
+	}
+
+	describe() {
+		return { message: `Patch trigger ${this.data.triggerName}` }
+	}
+}
+
+export interface PatchTriggerModificationData {
+	triggerName: string
+	patch: Operation[]
+}
+
+export const patchTriggerModification = createModificationType({
+	id: 'patchTrigger',
+	handler: PatchTriggerModificationHandler,
+})

package/src/modifications/actions/UpdateTriggerModification.ts

@@ -2,6 +2,8 @@ import { Actions, Schema } from '@contember/schema'
 import { SchemaUpdater } from '../utils/schemaUpdateUtils'
 import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
 import deepEqual from 'fast-deep-equal'
+import { createPatch } from 'rfc6902'
+import { patchTriggerModification } from './PatchTriggerModification'
 
 export class UpdateTriggerModificationHandler implements ModificationHandler<UpdateTriggerModificationData> {
 	constructor(private readonly data: UpdateTriggerModificationData) {
@@ -40,9 +42,28 @@ export const updateTriggerModification = createModificationType({
 })
 
 export class UpdateTriggerDiffer implements Differ {
+	constructor(
+		private readonly options?: {
+			maxPatchSize?: number
+		},
+	) {
+	}
+
 	createDiff(originalSchema: Schema, updatedSchema: Schema) {
 		return Object.entries(updatedSchema.actions.triggers)
 			.filter(([name, trigger]) => originalSchema.actions.triggers[name] && !deepEqual(trigger, originalSchema.actions.triggers[name]))
-			.map(([, trigger]) => updateTriggerModification.createModification({ trigger }))
+			.map(([name, trigger]) => {
+				const originalTrigger = originalSchema.actions.triggers[name]
+
+				const patch = createPatch(originalTrigger, trigger)
+				if (patch.length <= (this.options?.maxPatchSize ?? 100)) {
+					return patchTriggerModification.createModification({
+						triggerName: name,
+						patch,
+					})
+				}
+
+				return updateTriggerModification.createModification({ trigger })
+			})
 	}
 }

package/src/modifications/actions/index.ts

@@ -1,3 +1,4 @@
 export * from './CreateTriggerModification'
 export * from './RemoveTriggerModification'
 export * from './UpdateTriggerModification'
+export * from './PatchTriggerModification'

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

@@ -0,0 +1,184 @@
+import { Actions } from '@contember/schema'
+import { emptySchema } from '@contember/schema-utils'
+import { describe } from 'bun:test'
+import { testMigrations } from '../../src/tests'
+import { c, createSchema } from '@contember/schema-definition'
+namespace Schema {
+	export class Post {
+		title = c.stringColumn()
+		description = c.stringColumn()
+		category = c.manyHasOne(Category, 'articles')
+	}
+
+	export class Category {
+		name = c.stringColumn()
+		slug = c.stringColumn()
+		articles = c.oneHasMany(Post, 'category')
+	}
+
+
+}
+
+describe('patch trigger', () => testMigrations({
+	original: {
+		...createSchema(Schema),
+		actions: {
+			triggers: {
+				'post_created': {
+					type: 'basic',
+					name: 'post_created',
+					entity: 'Post',
+					create: true,
+					delete: false,
+					update: false,
+					target: 'webhook',
+					selection: [
+						'id',
+						'title',
+						['category', {}, ['name']],
+					],
+				} satisfies Actions.BasicTrigger,
+			},
+			targets: {
+				'webhook': {
+					type: 'webhook',
+					name: 'webhook',
+					url: 'https://example.com/webhook',
+				} satisfies Actions.WebhookTarget,
+			},
+		},
+	},
+	updated: {
+		...createSchema(Schema),
+		actions: {
+			triggers: {
+				'post_created': {
+					type: 'basic',
+					name: 'post_created',
+					entity: 'Post',
+					create: true,
+					delete: false,
+					update: false,
+					target: 'webhook',
+					selection: [
+						'id',
+						'title',
+						'description', // added field
+						['category', {}, ['name', 'slug']], // added sub-field
+					],
+				} satisfies Actions.BasicTrigger,
+			},
+			targets: {
+				'webhook': {
+					type: 'webhook',
+					name: 'webhook',
+					url: 'https://example.com/webhook',
+				} satisfies Actions.WebhookTarget,
+			},
+		},
+	},
+	diff: [
+		{
+			modification: 'patchTrigger',
+			triggerName: 'post_created',
+			patch: [
+				{
+					op: 'replace',
+					path: '/selection/2',
+					value: 'description',
+				},
+				{
+					op: 'add',
+					path: '/selection/-',
+					value: [
+						'category',
+						{},
+						[
+							'name',
+							'slug',
+						],
+					],
+				},
+			],
+		},
+	],
+	sql: '', // no SQL changes for action modifications
+}))
+
+describe('patch watch trigger', () => testMigrations({
+	original: {
+		...createSchema(Schema),
+		actions: {
+			triggers: {
+				'post_watch': {
+					type: 'watch',
+					name: 'post_watch',
+					entity: 'Post',
+					target: 'webhook',
+					watch: [
+						'title',
+						['category', {}, ['name']],
+					],
+				} satisfies Actions.WatchTrigger,
+			},
+			targets: {
+				'webhook': {
+					type: 'webhook',
+					name: 'webhook',
+					url: 'https://example.com/webhook',
+				} satisfies Actions.WebhookTarget,
+			},
+		},
+	},
+	updated: {
+		...createSchema(Schema),
+		actions: {
+			triggers: {
+				'post_watch': {
+					type: 'watch',
+					name: 'post_watch',
+					entity: 'Post',
+					target: 'webhook',
+					watch: [
+						'title',
+						'description', // added field
+						['category', {}, ['name', 'slug']], // added sub-field
+					],
+				} satisfies Actions.WatchTrigger,
+			},
+			targets: {
+				'webhook': {
+					type: 'webhook',
+					name: 'webhook',
+					url: 'https://example.com/webhook',
+				} satisfies Actions.WebhookTarget,
+			},
+		},
+	},
+	diff: [
+		{
+			modification: 'patchTrigger',
+			triggerName: 'post_watch',
+			patch: [
+				{
+					op: 'replace',
+					path: '/watch/1',
+					value: 'description',
+				},
+				{
+					op: 'add',
+					path: '/watch/-',
+					value: [
+						'category',
+						{},
+						[
+							'name',
+							'slug',
+						],
+					],
+				},
+			],
+		},
+	],
+	sql: '', // no SQL changes for action modifications
+}))