@contember/engine-system-api 1.2.0 → 1.3.0-alpha.13

package/src/model/metadata/index.ts

@@ -0,0 +1,3 @@
+export * from './SchemaDatabaseMetadataResolver'
+export * from './SchemaDatabaseMetadataResolverStore'
+export { ResolvedDatabaseMetadata } from './ResolvedDatabaseMetadata'

package/src/model/migrations/ProjectMigrator.ts

@@ -9,12 +9,17 @@ import { MigrateErrorCode } from '../../schema'
 import { SchemaVersionBuilder } from './SchemaVersionBuilder'
 import { SchemaValidator } from '@contember/schema-utils'
 import { logger } from '@contember/logger'
+import {
+	SchemaDatabaseMetadataResolverStore,
+	MigrationsDatabaseMetadataResolverStoreFactory,
+} from '../metadata/SchemaDatabaseMetadataResolverStore'
 
 export class ProjectMigrator {
 	constructor(
 		private readonly migrationDescriber: MigrationDescriber,
 		private readonly schemaVersionBuilder: SchemaVersionBuilder,
 		private readonly executedMigrationsResolver: ExecutedMigrationsResolver,
+		private readonly migrationsDatabaseMetadataResolverStoreFactory: MigrationsDatabaseMetadataResolverStoreFactory,
 	) {}
 
 	public async migrate(
@@ -29,11 +34,13 @@ export class ProjectMigrator {
 		if (migrationsToExecute.length === 0) {
 			return
 		}
-		let { version, notNormalized, ...schema }  = await this.schemaVersionBuilder.buildSchema(db)
+		let { version, notNormalized, id, ...schema }  = await this.schemaVersionBuilder.buildSchema(db)
 		const validated = await this.validateMigrations(db, schema, version, migrationsToExecute, { ignoreOrder, skipExecuted })
 
 		const sorted = [...validated].sort((a, b) => a.version.localeCompare(b.version))
 
+		const metadataStore = this.migrationsDatabaseMetadataResolverStoreFactory.create(db)
+
 		for (const migration of sorted) {
 			const formatVersion = migration.formatVersion
 
@@ -46,6 +53,7 @@ export class ProjectMigrator {
 					formatVersion,
 					migration.version,
 					db.client.schema,
+					metadataStore,
 				)
 			}
 			await db.commandBus.execute(new SaveMigrationCommand(migration))
@@ -76,7 +84,7 @@ export class ProjectMigrator {
 			if (migration.version < version && !ignoreOrder) {
 				throw new MustFollowLatestMigrationError(migration.version, `Must follow latest executed migration ${version}`)
 			}
-			const described = await this.migrationDescriber.describeModifications(schema, migration, 'system') // system schema name not important here
+			const described = this.migrationDescriber.describeModifications(schema, migration)
 			if (described.length === 0) {
 				continue
 			}
@@ -112,13 +120,19 @@ export class ProjectMigrator {
 		formatVersion: number,
 		migrationVersion: string,
 		systemSchema: string,
+		metadataStore: SchemaDatabaseMetadataResolverStore,
 	): Promise<[Schema]> {
 		const {
-			sql,
+			getSql,
 			schema: newSchema,
-			handler,
-		} = await this.migrationDescriber.describeModification(schema, modification, { systemSchema, formatVersion })
+		} = this.migrationDescriber.describeModification(schema, modification, { formatVersion })
 		for (const stage of stages) {
+			const databaseMetadata = await metadataStore.getMetadata(stage.schema)
+			const sql = getSql({
+				systemSchema,
+				databaseMetadata,
+				invalidateDatabaseMetadata: () => metadataStore.invalidate(stage.schema),
+			})
 			await this.executeOnStage(db, stage, sql, migrationVersion)
 		}
 		return [newSchema]

package/src/model/migrations/SchemaVersionBuilder.ts

@@ -5,9 +5,9 @@ import { ExecutedMigrationsResolver } from './ExecutedMigrationsResolver'
 import { DatabaseContext } from '../database'
 import { normalizeSchema } from '@contember/schema-utils'
 
-export type VersionedSchema = Schema & { version: string; notNormalized: Schema & { version: string } }
+export type VersionedSchema = Schema & { version: string; id: number; notNormalized: Schema & { version: string; id: number } }
 
-const emptyVersionedSchema = { ...normalizeSchema(emptySchema), version: '', notNormalized: { ...emptySchema, version: '' } }
+export const emptyVersionedSchema = { ...normalizeSchema(emptySchema), version: '', id: -1, notNormalized: { ...emptySchema, version: '', id: -1 } }
 
 export class SchemaVersionBuilder {
 	constructor(
@@ -25,6 +25,7 @@ export class SchemaVersionBuilder {
 			(schema, migration) => ({
 				...this.schemaMigrator.applyModifications(schema, migration.modifications, migration.formatVersion),
 				version: migration.version,
+				id: migration.id,
 			}),
 			after?.notNormalized ?? emptyVersionedSchema.notNormalized,
 		)

package/src/model/queries/events/EventQueryHelpers.ts

@@ -1,4 +1,4 @@
-import { AnyEvent, CreateEvent, DeleteEvent, EventType, UpdateEvent } from '@contember/engine-common'
+import { ContentEvent, CreateEvent, DeleteEvent, EventType, UpdateEvent } from '../../events'
 import { assertNever } from '../../../utils'
 
 export type EventRow = {
@@ -13,7 +13,7 @@ export type EventRow = {
 	transaction_id: string
 }
 
-export const createEventsFromRows = (rows: EventRow[]): AnyEvent[] => {
+export const createEventsFromRows = (rows: EventRow[]): ContentEvent[] => {
 	return rows.map(event => {
 		switch (event.type) {
 			case EventType.create:

package/src/model/queries/events/EventsQuery.ts

@@ -6,11 +6,11 @@ import {
 	SelectBuilder,
 	SelectBuilderSpecification, Value,
 } from '@contember/database'
-import { AnyEvent, ContentEvent } from '@contember/engine-common'
+import { ContentEvent } from '../../events'
 import { EventsFilter, EventsFilterDate, EventsOrder } from '../../../schema'
 import { createEventsFromRows, EventRow } from './EventQueryHelpers'
 
-export class EventsQuery extends DatabaseQuery<AnyEvent[]> {
+export class EventsQuery extends DatabaseQuery<ContentEvent[]> {
 	constructor(
 		private readonly filter: EventsFilter,
 		private readonly order: EventsOrder,

package/src/model/queries/migrations/ExecutedMigrationsQueryHelper.ts

@@ -2,9 +2,10 @@ import { SelectBuilder } from '@contember/database'
 import { ExecutedMigration } from '../../dtos'
 import { VERSION_INITIAL } from '@contember/schema-migrations'
 
-type ExecutedMigrationRow = { name: string; migration: any; checksum: string; executed_at: Date }
+type ExecutedMigrationRow = { id: number; name: string; migration: any; checksum: string; executed_at: Date }
 export const createExecutedMigrationQueryBuilder = () =>
 	SelectBuilder.create<ExecutedMigrationRow>()
+		.select('id')
 		.select('name')
 		.select('migration')
 		.select('checksum')
@@ -14,6 +15,7 @@ export const createExecutedMigrationQueryBuilder = () =>
 
 export const createExecutedMigrationDto = (row: ExecutedMigrationRow) =>
 	new ExecutedMigration(
+		row.id,
 		row.name,
 		row.migration.formatVersion || VERSION_INITIAL,
 		row.migration.modifications,

package/src/tsconfig.json

@@ -5,38 +5,15 @@
 		"esModuleInterop": true
 	},
 	"references": [
-		{
-			"path": "../../authorization/src"
-		},
-		{
-			"path": "../../database/src"
-		},
-		{
-			"path": "../../database-migrations/src"
-		},
-		{
-			"path": "../../engine-common/src"
-		},
-		{
-			"path": "../../graphql-utils/src"
-		},
-		{
-			"path": "../../logger/src"
-		},
-		{
-			"path": "../../queryable/src"
-		},
-		{
-			"path": "../../schema/src"
-		},
-		{
-			"path": "../../schema-utils/src"
-		},
-		{
-			"path": "../../schema-migrations/src"
-		},
-		{
-			"path": "../../dic/src"
-		}
+		{ "path": "../../authorization/src" },
+		{ "path": "../../database/src" },
+		{ "path": "../../database-migrations/src" },
+		{ "path": "../../graphql-utils/src" },
+		{ "path": "../../logger/src" },
+		{ "path": "../../queryable/src" },
+		{ "path": "../../schema/src" },
+		{ "path": "../../schema-utils/src" },
+		{ "path": "../../schema-migrations/src" },
+		{ "path": "../../dic/src" }
 	]
 }

package/tests/cases/migrations/2020-05-06-150000-composed-primary.test.ts

@@ -2,12 +2,14 @@ import migration from '../../../src/migrations/2020-05-06-150000-composed-primar
 import { createMigrationBuilder } from '@contember/database-migrations'
 import { sampleProject } from '@contember/engine-api-tester'
 import { test, assert } from 'vitest'
+import { dummySchemaDatabaseMetadata } from '@contember/schema-utils'
 
 test('many-has-many-primary migration sql', async () => {
 	const builder = createMigrationBuilder()
 	await migration(builder, {
 		connection: undefined as any,
 		schemaResolver: () => Promise.resolve(sampleProject),
+		databaseMetadataResolver: () => Promise.resolve(dummySchemaDatabaseMetadata),
 		project: {
 			slug: 'test',
 			stages: [

package/tests/cases/migrations/2020-06-01-103000-event-trigger-perf.test.ts

@@ -2,6 +2,7 @@ import migration from '../../../src/migrations/2020-06-01-103000-event-trigger-p
 import { createMigrationBuilder } from '@contember/database-migrations'
 import { sampleProject } from '@contember/engine-api-tester'
 import { test, assert } from 'vitest'
+import { dummySchemaDatabaseMetadata } from '@contember/schema-utils'
 
 
 test('event-trigger-performance sql', async () => {
@@ -9,6 +10,7 @@ test('event-trigger-performance sql', async () => {
 	await migration(builder, {
 		connection: undefined as any,
 		schemaResolver: () => Promise.resolve(sampleProject),
+		databaseMetadataResolver: () => Promise.resolve(dummySchemaDatabaseMetadata),
 		project: {
 			slug: 'test',
 			stages: [

package/tests/cases/migrations/2022-10-03-110000-table-on-delete.test.ts

@@ -0,0 +1,45 @@
+import migration from '../../../src/migrations/2022-10-03-110000-table-on-delete'
+import { createMigrationBuilder } from '@contember/database-migrations'
+import { assert, test } from 'vitest'
+import { SchemaBuilder } from '@contember/schema-definition'
+import { dummySchemaDatabaseMetadata, emptySchema } from '@contember/schema-utils'
+import { Model } from '@contember/schema'
+import { createConnectionMock } from '@contember/database-tester'
+
+
+test('table-on-delete test', async () => {
+	const builder = createMigrationBuilder()
+	const connection = createConnectionMock([{
+		sql: 'select schema from stage',
+		response: { rows: [{ schema: 'stage_live' }] },
+	}])
+	await migration(builder, {
+		connection: connection,
+		databaseMetadataResolver: () => Promise.resolve(dummySchemaDatabaseMetadata),
+		schemaResolver: () => Promise.resolve(({ ...emptySchema, model: new SchemaBuilder()
+			.entity('Post', entity =>
+				entity.manyHasOne('author', relation => relation.target('Author').onDelete(Model.OnDelete.setNull)),
+			)
+			.entity('Author', entity => entity)
+			.buildSchema() })),
+		project: {
+			slug: 'test',
+			stages: [
+				{
+					slug: 'prod',
+					name: 'prod',
+				},
+			],
+		},
+	})
+	assert.equal(
+		builder.getSql(),
+		`ALTER TABLE "stage_live"."post" DROP CONSTRAINT "fk_post_author_id_author_id";
+ALTER TABLE "stage_live"."post"
+					ADD FOREIGN KEY ("author_id") 
+					REFERENCES "stage_live"."author" ("id") ON DELETE SET NULL DEFERRABLE INITIALLY IMMEDIATE
+				;
+`,
+	)
+})
+

package/tests/tsconfig.json

@@ -5,11 +5,7 @@
 		"esModuleInterop": true
 	},
 	"references": [
-		{
-			"path": "../src"
-		},
-		{
-			"path": "../../engine-api-tester/src"
-		}
+		{ "path": "../src" },
+		{ "path": "../../engine-api-tester/src" }
 	]
 }

package/tsconfig.json

@@ -2,11 +2,7 @@
 	"files": [],
 	"include": [],
 	"references": [
-		{
-			"path": "./src"
-		},
-		{
-			"path": "./tests"
-		}
+		{ "path": "./src" },
+		{ "path": "./tests" }
 	]
 }

package/dist/src/model/helpers/SystemVariablesSetupHelper.d.ts

@@ -1,5 +0,0 @@
-import { Client } from '@contember/database';
-import { UuidProvider } from '../../utils';
-export declare const unnamedIdentity = "00000000-0000-0000-0000-000000000000";
-export declare function setupSystemVariables(db: Client, identityId: string, providers: UuidProvider): Promise<void>;
-//# sourceMappingURL=SystemVariablesSetupHelper.d.ts.map

package/dist/src/model/helpers/SystemVariablesSetupHelper.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SystemVariablesSetupHelper.d.ts","sourceRoot":"","sources":["../../../../src/model/helpers/SystemVariablesSetupHelper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,eAAO,MAAM,eAAe,yCAAyC,CAAA;AAErE,wBAAsB,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,iBAQjG"}

package/dist/src/model/helpers/SystemVariablesSetupHelper.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupSystemVariables = exports.unnamedIdentity = void 0;
-exports.unnamedIdentity = '00000000-0000-0000-0000-000000000000';
-async function setupSystemVariables(db, identityId, providers) {
-    await Promise.all([
-        await db.query('SELECT set_config(?, ?, false)', [
-            'tenant.identity_id',
-            identityId,
-        ]),
-        await db.query('SELECT set_config(?, ?, false)', ['system.transaction_id', providers.uuid()]),
-    ]);
-}
-exports.setupSystemVariables = setupSystemVariables;
-//# sourceMappingURL=SystemVariablesSetupHelper.js.map

package/dist/src/model/helpers/SystemVariablesSetupHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SystemVariablesSetupHelper.js","sourceRoot":"","sources":["../../../../src/model/helpers/SystemVariablesSetupHelper.ts"],"names":[],"mappings":";;;AAGa,QAAA,eAAe,GAAG,sCAAsC,CAAA;AAE9D,KAAK,UAAU,oBAAoB,CAAC,EAAU,EAAE,UAAkB,EAAE,SAAuB;IACjG,MAAM,OAAO,CAAC,GAAG,CAAC;QACjB,MAAM,EAAE,CAAC,KAAK,CAAC,gCAAgC,EAAE;YAChD,oBAAoB;YACpB,UAAU;SACV,CAAC;QACF,MAAM,EAAE,CAAC,KAAK,CAAC,gCAAgC,EAAE,CAAC,uBAAuB,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;KAC7F,CAAC,CAAA;AACH,CAAC;AARD,oDAQC"}

package/dist/tests/cases/integration/systemApi/projectInitializer.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=projectInitializer.test.d.ts.map

package/dist/tests/cases/integration/systemApi/projectInitializer.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"projectInitializer.test.d.ts","sourceRoot":"","sources":["../../../../../tests/cases/integration/systemApi/projectInitializer.test.ts"],"names":[],"mappings":""}

package/dist/tests/cases/integration/systemApi/projectInitializer.test.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const engine_api_tester_1 = require("@contember/engine-api-tester");
-const vitest_1 = require("vitest");
-const logger_1 = require("@contember/logger");
-const logger = (0, logger_1.createLogger)(new logger_1.JsonStreamLoggerHandler(process.stderr));
-(0, vitest_1.test)('create stage', async () => {
-    const prodStage = {
-        name: 'Prod',
-        slug: 'prod',
-    };
-    const project = {
-        slug: 'example-project',
-        stages: [prodStage],
-    };
-    const tester = await engine_api_tester_1.ApiTester.create({
-        project: {
-            stages: [prodStage],
-        },
-    });
-    await tester.systemContainer.projectInitializer.initialize(tester.databaseContextFactory, project, logger);
-    const createdStagesA = await tester.stages.refreshCreatedStages();
-    vitest_1.assert.ok(createdStagesA.has('prod'));
-    await tester.cleanup();
-});
-//# sourceMappingURL=projectInitializer.test.js.map

package/dist/tests/cases/integration/systemApi/projectInitializer.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"projectInitializer.test.js","sourceRoot":"","sources":["../../../../../tests/cases/integration/systemApi/projectInitializer.test.ts"],"names":[],"mappings":";;AAAA,oEAAwD;AAExD,mCAAqC;AACrC,8CAAyE;AAGzE,MAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,IAAI,gCAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;AAExE,IAAA,aAAI,EAAC,cAAc,EAAE,KAAK,IAAI,EAAE;IAC/B,MAAM,SAAS,GAAgB;QAC9B,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,MAAM;KACZ,CAAA;IACD,MAAM,OAAO,GAAkB;QAC9B,IAAI,EAAE,iBAAiB;QACvB,MAAM,EAAE,CAAC,SAAS,CAAC;KACnB,CAAA;IAED,MAAM,MAAM,GAAG,MAAM,6BAAS,CAAC,MAAM,CAAC;QACrC,OAAO,EAAE;YACR,MAAM,EAAE,CAAC,SAAS,CAAC;SACnB;KACD,CAAC,CAAA;IAEF,MAAM,MAAM,CAAC,eAAe,CAAC,kBAAkB,CAAC,UAAU,CAAC,MAAM,CAAC,sBAAsB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC1G,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAA;IACjE,eAAM,CAAC,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;IAErC,MAAM,MAAM,CAAC,OAAO,EAAE,CAAA;AACvB,CAAC,CAAC,CAAA"}

package/src/migrations/2019-03-18-104147-event-run-migration-struct.sql

@@ -1,3 +0,0 @@
-UPDATE event
-SET data = jsonb_build_object('version', coalesce(substring(data ->> 'file', 0, 17), data ->> 'version'))
-WHERE type = 'run_migration';

package/src/migrations/2022-02-08-140500-drop-deadcode.sql

@@ -1,2 +0,0 @@
-DROP FUNCTION rebase_events_unsafe(head UUID, oldbase UUID, newbase UUID, appliedevents UUID[]);
-DROP FUNCTION statement_trigger_event();

package/src/model/helpers/SystemVariablesSetupHelper.ts

@@ -1,14 +0,0 @@
-import { Client } from '@contember/database'
-import { UuidProvider } from '../../utils'
-
-export const unnamedIdentity = '00000000-0000-0000-0000-000000000000'
-
-export async function setupSystemVariables(db: Client, identityId: string, providers: UuidProvider) {
-	await Promise.all([
-		await db.query('SELECT set_config(?, ?, false)', [
-			'tenant.identity_id', // todo rename to system.identity_id
-			identityId,
-		]),
-		await db.query('SELECT set_config(?, ?, false)', ['system.transaction_id', providers.uuid()]),
-	])
-}

package/tests/cases/integration/systemApi/projectInitializer.test.ts

@@ -1,31 +0,0 @@
-import { ApiTester } from '@contember/engine-api-tester'
-import { ProjectConfig, StageConfig } from '../../../../src'
-import { assert, test } from 'vitest'
-import { createLogger, JsonStreamLoggerHandler } from '@contember/logger'
-
-
-const logger = createLogger(new JsonStreamLoggerHandler(process.stderr))
-
-test('create stage', async () => {
-	const prodStage: StageConfig = {
-		name: 'Prod',
-		slug: 'prod',
-	}
-	const project: ProjectConfig = {
-		slug: 'example-project',
-		stages: [prodStage],
-	}
-
-	const tester = await ApiTester.create({
-		project: {
-			stages: [prodStage],
-		},
-	})
-
-	await tester.systemContainer.projectInitializer.initialize(tester.databaseContextFactory, project, logger)
-	const createdStagesA = await tester.stages.refreshCreatedStages()
-	assert.ok(createdStagesA.has('prod'))
-
-	await tester.cleanup()
-})
-