@sqb/migrator 4.10.0 → 4.10.2

package/cjs/adapters/pg-migration-adapter.js

@@ -46,6 +46,7 @@ class PgMigrationAdapter extends migration_adapter_js_1.MigrationAdapter {
         try {
             const adapter = new PgMigrationAdapter();
             adapter._connection = connection;
+            adapter._packageName = options.migrationPackage.name;
             adapter._infoSchema = options.infoSchema || '__migration';
             adapter.defaultVariables.schema = options.connection.schema || '';
             if (!adapter.defaultVariables.schema) {
@@ -108,14 +109,16 @@ CREATE TABLE IF NOT EXISTS ${adapter.eventTableFull}
         const params = [];
         if (info.status && info.status !== this.status) {
             params.push(info.status);
-            sql += ', status = $' + (params.length);
+            sql += ',\n  status = $' + (params.length);
         }
         if (info.version && info.version !== this.version) {
             params.push(info.version);
-            sql += ', current_version = $' + (params.length);
+            sql += ',\n  current_version = $' + (params.length);
         }
         if (sql) {
-            sql = `update ${this.summaryTableFull} set updated_at = current_timestamp` + sql;
+            params.push(this.packageName);
+            sql = `update ${this.summaryTableFull} set updated_at = current_timestamp` + sql +
+                `\n where package_name =$` + (params.length);
             await this._connection.query(sql, { params });
             if (info.status)
                 this._status = info.status;

package/cjs/db-migrator.js

@@ -49,12 +49,19 @@ class DbMigrator extends strict_typed_events_1.AsyncEventEmitter {
                 await migrationAdapter.backupDatabase();
             }
             // Execute migration tasks
+            let migrationIndex = -1;
             for (const migration of migrations) {
+                migrationIndex++;
                 if (migration.version > targetVersion || migrationAdapter.version >= migration.version)
                     continue;
+                await this.emitAsync('migration-start', {
+                    migration,
+                    total: migrations.length,
+                    index: migrationIndex
+                });
                 for (let index = 0; index < migration.tasks.length; index++) {
                     task = migration.tasks[index];
-                    await this.emitAsync('task-start', { task: task.title, total, index });
+                    await this.emitAsync('task-start', { migration, task, total, index });
                     await migrationAdapter.update({ status: types_js_1.MigrationStatus.busy });
                     await migrationAdapter.writeEvent({
                         event: migration_adapter_js_1.MigrationAdapter.EventKind.started,
@@ -76,14 +83,23 @@ class DbMigrator extends strict_typed_events_1.AsyncEventEmitter {
                         await migrationAdapter.writeEvent({
                             event: migration_adapter_js_1.MigrationAdapter.EventKind.error,
                             version: migration.version,
-                            message: String(e)
+                            message: String(e),
+                            details: e.message + '\n\n' +
+                                Object.keys(e)
+                                    .filter(k => e[k] != null)
+                                    .map(k => k + ': ' + e[k]).join('\n')
                         });
                         // noinspection ExceptionCaughtLocallyJS
                         throw e;
                     }
-                    await this.emitAsync('task-finish', { task: task.title, total, index });
+                    await this.emitAsync('task-finish', { migration, task, total, index });
                 }
-                await migrationAdapter.update({ version: migration.version });
+                await migrationAdapter.update({ version: migration.version, status: types_js_1.MigrationStatus.idle });
+                await this.emitAsync('migration-finish', {
+                    migration,
+                    total: migrations.length,
+                    index: migrationIndex
+                });
             }
         }
         catch (e) {

package/cjs/migration-package.js

@@ -57,7 +57,11 @@ var MigrationPackage;
                     else if (typeof t === 'string') {
                         let pattern = t.replace(/\\/g, '/');
                         pattern = path_1.default.resolve(migration.dirname || baseDir, pattern);
-                        const files = await (0, fast_glob_1.default)(pattern, { absolute: true, onlyFiles: true });
+                        const files = await (0, fast_glob_1.default)(pattern, {
+                            absolute: true,
+                            onlyFiles: true
+                        });
+                        files.sort();
                         for (const filename of files) {
                             const ext = path_1.default.extname(filename).toLowerCase();
                             if (!path_1.default.basename(filename, ext).endsWith('.task'))

package/esm/adapters/pg-migration-adapter.js

@@ -43,6 +43,7 @@ export class PgMigrationAdapter extends MigrationAdapter {
         try {
             const adapter = new PgMigrationAdapter();
             adapter._connection = connection;
+            adapter._packageName = options.migrationPackage.name;
             adapter._infoSchema = options.infoSchema || '__migration';
             adapter.defaultVariables.schema = options.connection.schema || '';
             if (!adapter.defaultVariables.schema) {
@@ -105,14 +106,16 @@ CREATE TABLE IF NOT EXISTS ${adapter.eventTableFull}
         const params = [];
         if (info.status && info.status !== this.status) {
             params.push(info.status);
-            sql += ', status = $' + (params.length);
+            sql += ',\n  status = $' + (params.length);
         }
         if (info.version && info.version !== this.version) {
             params.push(info.version);
-            sql += ', current_version = $' + (params.length);
+            sql += ',\n  current_version = $' + (params.length);
         }
         if (sql) {
-            sql = `update ${this.summaryTableFull} set updated_at = current_timestamp` + sql;
+            params.push(this.packageName);
+            sql = `update ${this.summaryTableFull} set updated_at = current_timestamp` + sql +
+                `\n where package_name =$` + (params.length);
             await this._connection.query(sql, { params });
             if (info.status)
                 this._status = info.status;

package/esm/db-migrator.js

@@ -46,12 +46,19 @@ export class DbMigrator extends AsyncEventEmitter {
                 await migrationAdapter.backupDatabase();
             }
             // Execute migration tasks
+            let migrationIndex = -1;
             for (const migration of migrations) {
+                migrationIndex++;
                 if (migration.version > targetVersion || migrationAdapter.version >= migration.version)
                     continue;
+                await this.emitAsync('migration-start', {
+                    migration,
+                    total: migrations.length,
+                    index: migrationIndex
+                });
                 for (let index = 0; index < migration.tasks.length; index++) {
                     task = migration.tasks[index];
-                    await this.emitAsync('task-start', { task: task.title, total, index });
+                    await this.emitAsync('task-start', { migration, task, total, index });
                     await migrationAdapter.update({ status: MigrationStatus.busy });
                     await migrationAdapter.writeEvent({
                         event: MigrationAdapter.EventKind.started,
@@ -73,14 +80,23 @@ export class DbMigrator extends AsyncEventEmitter {
                         await migrationAdapter.writeEvent({
                             event: MigrationAdapter.EventKind.error,
                             version: migration.version,
-                            message: String(e)
+                            message: String(e),
+                            details: e.message + '\n\n' +
+                                Object.keys(e)
+                                    .filter(k => e[k] != null)
+                                    .map(k => k + ': ' + e[k]).join('\n')
                         });
                         // noinspection ExceptionCaughtLocallyJS
                         throw e;
                     }
-                    await this.emitAsync('task-finish', { task: task.title, total, index });
+                    await this.emitAsync('task-finish', { migration, task, total, index });
                 }
-                await migrationAdapter.update({ version: migration.version });
+                await migrationAdapter.update({ version: migration.version, status: MigrationStatus.idle });
+                await this.emitAsync('migration-finish', {
+                    migration,
+                    total: migrations.length,
+                    index: migrationIndex
+                });
             }
         }
         catch (e) {

package/esm/migration-package.js

@@ -50,7 +50,11 @@ export var MigrationPackage;
                     else if (typeof t === 'string') {
                         let pattern = t.replace(/\\/g, '/');
                         pattern = path.resolve(migration.dirname || baseDir, pattern);
-                        const files = await glob(pattern, { absolute: true, onlyFiles: true });
+                        const files = await glob(pattern, {
+                            absolute: true,
+                            onlyFiles: true
+                        });
+                        files.sort();
                         for (const filename of files) {
                             const ext = path.extname(filename).toLowerCase();
                             if (!path.basename(filename, ext).endsWith('.task'))

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sqb/migrator",
   "description": "Database migrator for SQB",
-  "version": "4.10.0",
+  "version": "4.10.2",
   "author": "Panates",
   "contributors": [
     "Eray Hanoglu <e.hanoglu@panates.com>",
@@ -36,9 +36,9 @@
     "ts-gems": "^2.5.0"
   },
   "peerDependencies": {
-    "@sqb/builder": "^4.10.0",
-    "@sqb/connect": "^4.10.0",
-    "@sqb/postgres": "^4.10.0"
+    "@sqb/builder": "^4.10.2",
+    "@sqb/connect": "^4.10.2",
+    "@sqb/postgres": "^4.10.2"
   },
   "engines": {
     "node": ">=16.0",
@@ -48,6 +48,7 @@
     "bin/",
     "cjs/",
     "esm/",
+    "types/",
     "LICENSE",
     "README.md"
   ],

package/types/adapters/pg-migration-adapter.d.ts

@@ -0,0 +1,39 @@
+import { Connection } from 'postgresql-client';
+import type { DbMigratorOptions } from '../db-migrator.js';
+import { MigrationAdapter } from '../migration-adapter.js';
+import { MigrationTask } from '../migration-package.js';
+import { MigrationStatus } from '../types.js';
+export declare class PgMigrationAdapter extends MigrationAdapter {
+    protected _connection: Connection;
+    protected _infoSchema: string;
+    protected _packageName: string;
+    protected _version: number;
+    protected _status: MigrationStatus;
+    protected defaultVariables: {
+        tablespace: string;
+        schema: string;
+        owner: string;
+    };
+    readonly summaryTable = "migration_summary";
+    readonly eventTable = "migration_events";
+    get packageName(): string;
+    get version(): number;
+    get status(): MigrationStatus;
+    get infoSchema(): string;
+    get summaryTableFull(): string;
+    get eventTableFull(): string;
+    static create(options: DbMigratorOptions): Promise<PgMigrationAdapter>;
+    close(): Promise<void>;
+    refresh(): Promise<void>;
+    update(info: {
+        status?: MigrationStatus;
+        version?: number;
+    }): Promise<void>;
+    writeEvent(event: MigrationAdapter.Event): Promise<void>;
+    executeTask(task: MigrationTask, variables: Record<string, any>): Promise<void>;
+    backupDatabase(): Promise<void>;
+    lockSchema(): Promise<void>;
+    restoreDatabase(): Promise<void>;
+    unlockSchema(): Promise<void>;
+    protected rowToSql(tableName: string, row: Object): string;
+}

package/types/db-migrator.d.ts

@@ -0,0 +1,15 @@
+import { AsyncEventEmitter } from 'strict-typed-events';
+import { ClientConfiguration } from '@sqb/connect';
+import { MigrationAdapter } from './migration-adapter.js';
+import { MigrationPackage, MigrationPackageAsync } from './migration-package.js';
+export interface DbMigratorOptions {
+    connection: ClientConfiguration;
+    migrationPackage: MigrationPackage | MigrationPackageAsync;
+    infoSchema?: string;
+    scriptVariables?: Record<string, string>;
+    targetVersion?: number;
+}
+export declare class DbMigrator extends AsyncEventEmitter {
+    protected adapter: MigrationAdapter;
+    execute(options: DbMigratorOptions): Promise<boolean>;
+}

package/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './db-migrator.js';
+export * from './migration-package.js';
+export * from './migration-adapter.js';
+export * from './types.js';

package/types/migration-adapter.d.ts

@@ -0,0 +1,32 @@
+import type { MigrationTask } from './migration-package.js';
+import { MigrationStatus } from './types.js';
+export declare abstract class MigrationAdapter {
+    abstract readonly packageName: string;
+    abstract readonly status: MigrationStatus;
+    abstract readonly version: number;
+    abstract close(): Promise<void>;
+    abstract refresh(): Promise<void>;
+    abstract update(info: {
+        status?: MigrationStatus;
+        version?: number;
+    }): Promise<void>;
+    abstract writeEvent(event: MigrationAdapter.Event): Promise<void>;
+    abstract executeTask(task: MigrationTask, variables: Record<string, any>): Promise<void>;
+    abstract lockSchema(): Promise<void>;
+    abstract unlockSchema(): Promise<void>;
+    abstract backupDatabase(): Promise<void>;
+    abstract restoreDatabase(): Promise<void>;
+}
+export declare namespace MigrationAdapter {
+    enum EventKind {
+        started = "started",
+        success = "success",
+        error = "error"
+    }
+    interface Event {
+        event: EventKind;
+        version: number;
+        message: string;
+        details?: string;
+    }
+}

package/types/migration-package.d.ts

@@ -0,0 +1,44 @@
+import { StrictOmit } from 'ts-gems';
+import type { MigrationAdapter } from './migration-adapter.js';
+export interface MigrationPackage {
+    name: string;
+    description?: string;
+    migrations: Migration[];
+    informationTableName?: string;
+}
+export interface Migration {
+    version: number;
+    tasks: MigrationTask[];
+    dirname?: string;
+    backup?: boolean;
+}
+export type MigrationTask = SqlScriptMigrationTask | CustomMigrationTask | InsertDataMigrationTask;
+export interface BaseMigrationTask {
+    title: string;
+    filename?: string;
+}
+export interface SqlScriptMigrationTask extends BaseMigrationTask {
+    title: string;
+    script: string;
+}
+export interface InsertDataMigrationTask extends BaseMigrationTask {
+    title: string;
+    tableName: string;
+    rows: Record<string, any>[];
+}
+export interface CustomMigrationTask extends BaseMigrationTask {
+    title: string;
+    fn: (connection: any, adapter: MigrationAdapter) => void | Promise<void>;
+}
+export declare function isSqlScriptMigrationTask(x: any): x is SqlScriptMigrationTask;
+export declare function isInsertDataMigrationTask(x: any): x is InsertDataMigrationTask;
+export declare function isCustomMigrationTask(x: any): x is CustomMigrationTask;
+export interface MigrationPackageAsync extends StrictOmit<MigrationPackage, 'migrations'> {
+    migrations: (string | MigrationAsync | (() => MigrationAsync) | (() => Promise<MigrationAsync>))[];
+}
+export interface MigrationAsync extends StrictOmit<Migration, 'tasks'> {
+    tasks: (string | MigrationTask | (() => MigrationTask) | (() => Promise<MigrationTask>))[];
+}
+export declare namespace MigrationPackage {
+    function load(asyncConfig: MigrationPackageAsync): Promise<MigrationPackage>;
+}

package/types/types.d.ts

@@ -0,0 +1,9 @@
+export interface MigrationInfo {
+    packageName: string;
+    status: MigrationStatus;
+    version: number;
+}
+export declare enum MigrationStatus {
+    idle = "idle",
+    busy = "busy"
+}

package/types/utils/get-calling-filename.d.ts

@@ -0,0 +1 @@
+export declare function getCallingFilename(position?: number): string;