Merge pull request #198 from kshitish182/master

mesaugat · web-flow · commit 31d783e8631f · 2023-04-28T15:53:03.000+05:45
Upgrade `knex(v2.4.2)` and `typescript(v5.0.4)` to latest version
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,6 @@
 /tmp
 node_modules
 /coverage
+
+# IDE settings
+.vscode
diff --git a/README.md b/README.md
@@ -240,12 +240,12 @@ import { synchronize, loadConfig, resolveConnections } from '@leapfrogtechnology
 You can also pass your own database connection (eg: Knex connection) instead of resolving `connections.sync-db.json` file.
 
 ```ts
-import * as Knex from 'knex';
+import { knex } from 'knex';
 import { synchronize, loadConfig } from '@leapfrogtechnology/sync-db';
 
 (async () => {
   const config = await loadConfig(); // Load sync-db.yml
-  const connection = Knex({
+  const connection = knex({
     // Your Knex connection instance.
     client: 'mssql',
     connection: {
diff --git a/assets/templates/migration/create_ts.stub b/assets/templates/migration/create_ts.stub
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Create {{table}} table.
diff --git a/assets/templates/migration/update_ts.stub b/assets/templates/migration/update_ts.stub
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Alter {{table}} table.
diff --git a/examples/node-app-mssql-ts/src/index.js b/examples/node-app-mssql-ts/src/index.js
@@ -9,7 +9,7 @@ const { connections } = require('../connections.sync-db.json');
     // Getting knex instance of mssql database with id db1.
     const db = knex({
       client: 'mssql',
-      connection: connections.find(({ id }) => id === 'testdb1').connection
+      connection: connections.find(({ id }) => id === 'db1').connection
     });
 
     const tasks = await db.raw('SELECT * FROM utils.vw_tasks');
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@leapfrogtechnology/sync-db",
   "description": "Command line utility to synchronize and version control relational database objects across databases",
-  "version": "1.2.1",
+  "version": "2.0.0",
   "license": "MIT",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -62,8 +62,8 @@
     "debug": "^4.1.1",
     "esm": "^3.2.25",
     "globby": "^10.0.2",
-    "knex": "^0.20.11",
-    "ramda": "^0.26.1",
+    "knex": "^2.4.2",
+    "ramda": "^0.29.0",
     "ts-node": "^8",
     "tslib": "^1",
     "yamljs": "^0.3.0"
@@ -78,7 +78,7 @@
     "@types/debug": "^4.1.4",
     "@types/mocha": "^5",
     "@types/node": "^10",
-    "@types/ramda": "^0.26.12",
+    "@types/ramda": "^0.29.0",
     "@types/yamljs": "^0.2.30",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
@@ -90,7 +90,7 @@
     "prettier": "2.0.2",
     "tslint": "^6.1.3",
     "tslint-config-leapfrog": "^1.0.3",
-    "typescript": "^3.8.2"
+    "typescript": "^5.0.2"
   },
   "engines": {
     "node": ">= 14.15.0"
diff --git a/src/config.ts b/src/config.ts
@@ -1,3 +1,4 @@
+import { Knex } from 'knex';
 import * as path from 'path';
 import * as yaml from 'yamljs';
 import { mergeDeepRight } from 'ramda';
@@ -58,7 +59,7 @@ export async function loadConfig(configFilename: string = CONFIG_FILENAME): Prom
 
   log('Resolved config file.');
 
-  const loaded = mergeDeepRight(DEFAULT_CONFIG, loadedConfig) as Configuration;
+  const loaded = mergeDeepRight<Configuration, Configuration>(DEFAULT_CONFIG, loadedConfig);
 
   validate(loaded);
 
@@ -130,8 +131,8 @@ export async function resolveConnections(config: Configuration, resolver?: strin
       id,
       client,
       connection: {
-        host: (connection as any).host,
-        database: (connection as any).database
+        host: (connection as Knex.ConnectionConfig).host,
+        database: (connection as Knex.ConnectionConfig).database
       }
     }))
   );
diff --git a/src/domain/ConnectionConfig.ts b/src/domain/ConnectionConfig.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Database connection configuration.
diff --git a/src/domain/ConnectionReference.ts b/src/domain/ConnectionReference.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Connection reference.
diff --git a/src/domain/MigrationContext.ts b/src/domain/MigrationContext.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import OperationParams from './operation/OperationParams';
 import OperationContext from './operation/OperationContext';
diff --git a/src/domain/RawBingingParams.ts b/src/domain/RawBingingParams.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 type Value = Date | string | number | boolean | Date[] | string[] | number[] | boolean[] | Buffer | Knex.Raw;
 
diff --git a/src/domain/SynchronizeContext.ts b/src/domain/SynchronizeContext.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import SynchronizeParams from './SynchronizeParams';
 import OperationContext from './operation/OperationContext';
diff --git a/src/init.ts b/src/init.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import { log } from './util/logger';
 import { validate, isCLI } from './config';
@@ -37,7 +37,7 @@ export async function prepare(config: Configuration, options: PrepareOptions): P
   return {
     knexMigrationConfig: (connectionId: string) => ({
       tableName: config.migration.tableName,
-      migrationSource: migrationContext ? new KnexMigrationSource(migrationContext.bind(connectionId)) : null
+      migrationSource: migrationContext ? new KnexMigrationSource(migrationContext.bind(connectionId)) : undefined
     })
   };
 }
diff --git a/src/migration/KnexMigrationSource.ts b/src/migration/KnexMigrationSource.ts
@@ -1,4 +1,6 @@
+import { Knex } from 'knex';
 import { dbLogger } from '../util/logger';
+import MigrationRunner from './domain/MigrationRunner';
 import MigrationSourceContext from './domain/MigrationSourceContext';
 
 /**
@@ -7,7 +9,7 @@ import MigrationSourceContext from './domain/MigrationSourceContext';
  *
  * Reference: http://knexjs.org/#Migrations-API
  */
-class KnexMigrationSource {
+class KnexMigrationSource implements Knex.MigrationSource<string> {
   private migrationContext: MigrationSourceContext;
   private log: debug.Debugger;
 
@@ -47,15 +49,16 @@ class KnexMigrationSource {
   /**
    * Get the migration runner.
    *
-   * @param {SqlMigrationEntry} migration
+   * @param {string} name
+   * @returns {Promise<MigrationRunner>}
    */
-  getMigration(name: string) {
+  getMigration(name: string): Promise<MigrationRunner> {
     const migration = this.migrationContext.get(name);
 
     this.log(`getMigration - ${name}`);
     this.log(`getMigration - resolve: %o`, migration);
 
-    return migration;
+    return Promise.resolve(migration);
   }
 }
 
diff --git a/src/migration/domain/JavaScriptMigrationEntry.ts b/src/migration/domain/JavaScriptMigrationEntry.ts
@@ -1,4 +1,4 @@
-import Knex from 'knex';
+import { Knex } from 'knex';
 
 interface JavaScriptMigrationEntry {
   name: string;
diff --git a/src/migration/domain/MigrationRunner.ts b/src/migration/domain/MigrationRunner.ts
@@ -1,4 +1,4 @@
-import Knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * Contract for a migration runner.
diff --git a/src/migration/service/knexMigrator.ts b/src/migration/service/knexMigrator.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 import * as path from 'path';
 
 import { PrepareOptions } from '../../init';
diff --git a/src/migration/source-types/SqlMigrationSourceContext.ts b/src/migration/source-types/SqlMigrationSourceContext.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import MigrationRunner from '../domain/MigrationRunner';
 import { dbLogger, log as logger } from '../../util/logger';
diff --git a/src/service/configInjection.ts b/src/service/configInjection.ts
@@ -1,6 +1,6 @@
 import * as fs from 'fs';
 import * as path from 'path';
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import Mapping from '../domain/Mapping';
 import { dbLogger } from '../util/logger';
@@ -74,6 +74,12 @@ export async function setup(trx: Knex.Transaction, context: SynchronizeContext):
 
   const values = convertToKeyValuePairs(injectedConfig.vars);
 
+  if (!values.length) {
+    log(`Config not available. Skipping insertion on ${INJECTED_CONFIG_TABLE} table.`);
+
+    return;
+  }
+
   // Create table
   log(`Creating table ${INJECTED_CONFIG_TABLE}.`);
   await trx.schema.createTable(INJECTED_CONFIG_TABLE, table => {
diff --git a/src/service/sqlRunner.ts b/src/service/sqlRunner.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 import * as path from 'path';
 import { reverse, keys } from 'ramda';
 
diff --git a/src/service/sync.ts b/src/service/sync.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import * as sqlRunner from './sqlRunner';
 import { dbLogger } from '../util/logger';
diff --git a/src/util/db.ts b/src/util/db.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex, knex } from 'knex';
 import { dbLogger, log } from './logger';
 import { getConnectionId } from '../config';
 import ConnectionConfig from '../domain/ConnectionConfig';
@@ -48,11 +48,22 @@ export function createInstance(config: ConnectionConfig): Knex {
     throw new Error('The provided connection already contains a connection instance.');
   }
 
-  const { host, database } = config.connection as any;
+  const { host, database, user } = config.connection as Knex.ConnectionConfig;
 
   log(`Connecting to database: ${host}/${database}`);
 
-  return Knex({
+  if (config.client === 'mssql') {
+    return knex({
+      client: config.client,
+      connection: {
+        ...(config.connection as Knex.MsSqlConnectionConfig),
+        server: host,
+        userName: user
+      }
+    });
+  }
+
+  return knex({
     client: config.client,
     connection: config.connection
   });
diff --git a/test/cli/commands/make.test.ts b/test/cli/commands/make.test.ts
@@ -10,7 +10,7 @@ import { mkdir, mkdtemp, write, exists, glob, read } from '../../../src/util/fs'
 
 const MIGRATION_TEMPLATE_PATH = path.resolve(__dirname, '../../../assets/templates/migration');
 const CUSTOM_CREATE_TEMPLATE = `
-import * as Knex from "knex";
+import { Knex } from "knex";
 
 export function up(db: Knex) {
   return db.schema.createTable("{{table}}", table => {})
diff --git a/test/unit/migration/JavaScriptMigrationContext.test.ts b/test/unit/migration/JavaScriptMigrationContext.test.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 import { describe, it } from 'mocha';
 import JavaScriptMigrationEntry from '../../../src/migration/domain/JavaScriptMigrationEntry';
 import JavaScriptMigrationContext from '../../../src/migration/source-types/JavaScriptMigrationSourceContext';
diff --git a/test/unit/migration/KnexMigrationSource.test.ts b/test/unit/migration/KnexMigrationSource.test.ts
@@ -54,7 +54,7 @@ describe('MIGRATION: KnexMigrationSource', () => {
       const instance = await getInstance();
       const dbStub = {} as any;
 
-      const migration = instance.getMigration('mgr_002');
+      const migration = await instance.getMigration('mgr_002');
 
       const upResult = await migration.up(dbStub);
       const downResult = await migration.down(dbStub);
diff --git a/tsconfig.json b/tsconfig.json
@@ -11,6 +11,7 @@
     "target": "es2017",
     "skipLibCheck": true,
     "allowSyntheticDefaultImports": true,
+    "useUnknownInCatchVariables": false,
     "typeRoots": ["src/@types"]
   },
   "include": ["src/**/*"],
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import * as Knex from 'knex';`
	`1`	`+import { Knex } from 'knex';`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* Create {{table}} table.`