mirror of
https://github.com/n8n-io/n8n.git
synced 2025-03-05 20:50:17 -08:00
109 lines
3.4 KiB
TypeScript
109 lines
3.4 KiB
TypeScript
import { Command, Flags } from '@oclif/core';
|
|
// eslint-disable-next-line n8n-local-rules/misplaced-n8n-typeorm-import
|
|
import type { DataSourceOptions as ConnectionOptions } from '@n8n/typeorm';
|
|
// eslint-disable-next-line n8n-local-rules/misplaced-n8n-typeorm-import
|
|
import { MigrationExecutor, DataSource as Connection } from '@n8n/typeorm';
|
|
import { Container } from 'typedi';
|
|
import { Logger } from '@/logger';
|
|
import { getConnectionOptions } from '@db/config';
|
|
import type { Migration } from '@db/types';
|
|
import { wrapMigration } from '@/databases/utils/migration-helpers';
|
|
|
|
// This function is extracted to make it easier to unit test it.
|
|
// Mocking turned into a mess due to this command using typeorm and the db
|
|
// config directly and customizing and monkey patching parts.
|
|
export async function main(
|
|
logger: Logger,
|
|
connection: Connection,
|
|
migrationExecutor: MigrationExecutor,
|
|
) {
|
|
const executedMigrations = await migrationExecutor.getExecutedMigrations();
|
|
const lastExecutedMigration = executedMigrations.at(0);
|
|
|
|
if (lastExecutedMigration === undefined) {
|
|
logger.error(
|
|
"Cancelled command. The database was never migrated. Are you sure you're connected to the right database?.",
|
|
);
|
|
return;
|
|
}
|
|
|
|
const lastMigrationInstance = connection.migrations.find((m) => {
|
|
// Migration names are optional. If a migration has no name property
|
|
// TypeORM will default to the class name.
|
|
const name1 = m.name ?? m.constructor.name;
|
|
const name2 = lastExecutedMigration.name;
|
|
|
|
return name1 === name2;
|
|
});
|
|
|
|
if (lastMigrationInstance === undefined) {
|
|
logger.error(
|
|
`The last migration that was executed is "${lastExecutedMigration.name}", but I could not find that migration's code in the currently installed version of n8n.`,
|
|
);
|
|
logger.error(
|
|
'This usually means that you downgraded n8n before running `n8n db:revert`. Please upgrade n8n again and run `n8n db:revert` and then downgrade again.',
|
|
);
|
|
return;
|
|
}
|
|
|
|
if (!lastMigrationInstance.down) {
|
|
const message = lastMigrationInstance.name
|
|
? `Cancelled command. The last migration "${lastMigrationInstance.name}" was irreversible.`
|
|
: 'Cancelled command. The last migration was irreversible.';
|
|
logger.error(message);
|
|
return;
|
|
}
|
|
|
|
await connection.undoLastMigration();
|
|
await connection.destroy();
|
|
}
|
|
|
|
export class DbRevertMigrationCommand extends Command {
|
|
static description = 'Revert last database migration';
|
|
|
|
static examples = ['$ n8n db:revert'];
|
|
|
|
static flags = {
|
|
help: Flags.help({ char: 'h' }),
|
|
};
|
|
|
|
protected logger = Container.get(Logger);
|
|
|
|
private connection: Connection;
|
|
|
|
async init() {
|
|
await this.parse(DbRevertMigrationCommand);
|
|
}
|
|
|
|
async run() {
|
|
const connectionOptions: ConnectionOptions = {
|
|
...getConnectionOptions(),
|
|
subscribers: [],
|
|
synchronize: false,
|
|
migrationsRun: false,
|
|
dropSchema: false,
|
|
logging: ['query', 'error', 'schema'],
|
|
};
|
|
|
|
const connection = new Connection(connectionOptions);
|
|
await connection.initialize();
|
|
|
|
const migrationExecutor = new MigrationExecutor(connection);
|
|
|
|
(connectionOptions.migrations as Migration[]).forEach(wrapMigration);
|
|
|
|
return await main(this.logger, connection, migrationExecutor);
|
|
}
|
|
|
|
async catch(error: Error) {
|
|
this.logger.error('Error reverting last migration. See log messages for details.');
|
|
this.logger.error(error.message);
|
|
}
|
|
|
|
protected async finally(error: Error | undefined) {
|
|
if (this.connection?.isInitialized) await this.connection.destroy();
|
|
|
|
this.exit(error ? 1 : 0);
|
|
}
|
|
}
|