@mikro-orm/core 7.0.0-dev.33 → 7.0.0-dev.331

package/utils/AbstractMigrator.d.ts

@@ -0,0 +1,101 @@
+import type { Constructor, IMigrationGenerator, IMigrationRunner, IMigrator, IMigratorStorage, MaybePromise, Migration, MigrationInfo, MigrationRow, MigratorEvent } from '../typings.js';
+import type { Transaction } from '../connections/Connection.js';
+import type { Configuration, MigrationsOptions } from './Configuration.js';
+import type { EntityManagerType, IDatabaseDriver } from '../drivers/IDatabaseDriver.js';
+interface RunnableMigration {
+    name: string;
+    path?: string;
+    up: () => MaybePromise<void>;
+    down: () => MaybePromise<void>;
+}
+type MigrateOptions = {
+    from?: string | number;
+    to?: string | number;
+    migrations?: string[];
+    transaction?: Transaction;
+};
+export declare abstract class AbstractMigrator<D extends IDatabaseDriver> implements IMigrator {
+    #private;
+    protected readonly em: D[typeof EntityManagerType];
+    protected runner: IMigrationRunner;
+    protected storage: IMigratorStorage;
+    protected generator: IMigrationGenerator;
+    protected readonly driver: D;
+    protected readonly config: Configuration;
+    protected readonly options: MigrationsOptions;
+    protected absolutePath: string;
+    protected initialized: boolean;
+    constructor(em: D[typeof EntityManagerType]);
+    protected abstract createRunner(): IMigrationRunner;
+    protected abstract createStorage(): IMigratorStorage;
+    protected abstract getDefaultGenerator(): IMigrationGenerator;
+    abstract create(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<{
+        fileName: string;
+        code: string;
+        diff: {
+            up: string[];
+            down: string[];
+        };
+    }>;
+    abstract checkSchema(): Promise<boolean>;
+    abstract createInitial(path?: string, name?: string, blank?: boolean): Promise<{
+        fileName: string;
+        code: string;
+        diff: {
+            up: string[];
+            down: string[];
+        };
+    }>;
+    /**
+     * @inheritDoc
+     */
+    on(eventName: MigratorEvent, listener: (event: MigrationInfo) => MaybePromise<void>): this;
+    /**
+     * @inheritDoc
+     */
+    off(eventName: MigratorEvent, listener: (event: MigrationInfo) => MaybePromise<void>): this;
+    /**
+     * @inheritDoc
+     */
+    getExecuted(): Promise<MigrationRow[]>;
+    /**
+     * @inheritDoc
+     */
+    getPending(): Promise<MigrationInfo[]>;
+    /**
+     * @inheritDoc
+     */
+    up(options?: string | string[] | MigrateOptions): Promise<MigrationInfo[]>;
+    /**
+     * @inheritDoc
+     */
+    down(options?: string | string[] | Omit<MigrateOptions, 'from'>): Promise<MigrationInfo[]>;
+    abstract getStorage(): IMigratorStorage;
+    protected init(): Promise<void>;
+    protected initServices(): void;
+    protected resolve(params: {
+        name: string;
+        path: string;
+    }): RunnableMigration;
+    protected initialize(MigrationClass: Constructor<Migration>, name: string): RunnableMigration;
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    private detectSourceFolder;
+    private registerDefaultListeners;
+    private emit;
+    private discoverMigrations;
+    private executeMigrations;
+    private filterUp;
+    private filterDown;
+    private getMigrationFilename;
+    private prefix;
+    protected runMigrations(method: 'up' | 'down', options?: string | string[] | MigrateOptions): Promise<MigrationInfo[]>;
+    private runInTransaction;
+}
+export {};

package/utils/AbstractMigrator.js

@@ -0,0 +1,303 @@
+import { Utils } from './Utils.js';
+export class AbstractMigrator {
+    em;
+    runner;
+    storage;
+    generator;
+    driver;
+    config;
+    options;
+    absolutePath;
+    initialized = false;
+    #listeners = new Map();
+    constructor(em) {
+        this.em = em;
+        this.driver = this.em.getDriver();
+        this.config = this.em.config;
+        this.options = this.config.get('migrations');
+        this.initServices();
+        this.registerDefaultListeners();
+    }
+    /**
+     * @inheritDoc
+     */
+    on(eventName, listener) {
+        if (!this.#listeners.has(eventName)) {
+            this.#listeners.set(eventName, new Set());
+        }
+        this.#listeners.get(eventName).add(listener);
+        return this;
+    }
+    /**
+     * @inheritDoc
+     */
+    off(eventName, listener) {
+        this.#listeners.get(eventName)?.delete(listener);
+        return this;
+    }
+    /**
+     * @inheritDoc
+     */
+    async getExecuted() {
+        await this.init();
+        return this.storage.getExecutedMigrations();
+    }
+    /**
+     * @inheritDoc
+     */
+    async getPending() {
+        await this.init();
+        const all = await this.discoverMigrations();
+        const executed = new Set(await this.storage.executed());
+        return all.filter(m => !executed.has(m.name)).map(m => ({ name: m.name, path: m.path }));
+    }
+    /**
+     * @inheritDoc
+     */
+    async up(options) {
+        return this.runMigrations('up', options);
+    }
+    /**
+     * @inheritDoc
+     */
+    async down(options) {
+        return this.runMigrations('down', options);
+    }
+    async init() {
+        if (this.initialized) {
+            return;
+        }
+        this.initialized = true;
+        if (!this.options.migrationsList) {
+            const { fs } = await import('@mikro-orm/core/fs-utils');
+            this.detectSourceFolder(fs);
+            /* v8 ignore next */
+            const key = this.config.get('preferTs', Utils.detectTypeScriptSupport()) && this.options.pathTs ? 'pathTs' : 'path';
+            this.absolutePath = fs.absolutePath(this.options[key], this.config.get('baseDir'));
+            fs.ensureDir(this.absolutePath);
+        }
+    }
+    initServices() {
+        this.runner = this.createRunner();
+        this.storage = this.createStorage();
+        if (this.options.generator) {
+            this.generator = new this.options.generator(this.driver, this.config.getNamingStrategy(), this.options);
+        }
+        else {
+            this.generator = this.getDefaultGenerator();
+        }
+    }
+    resolve(params) {
+        const createMigrationHandler = async (method) => {
+            const { fs } = await import('@mikro-orm/core/fs-utils');
+            const migration = await fs.dynamicImport(params.path);
+            const MigrationClass = Object.values(migration).find(cls => typeof cls === 'function' && typeof cls.constructor === 'function');
+            const instance = new MigrationClass(this.driver, this.config);
+            await this.runner.run(instance, method);
+        };
+        return {
+            name: this.storage.getMigrationName(params.name),
+            path: params.path,
+            up: () => createMigrationHandler('up'),
+            down: () => createMigrationHandler('down'),
+        };
+    }
+    initialize(MigrationClass, name) {
+        const instance = new MigrationClass(this.driver, this.config);
+        return {
+            name: this.storage.getMigrationName(name),
+            up: () => this.runner.run(instance, 'up'),
+            down: () => this.runner.run(instance, 'down'),
+        };
+    }
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    detectSourceFolder(fs) {
+        const baseDir = this.config.get('baseDir');
+        const defaultPath = './migrations';
+        if (!fs.pathExists(baseDir + '/src')) {
+            this.options.path ??= defaultPath;
+            return;
+        }
+        const exists = fs.pathExists(`${baseDir}/${defaultPath}`);
+        const distDir = fs.pathExists(baseDir + '/dist');
+        const buildDir = fs.pathExists(baseDir + '/build');
+        // if neither `dist` nor `build` exist, we use the `src` folder as it might be a JS project without building, but with `src` folder
+        /* v8 ignore next */
+        const path = distDir ? './dist' : buildDir ? './build' : './src';
+        // only if the user did not provide any values and if the default path does not exist
+        if (!this.options.path && !this.options.pathTs && !exists) {
+            this.options.path = `${path}/migrations`;
+            this.options.pathTs = './src/migrations';
+        }
+    }
+    registerDefaultListeners() {
+        /* v8 ignore else */
+        if (!this.options.silent) {
+            const logger = this.config.getLogger();
+            this.on('migrating', event => logger.log('migrator', `Processing '${event.name}'`, { enabled: true }));
+            this.on('migrated', event => logger.log('migrator', `Applied '${event.name}'`, { enabled: true }));
+            this.on('reverting', event => logger.log('migrator', `Processing '${event.name}'`, { enabled: true }));
+            this.on('reverted', event => logger.log('migrator', `Reverted '${event.name}'`, { enabled: true }));
+        }
+    }
+    async emit(event, data) {
+        for (const listener of this.#listeners.get(event) ?? []) {
+            await listener(data);
+        }
+    }
+    async discoverMigrations() {
+        if (this.options.migrationsList) {
+            return this.options.migrationsList.map(migration => {
+                if (typeof migration === 'function') {
+                    return this.initialize(migration, migration.name);
+                }
+                return this.initialize(migration.class, migration.name);
+            });
+        }
+        const { fs } = await import('@mikro-orm/core/fs-utils');
+        const pattern = fs.normalizePath(this.absolutePath, this.options.glob);
+        const files = fs.glob(pattern).sort();
+        return files.map(filePath => this.resolve({
+            name: filePath.replace(/\\/g, '/').split('/').pop(),
+            path: filePath,
+        }));
+    }
+    async executeMigrations(method, options = {}) {
+        const all = await this.discoverMigrations();
+        const executed = await this.storage.executed();
+        const executedSet = new Set(executed);
+        let toRun;
+        if (method === 'up') {
+            toRun = this.filterUp(all, executedSet, options);
+        }
+        else {
+            toRun = this.filterDown(all, executed, options);
+        }
+        const result = [];
+        const eventBefore = method === 'up' ? 'migrating' : 'reverting';
+        const eventAfter = method === 'up' ? 'migrated' : 'reverted';
+        for (const migration of toRun) {
+            const event = { name: migration.name, path: migration.path };
+            await this.emit(eventBefore, event);
+            await migration[method]();
+            if (method === 'up') {
+                await this.storage.logMigration({ name: migration.name });
+            }
+            else {
+                await this.storage.unlogMigration({ name: migration.name });
+            }
+            await this.emit(eventAfter, event);
+            result.push(event);
+        }
+        return result;
+    }
+    filterUp(all, executed, options) {
+        let pending = all.filter(m => !executed.has(m.name));
+        if (options.migrations) {
+            const set = new Set(options.migrations);
+            return pending.filter(m => set.has(m.name));
+        }
+        if (options.from) {
+            const idx = all.findIndex(m => m.name === options.from);
+            if (idx >= 0) {
+                const names = new Set(all.slice(idx + 1).map(m => m.name));
+                pending = pending.filter(m => names.has(m.name));
+            }
+        }
+        if (options.to && typeof options.to === 'string') {
+            const idx = all.findIndex(m => m.name === options.to);
+            if (idx >= 0) {
+                const names = new Set(all.slice(0, idx + 1).map(m => m.name));
+                pending = pending.filter(m => names.has(m.name));
+            }
+        }
+        return pending;
+    }
+    filterDown(all, executed, options) {
+        const migrationMap = new Map(all.map(m => [m.name, m]));
+        const executedReversed = [...executed].reverse();
+        if (options.migrations) {
+            const set = new Set(options.migrations);
+            return executedReversed
+                .filter(name => set.has(name))
+                .map(name => migrationMap.get(name))
+                .filter(Boolean);
+        }
+        if (options.to === 0) {
+            return executedReversed.map(name => migrationMap.get(name)).filter(Boolean);
+        }
+        if (options.to) {
+            const result = [];
+            for (const name of executedReversed) {
+                if (name === String(options.to)) {
+                    break;
+                }
+                const m = migrationMap.get(name);
+                if (m) {
+                    result.push(m);
+                }
+            }
+            return result;
+        }
+        // Default: revert last 1
+        if (executedReversed.length > 0) {
+            const m = migrationMap.get(executedReversed[0]);
+            return m ? [m] : [];
+        }
+        return [];
+    }
+    getMigrationFilename(name) {
+        name = name.replace(/\.[jt]s$/, '');
+        return /^\d{14}$/.exec(name) ? this.options.fileName(name) : name;
+    }
+    prefix(options) {
+        if (typeof options === 'string' || Array.isArray(options)) {
+            return { migrations: Utils.asArray(options).map(name => this.getMigrationFilename(name)) };
+        }
+        if (!options) {
+            return {};
+        }
+        const result = {};
+        if (options.migrations) {
+            result.migrations = options.migrations.map(name => this.getMigrationFilename(name));
+        }
+        if (options.from) {
+            result.from = this.getMigrationFilename(String(options.from));
+        }
+        if (options.to && options.to !== 0) {
+            result.to = this.getMigrationFilename(String(options.to));
+        }
+        else if (options.to === 0) {
+            result.to = 0;
+        }
+        return result;
+    }
+    async runMigrations(method, options) {
+        await this.init();
+        if (!this.options.transactional || !this.options.allOrNothing) {
+            return this.executeMigrations(method, this.prefix(options));
+        }
+        if (Utils.isObject(options) && options.transaction) {
+            return this.runInTransaction(options.transaction, method, options);
+        }
+        return this.driver.getConnection().transactional(trx => this.runInTransaction(trx, method, options));
+    }
+    async runInTransaction(trx, method, options) {
+        this.runner.setMasterMigration(trx);
+        this.storage.setMasterMigration(trx);
+        try {
+            return await this.executeMigrations(method, this.prefix(options));
+        }
+        finally {
+            this.runner.unsetMasterMigration();
+            this.storage.unsetMasterMigration();
+        }
+    }
+}

package/utils/AbstractSchemaGenerator.d.ts

@@ -10,18 +10,18 @@ export declare abstract class AbstractSchemaGenerator<D extends IDatabaseDriver>
     protected readonly platform: ReturnType<D['getPlatform']>;
     protected readonly connection: ReturnType<D['getConnection']>;
     constructor(em: D | D[typeof EntityManagerType]);
-    createSchema(options?: CreateSchemaOptions): Promise<void>;
+    create(options?: CreateSchemaOptions): Promise<void>;
     /**
      * Returns true if the database was created.
      */
     ensureDatabase(options?: EnsureDatabaseOptions): Promise<boolean>;
-    refreshDatabase(options?: RefreshDatabaseOptions): Promise<void>;
-    clearDatabase(options?: ClearDatabaseOptions): Promise<void>;
+    refresh(options?: RefreshDatabaseOptions): Promise<void>;
+    clear(options?: ClearDatabaseOptions): Promise<void>;
     protected clearIdentityMap(): void;
     getCreateSchemaSQL(options?: CreateSchemaOptions): Promise<string>;
-    dropSchema(options?: DropSchemaOptions): Promise<void>;
+    drop(options?: DropSchemaOptions): Promise<void>;
     getDropSchemaSQL(options?: Omit<DropSchemaOptions, 'dropDb'>): Promise<string>;
-    updateSchema(options?: UpdateSchemaOptions): Promise<void>;
+    update(options?: UpdateSchemaOptions): Promise<void>;
     getUpdateSchemaSQL(options?: UpdateSchemaOptions): Promise<string>;
     getUpdateSchemaMigrationSQL(options?: UpdateSchemaOptions): Promise<{
         up: string;

package/utils/AbstractSchemaGenerator.js

@@ -15,7 +15,7 @@ export class AbstractSchemaGenerator {
         this.platform = this.driver.getPlatform();
         this.connection = this.driver.getConnection();
     }
-    async createSchema(options) {
+    async create(options) {
         this.notImplemented();
     }
     /**
@@ -24,7 +24,7 @@ export class AbstractSchemaGenerator {
     async ensureDatabase(options) {
         this.notImplemented();
     }
-    async refreshDatabase(options) {
+    async refresh(options) {
         if (options?.dropDb) {
             const name = this.config.get('dbName');
             await this.dropDatabase(name);
@@ -32,20 +32,22 @@ export class AbstractSchemaGenerator {
         }
         else {
             await this.ensureDatabase();
-            await this.dropSchema(options);
+            await this.drop(options);
         }
         if (options?.createSchema !== false) {
-            await this.createSchema(options);
+            await this.create(options);
         }
     }
-    async clearDatabase(options) {
+    async clear(options) {
         for (const meta of this.getOrderedMetadata(options?.schema).reverse()) {
-            await this.driver.nativeDelete(meta.className, {}, options);
+            await this.driver.nativeDelete(meta.class, {}, options);
+        }
+        if (options?.clearIdentityMap ?? true) {
+            this.clearIdentityMap();
         }
-        this.clearIdentityMap();
     }
     clearIdentityMap() {
-        /* v8 ignore next 3 */
+        /* v8 ignore next */
         if (!this.em) {
             return;
         }
@@ -57,13 +59,13 @@ export class AbstractSchemaGenerator {
     async getCreateSchemaSQL(options) {
         this.notImplemented();
     }
-    async dropSchema(options) {
+    async drop(options) {
         this.notImplemented();
     }
     async getDropSchemaSQL(options) {
         this.notImplemented();
     }
-    async updateSchema(options) {
+    async update(options) {
         this.notImplemented();
     }
     async getUpdateSchemaSQL(options) {
@@ -88,21 +90,31 @@ export class AbstractSchemaGenerator {
         this.notImplemented();
     }
     getOrderedMetadata(schema) {
-        const metadata = Object.values(this.metadata.getAll()).filter(meta => {
-            const isRootEntity = meta.root.className === meta.className;
-            return isRootEntity && !meta.embeddable && !meta.virtual;
+        const metadata = [...this.metadata.getAll().values()].filter(meta => {
+            const isRootEntity = meta.root.class === meta.class;
+            const isTPTChild = meta.inheritanceType === 'tpt' && meta.tptParent;
+            return (isRootEntity || isTPTChild) && !meta.embeddable && !meta.virtual;
         });
         const calc = new CommitOrderCalculator();
-        metadata.forEach(meta => calc.addNode(meta.root.className));
+        metadata.forEach(meta => {
+            const nodeId = meta.inheritanceType === 'tpt' && meta.tptParent ? meta._id : meta.root._id;
+            calc.addNode(nodeId);
+        });
         let meta = metadata.pop();
         while (meta) {
-            for (const prop of meta.props) {
-                calc.discoverProperty(prop, meta.root.className);
+            const nodeId = meta.inheritanceType === 'tpt' && meta.tptParent ? meta._id : meta.root._id;
+            for (const prop of meta.relations) {
+                calc.discoverProperty(prop, nodeId);
+            }
+            if (meta.inheritanceType === 'tpt' && meta.tptParent) {
+                const parentId = meta.tptParent._id;
+                calc.addDependency(parentId, nodeId, 1);
             }
             meta = metadata.pop();
         }
-        return calc.sort()
-            .map(cls => this.metadata.find(cls))
+        return calc
+            .sort()
+            .map(cls => this.metadata.getById(cls))
             .filter(meta => {
             const targetSchema = meta.schema ?? this.config.get('schema', this.platform.getDefaultSchemaName());
             return schema ? [schema, '*'].includes(targetSchema) : meta.schema !== '*';

package/utils/AsyncContext.d.ts

@@ -0,0 +1,6 @@
+export interface AsyncContext<T> {
+    getStore(): T | undefined;
+    run<R>(store: T, callback: () => R): R;
+    enterWith(store: T): void;
+}
+export declare function createAsyncContext<T>(): AsyncContext<T>;

package/utils/AsyncContext.js

@@ -0,0 +1,42 @@
+function getNodeAsyncContext() {
+    const mod = globalThis.process?.getBuiltinModule?.('node:async_hooks');
+    /* v8 ignore next */
+    if (!mod?.AsyncLocalStorage) {
+        throw new Error('AsyncLocalStorage not available');
+    }
+    return new mod.AsyncLocalStorage();
+}
+/* v8 ignore next */
+function createFallbackAsyncContext() {
+    let store;
+    // eslint-disable-next-line no-console
+    console.warn('AsyncLocalStorage not available');
+    return {
+        getStore: () => store,
+        enterWith: value => (store = value),
+        run: (value, cb) => {
+            const prev = store;
+            store = value;
+            try {
+                return cb();
+            }
+            finally {
+                store = prev;
+            }
+        },
+    };
+}
+export function createAsyncContext() {
+    /* v8 ignore next */
+    const ALS = globalThis.AsyncLocalStorage;
+    /* v8 ignore next */
+    if (typeof ALS === 'function' && ALS.prototype?.run) {
+        return new ALS();
+    }
+    /* v8 ignore else */
+    if (globalThis.process?.versions?.node) {
+        return getNodeAsyncContext();
+    }
+    /* v8 ignore next */
+    return createFallbackAsyncContext();
+}