@contember/migrations-client 2.1.0-alpha.3 → 2.1.0-alpha.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contember/migrations-client",
-  "version": "2.1.0-alpha.3",
+  "version": "2.1.0-alpha.30",
   "license": "Apache-2.0",
   "main": "./dist/production/index.js",
   "typings": "./dist/types/index.d.ts",
@@ -26,11 +26,11 @@
     "test": "echo 'No tests'"
   },
   "dependencies": {
-    "@contember/engine-common": "2.1.0-alpha.3",
-    "@contember/graphql-client": "2.1.0-alpha.3",
-    "@contember/schema": "2.1.0-alpha.3",
-    "@contember/schema-migrations": "2.1.0-alpha.3",
-    "@contember/schema-utils": "2.1.0-alpha.3"
+    "@contember/engine-common": "2.1.0-alpha.30",
+    "@contember/graphql-client": "2.1.0-alpha.30",
+    "@contember/schema": "2.1.0-alpha.30",
+    "@contember/schema-migrations": "2.1.0-alpha.30",
+    "@contember/schema-utils": "2.1.0-alpha.30"
   },
   "devDependencies": {
     "@types/node": "^20.17.22"

package/src/JsLoader.ts

@@ -1,6 +1,6 @@
 import { MigrationFileLoader } from './MigrationFileLoader'
 import { MigrationParser } from './MigrationParser'
-import { ContentMigration, MigrationContent, MigrationFile } from './MigrationFile'
+import { ContentMigration, ContentMigrationFactoryArgs, MigrationContent, MigrationFile } from './MigrationFile'
 
 export class JsLoader implements MigrationFileLoader {
 	constructor(
@@ -11,10 +11,6 @@ export class JsLoader implements MigrationFileLoader {
 
 
 	public async load(file: MigrationFile): Promise<MigrationContent> {
-
-		// const code = await buildJs(file.path)
-		// const fn = new Function(`var module = {}; ((module) => { ${code} })(module); return module`)
-
 		const exports = await this.jsExecutor(file.path)
 		if (!('default' in exports) && !('query' in exports) && !('queries' in exports)) {
 			throw `export "default" or "query" is required in ${file.path}`
@@ -25,8 +21,8 @@ export class JsLoader implements MigrationFileLoader {
 
 		return {
 			type: 'factory',
-			factory: async (): Promise<ContentMigration> => {
-				const result = await exports.default()
+			factory: async (args: ContentMigrationFactoryArgs): Promise<ContentMigration> => {
+				const result = await exports.default(args)
 				const migration = this.migrationParser.parse(file, result ?? { queries: [] })
 				if (migration.type !== 'content') {
 					throw new Error()

package/src/MigrationExecuteHelper.ts

@@ -15,7 +15,7 @@ export class MigrationExecutor {
 	}: {
 		client: SystemClient
 		migrations: MigrationToExecuteOkStatus[]
-		contentMigrationFactoryArgs: ContentMigrationFactoryArgs
+		contentMigrationFactoryArgs: Omit<ContentMigrationFactoryArgs, 'migration'>
 		log: (message: string) => void
 		force?: boolean
 	}): Promise<void> {
@@ -66,7 +66,10 @@ export class MigrationExecutor {
 			const migrationContent = await migration.localMigration.getContent()
 			if (migrationContent.type === 'factory') {
 				await executeMigrations()
-				const result = await migrationContent.factory(contentMigrationFactoryArgs)
+				const result = await migrationContent.factory({
+					...contentMigrationFactoryArgs,
+					migration: migration.localMigration,
+				})
 				migrationsToRun.push(result)
 				await executeMigrations()
 			} else {

package/src/MigrationFile.ts

@@ -1,5 +1,6 @@
 import { Migration } from '@contember/schema-migrations'
 import { JSONObject } from './utils/json'
+import { SchemaVersionBuilder } from './SchemaVersionBuilder'
 
 export interface MigrationFile {
 	path: string
@@ -36,6 +37,8 @@ export type ContentMigrationFactoryArgs = {
 	apiBaseUrl: string
 	projectName: string
 	apiToken: string
+	migration: MigrationFile
+	schemaVersionBuilder: SchemaVersionBuilder
 }
 
 export type ContentMigrationFactory = {

package/src/migrations.ts

@@ -14,6 +14,7 @@ export interface ExecutedMigration extends Migration {
 export enum MigrationState {
 	TO_EXECUTE_OK = 'to_execute_ok',
 	TO_EXECUTE_ERROR = 'to_execute_error',
+	SKIP_EMPTY = 'skip_empty',
 	EXECUTED_OK = 'executed_ok',
 	EXECUTED_ERROR = 'executed_error',
 	EXECUTED_MISSING = 'executed_missing',
@@ -34,22 +35,27 @@ interface MigrationToExecuteInvalidStatus extends MigrationStatusBase<MigrationS
 	errorMessage: string
 }
 
-interface MigrationExecutedOkStatus extends MigrationStatusBase<MigrationState.EXECUTED_OK>{
+interface MigrationExecutedOkStatus extends MigrationStatusBase<MigrationState.EXECUTED_OK> {
 	executedMigration: ExecutedMigrationInfo
 	localMigration: MigrationFile
 }
 
-interface MigrationExecutedMissingStatus extends MigrationStatusBase<MigrationState.EXECUTED_MISSING>{
+interface MigrationExecutedMissingStatus extends MigrationStatusBase<MigrationState.EXECUTED_MISSING> {
 	executedMigration: ExecutedMigrationInfo
 	errorMessage: string
 }
 
-interface MigrationExecutedErrorStatus extends MigrationStatusBase<MigrationState.EXECUTED_ERROR>{
+interface MigrationExecutedErrorStatus extends MigrationStatusBase<MigrationState.EXECUTED_ERROR> {
 	executedMigration: ExecutedMigrationInfo
 	localMigration: MigrationFile
 	errorMessage: string
 }
 
+export interface MigrationSkipStatus extends MigrationStatusBase<MigrationState.SKIP_EMPTY> {
+	localMigration: MigrationFile
+}
+
+
 export type ErrorMigrationStatus =
 	| MigrationToExecuteInvalidStatus
 	| MigrationExecutedMissingStatus
@@ -59,6 +65,7 @@ export type AnyMigrationStatus =
 	| ErrorMigrationStatus
 	| MigrationToExecuteOkStatus
 	| MigrationExecutedOkStatus
+	| MigrationSkipStatus
 
 const isErrorMigrationStatus = (migration: AnyMigrationStatus): migration is ErrorMigrationStatus =>
 	[MigrationState.EXECUTED_ERROR, MigrationState.EXECUTED_MISSING, MigrationState.TO_EXECUTE_ERROR].includes(
@@ -124,6 +131,16 @@ export class MigrationsStatusResolver {
 			if (allMigrations.find(it => it.version === localMigration.version)) {
 				continue
 			}
+			const migrationContent = await localMigration.getContent()
+			if (isSchemaMigration(migrationContent) && migrationContent.modifications.length === 0) {
+				allMigrations.push({
+					state: MigrationState.SKIP_EMPTY,
+					localMigration,
+					version: localMigration.version,
+					name: localMigration.name,
+				})
+				continue
+			}
 
 			if (latestExecuted && latestExecuted.version > localMigration.version) {
 				allMigrations.push({