Refactor config parsing

Author: MunifTanjim

README.md

@@ -20,17 +20,17 @@ npm install --save @synor/database-mongodb
 
 ## URI
 
-**Format**: `mongodb://[user[:password]@][hostname][:port]/database[?param=value&...]`
+**Format**: `mongodb[+srv]://[username:password@]hostname[:port]/database[?param=value&...]`
 
 **Params**:
 
-| Name                           | Description                     | Default Value            |
-| ------------------------------ | ------------------------------- | ------------------------ |
-| `synor_migration_record_table` | Name for Migration Record Table | `synor_migration_record` |
+| Name                                | Description                          | Default Value            |
+| ----------------------------------- | ------------------------------------ | ------------------------ |
+| `synor_migration_record_collection` | Name for Migration Record Collection | `synor_migration_record` |
 
 **Examples**:
 
-- `mongodb://root:root@127.0.0.1:27017/synor?synor_migration_record_table=migration_record`
+- `mongodb://mongo:mongo@127.0.0.1:27017/synor?synor_migration_record_collection=migration_record`
 
 ## License
 

package.json

@@ -29,39 +29,39 @@
     "watch": "bili --format cjs --watch"
   },
   "dependencies": {
-    "connection-string": "^3.1.1",
+    "connection-string": "^3.1.3",
     "debug": "^4.1.1",
-    "mongodb": "^3.5.3"
+    "mongodb": "^3.5.4"
   },
   "devDependencies": {
-    "@synor/core": "^0.9.1",
+    "@synor/core": "^0.9.2",
     "@synor/eslint-config": "^0.1.0",
     "@types/debug": "^4.1.5",
     "@types/jest": "^25.1.2",
-    "@types/mongodb": "^3.3.16",
-    "@typescript-eslint/eslint-plugin": "^2.19.0",
-    "@typescript-eslint/parser": "^2.19.0",
+    "@types/mongodb": "^3.5.2",
+    "@typescript-eslint/eslint-plugin": "^2.22.0",
+    "@typescript-eslint/parser": "^2.22.0",
     "bili": "^4.8.1",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.10.0",
     "eslint-config-standard-with-typescript": "^14.0.0",
     "eslint-plugin-import": "^2.20.1",
-    "eslint-plugin-jest": "^23.7.0",
+    "eslint-plugin-jest": "^23.8.2",
     "eslint-plugin-node": "^11.0.0",
     "eslint-plugin-prettier": "^3.1.2",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
     "husky": "^4.2.1",
     "jest": "^25.1.0",
-    "lint-staged": "^10.0.7",
+    "lint-staged": "^10.0.8",
     "prettier": "^1.19.1",
     "pretty-quick": "^2.0.1",
     "rimraf": "^3.0.2",
-    "rollup-plugin-typescript2": "^0.25.3",
-    "typescript": "^3.8.2"
+    "rollup-plugin-typescript2": "^0.26.0",
+    "typescript": "^3.8.3"
   },
   "peerDependencies": {
-    "@synor/core": "^0.9.1"
+    "@synor/core": "^0.9.2"
   },
   "publishConfig": {
     "access": "public"

src/index.ts

@@ -1,8 +1,8 @@
 import { MigrationRecord, SynorError } from '@synor/core';
-import { ConnectionString } from 'connection-string';
 import Debug from 'debug';
 import { Db, MongoClient } from 'mongodb';
 import { performance } from 'perf_hooks';
+import { getConfig } from './utils/get-config';
 
 type DatabaseEngine = import('@synor/core').DatabaseEngine;
 type DatabaseEngineFactory = import('@synor/core').DatabaseEngineFactory;
@@ -15,50 +15,6 @@ async function noOp(): Promise<null> {
   return null;
 }
 
-function parseConnectionString(
-  cn: string
-): {
-  protocol: string;
-  host: string;
-  port: number | undefined;
-  path: string[];
-  params: Record<string, any>;
-  database: string;
-  migrationRecordTable: string;
-} {
-  debug(cn);
-  const { protocol, hostname: host, port, path, params } = new ConnectionString(
-    cn,
-    {
-      params: {
-        synor_migration_record_table: 'synor_migration_record'
-      }
-    }
-  );
-
-  debug('host ', host);
-  debug('port ', port);
-  debug('protocol ', protocol);
-  debug('path ', path);
-  debug('params ', params);
-
-  if (!host || !protocol || !path || !params) {
-    throw new SynorError('Invalid connection uri');
-  }
-  const database = path?.[0];
-  const migrationRecordTable = params.synor_migration_record_table;
-
-  return {
-    database,
-    host,
-    protocol,
-    port,
-    path,
-    params,
-    migrationRecordTable
-  };
-}
-
 async function doesMigrationRecordTableExists(
   db: Db,
   mgCollName: string
@@ -150,19 +106,22 @@ export const MongoDBDatabaseEngine: DatabaseEngineFactory = (
     throw new SynorError(`Missing: getUserInfo`);
   }
 
-  const { database, migrationRecordTable } = parseConnectionString(uri);
+  const { databaseConfig, engineConfig } = getConfig(uri);
 
   let client: MongoClient | null = null;
   let db: Db | null = null;
 
   return {
     async open() {
       debug('in open function');
-      client = await MongoClient.connect(uri);
-      db = await client.db(database);
+      client = await MongoClient.connect(uri, {
+        appname: databaseConfig.appname,
+        poolSize: 1
+      });
+      db = await client.db();
       await ensureMigrationRecordTableExists(
         db,
-        migrationRecordTable,
+        engineConfig.migrationRecordCollection,
         baseVersion
       );
     },
@@ -229,9 +188,9 @@ export const MongoDBDatabaseEngine: DatabaseEngineFactory = (
         const endTime = performance.now();
         const newRecordId = await findNextAutoIncrementedId(
           db as Db,
-          migrationRecordTable
+          engineConfig.migrationRecordCollection
         );
-        await db?.collection(migrationRecordTable).insert({
+        await db?.collection(engineConfig.migrationRecordCollection).insert({
           id: newRecordId,
           version,
           type,
@@ -249,10 +208,13 @@ export const MongoDBDatabaseEngine: DatabaseEngineFactory = (
       if (!db) {
         throw new SynorError('Database connection is null');
       }
-      await deleteDirtyRecords(db, migrationRecordTable);
+      await deleteDirtyRecords(db, engineConfig.migrationRecordCollection);
 
       for (const { id, hash } of records) {
-        await updateRecord(db, migrationRecordTable, { id, hash });
+        await updateRecord(db, engineConfig.migrationRecordCollection, {
+          id,
+          hash
+        });
       }
     },
     async records(startid: number) {
@@ -262,7 +224,7 @@ export const MongoDBDatabaseEngine: DatabaseEngineFactory = (
       }
 
       const records = (await (
-        await db.collection(migrationRecordTable).find({
+        await db.collection(engineConfig.migrationRecordCollection).find({
           id: {
             $gte: startid
           }

src/utils/get-config.ts

@@ -0,0 +1,64 @@
+import { SynorError } from '@synor/core';
+import { ConnectionString } from 'connection-string';
+
+type MongoClientOptions = import('mongodb').MongoClientOptions;
+
+type MongoDBDatabaseConfig = Required<Pick<MongoClientOptions, 'appname'>>;
+
+type MongoDBEngineConfig = {
+  migrationRecordCollection: string;
+};
+
+const validProtocol = ['mongodb', 'mongodb+srv'];
+
+export function getConfig(
+  uri: string
+): {
+  databaseConfig: MongoDBDatabaseConfig;
+  engineConfig: MongoDBEngineConfig;
+} {
+  try {
+    const { protocol, hostname: host, path, params } = new ConnectionString(
+      uri,
+      {
+        params: {
+          appname: '@synor/database-mongodb',
+          synor_migration_record_collection: 'synor_migration_record'
+        }
+      }
+    );
+
+    if (!protocol) {
+      throw new Error(`[URI] missing: protocol!`);
+    }
+
+    if (!validProtocol.includes(protocol)) {
+      throw new Error(`[URI] unsupported: protocol(${protocol})!`);
+    }
+
+    if (!host) {
+      throw new Error(`[URI] missing: host!`);
+    }
+
+    const database = path?.[0];
+
+    if (!database) {
+      throw new Error('[URI] missing: database!');
+    }
+
+    const databaseConfig: MongoDBDatabaseConfig = {
+      appname: params!.appname
+    };
+
+    const engineConfig: MongoDBEngineConfig = {
+      migrationRecordCollection: params!.synor_migration_record_collection
+    };
+
+    return {
+      databaseConfig,
+      engineConfig
+    };
+  } catch (error) {
+    throw new SynorError('Invalid DatabaseURI', 'exception', error);
+  }
+}

tsconfig.json

@@ -3,7 +3,7 @@
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "ES2019" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
-    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "module": "ESNext" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
     // "lib": [],                             /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
@@ -17,7 +17,7 @@
     // "composite": true,                     /* Enable project compilation */
     // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
     // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true /* Do not emit outputs. */,
+    "noEmit": true /* Do not emit outputs. */,
     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
     // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */