dbgate-api-premium 6.1.1 → 6.1.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dbgate-api-premium",
   "main": "src/index.js",
-  "version": "6.1.1",
+  "version": "6.1.3",
   "homepage": "https://dbgate.org/",
   "repository": {
     "type": "git",
@@ -29,10 +29,10 @@
     "compare-versions": "^3.6.0",
     "cors": "^2.8.5",
     "cross-env": "^6.0.3",
-    "dbgate-datalib": "^6.1.1",
-    "dbgate-query-splitter": "^4.11.2",
-    "dbgate-sqltree": "^6.1.1",
-    "dbgate-tools": "^6.1.1",
+    "dbgate-datalib": "^6.1.3",
+    "dbgate-query-splitter": "^4.11.3",
+    "dbgate-sqltree": "^6.1.3",
+    "dbgate-tools": "^6.1.3",
     "debug": "^4.3.4",
     "diff": "^5.0.0",
     "diff2html": "^3.4.13",
@@ -60,7 +60,7 @@
     "rimraf": "^3.0.0",
     "semver": "^7.6.3",
     "simple-encryptor": "^4.0.0",
-    "ssh2": "^1.11.0",
+    "ssh2": "^1.16.0",
     "stream-json": "^1.8.0",
     "tar": "^6.0.5"
   },
@@ -81,7 +81,7 @@
   "devDependencies": {
     "@types/fs-extra": "^9.0.11",
     "@types/lodash": "^4.14.149",
-    "dbgate-types": "^6.1.1",
+    "dbgate-types": "^6.1.3",
     "env-cmd": "^10.1.0",
     "jsdoc-to-markdown": "^9.0.5",
     "node-loader": "^1.0.2",

package/src/controllers/connections.js

@@ -222,7 +222,7 @@ module.exports = {
   },
 
   test_meta: true,
-  test({ connection, requestDbList }) {
+  test({ connection, requestDbList = false }) {
     const subprocess = fork(
       global['API_PACKAGE'] || process.argv[1],
       [
@@ -237,7 +237,7 @@ module.exports = {
       }
     );
     pipeForkLogs(subprocess);
-    subprocess.send({ connection, requestDbList });
+    subprocess.send({ ...connection, requestDbList });
     return new Promise(resolve => {
       subprocess.on('message', resp => {
         if (handleProcessCommunication(resp, subprocess)) return;
@@ -267,7 +267,7 @@ module.exports = {
     }
 
     if (test) {
-      const testRes = await this.test(res);
+      const testRes = await this.test({ connection: res });
       if (testRes.msgtype == 'connected') {
         volatileConnections[res._id] = res;
         return {

package/src/controllers/runners.js

@@ -49,7 +49,8 @@ logger.info('Finished job script');
 dbgateApi.runScript(run);
 `;
 
-const loaderScriptTemplate = (functionName, props, runid) => `
+const loaderScriptTemplate = (prefix, functionName, props, runid) => `
+${prefix}
 const dbgateApi = require(process.env.DBGATE_API);
 dbgateApi.initializeApiEnvironment();
 ${requirePluginsTemplate(extractShellApiPlugins(functionName, props))}
@@ -149,7 +150,7 @@ module.exports = {
     byline(subprocess.stdout).on('data', pipeDispatcher('info'));
     byline(subprocess.stderr).on('data', pipeDispatcher('error'));
     subprocess.on('exit', code => {
-      this.rejectRequest(runid, { message: 'No data retured, maybe input data source is too big' });
+      this.rejectRequest(runid, { message: 'No data returned, maybe input data source is too big' });
       logger.info({ code, pid: subprocess.pid }, 'Exited process');
       socket.emit(`runner-done-${runid}`, code);
     });
@@ -224,10 +225,14 @@ module.exports = {
 
   loadReader_meta: true,
   async loadReader({ functionName, props }) {
+    const prefix = extractShellApiPlugins(functionName)
+      .map(packageName => `// @require ${packageName}\n`)
+      .join('');
+
     const promise = new Promise((resolve, reject) => {
       const runid = crypto.randomUUID();
       this.requests[runid] = [resolve, reject];
-      this.startCore(runid, loaderScriptTemplate(functionName, props, runid));
+      this.startCore(runid, loaderScriptTemplate(prefix, functionName, props, runid));
     });
     return promise;
   },

package/src/currentVersion.js

@@ -1,5 +1,5 @@
 
 module.exports = { 
-  version: '6.1.1',
-  buildTime: '2024-12-23T06:08:08.745Z'
+  version: '6.1.3',
+  buildTime: '2025-01-10T10:40:18.786Z'
 };

package/src/gistSecret.js

@@ -1,2 +1,2 @@
 
-module.exports = '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';
+module.exports = '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';

package/src/proc/connectProcess.js

@@ -16,9 +16,9 @@ Platform: ${process.platform}
 
 function start() {
   childProcessChecker();
-  process.on('message', async args => {
+  process.on('message', async connection => {
     // @ts-ignore
-    const { connection, requestDbList } = args;
+    const { requestDbList } = connection;
     if (handleProcessCommunication(connection)) return;
     try {
       const driver = requireEngineDriver(connection);

package/src/proc/serverConnectionProcess.js

@@ -166,7 +166,9 @@ function start() {
     if (time - lastPing > 40 * 1000) {
       logger.info('Server connection not alive, exiting');
       const driver = requireEngineDriver(storedConnection);
-      await driver.close(dbhan);
+      if (dbhan) {
+        await driver.close(dbhan);
+      }
       process.exit(0);
     }
   }, 10 * 1000);

package/src/proc/sshForwardProcess.js

@@ -7,7 +7,7 @@ const { getLogger, extractErrorLogData, extractErrorMessage } = require('dbgate-
 
 const logger = getLogger('sshProcess');
 
-async function getSshConnection(connection) {
+async function getSshConnection(connection, tunnelConfig) {
   const sshConfig = {
     endHost: connection.sshHost || '',
     endPort: connection.sshPort || 22,
@@ -23,6 +23,7 @@ async function getSshConnection(connection) {
         : undefined,
     skipAutoPrivateKey: true,
     noReadline: true,
+    bindHost: tunnelConfig.fromHost,
   };
 
   const sshConn = new SSHConnection(sshConfig);
@@ -31,7 +32,7 @@ async function getSshConnection(connection) {
 
 async function handleStart({ connection, tunnelConfig }) {
   try {
-    const sshConn = await getSshConnection(connection);
+    const sshConn = await getSshConnection(connection, tunnelConfig);
     await sshConn.forward(tunnelConfig);
 
     process.send({

package/src/utility/SSHConnection.js

@@ -130,7 +130,7 @@ class SSHConnection {
     const connectionToBastion = await this.connect(bastionHost);
     return new Promise((resolve, reject) => {
       connectionToBastion.forwardOut(
-        '127.0.0.1',
+        this.options.bindHost,
         22,
         this.options.endHost,
         this.options.endPort || 22,
@@ -228,9 +228,9 @@ class SSHConnection {
             options.toPort
           );
           connection.forwardOut(
-            'localhost',
+            this.options.bindHost,
             options.fromPort,
-            options.toHost || 'localhost',
+            options.toHost || this.options.bindHost,
             options.toPort,
             (error, stream) => {
               if (error) {
@@ -241,7 +241,7 @@ class SSHConnection {
             }
           );
         })
-        .listen(options.fromPort, 'localhost', () => {
+        .listen(options.fromPort, this.options.bindHost, () => {
           return resolve();
         });
     });

package/src/utility/connectUtility.js

@@ -63,7 +63,7 @@ async function connectUtility(driver, storedConnection, connectionMode, addition
       throw new Error(tunnel.message);
     }
 
-    connection.server = 'localhost';
+    connection.server = tunnel.localHost;
     connection.port = tunnel.localPort;
   }
 

package/src/utility/directories.js

@@ -97,7 +97,7 @@ function packagedPluginsDir() {
     // }
   }
   if (processArgs.runE2eTests) {
-    return path.resolve('packer/build/plugins');    
+    return path.resolve('packer/build/plugins');
   }
   return null;
 }
@@ -113,7 +113,7 @@ function getPluginBackendPath(packageName) {
     return path.join(packagedPluginsDir(), packageName, 'dist', 'backend.js');
   }
 
-  const res = path.join(pluginsdir(), packageName, 'dist', 'backend.js')
+  const res = path.join(pluginsdir(), packageName, 'dist', 'backend.js');
   if (fs.existsSync(res)) {
     return res;
   }

package/src/utility/processArgs.js

@@ -1,3 +1,5 @@
+const path = require('path');
+
 function getNamedArg(name) {
   const argIndex = process.argv.indexOf(name);
   if (argIndex > 0) {
@@ -20,13 +22,15 @@ function getPassArgs() {
   const res = [];
   if (global['PLUGINS_DIR']) {
     res.push('--plugins-dir', global['PLUGINS_DIR']);
+  } else if (runE2eTests) {
+    res.push('--plugins-dir', path.resolve('packer/build/plugins'));
   }
   if (listenApiChild) {
     res.push('listen-api-child');
   }
-  if (runE2eTests) {
-    res.push('--run-e2e-tests');
-  }
+  // if (runE2eTests) {
+  //   res.push('--run-e2e-tests');
+  // }
   return res;
 }
 

package/src/utility/sshTunnel.js

@@ -43,33 +43,44 @@ function callForwardProcess(connection, tunnelConfig, tunnelCacheKey) {
     logger.error(extractErrorLogData(err), 'Error connecting SSH');
   }
   return new Promise((resolve, reject) => {
+    let promiseHandled = false;
     subprocess.on('message', resp => {
       // @ts-ignore
       const { msgtype, errorMessage } = resp;
       if (msgtype == 'connected') {
         resolve(subprocess);
+        promiseHandled = true;
       }
       if (msgtype == 'error') {
         reject(new Error(errorMessage));
+        promiseHandled = true;
       }
     });
     subprocess.on('exit', code => {
       logger.info('SSH forward process exited');
       delete sshTunnelCache[tunnelCacheKey];
+      if (!promiseHandled) {
+        reject(new Error('SSH forward process exited, try to change "Local host address for SSH connections" in Settings/Connections'));
+      }
     });
   });
 }
 
 async function getSshTunnel(connection) {
+  const config = require('../controllers/config');
+
   const tunnelCacheKey = stableStringify(_.pick(connection, TUNNEL_FIELDS));
+  const globalSettings = await config.getSettings();
 
   return await lock.acquire(tunnelCacheKey, async () => {
     if (sshTunnelCache[tunnelCacheKey]) return sshTunnelCache[tunnelCacheKey];
     const localPort = await portfinder.getPortPromise({ port: 10000, stopPort: 60000 });
+    const localHost = globalSettings?.['connection.sshBindHost'] || '127.0.0.1';
     // workaround for `getPortPromise` not releasing the port quickly enough
     await new Promise(resolve => setTimeout(resolve, 500));
     const tunnelConfig = {
       fromPort: localPort,
+      fromHost: localHost,
       toPort: connection.port,
       toHost: connection.server,
     };
@@ -87,6 +98,7 @@ async function getSshTunnel(connection) {
       sshTunnelCache[tunnelCacheKey] = {
         state: 'ok',
         localPort,
+        localHost,
         subprocess,
       };
       return sshTunnelCache[tunnelCacheKey];