@contember/engine-system-api 2.1.0-beta.1 → 2.2.0-alpha.1

package/src/model/queries/schema/SchemaQuery.ts

@@ -1,10 +1,11 @@
 import { DatabaseQuery, DatabaseQueryable, Literal, SelectBuilder } from '@contember/database'
 import { Schema } from '@contember/schema'
-import { SchemaWithMeta } from '../../migrations'
+import { SchemaWithMeta } from '../../migrations/index.js'
 
 export class SchemaQuery extends DatabaseQuery<SchemaWithMeta | null> {
 	constructor(
 		private readonly currentHash?: string,
+		private readonly currentVersion?: string,
 	) {
 		super()
 	}
@@ -26,6 +27,9 @@ export class SchemaQuery extends DatabaseQuery<SchemaWithMeta | null> {
 				if (!this.currentHash) {
 					return it
 				}
+				if (this.currentVersion) {
+					return it.where(it => it.raw('(checksum != ? OR version != ?)', this.currentHash, this.currentVersion))
+				}
 				return it.where(it => it.raw('checksum != ?', this.currentHash))
 			})
 

package/src/model/queries/schema/index.ts

@@ -1 +1 @@
-export * from './SchemaQuery'
+export * from './SchemaQuery.js'

package/src/model/queries/stages/StageBySlugQuery.ts

@@ -1,6 +1,6 @@
 import { DatabaseQuery, DatabaseQueryable } from '@contember/database'
-import { prepareStageQueryBuilder } from './StageQueryFactory'
-import { Stage } from '../../dtos'
+import { prepareStageQueryBuilder } from './StageQueryFactory.js'
+import { Stage } from '../../dtos/index.js'
 
 class StageBySlugQuery extends DatabaseQuery<StageBySlugQuery.Result> {
 	constructor(private readonly slug: string) {

package/src/model/queries/stages/StageQueryFactory.ts

@@ -1,5 +1,5 @@
 import { SelectBuilder } from '@contember/database'
-import { Stage } from '../../dtos'
+import { Stage } from '../../dtos/index.js'
 
 export const prepareStageQueryBuilder = () => {
 	return SelectBuilder.create<Stage>()

package/src/model/queries/stages/StagesQuery.ts

@@ -1,6 +1,6 @@
 import { DatabaseQuery, DatabaseQueryable } from '@contember/database'
-import { prepareStageQueryBuilder } from './StageQueryFactory'
-import { Stage } from '../../dtos'
+import { prepareStageQueryBuilder } from './StageQueryFactory.js'
+import { Stage } from '../../dtos/index.js'
 
 class StagesQuery extends DatabaseQuery<Stage[]> {
 	async fetch(queryable: DatabaseQueryable): Promise<Stage[]> {

package/src/model/queries/stages/index.ts

@@ -1,3 +1,3 @@
-export * from './StageBySlugQuery'
-export * from './StageQueryFactory'
-export * from './StagesQuery'
+export * from './StageBySlugQuery.js'
+export * from './StageQueryFactory.js'
+export * from './StagesQuery.js'

package/src/model/stages/StageCreator.ts

@@ -1,7 +1,7 @@
-import { CreateStageCommand } from '../commands'
-import { StageBySlugQuery } from '../queries'
-import { StageConfig } from '../../types'
-import { DatabaseContext } from '../database'
+import { CreateStageCommand } from '../commands/index.js'
+import { StageBySlugQuery } from '../queries/index.js'
+import { StageConfig } from '../../types.js'
+import { DatabaseContext } from '../database/index.js'
 
 class StageCreator {
 	public async createStage(

package/src/model/stages/index.ts

@@ -1 +1 @@
-export * from './StageCreator'
+export * from './StageCreator.js'

package/src/resolvers/Resolver.ts

@@ -1,4 +1,4 @@
-import * as Schema from '../schema'
+import * as Schema from '../schema/index.js'
 import { IResolvers } from '@graphql-tools/utils'
 
 export interface IgnoreIndex {

package/src/resolvers/ResolverFactory.ts

@@ -1,11 +1,11 @@
-import { EventsQueryResolver, ExecutedMigrationsQueryResolver, StagesQueryResolver } from './query'
-import { Event, EventType, Resolvers } from '../schema'
-import { assertNever } from '../utils'
-import { MigrateMutationResolver, MigrationAlterMutationResolver, TruncateMutationResolver } from './mutation'
+import { EventsQueryResolver, ExecutedMigrationsQueryResolver, StagesQueryResolver } from './query/index.js'
+import { Event, EventType, Resolvers } from '../schema/index.js'
+import { assertNever } from '../utils/index.js'
+import { MigrateMutationResolver, MigrationAlterMutationResolver, TruncateMutationResolver } from './mutation/index.js'
 import { createJsonLikeType, DateTimeType, JSONType } from '@contember/graphql-utils'
-import { EventOldValuesResolver } from './types'
+import { EventOldValuesResolver } from './types/index.js'
 import { GraphQLError, GraphQLScalarType, Kind } from 'graphql'
-import { SchemaQueryResolver } from './query/SchemaQueryResolver'
+import { SchemaQueryResolver } from './query/SchemaQueryResolver.js'
 
 export class ResolverFactory {
 	public constructor(
@@ -34,6 +34,8 @@ export class ResolverFactory {
 							return 'UpdateEvent'
 						case EventType.Delete:
 							return 'DeleteEvent'
+						case EventType.Truncate:
+							return 'TruncateEvent'
 						case null:
 						case undefined:
 							return null
@@ -50,6 +52,7 @@ export class ResolverFactory {
 			},
 			Mutation: {
 				migrate: this.migrateMutationResolver.migrate.bind(this.migrateMutationResolver),
+				migrateFromSnapshot: this.migrateMutationResolver.migrateFromSnapshot.bind(this.migrateMutationResolver),
 			},
 			DeleteEvent: {
 				oldValues: this.eventOldValuesResolver.oldValues.bind(this.eventOldValuesResolver),

package/src/resolvers/SystemResolverContext.ts

@@ -1,11 +1,11 @@
 import { Authorizator } from '@contember/authorization'
 import { ForbiddenError } from '@contember/graphql-utils'
-import { DatabaseContext, Identity } from '../model'
-import { ProjectConfig } from '../types'
-import { StagePermissionsFactory } from '../model/authorization/StagePermissionsFactory'
-import { StageScope } from '../model/authorization/StageScope'
-import { ItemLoader } from '../utils/batchQuery'
-import { SchemaGetter } from '../model/SchemaGetter'
+import { DatabaseContext, Identity } from '../model/index.js'
+import { ProjectConfig } from '../types.js'
+import { StagePermissionsFactory } from '../model/authorization/StagePermissionsFactory.js'
+import { StageScope } from '../model/authorization/StageScope.js'
+import { ItemLoader } from '../utils/batchQuery.js'
+import { SchemaGetter } from '../model/SchemaGetter.js'
 
 export class SystemResolverContextFactory {
 	constructor(

package/src/resolvers/index.ts

@@ -1,5 +1,5 @@
-export * from './mutation'
-export * from './query'
-export * from './Resolver'
-export * from './SystemResolverContext'
-export * from './ResolverFactory'
+export * from './mutation/index.js'
+export * from './query/index.js'
+export * from './Resolver.js'
+export * from './SystemResolverContext.js'
+export * from './ResolverFactory.js'

package/src/resolvers/mutation/MigrateMutationResolver.ts

@@ -1,13 +1,13 @@
 import { GraphQLResolveInfo } from 'graphql'
-import { SystemResolverContext } from '../SystemResolverContext'
-import { MutationResolver } from '../Resolver'
-import { MigrateResponse, MigrationType, MutationMigrateArgs } from '../../schema'
+import { SystemResolverContext } from '../SystemResolverContext.js'
+import { MutationResolver } from '../Resolver.js'
+import { MigrateResponse, MigrationType, MutationMigrateArgs, MutationMigrateFromSnapshotArgs } from '../../schema/index.js'
 import { Migration } from '@contember/schema-migrations'
-import { AuthorizationActions, MigrationError, ProjectMigrator, StagesQuery } from '../../model'
-import { MigrationInput } from '../../model/migrations/MigrationInput'
+import { AuthorizationActions, MigrationError, ProjectMigrator, StagesQuery } from '../../model/index.js'
+import { MigrationInput } from '../../model/migrations/MigrationInput.js'
 import { UserInputError } from '@contember/graphql-utils'
 import { SchemaValidatorSkippedErrors } from '@contember/schema-utils'
-import { assertNever } from '../../utils'
+import { assertNever } from '../../utils/index.js'
 
 const pg_lock_id = 1597474138739147
 
@@ -31,6 +31,7 @@ export class MigrateMutationResolver implements MutationResolver<'migrate'> {
 		force = false,
 	): Promise<MigrateResponse> {
 		const migrations = this.parseMigrationInput(args)
+		const schemaState = args.schemaState ?? undefined
 
 		return context.db.locked(pg_lock_id, db =>
 			db.transaction(async trx => {
@@ -45,6 +46,7 @@ export class MigrateMutationResolver implements MutationResolver<'migrate'> {
 						identity: context.identity,
 						stages,
 						migrationsToExecute: migrations,
+						schemaState,
 						options: {
 							ignoreOrder: force,
 							skipExecuted: true,
@@ -74,8 +76,63 @@ export class MigrateMutationResolver implements MutationResolver<'migrate'> {
 			}))
 	}
 
+	async migrateFromSnapshot(
+		parent: any,
+		args: MutationMigrateFromSnapshotArgs,
+		context: SystemResolverContext,
+		info: GraphQLResolveInfo,
+	): Promise<MigrateResponse> {
+		const covers = this.parseMigrations(args.snapshot.covers)
+		const schemaState = args.schemaState ?? undefined
+
+		return context.db.locked(pg_lock_id, db =>
+			db.transaction(async trx => {
+				const stages = await trx.queryHandler.fetch(new StagesQuery())
+				for (const stage of stages) {
+					await context.requireAccess(AuthorizationActions.PROJECT_MIGRATE, stage.slug)
+				}
+				try {
+					await this.projectMigrator.migrateFromSnapshot({
+						db: trx,
+						project: context.project,
+						stages,
+						snapshot: {
+							formatVersion: args.snapshot.formatVersion,
+							modifications: args.snapshot.modifications as Migration.Modification[],
+						},
+						covers,
+						schemaState,
+					})
+				} catch (e) {
+					if (e instanceof MigrationError) {
+						await trx.client.connection.rollback()
+						const error = {
+							code: e.code,
+							migration: e.version,
+							developerMessage: e.message,
+						}
+						return {
+							ok: false,
+							errors: [error],
+							error,
+						}
+					} else {
+						throw e
+					}
+				}
+				return {
+					ok: true,
+					errors: [],
+				}
+			}))
+	}
+
 	private parseMigrationInput(args: MutationMigrateArgs): MigrationInput[] {
-		return args.migrations.map((it): MigrationInput => {
+		return this.parseMigrations(args.migrations)
+	}
+
+	private parseMigrations(migrations: MutationMigrateArgs['migrations']): MigrationInput[] {
+		return migrations.map((it): MigrationInput => {
 			if (!it.type) {
 				if (!it.modifications || !it.formatVersion) {
 					throw new UserInputError('invalid migration format')

package/src/resolvers/mutation/MigrationAlterMutationResolver.ts

@@ -1,6 +1,6 @@
 import { GraphQLResolveInfo } from 'graphql'
-import { SystemResolverContext } from '../SystemResolverContext'
-import { MutationResolver } from '../Resolver'
+import { SystemResolverContext } from '../SystemResolverContext.js'
+import { MutationResolver } from '../Resolver.js'
 import {
 	MigrationDeleteErrorCode,
 	MigrationDeleteResponse,
@@ -8,8 +8,8 @@ import {
 	MigrationModifyResponse,
 	MutationMigrationDeleteArgs,
 	MutationMigrationModifyArgs,
-} from '../../schema'
-import { DeleteMigrationErrorCode, MigrationAlterer, UpdateMigrationErrorCode } from '../../model'
+} from '../../schema/index.js'
+import { DeleteMigrationErrorCode, MigrationAlterer, UpdateMigrationErrorCode } from '../../model/index.js'
 import { Migration } from '@contember/schema-migrations'
 
 export class MigrationAlterMutationResolver implements MutationResolver<'migrationModify'>, MutationResolver<'migrationDelete'> {

package/src/resolvers/mutation/TruncateMutationResolver.ts

@@ -1,8 +1,8 @@
 import { GraphQLResolveInfo } from 'graphql'
-import { SystemResolverContext } from '../SystemResolverContext'
-import { MutationResolver } from '../Resolver'
-import { TruncateResponse } from '../../schema'
-import { ProjectTruncateExecutor } from '../../model'
+import { SystemResolverContext } from '../SystemResolverContext.js'
+import { MutationResolver } from '../Resolver.js'
+import { TruncateResponse } from '../../schema/index.js'
+import { ProjectTruncateExecutor } from '../../model/index.js'
 
 export class TruncateMutationResolver implements MutationResolver<'truncate'> {
 	constructor(private readonly projectTruncateExecutor: ProjectTruncateExecutor) {}
@@ -12,7 +12,7 @@ export class TruncateMutationResolver implements MutationResolver<'truncate'> {
 		context: SystemResolverContext,
 		info: GraphQLResolveInfo,
 	): Promise<TruncateResponse> {
-		await this.projectTruncateExecutor.truncateProject(context.db, context.project, await context.getSchema())
+		await this.projectTruncateExecutor.truncateProject(context.db, context.project, await context.getSchema(), context.identity.id)
 		return {
 			ok: true,
 		}

package/src/resolvers/mutation/index.ts

@@ -1,3 +1,3 @@
-export * from './MigrateMutationResolver'
-export * from './TruncateMutationResolver'
-export * from './MigrationAlterMutationResolver'
+export * from './MigrateMutationResolver.js'
+export * from './TruncateMutationResolver.js'
+export * from './MigrationAlterMutationResolver.js'

package/src/resolvers/query/EventsQueryResolver.ts

@@ -1,8 +1,8 @@
 import { GraphQLResolveInfo } from 'graphql'
-import { SystemResolverContext } from '../SystemResolverContext'
-import { QueryResolver } from '../Resolver'
-import { EventsOrder, QueryEventsArgs, ResolversTypes } from '../../schema'
-import { AuthorizationActions, EventResponseBuilder, EventsQuery, StageBySlugQuery } from '../../model'
+import { SystemResolverContext } from '../SystemResolverContext.js'
+import { QueryResolver } from '../Resolver.js'
+import { EventsOrder, QueryEventsArgs, ResolversTypes } from '../../schema/index.js'
+import { AuthorizationActions, EventResponseBuilder, EventsQuery, StageBySlugQuery } from '../../model/index.js'
 import { UserInputError } from '@contember/graphql-utils'
 
 export class EventsQueryResolver implements QueryResolver<'events'> {

package/src/resolvers/query/ExecutedMigrationsQueryResolver.ts

@@ -1,8 +1,8 @@
 import { GraphQLResolveInfo } from 'graphql'
-import { SystemResolverContext } from '../SystemResolverContext'
-import { QueryResolver } from '../Resolver'
-import { ExecutedMigration, QueryExecutedMigrationsArgs } from '../../schema'
-import { AuthorizationActions, ExecutedMigrationByVersionQuery, ExecutedMigrationsQuery, StagesQuery } from '../../model'
+import { SystemResolverContext } from '../SystemResolverContext.js'
+import { QueryResolver } from '../Resolver.js'
+import { ExecutedMigration, QueryExecutedMigrationsArgs } from '../../schema/index.js'
+import { AuthorizationActions, ExecutedMigrationByVersionQuery, ExecutedMigrationsQuery, StagesQuery } from '../../model/index.js'
 
 export class ExecutedMigrationsQueryResolver implements QueryResolver<'executedMigrations'> {
 	async executedMigrations(

package/src/resolvers/query/SchemaQueryResolver.ts

@@ -1,7 +1,7 @@
 import { GraphQLResolveInfo } from 'graphql'
-import { SystemResolverContext } from '../SystemResolverContext'
-import { QueryResolver } from '../Resolver'
-import { AuthorizationActions, StagesQuery } from '../../model'
+import { SystemResolverContext } from '../SystemResolverContext.js'
+import { QueryResolver } from '../Resolver.js'
+import { AuthorizationActions, StagesQuery } from '../../model/index.js'
 
 export class SchemaQueryResolver implements QueryResolver<'schema'> {
 	async schema(

package/src/resolvers/query/StagesQueryResolver.ts

@@ -1,8 +1,8 @@
 import { GraphQLResolveInfo } from 'graphql'
-import { SystemResolverContext } from '../SystemResolverContext'
-import { QueryResolver } from '../Resolver'
-import { Stage } from '../../schema'
-import { StagesQuery } from '../../model'
+import { SystemResolverContext } from '../SystemResolverContext.js'
+import { QueryResolver } from '../Resolver.js'
+import { Stage } from '../../schema/index.js'
+import { StagesQuery } from '../../model/index.js'
 
 export class StagesQueryResolver implements QueryResolver<'stages'> {
 	async stages(parent: any, args: any, context: SystemResolverContext, info: GraphQLResolveInfo): Promise<Stage[]> {

package/src/resolvers/query/index.ts

@@ -1,3 +1,3 @@
-export * from './EventsQueryResolver'
-export * from './ExecutedMigrationsQueryResolver'
-export * from './StagesQueryResolver'
+export * from './EventsQueryResolver.js'
+export * from './ExecutedMigrationsQueryResolver.js'
+export * from './StagesQueryResolver.js'

package/src/resolvers/types/EventOldValuesResolver.ts

@@ -1,6 +1,6 @@
-import { DeleteEvent, DeleteEventResolvers, UpdateEvent, UpdateEventResolvers } from '../../schema'
-import { SystemResolverContext } from '../SystemResolverContext'
-import { oldValuesLoaderFactory } from './OldValuesHelpers'
+import { DeleteEvent, DeleteEventResolvers, UpdateEvent, UpdateEventResolvers } from '../../schema/index.js'
+import { SystemResolverContext } from '../SystemResolverContext.js'
+import { oldValuesLoaderFactory } from './OldValuesHelpers.js'
 
 export class EventOldValuesResolver implements UpdateEventResolvers<SystemResolverContext>, DeleteEventResolvers<SystemResolverContext> {
 	async oldValues(

package/src/resolvers/types/OldValuesHelpers.ts

@@ -1,6 +1,6 @@
-import { DatabaseContext } from '../../model'
-import { createBatchLoader } from '../../utils/batchQuery'
-import { OldValuesQuery } from '../../model'
+import { DatabaseContext } from '../../model/index.js'
+import { createBatchLoader } from '../../utils/batchQuery.js'
+import { OldValuesQuery } from '../../model/index.js'
 
 export const oldValuesLoaderFactory = (db: DatabaseContext) =>
 	createBatchLoader<string, Record<string, object>, object>(

package/src/resolvers/types/index.ts

@@ -1 +1 @@
-export * from './EventOldValuesResolver'
+export * from './EventOldValuesResolver.js'

package/src/schema/dev.graphql.ts

@@ -8,7 +8,7 @@ const schema: DocumentNode = gql`
 
 	type Mutation {
 		truncate: TruncateResponse!
-		forceMigrate(migrations: [Migration!]!): MigrateResponse!
+		forceMigrate(migrations: [Migration!]!, schemaState: SchemaStateInput): MigrateResponse!
 		migrationModify(migration: String!, modification: MigrationModification!): MigrationModifyResponse!
 		migrationDelete(migration: String!): MigrationDeleteResponse!
 	}

package/src/schema/index.ts

@@ -1,5 +1,7 @@
-export * from './types'
-import * as Schema from './types'
+export * from './types.js'
+import * as Schema from './types.js'
 export { Schema }
+// biome-ignore lint/correctness/useImportExtensions: .graphql files are resolved by the bundler loader, not as JS modules
 export { default as devTypeDefs } from './dev.graphql'
+// biome-ignore lint/correctness/useImportExtensions: .graphql files are resolved by the bundler loader, not as JS modules
 export { default as typeDefs } from './system.graphql'

package/src/schema/system.graphql.ts

@@ -20,7 +20,28 @@ const schema: DocumentNode = gql`
 	}
 
 	type Mutation {
-		migrate(migrations: [Migration!]!): MigrateResponse!
+		migrate(migrations: [Migration!]!, schemaState: SchemaStateInput): MigrateResponse!
+		"""
+		Bootstraps an empty project from a snapshot: applies the collapsed schema in a
+		single step and records the covered migrations as executed without replaying them.
+		Refused (PROJECT_NOT_EMPTY) when any migration has already been executed.
+		"""
+		migrateFromSnapshot(snapshot: SnapshotInput!, schemaState: SchemaStateInput): MigrateResponse!
+	}
+
+	input SchemaStateInput {
+		acl: Json!
+		validation: Json!
+		actions: Json!
+		settings: Json!
+	}
+
+	input SnapshotInput {
+		"Collapsed schema (empty -> target) applied once to every stage."
+		formatVersion: Int!
+		modifications: [Json!]!
+		"Migrations subsumed by the snapshot, recorded as executed without running their SQL."
+		covers: [Migration!]!
 	}
 
 	# === events ===
@@ -70,14 +91,15 @@ const schema: DocumentNode = gql`
 		createdAt: DateTime!
 		appliedAt: DateTime!
 		type: EventType!
-		tableName: String!
-		primaryKey: [PrimaryKey!]!
+		tableName: String
+		primaryKey: [PrimaryKey!]
 	}
 
 	enum EventType {
 		UPDATE
 		DELETE
 		CREATE
+		TRUNCATE
 	}
 
 	type UpdateEvent implements Event {
@@ -123,6 +145,19 @@ const schema: DocumentNode = gql`
 		newValues: Json!
 	}
 
+	type TruncateEvent implements Event {
+		id: String!
+		transactionId: String!
+		identityId: String!
+		identityDescription: String!
+		description: String!
+		createdAt: DateTime!
+		appliedAt: DateTime!
+		type: EventType!
+		tableName: String
+		primaryKey: [PrimaryKey!]
+	}
+
 	# === executedMigrations ===
 
 	type ExecutedMigration {
@@ -181,6 +216,7 @@ const schema: DocumentNode = gql`
 		MIGRATION_FAILED
 		CONTENT_MIGRATION_FAILED
 		CONTENT_MIGRATION_NOT_SUCCESSFUL
+		PROJECT_NOT_EMPTY
 	}
 
 	type MigrateError {