dbgate-api/src/proc/serverConnectionProcess.js

Allows run DbGate data-manipulation scripts.

const stableStringify = require('json-stable-stringify');
const { extractBoolSettingsValue, extractIntSettingsValue, getLogger, extractErrorLogData } = require('dbgate-tools');
const childProcessChecker = require('../utility/childProcessChecker');
const requireEngineDriver = require('../utility/requireEngineDriver');
const { connectUtility } = require('../utility/connectUtility');
const { handleProcessCommunication } = require('../utility/processComm');
const logger = getLogger('srvconnProcess');

let dbhan;
let storedConnection;
let lastDatabases = null;
let lastStatus = null;
let lastPing = null;
let afterConnectCallbacks = [];

async function handleRefresh() {
  const driver = requireEngineDriver(storedConnection);
  try {
    let databases = await driver.listDatabases(dbhan);
    if (storedConnection?.allowedDatabases?.trim()) {
      const allowedDatabaseList = storedConnection.allowedDatabases
        .split('\n')
        .map(x => x.trim().toLowerCase())
        .filter(x => x);
      databases = databases.filter(x => allowedDatabaseList.includes(x.name.toLocaleLowerCase()));
    }
    if (storedConnection?.allowedDatabasesRegex?.trim()) {
      const regex = new RegExp(storedConnection.allowedDatabasesRegex, 'i');
      databases = databases.filter(x => regex.test(x.name));
    }
    setStatusName('ok');
    const databasesString = stableStringify(databases);
    if (lastDatabases != databasesString) {
      process.send({ msgtype: 'databases', databases });
      lastDatabases = databasesString;
    }
  } catch (err) {
    setStatus({
      name: 'error',
      message: err.message,
    });
    logger.error(extractErrorLogData(err), 'DBGM-00152 Error refreshing server databases');
    setTimeout(() => process.exit(1), 1000);
  }
}

async function readVersion() {
  const driver = requireEngineDriver(storedConnection);
  let version;
  try {
    version = await driver.getVersion(dbhan);
  } catch (err) {
    logger.error(extractErrorLogData(err), 'DBGM-00153 Error getting DB server version');
    version = { version: 'Unknown' };
  }
  process.send({ msgtype: 'version', version });
}

function setStatus(status) {
  const statusString = stableStringify(status);
  if (lastStatus != statusString) {
    process.send({ msgtype: 'status', status });
    lastStatus = statusString;
  }
}

function setStatusName(name) {
  setStatus({ name });
}

async function handleConnect(connection) {
  storedConnection = connection;
  const { globalSettings } = storedConnection;
  setStatusName('pending');
  lastPing = new Date().getTime();

  const driver = requireEngineDriver(storedConnection);
  try {
    dbhan = await connectUtility(driver, storedConnection, 'app');
    readVersion();
    handleRefresh();
    if (extractBoolSettingsValue(globalSettings, 'connection.autoRefresh', false)) {
      setInterval(
        handleRefresh,
        extractIntSettingsValue(globalSettings, 'connection.autoRefreshInterval', 30, 5, 3600) * 1000
      );
    }
  } catch (err) {
    setStatus({
      name: 'error',
      message: err.message,
    });
    logger.error(extractErrorLogData(err), 'DBGM-00154 Error connecting to server');
    setTimeout(() => process.exit(1), 1000);
  }

  for (const [resolve] of afterConnectCallbacks) {
    resolve();
  }
  afterConnectCallbacks = [];
}

function waitConnected() {
  if (dbhan) return Promise.resolve();
  return new Promise((resolve, reject) => {
    afterConnectCallbacks.push([resolve, reject]);
  });
}

function handlePing() {
  lastPing = new Date().getTime();
}

async function handleDatabaseOp(op, { msgid, name }) {
  try {
    const driver = requireEngineDriver(storedConnection);
    dbhan = await connectUtility(driver, storedConnection, 'app');
    if (driver[op]) {
      await driver[op](dbhan, name);
    } else {
      const dmp = driver.createDumper();
      dmp[op](name);
      logger.info({ sql: dmp.s }, 'DBGM-00043 Running script');
      await driver.query(dbhan, dmp.s, { discardResult: true });
    }
    await handleRefresh();

    process.send({ msgtype: 'response', msgid, status: 'ok' });
  } catch (err) {
    process.send({ msgtype: 'response', msgid, errorMessage: err.message });
  }
}

async function handleDriverDataCore(msgid, callMethod) {
  await waitConnected();
  const driver = requireEngineDriver(storedConnection);
  try {
    const result = await callMethod(driver);
    process.send({ msgtype: 'response', msgid, result });
  } catch (err) {
    process.send({ msgtype: 'response', msgid, errorMessage: err.message });
  }
}

async function handleServerSummary({ msgid }) {
  return handleDriverDataCore(msgid, driver => driver.serverSummary(dbhan));
}

async function handleKillDatabaseProcess({ msgid, pid }) {
  await waitConnected();
  const driver = requireEngineDriver(storedConnection);

  try {
    const result = await driver.killProcess(dbhan, Number(pid));
    process.send({ msgtype: 'response', msgid, result });
  } catch (err) {
    process.send({ msgtype: 'response', msgid, errorMessage: err.message });
  }
}

async function handleListDatabaseProcesses({ msgid }) {
  await waitConnected();
  const driver = requireEngineDriver(storedConnection);

  try {
    const result = await driver.listProcesses(dbhan);
    process.send({ msgtype: 'response', msgid, result });
  } catch (err) {
    process.send({ msgtype: 'response', msgid, errorMessage: err.message });
  }
}

async function handleSummaryCommand({ msgid, command, row }) {
  return handleDriverDataCore(msgid, driver => driver.summaryCommand(dbhan, command, row));
}

const messageHandlers = {
  connect: handleConnect,
  ping: handlePing,
  serverSummary: handleServerSummary,
  killDatabaseProcess: handleKillDatabaseProcess,
  listDatabaseProcesses: handleListDatabaseProcesses,
  summaryCommand: handleSummaryCommand,
  createDatabase: props => handleDatabaseOp('createDatabase', props),
  dropDatabase: props => handleDatabaseOp('dropDatabase', props),
};

async function handleMessage({ msgtype, ...other }) {
  const handler = messageHandlers[msgtype];
  await handler(other);
}

function start() {
  childProcessChecker();

  setInterval(async () => {
    const time = new Date().getTime();
    if (time - lastPing > 40 * 1000) {
      logger.info('DBGM-00044 Server connection not alive, exiting');
      const driver = requireEngineDriver(storedConnection);
      if (dbhan) {
        await driver.close(dbhan);
      }
      process.exit(0);
    }
  }, 10 * 1000);

  process.on('message', async message => {
    if (handleProcessCommunication(message)) return;
    try {
      await handleMessage(message);
    } catch (err) {
      setStatus({
        name: 'error',
        message: err.message,
      });
      logger.error(extractErrorLogData(err), `DBGM-00155 Error processing message ${message?.['msgtype']}`);
    }
  });
}

module.exports = { start };