@contember/cli 2.1.0-beta.2 → 2.2.0-alpha.1

package/tests/cases/unit/MigrationExecutionFacade.test.ts

@@ -0,0 +1,81 @@
+import { afterEach, beforeEach, expect, test } from 'bun:test'
+import * as fs from 'node:fs/promises'
+import * as os from 'node:os'
+import * as path from 'node:path'
+import { createSchema, SchemaDefinition as def } from '@contember/schema-definition'
+import { Schema } from '@contember/schema'
+import { SchemaStateManager } from '@contember/migrations-client'
+import { MigrationExecutionFacade } from '../../../src/lib/migrations/MigrationExecutionFacade.js'
+
+namespace BlogModel {
+	export class Author {
+		name = def.stringColumn()
+	}
+}
+
+const aclWith = (role: string): Schema['acl'] => ({
+	roles: { [role]: { variables: {}, stages: '*', entities: {} } },
+})
+
+let migrationsDir: string
+
+beforeEach(async () => {
+	migrationsDir = await fs.mkdtemp(path.join(os.tmpdir(), 'contember-exec-'))
+	await new SchemaStateManager(path.join(migrationsDir, 'state')).extractState({ ...createSchema(BlogModel), acl: aclWith('admin') })
+})
+
+afterEach(async () => {
+	await fs.rm(migrationsDir, { recursive: true, force: true })
+})
+
+// Drives MigrationExecutionFacade.execute with a recording migration executor and a real state manager.
+// Returns the schemaState the executor was handed plus everything written to console.log.
+const runExecute = async (opts: { until?: string }) => {
+	const schemaStateManager = new SchemaStateManager(path.join(migrationsDir, 'state'))
+	let executedSchemaState: unknown = 'not-called'
+	const migrationExecutor = {
+		executeMigrations: async (args: any) => {
+			executedSchemaState = args.schemaState
+		},
+	}
+	const status = {
+		migrationsToExecute: [{ version: '2024-01-01-120000', name: '2024-01-01-120000-init', localMigration: {} }],
+	}
+
+	const facade = new MigrationExecutionFacade(
+		{ get: () => ({ listExecutedMigrations: async () => [] }) } as any, // systemClientProvider
+		{ get: () => ({ createProject: async () => {} }) } as any, // tenantClientProvider
+		{ get: () => ({ name: 'p', token: 't', endpoint: 'e' }) } as any, // projectProvider
+		{} as any, // schemaVersionBuilder (only used in the describe prompt path)
+		{} as any, // migrationPrinter
+		migrationExecutor as any,
+		{ resolveMigrationsStatus: async () => status } as any,
+		schemaStateManager,
+		{ getUsableSnapshot: async () => null } as any, // migrationSnapshotFacade — these tests exercise the no-snapshot path
+	)
+
+	const logs: string[] = []
+	const original = console.log
+	console.log = (...args: any[]) => logs.push(args.join(' '))
+	try {
+		await facade.execute({ requireConfirmation: false, ...opts })
+	} finally {
+		console.log = original
+	}
+	return { executedSchemaState, logs }
+}
+
+test('does not push schema state when --until targets a specific migration, and warns', async () => {
+	const { executedSchemaState, logs } = await runExecute({ until: '2024-01-01-120000' })
+
+	expect(executedSchemaState).toBeUndefined()
+	expect(logs.some(it => it.includes('Warning') && it.includes('--until'))).toBe(true)
+})
+
+test('pushes schema state when no --until is given', async () => {
+	const { executedSchemaState, logs } = await runExecute({})
+
+	expect(executedSchemaState).toBeDefined()
+	expect(Object.keys((executedSchemaState as any).acl.roles)).toStrictEqual(['admin'])
+	expect(logs.some(it => it.includes('Warning'))).toBe(false)
+})

package/tests/cases/unit/MigrationRebaseFacade.test.ts

@@ -0,0 +1,87 @@
+import { afterEach, beforeEach, expect, test } from 'bun:test'
+import * as fs from 'node:fs/promises'
+import * as os from 'node:os'
+import * as path from 'node:path'
+import { c, createSchema } from '@contember/schema-definition'
+import { Schema } from '@contember/schema'
+import { emptySchema } from '@contember/schema-utils'
+import {
+	JsonLoader,
+	MigrationFilesManager,
+	MigrationParser,
+	MigrationsResolver,
+	ModificationHandlerFactory,
+	SchemaDiffer,
+	SchemaMigrator,
+	SchemaStateManager,
+	SchemaVersionBuilder,
+	VERSION_LATEST,
+} from '@contember/migrations-client'
+import { MigrationRebaseFacade } from '../../../src/lib/migrations/MigrationRebaseFacade.js'
+
+namespace BlogModel {
+	export class Author {
+		name = c.stringColumn()
+	}
+}
+
+const aclWith = (role: string): Schema['acl'] => ({
+	roles: { [role]: { variables: {}, stages: '*', entities: {} } },
+})
+
+let migrationsDir: string
+
+beforeEach(async () => {
+	migrationsDir = await fs.mkdtemp(path.join(os.tmpdir(), 'contember-rebase-'))
+	const schemaDiffer = new SchemaDiffer(new SchemaMigrator(new ModificationHandlerFactory(ModificationHandlerFactory.defaultFactoryMap)))
+	const model = createSchema(BlogModel)
+	const modifications = schemaDiffer.diffSchemas(emptySchema, model, { skipNonModelDiffers: true })
+	await fs.writeFile(
+		path.join(migrationsDir, '2024-01-01-120000-init.json'),
+		JSON.stringify({ formatVersion: VERSION_LATEST, modifications }, null, '\t'),
+	)
+	await new SchemaStateManager(path.join(migrationsDir, 'state')).extractState({ ...model, acl: aclWith('admin') })
+})
+
+afterEach(async () => {
+	await fs.rm(migrationsDir, { recursive: true, force: true })
+})
+
+test('rebase re-pushes schema state to the server after rewriting migrations', async () => {
+	// migrationModify rebuilds the server schema from migrations, dropping the non-model state;
+	// rebase must re-apply it from the state files once the rewrites are done.
+	const filesManager = new MigrationFilesManager(migrationsDir, { json: new JsonLoader(new MigrationParser()) })
+	const migrationsResolver = new MigrationsResolver(filesManager)
+	const schemaMigrator = new SchemaMigrator(new ModificationHandlerFactory(ModificationHandlerFactory.defaultFactoryMap))
+	const schemaStateManager = new SchemaStateManager(path.join(migrationsDir, 'state'))
+	const schemaVersionBuilder = new SchemaVersionBuilder(migrationsResolver, schemaMigrator, schemaStateManager)
+
+	const calls: Array<{ method: string; args: any[] }> = []
+	const systemClientProvider = {
+		get: () => ({
+			migrationModify: async (...args: any[]) => {
+				calls.push({ method: 'migrationModify', args })
+			},
+			migrate: async (...args: any[]) => {
+				calls.push({ method: 'migrate', args })
+			},
+		}),
+	}
+	const migrationsValidator = { validate: () => true }
+
+	const facade = new MigrationRebaseFacade(
+		schemaVersionBuilder,
+		migrationsValidator as any,
+		systemClientProvider as any,
+		filesManager,
+		schemaStateManager,
+	)
+
+	await facade.rebase([...(await migrationsResolver.getSchemaMigrations())])
+
+	const modifyIndex = calls.findIndex(it => it.method === 'migrationModify')
+	expect(modifyIndex).toBeGreaterThanOrEqual(0)
+	const restate = calls.slice(modifyIndex + 1).find(it => it.method === 'migrate' && it.args[2])
+	expect(restate).toBeDefined()
+	expect(Object.keys(restate!.args[2].acl.roles)).toStrictEqual(['admin'])
+})

package/tests/cases/unit/MigrationSnapshotFacade.test.ts

@@ -0,0 +1,243 @@
+import { afterEach, beforeEach, describe, expect, test } from 'bun:test'
+import * as fs from 'node:fs/promises'
+import * as os from 'node:os'
+import * as path from 'node:path'
+import { c, createSchema } from '@contember/schema-definition'
+import { emptySchema } from '@contember/schema-utils'
+import {
+	JsonLoader,
+	MigrationFilesManager,
+	MigrationParser,
+	MigrationsResolver,
+	ModificationHandlerFactory,
+	SchemaDiffer,
+	SchemaMigrator,
+	SchemaStateManager,
+	SchemaVersionBuilder,
+	SnapshotManager,
+	VERSION_LATEST,
+} from '@contember/migrations-client'
+import { MigrationSnapshotFacade } from '../../../src/lib/migrations/MigrationSnapshotFacade.js'
+
+namespace ModelA {
+	export class Author {
+		name = c.stringColumn()
+	}
+}
+
+namespace ModelB {
+	export class Author {
+		name = c.stringColumn()
+	}
+
+	export class Category {
+		title = c.stringColumn()
+	}
+}
+
+namespace WithRelation {
+	export class Author {
+		name = c.stringColumn()
+		posts = c.oneHasMany(Post, 'author')
+	}
+
+	export class Post {
+		title = c.stringColumn()
+		author = c.manyHasOne(Author, 'posts').notNull()
+	}
+}
+
+namespace WithRelationAndColumn {
+	export class Author {
+		name = c.stringColumn()
+		// added after `posts` already exists — a replay orders Author.fields as [..., posts, nickname]
+		// while the collapsed differ emits columns before relations: [..., nickname, posts].
+		nickname = c.stringColumn()
+		posts = c.oneHasMany(Post, 'author')
+	}
+
+	export class Post {
+		title = c.stringColumn()
+		author = c.manyHasOne(Author, 'posts').notNull()
+	}
+}
+
+const setup = async (migrationsDir: string) => {
+	const filesManager = new MigrationFilesManager(migrationsDir, { json: new JsonLoader(new MigrationParser()) })
+	const migrationsResolver = new MigrationsResolver(filesManager)
+	const schemaMigrator = new SchemaMigrator(new ModificationHandlerFactory(ModificationHandlerFactory.defaultFactoryMap))
+	const schemaStateManager = new SchemaStateManager(path.join(migrationsDir, 'state'))
+	const schemaVersionBuilder = new SchemaVersionBuilder(migrationsResolver, schemaMigrator, schemaStateManager)
+	const schemaDiffer = new SchemaDiffer(schemaMigrator)
+	const snapshotManager = new SnapshotManager(path.join(migrationsDir, 'snapshot.json'))
+	const facade = new MigrationSnapshotFacade(
+		migrationsResolver,
+		schemaVersionBuilder,
+		schemaDiffer,
+		schemaMigrator,
+		schemaStateManager,
+		snapshotManager,
+	)
+	return { facade, schemaDiffer, snapshotManager }
+}
+
+describe('MigrationSnapshotFacade', () => {
+	let migrationsDir: string
+
+	// Each call mints a facade with a fresh MigrationFilesManager cache, simulating a new CLI process.
+	const freshFacade = async () => (await setup(migrationsDir)).facade
+
+	beforeEach(async () => {
+		migrationsDir = await fs.mkdtemp(path.join(os.tmpdir(), 'contember-snapshot-facade-'))
+		const { schemaDiffer } = await setup(migrationsDir)
+
+		const schemaA = createSchema(ModelA)
+		const schemaB = createSchema(ModelB)
+		const write = (name: string, content: unknown) => fs.writeFile(path.join(migrationsDir, name), JSON.stringify(content, null, '\t'))
+
+		await write('2024-01-01-120000-a.json', { formatVersion: VERSION_LATEST, modifications: schemaDiffer.diffSchemas(emptySchema, schemaA) })
+		await write('2024-01-02-120000-b.json', { formatVersion: VERSION_LATEST, modifications: schemaDiffer.diffSchemas(schemaA, schemaB) })
+		await write('2024-01-03-120000-seed.json', { queries: [{ query: 'query { __typename }' }] })
+	})
+
+	afterEach(async () => {
+		await fs.rm(migrationsDir, { recursive: true, force: true })
+	})
+
+	test('create collapses all migrations and records what they cover', async () => {
+		const snapshot = await (await freshFacade()).create()
+
+		expect(snapshot.version).toBe('2024-01-03-120000')
+		expect(snapshot.covers.map(it => it.type)).toStrictEqual(['schema', 'schema', 'content'])
+		expect(snapshot.covers[0].checksum).toBeString()
+		expect(snapshot.covers[2].checksum).toBeNull()
+		// the content migration is flagged: its data is not reproduced by the schema snapshot
+		expect(snapshot.contentMigrations).toStrictEqual(['2024-01-03-120000'])
+		expect(snapshot.snapshot.modifications.length).toBeGreaterThan(0)
+	})
+
+	test('a freshly created snapshot verifies against a full replay', async () => {
+		await (await freshFacade()).create()
+		const result = await (await freshFacade()).verify()
+		expect(result.ok).toBe(true)
+	})
+
+	test('verify tolerates schema key-order differences between a replay and the collapsed snapshot', async () => {
+		// History adds a column to an entity that already has a relation. A replay orders the entity's
+		// fields as [..., relation, column]; the collapsed differ orders them [..., column, relation].
+		// The two schemas are deeply equal but their JSON checksums differ — verify must not report a
+		// false mismatch (it compares order-insensitively, like SchemaDiffer's own round-trip check).
+		const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'contember-snapshot-rel-'))
+		try {
+			const { schemaDiffer } = await setup(dir)
+			const a = createSchema(WithRelation)
+			const b = createSchema(WithRelationAndColumn)
+			const write = (name: string, content: unknown) => fs.writeFile(path.join(dir, name), JSON.stringify(content, null, '\t'))
+			await write('2024-01-01-120000-a.json', { formatVersion: VERSION_LATEST, modifications: schemaDiffer.diffSchemas(emptySchema, a) })
+			await write('2024-01-02-120000-b.json', { formatVersion: VERSION_LATEST, modifications: schemaDiffer.diffSchemas(a, b) })
+
+			await (await setup(dir)).facade.create()
+			const result = await (await setup(dir)).facade.verify()
+			expect(result.ok).toBe(true)
+		} finally {
+			await fs.rm(dir, { recursive: true, force: true })
+		}
+	})
+
+	test('verify fails when a covered migration changed after the snapshot', async () => {
+		await (await freshFacade()).create()
+		// tamper with a covered schema migration, then re-read from a fresh process
+		await fs.writeFile(
+			path.join(migrationsDir, '2024-01-02-120000-b.json'),
+			JSON.stringify({ formatVersion: VERSION_LATEST, modifications: [] }, null, '\t'),
+		)
+
+		const result = await (await freshFacade()).verify()
+		expect(result.ok).toBe(false)
+		expect(result.message).toMatch(/stale/)
+	})
+
+	test('getUsableSnapshot returns the snapshot for an empty project', async () => {
+		await (await freshFacade()).create()
+		expect(await (await freshFacade()).getUsableSnapshot([])).not.toBeNull()
+	})
+
+	test('getUsableSnapshot returns null when the project already has executed migrations', async () => {
+		await (await freshFacade()).create()
+		const executed = [{
+			version: '2024-01-01-120000',
+			name: '2024-01-01-120000-a',
+			formatVersion: VERSION_LATEST,
+			checksum: 'x',
+			executedAt: new Date(),
+		}]
+		expect(await (await freshFacade()).getUsableSnapshot(executed as any)).toBeNull()
+	})
+
+	test('getUsableSnapshot returns null (with a warning) when a covered migration is stale', async () => {
+		await (await freshFacade()).create()
+		await fs.rm(path.join(migrationsDir, '2024-01-01-120000-a.json'))
+		expect(await (await freshFacade()).getUsableSnapshot([])).toBeNull()
+	})
+
+	test('getUsableSnapshot ignores the snapshot when a migration was added within the covered range', async () => {
+		await (await freshFacade()).create()
+		// a migration whose version falls between two covered migrations, added without regenerating the
+		// snapshot. Bootstrapping would then fail with MUST_FOLLOW_LATEST, so it must fall back to replay.
+		await fs.writeFile(
+			path.join(migrationsDir, '2024-01-01-130000-inrange.json'),
+			JSON.stringify({ formatVersion: VERSION_LATEST, modifications: [] }, null, '\t'),
+		)
+		expect(await (await freshFacade()).getUsableSnapshot([])).toBeNull()
+
+		const result = await (await freshFacade()).verify()
+		expect(result.ok).toBe(false)
+		expect(result.message).toMatch(/within the covered range/)
+	})
+
+	test('verify fails when a covered migration changed type', async () => {
+		const { schemaDiffer } = await setup(migrationsDir)
+		await (await freshFacade()).create()
+		// the seed migration was recorded as a content cover; rewrite it into a schema migration. Its
+		// modifications are absent from the collapsed snapshot, so it no longer equals a full replay.
+		await fs.writeFile(
+			path.join(migrationsDir, '2024-01-03-120000-seed.json'),
+			JSON.stringify(
+				{ formatVersion: VERSION_LATEST, modifications: schemaDiffer.diffSchemas(createSchema(ModelB), createSchema(ModelA)) },
+				null,
+				'\t',
+			),
+		)
+
+		expect(await (await freshFacade()).getUsableSnapshot([])).toBeNull()
+		const result = await (await freshFacade()).verify()
+		expect(result.ok).toBe(false)
+		expect(result.message).toMatch(/changed type/)
+	})
+
+	test('verify fails when schema state mode was toggled after the snapshot', async () => {
+		await (await freshFacade()).create()
+		// enabling state mode (migrations:init-state) only creates the state/ dir — it leaves the covered
+		// migration files untouched, so without an explicit guard the snapshot would pass unnoticed.
+		await fs.mkdir(path.join(migrationsDir, 'state'), { recursive: true })
+
+		expect(await (await freshFacade()).getUsableSnapshot([])).toBeNull()
+		const result = await (await freshFacade()).verify()
+		expect(result.ok).toBe(false)
+		expect(result.message).toMatch(/state mode changed/)
+	})
+
+	test('buildSnapshotInput maps covered migrations to GraphQL inputs', async () => {
+		const facade = await freshFacade()
+		const snapshot = await facade.create()
+		const input = await facade.buildSnapshotInput(snapshot)
+
+		expect(input.covers).toHaveLength(3)
+		const schemaCover = input.covers[0] as any
+		expect(schemaCover.type).toBe('SCHEMA')
+		expect(schemaCover.schemaMigration.modifications.length).toBeGreaterThan(0)
+		const contentCover = input.covers[2] as any
+		expect(contentCover.type).toBe('CONTENT')
+		expect(contentCover.contentMigration).toStrictEqual([])
+	})
+})

package/tests/tenantConfigApplier.test.ts

@@ -0,0 +1,87 @@
+import { describe, expect, test } from 'bun:test'
+import { TenantConfigApplier } from '../src/lib/tenant/TenantConfigApplier.js'
+import type { RemoteIdentityProvider, TenantClient } from '../src/lib/tenant/TenantClient.js'
+
+const createClientMock = (existingIdps: RemoteIdentityProvider[] = []) => {
+	const calls: string[] = []
+	const client = {
+		configure: async () => {
+			calls.push('configure')
+		},
+		listIdentityProviders: async () => existingIdps,
+		addIdp: async (slug: string) => {
+			calls.push(`addIdp:${slug}`)
+		},
+		updateIdp: async (slug: string) => {
+			calls.push(`updateIdp:${slug}`)
+		},
+		enableIdp: async (slug: string) => {
+			calls.push(`enableIdp:${slug}`)
+		},
+		disableIdp: async (slug: string) => {
+			calls.push(`disableIdp:${slug}`)
+		},
+		addMailTemplate: async (template: { type: string }) => {
+			calls.push(`addMailTemplate:${template.type}`)
+		},
+	}
+	return { client: client as unknown as TenantClient, calls }
+}
+
+describe('TenantConfigApplier', () => {
+	test('sends configure when global config is present', async () => {
+		const { client, calls } = createClientMock()
+		await new TenantConfigApplier().apply(client, { config: { password: { minLength: 8 } } })
+		expect(calls).toEqual(['configure'])
+	})
+
+	test('adds a new identity provider', async () => {
+		const { client, calls } = createClientMock([])
+		await new TenantConfigApplier().apply(client, {
+			identityProviders: { google: { type: 'oidc', configuration: {} } },
+		})
+		expect(calls).toEqual(['addIdp:google'])
+	})
+
+	test('updates an existing identity provider', async () => {
+		const { client, calls } = createClientMock([{ slug: 'google', type: 'oidc', disabledAt: null }])
+		await new TenantConfigApplier().apply(client, {
+			identityProviders: { google: { type: 'oidc', configuration: {} } },
+		})
+		expect(calls).toEqual(['updateIdp:google'])
+	})
+
+	test('disables an enabled provider marked disabled', async () => {
+		const { client, calls } = createClientMock([{ slug: 'google', type: 'oidc', disabledAt: null }])
+		await new TenantConfigApplier().apply(client, {
+			identityProviders: { google: { type: 'oidc', configuration: {}, disabled: true } },
+		})
+		expect(calls).toEqual(['updateIdp:google', 'disableIdp:google'])
+	})
+
+	test('re-enables a disabled provider no longer marked disabled', async () => {
+		const { client, calls } = createClientMock([{ slug: 'google', type: 'oidc', disabledAt: '2024-01-01T00:00:00Z' }])
+		await new TenantConfigApplier().apply(client, {
+			identityProviders: { google: { type: 'oidc', configuration: {} } },
+		})
+		expect(calls).toEqual(['updateIdp:google', 'enableIdp:google'])
+	})
+
+	test('upserts mail templates', async () => {
+		const { client, calls } = createClientMock()
+		await new TenantConfigApplier().apply(client, {
+			mailTemplates: [{ type: 'RESET_PASSWORD_REQUEST', subject: 's', content: 'c' }],
+		})
+		expect(calls).toEqual(['addMailTemplate:RESET_PASSWORD_REQUEST'])
+	})
+
+	test('dry run performs no mutations but still reads state', async () => {
+		const { client, calls } = createClientMock([])
+		await new TenantConfigApplier().apply(client, {
+			config: { password: { minLength: 8 } },
+			identityProviders: { google: { type: 'oidc', configuration: {} } },
+			mailTemplates: [{ type: 'RESET_PASSWORD_REQUEST', subject: 's', content: 'c' }],
+		}, { dryRun: true })
+		expect(calls).toEqual([])
+	})
+})