@rpcbase/migrations 0.7.0 → 0.8.0

package/dist/diffResources.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"diffResources.d.ts","sourceRoot":"","sources":["../src/diffResources.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAKV,cAAc,EACd,kBAAkB,EAEnB,MAAM,SAAS,CAAA;AAyChB,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,cAAc,EACtB,OAAO,cAAc,KACpB,kBAoBF,CAAA"}
+{"version":3,"file":"diffResources.d.ts","sourceRoot":"","sources":["../src/diffResources.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAKV,cAAc,EACd,kBAAkB,EAEnB,MAAM,SAAS,CAAA;AAyChB,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,cAAc,EACtB,OAAO,cAAc,KACpB,kBAmBF,CAAA"}

package/dist/index.js

@@ -15,7 +15,7 @@ var sha256 = (value) => createHash("sha256").update(value).digest("hex");
 var canonicalChecksum = (value) => sha256(canonicalStringify(value));
 //#endregion
 //#region src/resources.ts
-var scopes = /* @__PURE__ */ new Set([
+var scopes$1 = /* @__PURE__ */ new Set([
 	"global",
 	"tenant",
 	"filesystem"
@@ -28,7 +28,7 @@ var assertName = (value, label) => {
 	return normalized;
 };
 var assertScope = (scope) => {
-	if (!scopes.has(scope)) throw new Error(`Invalid migration scope: ${String(scope)}`);
+	if (!scopes$1.has(scope)) throw new Error(`Invalid migration scope: ${String(scope)}`);
 };
 var copyDocument = (value) => {
 	if (!value) return void 0;
@@ -196,14 +196,13 @@ var diffMongoResources = (before, after) => {
 		...searchIndexes,
 		...collectionValidators
 	];
-	const offline = changes.some((change) => change.kind !== "added");
 	return {
 		collections,
 		indexes,
 		searchIndexes,
 		collectionValidators,
 		changed: changes.length > 0,
-		mode: offline ? "offline" : "online"
+		requiresContract: changes.some((change) => change.kind !== "added")
 	};
 };
 //#endregion
@@ -215,11 +214,49 @@ var scopeRank = {
 	tenant: 1,
 	filesystem: 2
 };
+var scopes = Object.keys(scopeRank);
+var bootstrapIntegrity = canonicalChecksum({
+	operation: "bootstrap-mongo-resources",
+	protocolVersion: 2,
+	revision: 1
+});
+var hasResources = (resources) => resources.collections.length > 0 || resources.indexes.length > 0 || resources.searchIndexes.length > 0 || resources.collectionValidators.length > 0;
+var bootstrapId = (scope) => `00000000-bootstrap-${scope}`;
+var runResourceBootstrap = async ({ helpers, resources }) => {
+	if (!resources) throw new Error("Missing bootstrap resource snapshot");
+	for (const index of resources.after.indexes) {
+		if (index.options?.unique !== true) continue;
+		const sparseFilter = index.options.sparse === true ? { $or: Object.keys(index.key).map((field) => ({ [field]: { $exists: true } })) } : void 0;
+		const partialFilter = index.options.partialFilterExpression;
+		const filter = sparseFilter && partialFilter ? { $and: [partialFilter, sparseFilter] } : partialFilter ?? sparseFilter;
+		const duplicates = await helpers.findDuplicateKeys(index.collection, index.key, {
+			...filter ? { filter } : {},
+			...index.options.collation ? { collation: index.options.collation } : {}
+		});
+		if (duplicates.length > 0) throw new Error(`Cannot create unique index ${index.collection}.${index.name}: duplicate keys found: ${JSON.stringify(duplicates)}`);
+	}
+	await helpers.reconcileResources(resources.after);
+};
+var createResourceBootstraps = (source, baseline) => scopes.flatMap((scope) => {
+	if (!hasResources(filterMongoResources(baseline, scope))) return [];
+	const id = bootstrapId(scope);
+	if (source.migrations.some((migration) => migration.id === id)) throw new Error(`Migration id ${id} is reserved for the ${source.name} resource bootstrap`);
+	return [Object.freeze({
+		id,
+		scope,
+		phase: "expand",
+		resources: Object.freeze({
+			before: null,
+			after: baseline.checksum
+		}),
+		up: runResourceBootstrap,
+		__rpcbaseIntegrity: bootstrapIntegrity
+	})];
+});
 var assertMigration = (migration) => {
 	if (!migrationIdPattern.test(migration.id)) throw new Error(`Invalid migration id "${migration.id}"`);
 	if (!(migration.scope in scopeRank)) throw new Error(`Invalid migration scope for ${migration.id}`);
-	if (migration.mode !== "online" && migration.mode !== "offline") throw new Error(`Invalid migration mode for ${migration.id}`);
-	if (migration.rollback !== void 0 && migration.rollback !== "compatible" && migration.rollback !== "incompatible") throw new Error(`Invalid migration rollback compatibility for ${migration.id}`);
+	if (migration.phase !== "expand" && migration.phase !== "contract") throw new Error(`Invalid migration phase for ${migration.id}`);
 	if (typeof migration.up !== "function") throw new Error(`Migration ${migration.id} is missing up()`);
 	if (migration.resources && migration.resources.before === migration.resources.after) throw new Error(`Migration ${migration.id} has an unchanged resource transition`);
 };
@@ -227,7 +264,6 @@ var defineMigration = (migration) => {
 	assertMigration(migration);
 	return Object.freeze({
 		...migration,
-		rollback: migration.rollback ?? (migration.mode === "online" ? "compatible" : "incompatible"),
 		dependsOn: Object.freeze([...migration.dependsOn ?? []]),
 		...migration.resources ? { resources: Object.freeze({ ...migration.resources }) } : {}
 	});
@@ -235,6 +271,7 @@ var defineMigration = (migration) => {
 var defineMigrationSource = (source) => {
 	const name = source.name.trim();
 	if (!sourceNamePattern.test(name)) throw new Error(`Invalid migration source name "${source.name}"`);
+	if (source.baseline === void 0 !== (source.resources === void 0)) throw new Error(`Migration source ${name} must declare baseline and resources together`);
 	let previousId = null;
 	const ids = /* @__PURE__ */ new Set();
 	for (const migration of source.migrations) {
@@ -262,8 +299,7 @@ var migrationChecksum = (migration, source) => {
 			id: migration.id,
 			source: source.name,
 			scope: migration.scope,
-			mode: migration.mode,
-			rollback: migration.rollback ?? (migration.mode === "online" ? "compatible" : "incompatible"),
+			phase: migration.phase,
 			dependsOn: migration.dependsOn ?? [],
 			resources: migration.resources ?? null,
 			codeChecksum
@@ -309,12 +345,18 @@ var compileMigrationRegistry = (inputSources, options = {}) => {
 		if (sourceNames.has(source.name)) throw new Error(`Duplicate migration source: ${source.name}`);
 		sourceNames.add(source.name);
 		const snapshots = /* @__PURE__ */ new Map();
-		for (const snapshot of [...source.resourceSnapshots ?? [], ...source.resources ? [source.resources] : []]) {
+		for (const snapshot of [
+			...source.baseline ? [source.baseline] : [],
+			...source.resourceSnapshots ?? [],
+			...source.resources ? [source.resources] : []
+		]) {
 			const normalized = defineMongoResources(snapshot);
 			if (normalized.checksum !== snapshot.checksum) throw new Error(`Invalid resource snapshot checksum in ${source.name}: ${snapshot.checksum}`);
 			snapshots.set(normalized.checksum, normalized);
 		}
-		const sourceMigrations = source.migrations.map((migration, sourcePosition) => {
+		const baseline = source.baseline ? snapshots.get(source.baseline.checksum) : void 0;
+		const currentResources = source.resources ? snapshots.get(source.resources.checksum) : void 0;
+		const sourceMigrations = [...baseline ? createResourceBootstraps(source, baseline) : [], ...source.migrations].map((migration, sourcePosition) => {
 			if (migration.resources) {
 				if (migration.resources.before && !snapshots.has(migration.resources.before)) throw new Error(`Missing before resource snapshot for ${source.name}:${migration.id}`);
 				if (!snapshots.has(migration.resources.after)) throw new Error(`Missing after resource snapshot for ${source.name}:${migration.id}`);
@@ -328,14 +370,13 @@ var compileMigrationRegistry = (inputSources, options = {}) => {
 				sourcePosition,
 				sourcePriority: priority,
 				dependsOn: Object.freeze((migration.dependsOn ?? []).map((id) => resolveDependencyId(source.name, id))),
-				rollback: migration.rollback ?? (migration.mode === "online" ? "compatible" : "incompatible"),
 				checksum: integrity.checksum,
 				sealed: integrity.sealed
 			});
 			migrations.push(compiled);
 			return compiled;
 		});
-		for (const scope of Object.keys(scopeRank)) {
+		for (const scope of scopes) {
 			let previousChecksum = null;
 			let previousResources = defineMongoResources();
 			for (const migration of sourceMigrations.filter((item) => item.scope === scope && item.resources)) {
@@ -346,8 +387,8 @@ var compileMigrationRegistry = (inputSources, options = {}) => {
 				previousChecksum = transition.after;
 				previousResources = snapshots.get(previousChecksum) ?? defineMongoResources();
 			}
-			const currentForScope = source.resources ? filterMongoResources(source.resources, scope) : defineMongoResources();
-			if (currentForScope.collections.length > 0 || currentForScope.indexes.length > 0 || currentForScope.searchIndexes.length > 0 || currentForScope.collectionValidators.length > 0 || previousChecksum) {
+			const currentForScope = currentResources ? filterMongoResources(currentResources, scope) : defineMongoResources();
+			if (hasResources(currentForScope) || previousChecksum) {
 				if (!previousChecksum) throw new Error(`Source ${source.name} has unmanaged ${scope} resources without a migration`);
 				const previousSnapshot = snapshots.get(previousChecksum);
 				if (!previousSnapshot || filterMongoResources(previousSnapshot, scope).checksum !== currentForScope.checksum) throw new Error(`Latest ${scope} resource transition for ${source.name} does not match current resources`);
@@ -355,6 +396,8 @@ var compileMigrationRegistry = (inputSources, options = {}) => {
 		}
 		compiledSources.push(Object.freeze({
 			...source,
+			...baseline ? { baseline } : {},
+			...currentResources ? { resources: currentResources } : {},
 			priority,
 			migrations: Object.freeze(sourceMigrations),
 			resourceSnapshots: snapshots
@@ -368,7 +411,7 @@ var compileMigrationRegistry = (inputSources, options = {}) => {
 	}
 	mergeMongoResources(compiledSources.flatMap((source) => source.resources ? [source.resources] : []));
 	return Object.freeze({
-		protocolVersion: 1,
+		protocolVersion: 2,
 		sources: Object.freeze(compiledSources),
 		migrations: ordered,
 		migrationsById,
@@ -918,8 +961,7 @@ var toPlanItem = (migration) => ({
 	checksum: migration.checksum,
 	source: migration.source,
 	scope: migration.scope,
-	mode: migration.mode,
-	rollback: migration.rollback,
+	phase: migration.phase,
 	dependsOn: migration.dependsOn
 });
 var historyById = (history) => new Map(history.map((record) => [record._id, record]));
@@ -930,8 +972,7 @@ var validateKnownRecord = (migration, record, targetScope) => {
 	if (record.sourcePosition !== migration.sourcePosition) errors.push(`${migration.qualifiedId}: source position differs`);
 	if (record.scope !== migration.scope) errors.push(`${migration.qualifiedId}: scope differs`);
 	if (migration.scope !== targetScope) errors.push(`${migration.qualifiedId}: migration history is stored in a ${targetScope} database`);
-	if (record.mode !== migration.mode) errors.push(`${migration.qualifiedId}: mode differs`);
-	if (record.rollback !== migration.rollback) errors.push(`${migration.qualifiedId}: rollback compatibility differs`);
+	if (record.phase !== migration.phase) errors.push(`${migration.qualifiedId}: phase differs`);
 	if (![
 		"running",
 		"applied",
@@ -986,7 +1027,7 @@ var planMigrationTarget = async (registry, target, options = {}) => {
 			continue;
 		}
 		unknown.push(record._id);
-		if (!(options.rollback && record.status === "applied" && record.mode === "online" && record.rollback === "compatible")) integrityErrors.push(`${record._id}: applied migration is absent from the registry`);
+		if (!(options.allowNewerApplied && record.status === "applied" && record.scope === target.scope)) integrityErrors.push(`${record._id}: applied migration is absent from the registry`);
 	}
 	integrityErrors.push(...validateSourcePrefixes(registry, target.scope, records));
 	const applied = relevant.filter((migration) => records.get(migration.qualifiedId)?.status === "applied").map((migration) => migration.qualifiedId);
@@ -994,7 +1035,7 @@ var planMigrationTarget = async (registry, target, options = {}) => {
 	const running = relevant.filter((migration) => records.get(migration.qualifiedId)?.status === "running").map((migration) => migration.qualifiedId);
 	const failed = relevant.filter((migration) => records.get(migration.qualifiedId)?.status === "failed").map((migration) => migration.qualifiedId);
 	const expectedResources = getExpectedResources(registry, target.scope, history);
-	const resourceDivergences = await inspectMongoResources(target.db, expectedResources, {
+	const resourceDivergences = options.allowNewerApplied && unknown.length > 0 ? [] : await inspectMongoResources(target.db, expectedResources, {
 		signal,
 		requireSearchReady: true
 	});
@@ -1041,13 +1082,10 @@ var planMigrations = async (registry, provider, options = {}) => {
 	const databases = [];
 	for (const target of targets) databases.push(await planMigrationTarget(registry, target, options));
 	return {
-		protocolVersion: 1,
+		protocolVersion: 2,
 		registryChecksum: registry.checksum,
 		databases,
 		hasPending: databases.some((database) => database.pending.length > 0 || database.running.length > 0 || database.failed.length > 0),
-		hasOffline: databases.some((database) => database.pending.some((migration) => migration.mode === "offline") || [...database.running, ...database.failed].some((id) => registry.migrationsById.get(id)?.mode === "offline")),
-		hasRollbackIncompatible: databases.some((database) => database.pending.some((migration) => migration.rollback === "incompatible") || [...database.running, ...database.failed].some((id) => registry.migrationsById.get(id)?.rollback === "incompatible")),
-		hasAppliedRollbackIncompatible: databases.some((database) => database.applied.some((id) => registry.migrationsById.get(id)?.rollback === "incompatible")),
 		hasErrors: databases.some((database) => database.integrityErrors.length > 0 || database.running.length === 0 && database.failed.length === 0 && database.resourceDivergences.some((divergence) => divergence.code !== "runtime_index_options_mismatch"))
 	};
 };
@@ -1207,8 +1245,7 @@ var recordForMigration = (migration, lock, attempt, release) => ({
 	source: migration.source,
 	sourcePosition: migration.sourcePosition,
 	scope: migration.scope,
-	mode: migration.mode,
-	rollback: migration.rollback,
+	phase: migration.phase,
 	status: "running",
 	attempt,
 	...migration.resources?.before ? { resourcesBeforeHash: migration.resources.before } : {},
@@ -1368,7 +1405,6 @@ var runTarget = async (registry, target, lock, signal, options, earlierScopeDepe
 	const applied = new Set(plan.applied);
 	const migrationsToRun = registry.migrations.filter((migration) => migration.scope === target.scope && !applied.has(migration.qualifiedId));
 	for (const migration of migrationsToRun) {
-		if (migration.mode === "offline" && !options.allowOffline) continue;
 		if (!sourcePredecessorsApplied(registry, migration, applied)) continue;
 		let dependenciesReady = true;
 		for (const dependencyId of migration.dependsOn) {
@@ -1461,7 +1497,6 @@ var runMigrations = async (registry, provider, options = {}) => {
 var initializeTenantMigrations = async (registry, provider, tenantId, options = {}) => await runMigrations(registry, provider, {
 	...options,
 	tenantId,
-	allowOffline: true,
 	initializeTenant: true
 });
 //#endregion
@@ -1577,7 +1612,6 @@ var testMigrationRegistry = async (options) => {
 			provisioningStatus: "active"
 		});
 		await runMigrations(options.registry, provider, {
-			allowOffline: true,
 			concurrency: 1,
 			signal: options.signal
 		});
@@ -1587,7 +1621,7 @@ var testMigrationRegistry = async (options) => {
 			migrations: [defineMigration({
 				id: "20000101000000-checkpoint-recovery",
 				scope: "global",
-				mode: "online",
+				phase: "expand",
 				async up({ checkpoint }) {
 					if (checkpoint.value === 1) return;
 					await checkpoint.save(1);