@orion-js/migrations 3.11.9 → 4.0.0-alpha.2

package/package.json

@@ -1,44 +1,49 @@
 {
   "name": "@orion-js/migrations",
-  "version": "3.11.9",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "version": "4.0.0-alpha.2",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
   "files": [
-    "/lib"
+    "dist"
   ],
   "author": "nicolaslopezj",
   "license": "MIT",
   "scripts": {
-    "test": "jest",
+    "test": "bun test",
     "prepare": "yarn run build",
-    "clean": "rm -rf ./lib",
-    "build": "yarn run clean && tsc",
+    "clean": "rm -rf ./dist",
+    "build": "bun run build.ts",
     "watch": "tsc -w",
-    "upgrade-interactive": "yarn upgrade-interactive"
+    "upgrade-interactive": "yarn upgrade-interactive",
+    "dev": "bun --watch src/index.ts"
   },
   "dependencies": {
-    "@orion-js/dogs": "^3.11.9",
-    "@orion-js/helpers": "^3.11.8",
-    "@orion-js/mongodb": "^3.11.8",
-    "@orion-js/services": "^3.11.8",
-    "@orion-js/typed-model": "^3.11.8"
+    "@orion-js/dogs": "^4.0.0-alpha.2",
+    "@orion-js/helpers": "^4.0.0-alpha.2",
+    "@orion-js/mongodb": "^4.0.0-alpha.2",
+    "@orion-js/services": "^4.0.0-alpha.2",
+    "@orion-js/typed-model": "^4.0.0-alpha.2"
   },
   "peerDependencies": {
     "@orion-js/logger": "*"
   },
   "devDependencies": {
-    "@orion-js/logger": "^3.11.8",
-    "@shelf/jest-mongodb": "^4.3.2",
-    "@types/jest": "^29.5.12",
+    "@orion-js/logger": "^4.0.0-alpha.2",
     "@types/lodash": "4.14.195",
     "@types/node": "20.4.2",
-    "jest": "29.7.0",
     "reflect-metadata": "^0.1.13",
-    "ts-jest": "29.1.2",
-    "typescript": "^5.1.6"
+    "typescript": "^5.4.5",
+    "@types/bun": "^1.2.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ff4915cc731d0d18bcb386da1845615f0aa9fd4e"
-}
+  "gitHead": "9fd28b6f6b348cebc9f0dc207805647969277372",
+  "type": "module",
+  "module": "./dist/index.js",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Orionjs Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/lib/MigrationsService.d.ts

@@ -1,9 +0,0 @@
-import { MigrationExecutable } from './service';
-import { ExecutionContext } from '@orion-js/dogs';
-export declare class MigrationsService {
-    private migrationsRepo;
-    getNextMigration(migrationsList: MigrationExecutable[]): Promise<MigrationExecutable>;
-    runMigrations(migrationsList: MigrationExecutable[], context: ExecutionContext): Promise<void>;
-    runMigration(func: (context: ExecutionContext) => Promise<void>, context: ExecutionContext): Promise<void>;
-    runAsTransaction(func: (context: ExecutionContext) => Promise<void>, context: ExecutionContext): Promise<void>;
-}

package/lib/MigrationsService.js

@@ -1,70 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MigrationsService = void 0;
-const services_1 = require("@orion-js/services");
-const Repo_1 = require("./Repo");
-const logger_1 = require("@orion-js/logger");
-let MigrationsService = exports.MigrationsService = class MigrationsService {
-    async getNextMigration(migrationsList) {
-        const completedNames = await this.migrationsRepo.getCompletedMigrationNames();
-        for (const migrationExecutable of migrationsList) {
-            if (completedNames.includes(migrationExecutable.name))
-                continue;
-            return migrationExecutable;
-        }
-    }
-    async runMigrations(migrationsList, context) {
-        const next = await this.getNextMigration(migrationsList);
-        if (!next)
-            return;
-        logger_1.logger.info('[orionjs/migrations] Running migration...', { name: next.name });
-        if (next.useMongoTransactions) {
-            await this.runAsTransaction(next.runMigration, context);
-        }
-        else {
-            await this.runMigration(next.runMigration, context);
-        }
-        logger_1.logger.info('[orionjs/migrations] Migration executed correctly', { name: next.name });
-        await this.migrationsRepo.saveCompletedMigration(next.name);
-        await this.runMigrations(migrationsList, context);
-    }
-    async runMigration(func, context) {
-        try {
-            await func(context);
-        }
-        catch (error) {
-            logger_1.logger.error('[orionjs/migrations] Error running migration', error);
-            throw error;
-        }
-    }
-    async runAsTransaction(func, context) {
-        const { client } = this.migrationsRepo.collection.client;
-        const session = client.startSession();
-        await session.withTransaction(async () => {
-            try {
-                await func(context);
-            }
-            catch (error) {
-                logger_1.logger.error('[orionjs/migrations] Error running migration, will abort transaction', error);
-                throw error;
-            }
-        });
-        session.endSession();
-    }
-};
-__decorate([
-    (0, services_1.Inject)(),
-    __metadata("design:type", Repo_1.MigrationsRepo)
-], MigrationsService.prototype, "migrationsRepo", void 0);
-exports.MigrationsService = MigrationsService = __decorate([
-    (0, services_1.Service)()
-], MigrationsService);

package/lib/Repo.d.ts

@@ -1,7 +0,0 @@
-import { Collection } from '@orion-js/mongodb';
-import { MigrationSchema } from './Schema';
-export declare class MigrationsRepo {
-    collection: Collection<MigrationSchema>;
-    getCompletedMigrationNames(): Promise<string[]>;
-    saveCompletedMigration(name: string): Promise<void>;
-}

package/lib/Repo.js

@@ -1,35 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MigrationsRepo = void 0;
-const mongodb_1 = require("@orion-js/mongodb");
-const Schema_1 = require("./Schema");
-let MigrationsRepo = exports.MigrationsRepo = class MigrationsRepo {
-    async getCompletedMigrationNames() {
-        const migrations = await this.collection.find().toArray();
-        return migrations.map(m => m.name);
-    }
-    async saveCompletedMigration(name) {
-        await this.collection.insertOne({ name, completedAt: new Date() });
-    }
-};
-__decorate([
-    (0, mongodb_1.MongoCollection)({
-        name: 'orionjs.migrations',
-        schema: Schema_1.MigrationSchema,
-        idPrefix: 'scnmg-',
-        indexes: []
-    }),
-    __metadata("design:type", Object)
-], MigrationsRepo.prototype, "collection", void 0);
-exports.MigrationsRepo = MigrationsRepo = __decorate([
-    (0, mongodb_1.Repository)()
-], MigrationsRepo);

package/lib/Schema.d.ts

@@ -1,6 +0,0 @@
-export type MigrationId = `scnmg-${string}`;
-export declare class MigrationSchema {
-    _id: MigrationId;
-    name: string;
-    completedAt: Date;
-}

package/lib/Schema.js

@@ -1,30 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MigrationSchema = void 0;
-const typed_model_1 = require("@orion-js/typed-model");
-let MigrationSchema = exports.MigrationSchema = class MigrationSchema {
-};
-__decorate([
-    (0, typed_model_1.Prop)(),
-    __metadata("design:type", String)
-], MigrationSchema.prototype, "_id", void 0);
-__decorate([
-    (0, typed_model_1.Prop)(),
-    __metadata("design:type", String)
-], MigrationSchema.prototype, "name", void 0);
-__decorate([
-    (0, typed_model_1.Prop)(),
-    __metadata("design:type", Date)
-], MigrationSchema.prototype, "completedAt", void 0);
-exports.MigrationSchema = MigrationSchema = __decorate([
-    (0, typed_model_1.TypedSchema)()
-], MigrationSchema);

package/lib/index.d.ts

@@ -1,5 +0,0 @@
-export * from './loadMigrations';
-export * from './service';
-export * from './MigrationsService';
-export * from './Repo';
-export * from './Schema';

package/lib/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./loadMigrations"), exports);
-__exportStar(require("./service"), exports);
-__exportStar(require("./MigrationsService"), exports);
-__exportStar(require("./Repo"), exports);
-__exportStar(require("./Schema"), exports);

package/lib/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/index.test.js

@@ -1,96 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const services_1 = require("@orion-js/services");
-const loadMigrations_1 = require("./loadMigrations");
-const service_1 = require("./service");
-const MigrationsService_1 = require("./MigrationsService");
-const lib_1 = require("../../helpers/lib");
-const Repo_1 = require("./Repo");
-describe('Migrations end to end', () => {
-    it('should create a migration service', async () => {
-        let executions = 0;
-        let MoveUsersMigrationService = class MoveUsersMigrationService {
-            async runMigration() {
-                executions++;
-            }
-        };
-        MoveUsersMigrationService = __decorate([
-            (0, service_1.MigrationService)({
-                name: (0, lib_1.generateId)(),
-                useMongoTransactions: false
-            })
-        ], MoveUsersMigrationService);
-        const migrationExecutables = (0, loadMigrations_1.loadMigrations)([MoveUsersMigrationService], { omitJob: true });
-        const instance = (0, services_1.getInstance)(MigrationsService_1.MigrationsService);
-        const context = {};
-        await instance.runMigrations(migrationExecutables, context);
-        await instance.runMigrations(migrationExecutables, context);
-        await instance.runMigrations(migrationExecutables, context);
-        await instance.runMigrations(migrationExecutables, context);
-        await instance.runMigrations(migrationExecutables, context);
-        expect(executions).toBe(1);
-    });
-    it('should not set a migration completed if it fails', async () => {
-        const migrationName = (0, lib_1.generateId)();
-        let MoveUsersMigrationService = class MoveUsersMigrationService {
-            async runMigration() {
-                throw new Error('test');
-            }
-        };
-        MoveUsersMigrationService = __decorate([
-            (0, service_1.MigrationService)({
-                name: migrationName,
-                useMongoTransactions: false
-            })
-        ], MoveUsersMigrationService);
-        const migrationExecutables = (0, loadMigrations_1.loadMigrations)([MoveUsersMigrationService], { omitJob: true });
-        const instance = (0, services_1.getInstance)(MigrationsService_1.MigrationsService);
-        const context = {};
-        try {
-            await instance.runMigrations(migrationExecutables, context);
-        }
-        catch { }
-        const migrationsRepo = (0, services_1.getInstance)(Repo_1.MigrationsRepo);
-        const completedNames = await migrationsRepo.getCompletedMigrationNames();
-        expect(completedNames.includes(migrationName)).toBe(false);
-    });
-    // it('should revert changes if an error is thrown', async () => {
-    //   expect.assertions(2)
-    //   @Repository()
-    //   class TestRepo {
-    //     @MongoCollection({
-    //       name: 'testMigration'
-    //     })
-    //     collection: Collection
-    //   }
-    //   @MigrationService({
-    //     name: generateId(),
-    //     useMongoTransactions: true
-    //   })
-    //   class TestTransactionMigrationService {
-    //     @Inject()
-    //     private testRepo: TestRepo
-    //     async runMigration() {
-    //       await this.testRepo.collection.insertOne({test: true})
-    //       const count = await this.testRepo.collection.countDocuments({})
-    //       expect(count).toBe(1)
-    //       console.log({count})
-    //       throw new Error('test')
-    //     }
-    //   }
-    //   const migrationExecutables = loadMigrations([TestTransactionMigrationService], {omitJob: true})
-    //   const instance = getInstance(MigrationsService)
-    //   try {
-    //     await instance.runMigrations(migrationExecutables)
-    //   } catch {}
-    //   const testRepo = getInstance(TestRepo)
-    //   const count = await testRepo.collection.countDocuments({})
-    //   expect(count).toBe(0)
-    // })
-});

package/lib/loadMigrations/index.d.ts

@@ -1,5 +0,0 @@
-export interface Options {
-    lockTime?: number;
-    omitJob?: boolean;
-}
-export declare function loadMigrations(migrationServices: any[], options?: Options): import("../service").MigrationExecutable[];

package/lib/loadMigrations/index.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadMigrations = void 0;
-const dogs_1 = require("@orion-js/dogs");
-const service_1 = require("../service");
-const services_1 = require("@orion-js/services");
-const MigrationsService_1 = require("../MigrationsService");
-function loadMigrations(migrationServices, options) {
-    const migrations = (0, service_1.getMigrationsFromServices)(migrationServices);
-    if (options?.omitJob)
-        return migrations;
-    (0, dogs_1.startWorkers)({
-        cooldownPeriod: 1000,
-        lockTime: 1000 * 60 * 20,
-        workersCount: 1,
-        pollInterval: 10 * 1000,
-        jobs: {
-            orionjsRunMigrations: (0, dogs_1.defineJob)({
-                type: 'recurrent',
-                runEvery: 30 * 1000,
-                async resolve(params, context) {
-                    const instance = (0, services_1.getInstance)(MigrationsService_1.MigrationsService);
-                    await instance.runMigrations(migrations, context);
-                }
-            })
-        }
-    });
-    return migrations;
-}
-exports.loadMigrations = loadMigrations;

package/lib/service/index.d.ts

@@ -1,10 +0,0 @@
-import { ExecutionContext } from '@orion-js/dogs';
-export interface MigrationServiceOptions {
-    name: string;
-    useMongoTransactions: false;
-}
-export declare function MigrationService(options: MigrationServiceOptions): ClassDecorator;
-export type MigrationExecutable = {
-    runMigration(context: ExecutionContext): Promise<void>;
-} & MigrationServiceOptions;
-export declare function getMigrationsFromServices(services: any[]): MigrationExecutable[];

package/lib/service/index.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMigrationsFromServices = exports.MigrationService = void 0;
-const services_1 = require("@orion-js/services");
-const services_2 = require("@orion-js/services");
-function MigrationService(options) {
-    return function (target) {
-        (0, services_2.Service)()(target);
-        target.prototype.service = target;
-        target.prototype.options = options;
-        target.prototype.serviceType = 'migration';
-    };
-}
-exports.MigrationService = MigrationService;
-function getMigrationsFromServices(services) {
-    return services
-        .filter(service => service.prototype.serviceType === 'migration')
-        .map(service => {
-        const options = service.prototype.options;
-        return {
-            ...options,
-            runMigration: async (context) => {
-                const instance = (0, services_1.getInstance)(service);
-                return await instance.runMigration(context);
-            }
-        };
-    });
-}
-exports.getMigrationsFromServices = getMigrationsFromServices;

package/lib/service/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/service/index.test.js

@@ -1,40 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-describe('Migration as IOC', () => {
-    it('should create a migration service', async () => {
-        let didRun = false;
-        let didExtend = false;
-        let MoveUsersMigrationService = class MoveUsersMigrationService {
-            async runMigration(context) {
-                didRun = true;
-                context.extendLockTime(1000);
-            }
-        };
-        MoveUsersMigrationService = __decorate([
-            (0, _1.MigrationService)({
-                name: 'moveUsers',
-                useMongoTransactions: false
-            })
-        ], MoveUsersMigrationService);
-        const migrations = (0, _1.getMigrationsFromServices)([MoveUsersMigrationService]);
-        let lastName = null;
-        for (const { runMigration, name } of migrations) {
-            lastName = name;
-            await runMigration({
-                extendLockTime: time => {
-                    didExtend = true;
-                }
-            });
-        }
-        expect(lastName).toBe('moveUsers');
-        expect(didRun).toBe(true);
-        expect(didExtend).toBe(true);
-    });
-});

package/lib/tests/setup.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/tests/setup.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const mongodb_1 = require("@orion-js/mongodb");
-const url = `${global.__MONGO_URI__}`;
-process.env.MONGO_URL = url;
-beforeAll(async () => {
-    const connection = (0, mongodb_1.getMongoConnection)({ name: 'main' });
-    await connection.connectionPromise;
-});
-afterAll(async () => {
-    /**
-     * We need to wait on indexes promises to be resolved to close all the handlers
-     */
-    await Promise.all(mongodb_1.createIndexesPromises);
-    for (const connectionName in mongodb_1.connections) {
-        const connection = mongodb_1.connections[connectionName];
-        await connection.client.close();
-    }
-});