Merge pull request #38 from rxdi/feature/added-prepare-step

feat(prepare): added prepare step
rxdi · Apr 23, 2024 · c0d4fb1 · c0d4fb1
2 parents a66ff59 + 6f0fc32
commit c0d4fb1
Show file tree

Hide file tree

Showing 24 changed files with 359 additions and 542 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ Migration library for `Mongodb` and `Mongoose` written in `TypeScript`
 - Mongoose and Mongodb compatibility
 - ACID transactions provided by MongoDB
 - `error` and `success` logs for `up`/`down` migrations
-- Infinite rrror log with `append` NodeJS streaming technique
+- Infinite error log with `append` NodeJS streaming technique
 - 100% TypeScript support with JIT compilation provided by [esbuild](https://esbuild.github.io/)
 
 ## Installation
@@ -33,7 +33,7 @@ chmod +x xmigrate-linux
 ```
 
 ```bash
-./xmigrate up|down|create|etc
+./xmigrate up|down|create|status
 ```
 
 Using `NodeJS`
@@ -55,16 +55,36 @@ Manual configuration
 You can create a `xmigrate.js` file where you execute the `xmigrate` command:
 
 ```typescript
+import { MongoClient } from 'mongodb';
+import { connect } from 'mongoose';
+
 export default async () => {
   return {
     changelogCollectionName: 'migrations',
     migrationsDir: './migrations',
     defaultTemplate: 'es6',
     typescript: true,
-    builder: 'ESBUILD',
     outDir: './.xmigrate',
     /* Custom datetime formatting can be applied like so */
     // dateTimeFormat: () => new Date().toISOString(),
+    /* If you do need some better bundling of your migrations when there are tsconfig paths namespaces @shared/my-namespace
+        You should consider using `bundler.build()` configuration.
+    */
+    // bundler: {
+    //   build(entryPoints: string[], outdir: string) {
+    //     return esbuild.build({
+    //       entryPoints,
+    //       bundle: true,
+    //       sourcemap: false,
+    //       minify: false,
+    //       platform: 'node',
+    //       format: 'cjs',
+    //       outdir,
+    //       logLevel: 'info',
+    //       plugins: [pluginTsc()],
+    //     })
+    //   },
+    // },
     logger: {
       folder: './migrations-log',
       up: {
@@ -76,11 +96,13 @@ export default async () => {
         error: 'down.error.log',
       },
     },
-    mongodb: {
-      url: `mongodb://localhost:27017`,
-      databaseName: 'test',
-      options: {
-        useNewUrlParser: true,
+    database: {
+      async connect() {
+        const url = 'mongodb://localhost:27017';
+
+        await connect(url);
+        const client = await MongoClient.connect(url);
+        return client;
       },
     },
   };
@@ -173,7 +195,12 @@ Native mongo driver template
 
 ```typescript
 module.exports = {
-  async up(client) {
+
+  async prepare(client) {
+    return [client]
+  }
+
+  async up([client]) {
     await client
       .db()
       .collection('albums')
@@ -183,7 +210,7 @@ module.exports = {
       .updateOne({ artist: 'The Doors' }, { $set: { stars: 5 } });
   },
 
-  async down(client) {
+  async down([client]) {
     await client
       .db()
       .collection('albums')
@@ -199,11 +226,16 @@ module.exports = {
 
 ```typescript
 module.exports = {
-  async up(client) {
+
+  async prepare(client) {
+    return [client]
+  }
+
+  async up([client]) {
     return ['UP'];
   },
 
-  async down(client) {
+  async down([client]) {
     return ['DOWN'];
   },
 };
@@ -212,10 +244,13 @@ module.exports = {
 `ES6` template
 
 ```typescript
-export async function up(client) {
+export async function prepare(client) {
+  return [client];
+}
+export async function up([client]) {
   return ['Up'];
 }
-export async function down(client) {
+export async function down([client]) {
   return ['Down'];
 }
 ```
@@ -231,7 +266,11 @@ npm install @types/mongodb @types/mongoose -D
 ```typescript
 import { MongoClient } from 'mongodb';
 
-export async function up(client: MongoClient) {
+export async function prepare(client: mongoClient) {
+  return [client];
+}
+
+export async function up([client]: [MongoClient]) {
   await client
     .db()
     .collection('albums')
@@ -243,7 +282,7 @@ export async function up(client: MongoClient) {
     .updateOne({ artist: 'The Doors' }, { $set: { stars: 5 } });
 }
 
-export async function down(client: MongoClient) {
+export async function down([client]: [MongoClient]) {
   await client
     .db()
     .collection('albums')
@@ -370,6 +409,8 @@ When you change your configuration file to `xmigrate.ts` it will automatically t
 
 ```typescript
 import { Config } from '@rxdi/xmigrate';
+import { MongoClient } from 'mongodb';
+import { connect } from 'mongoose';
 
 export default async (): Promise<Config> => {
   return {
@@ -378,6 +419,21 @@ export default async (): Promise<Config> => {
     defaultTemplate: 'typescript',
     typescript: true,
     outDir: './.xmigrate',
+    // bundler: {
+    //   build(entryPoints: string[], outdir: string) {
+    //     return esbuild.build({
+    //       entryPoints,
+    //       bundle: true,
+    //       sourcemap: false,
+    //       minify: false,
+    //       platform: 'node',
+    //       format: 'cjs',
+    //       outdir,
+    //       logLevel: 'info',
+    //       plugins: [pluginTsc()],
+    //     });
+    //   },
+    // },
     logger: {
       folder: './migrations-log',
       up: {
@@ -389,11 +445,14 @@ export default async (): Promise<Config> => {
         error: 'down.error.log',
       },
     },
-    mongodb: {
-      url: `mongodb://localhost:27017`,
-      databaseName: 'test',
-      options: {
-        useNewUrlParser: true,
+    database: {
+      async connect() {
+        const url =
+          process.env.MONGODB_CONNECTION_STRING ?? 'mongodb://localhost:27017';
+
+        await connect(url);
+        const client = await MongoClient.connect(url);
+        return client;
       },
     },
   };
@@ -421,6 +480,8 @@ import {
   LoggerConfig,
   Config,
 } from '@rxdi/xmigrate';
+import { MongoClient } from 'mongodb';
+import { connect } from 'mongoose';
 
 const config = {
   changelogCollectionName: 'migrations',
@@ -439,11 +500,14 @@ const config = {
       error: 'down.error.log',
     },
   },
-  mongodb: {
-    url: 'mongodb://localhost:27017',
-    databaseName: 'test',
-    options: {
-      useNewUrlParser: true,
+  database: {
+    async connect() {
+      const url =
+        process.env.MONGODB_CONNECTION_STRING ?? 'mongodb://localhost:27017';
+
+      await connect(url);
+      const client = await MongoClient.connect(url);
+      return client;
     },
   },
 };
@@ -466,10 +530,15 @@ setup({
   const template = `
 import { MongoClient } from 'mongodb';
 
-export async function up(client: MongoClient) {
+export async function prepare(client: MongoClient) {
+  return [client]
+}
+
+export async function up([client]: [MongoClient]) {
   return true
 }
-export async function down(client: MongoClient) {
+
+export async function down([client]: [MongoClient]) {
   return true
 }
 `;
@@ -498,30 +567,3 @@ export async function down(client: MongoClient) {
   process.exit(0);
 }, console.error.bind(console));
 ```
-
-### Minimal configuration
-
-```typescript
-export default async () => {
-  return {
-    defaultTemplate: 'typescript',
-    outDir: './.xmigrate',
-    typescript: true,
-    mongodb: {
-      url: 'mongodb://localhost:27017',
-      databaseName: 'test',
-      options: {
-        useNewUrlParser: true,
-      },
-    },
-  };
-};
-```
-
-### Performance tests
-
-Running 600 `migrations` takes less than 15 seconds in TypeScript compiled right down to Javascript ES5.
-
-Check [this](https://cloudflare-ipfs.com/ipfs/QmRsE9cRLxeVrya3eZUAheMRoxrM1RKn8MQwbczpicpvxK) video inside IPFS network
-
-Link is not working at the moment...
diff --git a/examples/api.ts b/examples/api.ts
@@ -1,12 +1,14 @@
 import { Container, setup } from '@rxdi/core';
+import { MongoClient } from 'mongodb';
+import { connect } from 'mongoose';
 
 import {
-  MigrationService,
+  Config,
+  ConfigService,
   GenericRunner,
   LogFactory,
-  ConfigService,
   LoggerConfig,
-  Config
+  MigrationService,
 } from '../src/index'; // equivalent to '@rxdi/xmigrate'
 
 const config = {
@@ -19,20 +21,22 @@ const config = {
     folder: './migrations-log',
     up: {
       success: 'up.success.log',
-      error: 'up.error.log'
+      error: 'up.error.log',
     },
     down: {
       success: 'down.success.log',
-      error: 'down.error.log'
-    }
+      error: 'down.error.log',
+    },
+  },
+  database: {
+    async connect() {
+      const url = 'mongodb://localhost:27017';
+
+      await connect(url);
+      const client = await MongoClient.connect(url);
+      return client;
+    },
   },
-  mongodb: {
-    url: 'mongodb://localhost:27017',
-    databaseName: 'test',
-    options: {
-      useNewUrlParser: true
-    }
-  }
 };
 
 setup({
@@ -42,13 +46,13 @@ setup({
     ConfigService,
     {
       provide: Config,
-      useValue: config
+      useValue: config,
     },
     {
       provide: LoggerConfig,
-      useValue: config.logger
-    }
-  ]
+      useValue: config.logger,
+    },
+  ],
 }).subscribe(async () => {
   const template = `
 import { MongoClient } from 'mongodb';
@@ -67,7 +71,7 @@ export async function down(client: MongoClient) {
   const filePath = await migrationService.createWithTemplate(
     template as 'typescript',
     'pesho1234',
-    { raw: true, typescript: true }
+    { raw: true, typescript: true },
   );
   console.log(filePath);