dbgate-api 5.5.5 → 5.5.6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dbgate-api",
   "main": "src/index.js",
-  "version": "5.5.5",
+  "version": "5.5.6",
   "homepage": "https://dbgate.org/",
   "repository": {
     "type": "git",
@@ -27,10 +27,10 @@
     "compare-versions": "^3.6.0",
     "cors": "^2.8.5",
     "cross-env": "^6.0.3",
-    "dbgate-datalib": "^5.5.5",
+    "dbgate-datalib": "^5.5.6",
     "dbgate-query-splitter": "^4.11.2",
-    "dbgate-sqltree": "^5.5.5",
-    "dbgate-tools": "^5.5.5",
+    "dbgate-sqltree": "^5.5.6",
+    "dbgate-tools": "^5.5.6",
     "debug": "^4.3.4",
     "diff": "^5.0.0",
     "diff2html": "^3.4.13",
@@ -77,7 +77,7 @@
   "devDependencies": {
     "@types/fs-extra": "^9.0.11",
     "@types/lodash": "^4.14.149",
-    "dbgate-types": "^5.5.5",
+    "dbgate-types": "^5.5.6",
     "env-cmd": "^10.1.0",
     "node-loader": "^1.0.2",
     "nodemon": "^2.0.2",

package/src/controllers/auth.js

@@ -22,7 +22,8 @@ function unauthorizedResponse(req, res, text) {
   // if (req.path == getExpressPath('/connections/list')) {
   //   return res.json([]);
   // }
-  return res.sendStatus(401).send(text);
+
+  return res.status(401).send(text);
 }
 
 function authMiddleware(req, res, next) {

package/src/controllers/config.js

@@ -17,6 +17,7 @@ const { checkLicense, checkLicenseKey } = require('../utility/checkLicense');
 const storage = require('./storage');
 const { getAuthProxyUrl } = require('../utility/authProxy');
 const { getPublicHardwareFingerprint } = require('../utility/hardwareFingerprint');
+const { extractErrorMessage } = require('dbgate-tools');
 
 const lock = new AsyncLock();
 
@@ -39,10 +40,12 @@ module.exports = {
     const isUserLoggedIn = authProvider.isUserLoggedIn(req);
 
     const singleConid = authProvider.getSingleConnectionId(req);
+    const storageConnectionError = storage.getStorageConnectionError();
 
-    const singleConnection = singleConid
-      ? await connections.getCore({ conid: singleConid })
-      : connections.singleConnection;
+    const singleConnection =
+      singleConid && !storageConnectionError
+        ? await connections.getCore({ conid: singleConid })
+        : connections.singleConnection;
 
     let configurationError = null;
     if (process.env.STORAGE_DATABASE && process.env.BASIC_AUTH) {
@@ -50,8 +53,13 @@ module.exports = {
         'Basic authentization is not allowed, when using storage. Cannot use both STORAGE_DATABASE and BASIC_AUTH';
     }
 
-    const checkedLicense = await checkLicense();
+    if (storageConnectionError && !configurationError) {
+      configurationError = extractErrorMessage(storageConnectionError);
+    }
+
+    const checkedLicense = storageConnectionError ? null : await checkLicense();
     const isLicenseValid = checkedLicense?.status == 'ok';
+    const logoutUrl = storageConnectionError ? null : await authProvider.getLogoutUrl();
 
     return {
       runAsPortal: !!connections.portalConnections,
@@ -68,7 +76,7 @@ module.exports = {
       trialDaysLeft: checkedLicense?.isGeneratedTrial && !checkedLicense?.isExpired ? checkedLicense?.daysLeft : null,
       checkedLicense,
       configurationError,
-      logoutUrl: await authProvider.getLogoutUrl(),
+      logoutUrl,
       permissions,
       login,
       // ...additionalConfigProps,

package/src/controllers/storage.js

@@ -17,4 +17,8 @@ module.exports = {
   async getConnectionsForLoginPage() {
     return null;
   },
+
+  getStorageConnectionError() {
+    return null;
+  }
 };

package/src/currentVersion.js

@@ -1,5 +1,5 @@
 
 module.exports = { 
-  version: '5.5.5',
-  buildTime: '2024-10-11T08:23:34.200Z'
+  version: '5.5.6',
+  buildTime: '2024-10-17T11:26:28.099Z'
 };

package/src/index.js

@@ -4,11 +4,13 @@ const fs = require('fs');
 const moment = require('moment');
 const path = require('path');
 const { logsdir, setLogsFilePath, getLogsFilePath } = require('./utility/directories');
+const currentVersion = require('./currentVersion');
 
 const logger = getLogger('apiIndex');
 
 process.on('uncaughtException', err => {
-  logger.fatal(extractErrorLogData(err), 'Uncaught exception');
+  logger.fatal(extractErrorLogData(err), 'Uncaught exception, exiting process');
+  process.exit(1);
 });
 
 if (processArgs.startProcess) {
@@ -99,10 +101,17 @@ function configureLogger() {
 
 if (processArgs.listenApi) {
   configureLogger();
+  logger.info(`Starting API process version ${currentVersion.version}`);
+
+  if (process.env.DEBUG_PRINT_ENV_VARIABLES) {
+    logger.info('Debug print environment variables:');
+    for (const key of Object.keys(process.env)) {
+      logger.info(`  ${key}: ${JSON.stringify(process.env[key])}`);
+    }
+  }
 }
 
 const shell = require('./shell/index');
-const currentVersion = require('./currentVersion');
 
 global.DBGATE_PACKAGES = {
   'dbgate-tools': require('dbgate-tools'),

package/src/proc/connectProcess.js

@@ -20,9 +20,10 @@ function start() {
     if (handleProcessCommunication(connection)) return;
     try {
       const driver = requireEngineDriver(connection);
-      const conn = await connectUtility(driver, connection, 'app');
-      const res = await driver.getVersion(conn);
+      const dbhan = await connectUtility(driver, connection, 'app');
+      const res = await driver.getVersion(dbhan);
       process.send({ msgtype: 'connected', ...res });
+      await driver.close(dbhan);
     } catch (e) {
       console.error(e);
       process.send({

package/src/proc/databaseConnectionProcess.js

@@ -329,8 +329,9 @@ async function handleSqlPreview({ msgid, objects, options }) {
     await generator.dump();
     process.send({ msgtype: 'response', msgid, sql: dmp.s, isTruncated: generator.isTruncated });
     if (generator.isUnhandledException) {
-      setTimeout(() => {
+      setTimeout(async () => {
         logger.error('Exiting because of unhandled exception');
+        await driver.close(dbhan);
         process.exit(0);
       }, 500);
     }
@@ -406,10 +407,12 @@ async function handleMessage({ msgtype, ...other }) {
 function start() {
   childProcessChecker();
 
-  setInterval(() => {
+  setInterval(async () => {
     const time = new Date().getTime();
     if (time - lastPing > 40 * 1000) {
       logger.info('Database connection not alive, exiting');
+      const driver = requireEngineDriver(storedConnection);
+      await driver.close(dbhan);
       process.exit(0);
     }
   }, 10 * 1000);

package/src/proc/serverConnectionProcess.js

@@ -6,7 +6,7 @@ const connectUtility = require('../utility/connectUtility');
 const { handleProcessCommunication } = require('../utility/processComm');
 const logger = getLogger('srvconnProcess');
 
-let systemConnection;
+let dbhan;
 let storedConnection;
 let lastDatabases = null;
 let lastStatus = null;
@@ -16,7 +16,7 @@ let afterConnectCallbacks = [];
 async function handleRefresh() {
   const driver = requireEngineDriver(storedConnection);
   try {
-    let databases = await driver.listDatabases(systemConnection);
+    let databases = await driver.listDatabases(dbhan);
     if (storedConnection?.allowedDatabases?.trim()) {
       const allowedDatabaseList = storedConnection.allowedDatabases
         .split('\n')
@@ -46,7 +46,7 @@ async function handleRefresh() {
 
 async function readVersion() {
   const driver = requireEngineDriver(storedConnection);
-  const version = await driver.getVersion(systemConnection);
+  const version = await driver.getVersion(dbhan);
   process.send({ msgtype: 'version', version });
 }
 
@@ -70,7 +70,7 @@ async function handleConnect(connection) {
 
   const driver = requireEngineDriver(storedConnection);
   try {
-    systemConnection = await connectUtility(driver, storedConnection, 'app');
+    dbhan = await connectUtility(driver, storedConnection, 'app');
     readVersion();
     handleRefresh();
     if (extractBoolSettingsValue(globalSettings, 'connection.autoRefresh', false)) {
@@ -95,7 +95,7 @@ async function handleConnect(connection) {
 }
 
 function waitConnected() {
-  if (systemConnection) return Promise.resolve();
+  if (dbhan) return Promise.resolve();
   return new Promise((resolve, reject) => {
     afterConnectCallbacks.push([resolve, reject]);
   });
@@ -108,14 +108,14 @@ function handlePing() {
 async function handleDatabaseOp(op, { msgid, name }) {
   try {
     const driver = requireEngineDriver(storedConnection);
-    systemConnection = await connectUtility(driver, storedConnection, 'app');
+    dbhan = await connectUtility(driver, storedConnection, 'app');
     if (driver[op]) {
-      await driver[op](systemConnection, name);
+      await driver[op](dbhan, name);
     } else {
       const dmp = driver.createDumper();
       dmp[op](name);
       logger.info({ sql: dmp.s }, 'Running script');
-      await driver.query(systemConnection, dmp.s, { discardResult: true });
+      await driver.query(dbhan, dmp.s, { discardResult: true });
     }
     await handleRefresh();
 
@@ -137,11 +137,11 @@ async function handleDriverDataCore(msgid, callMethod) {
 }
 
 async function handleServerSummary({ msgid }) {
-  return handleDriverDataCore(msgid, driver => driver.serverSummary(systemConnection));
+  return handleDriverDataCore(msgid, driver => driver.serverSummary(dbhan));
 }
 
 async function handleSummaryCommand({ msgid, command, row }) {
-  return handleDriverDataCore(msgid, driver => driver.summaryCommand(systemConnection, command, row));
+  return handleDriverDataCore(msgid, driver => driver.summaryCommand(dbhan, command, row));
 }
 
 const messageHandlers = {
@@ -161,10 +161,13 @@ async function handleMessage({ msgtype, ...other }) {
 function start() {
   childProcessChecker();
 
-  setInterval(() => {
+  setInterval(async () => {
     const time = new Date().getTime();
     if (time - lastPing > 40 * 1000) {
+      
       logger.info('Server connection not alive, exiting');
+      const driver = requireEngineDriver(storedConnection);
+      await driver.close(dbhan);
       process.exit(0);
     }
   }, 10 * 1000);

package/src/proc/sessionProcess.js

@@ -14,7 +14,7 @@ const { getLogger, extractIntSettingsValue, extractBoolSettingsValue } = require
 
 const logger = getLogger('sessionProcess');
 
-let systemConnection;
+let dbhan;
 let storedConnection;
 let afterConnectCallbacks = [];
 // let currentHandlers = [];
@@ -177,7 +177,7 @@ function handleStream(driver, resultIndexHolder, sqlItem) {
   return new Promise((resolve, reject) => {
     const start = sqlItem.trimStart || sqlItem.start;
     const handler = new StreamHandler(resultIndexHolder, resolve, start && start.line);
-    driver.stream(systemConnection, sqlItem.text, handler);
+    driver.stream(dbhan, sqlItem.text, handler);
   });
 }
 
@@ -196,7 +196,7 @@ async function handleConnect(connection) {
   storedConnection = connection;
 
   const driver = requireEngineDriver(storedConnection);
-  systemConnection = await connectUtility(driver, storedConnection, 'app');
+  dbhan = await connectUtility(driver, storedConnection, 'app');
   for (const [resolve] of afterConnectCallbacks) {
     resolve();
   }
@@ -210,7 +210,7 @@ async function handleConnect(connection) {
 // }
 
 function waitConnected() {
-  if (systemConnection) return Promise.resolve();
+  if (dbhan) return Promise.resolve();
   return new Promise((resolve, reject) => {
     afterConnectCallbacks.push([resolve, reject]);
   });
@@ -230,7 +230,7 @@ async function handleStartProfiler({ jslid }) {
   const writer = new TableWriter();
   writer.initializeFromReader(jslid);
 
-  currentProfiler = await driver.startProfiler(systemConnection, {
+  currentProfiler = await driver.startProfiler(dbhan, {
     row: data => writer.rowFromReader(data),
   });
   currentProfiler.writer = writer;
@@ -241,7 +241,7 @@ async function handleStopProfiler({ jslid }) {
 
   const driver = requireEngineDriver(storedConnection);
   currentProfiler.writer.close();
-  driver.stopProfiler(systemConnection, currentProfiler);
+  driver.stopProfiler(dbhan, currentProfiler);
   currentProfiler = null;
 }
 
@@ -304,7 +304,7 @@ async function handleExecuteReader({ jslid, sql, fileName }) {
   const writer = new TableWriter();
   writer.initializeFromReader(jslid);
 
-  const reader = await driver.readQuery(systemConnection, sql);
+  const reader = await driver.readQuery(dbhan, sql);
 
   reader.on('data', data => {
     writer.rowFromReader(data);
@@ -340,10 +340,12 @@ function start() {
 
   lastPing = new Date().getTime();
 
-  setInterval(() => {
+  setInterval(async () => {
     const time = new Date().getTime();
     if (time - lastPing > 25 * 1000) {
       logger.info('Session not alive, exiting');
+      const driver = requireEngineDriver(storedConnection);
+      await driver.close(dbhan);
       process.exit(0);
     }
 
@@ -362,6 +364,8 @@ function start() {
       executingScripts == 0
     ) {
       logger.info('Session not active, exiting');
+      const driver = requireEngineDriver(storedConnection);
+      await driver.close(dbhan);
       process.exit(0);
     }
   }, 10 * 1000);