dbgate-api 4.8.6 → 5.0.0-alpha.1

package/env/portal/.env

@@ -38,7 +38,7 @@ SSH_LOGIN_mysqlssh=root
 SSH_PASSWORD_mysqlssh=xxx
 
 LABEL_sqlite=sqlite
-FILE_sqlite=/home/jena/dbgate-data/files/sqlite/feeds.sqlite
+FILE_sqlite=/home/jena/.dbgate/files/sqlite/feeds.sqlite
 ENGINE_sqlite=sqlite@dbgate-plugin-sqlite
 
 # docker run -p 3000:3000 -e CONNECTIONS=mongo -e URL_mongo=mongodb://localhost:27017 -e ENGINE_mongo=mongo@dbgate-plugin-mongo -e LABEL_mongo=mongo dbgate/dbgate:beta

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dbgate-api",
   "main": "src/index.js",
-  "version": "4.8.6",
+  "version": "5.0.0-alpha.1",
   "homepage": "https://dbgate.org/",
   "repository": {
     "type": "git",
@@ -25,9 +25,9 @@
     "compare-versions": "^3.6.0",
     "cors": "^2.8.5",
     "cross-env": "^6.0.3",
-    "dbgate-query-splitter": "^4.8.3",
-    "dbgate-sqltree": "^4.8.6",
-    "dbgate-tools": "^4.8.6",
+    "dbgate-query-splitter": "^4.9.0",
+    "dbgate-sqltree": "^5.0.0-alpha.1",
+    "dbgate-tools": "^5.0.0-alpha.1",
     "diff": "^5.0.0",
     "diff2html": "^3.4.13",
     "eslint": "^6.8.0",
@@ -63,7 +63,7 @@
   "devDependencies": {
     "@types/fs-extra": "^9.0.11",
     "@types/lodash": "^4.14.149",
-    "dbgate-types": "^4.8.6",
+    "dbgate-types": "^5.0.0-alpha.1",
     "env-cmd": "^10.1.0",
     "node-loader": "^1.0.2",
     "nodemon": "^2.0.2",

package/src/controllers/config.js

@@ -37,6 +37,7 @@ module.exports = {
       // hideAppEditor: !!process.env.HIDE_APP_EDITOR,
       allowShellConnection: platformInfo.allowShellConnection,
       allowShellScripting: platformInfo.allowShellConnection,
+      isDocker: platformInfo.isDocker,
       permissions,
       login,
       ...currentVersion,

package/src/controllers/files.js

@@ -62,6 +62,15 @@ module.exports = {
     return true;
   },
 
+  refresh_meta: true,
+  async refresh({ folders }, req) {
+    for (const folder of folders) {
+      socket.emitChanged(`files-changed-${folder}`);
+      socket.emitChanged(`all-files-changed`);
+    }
+    return true;
+  },
+
   copy_meta: true,
   async copy({ folder, file, newFile }, req) {
     if (!hasPermission(`files/${folder}/write`, req)) return false;
@@ -90,6 +99,12 @@ module.exports = {
     }
   },
 
+  loadFrom_meta: true,
+  async loadFrom({ filePath, format }, req) {
+    const text = await fs.readFile(filePath, { encoding: 'utf-8' });
+    return deserialize(format, text);
+  },
+
   save_meta: true,
   async save({ folder, file, data, format }, req) {
     if (folder.startsWith('archive:')) {
@@ -177,4 +192,24 @@ module.exports = {
     await fs.writeFile(filePath, getDiagramExport(html, css, themeType, themeClassName));
     return true;
   },
+
+  getFileRealPath_meta: true,
+  async getFileRealPath({ folder, file }, req) {
+    if (folder.startsWith('archive:')) {
+      if (!hasPermission(`archive/write`, req)) return false;
+      const dir = resolveArchiveFolder(folder.substring('archive:'.length));
+      return path.join(dir, file);
+    } else if (folder.startsWith('app:')) {
+      if (!hasPermission(`apps/write`, req)) return false;
+      const app = folder.substring('app:'.length);
+      return path.join(appdir(), app, file);
+    } else {
+      if (!hasPermission(`files/${folder}/write`, req)) return false;
+      const dir = path.join(filesdir(), folder);
+      if (!(await fs.exists(dir))) {
+        await fs.mkdir(dir);
+      }
+      return path.join(dir, file);
+    }
+  },
 };

package/src/controllers/plugins.js

@@ -162,6 +162,7 @@ module.exports = {
   authTypes_meta: true,
   async authTypes({ engine }) {
     const packageName = extractPackageName(engine);
+    if (!packageName) return null;
     const content = requirePlugin(packageName);
     const driver = content.drivers.find(x => x.engine == engine);
     if (!driver || !driver.getAuthTypes) return null;

package/src/currentVersion.js

@@ -1,5 +1,5 @@
 
 module.exports = { 
-  version: '4.8.6',
-  buildTime: '2022-04-14T15:36:41.653Z'
+  version: '5.0.0-alpha.1',
+  buildTime: '2022-05-19T14:17:58.279Z'
 };

package/src/main.js

@@ -155,8 +155,8 @@ function useAllControllers(app, electron) {
   useController(app, electron, '/apps', apps);
 }
 
-function initializeElectronSender(electronSender) {
+function setElectronSender(electronSender) {
   socket.setElectronSender(electronSender);
 }
 
-module.exports = { start, useAllControllers, initializeElectronSender, configController: config };
+module.exports = { start, useAllControllers, setElectronSender, configController: config };

package/src/shell/dumpDatabase.js

@@ -0,0 +1,38 @@
+const requireEngineDriver = require('../utility/requireEngineDriver');
+const connectUtility = require('../utility/connectUtility');
+
+function doDump(dumper) {
+  return new Promise((resolve, reject) => {
+    dumper.once('end', () => {
+      resolve(true);
+    });
+    dumper.once('error', err => {
+      reject(err);
+    });
+    dumper.run();
+  });
+}
+
+async function dumpDatabase({
+  connection = undefined,
+  systemConnection = undefined,
+  driver = undefined,
+  outputFile,
+  databaseName,
+  schemaName,
+}) {
+  console.log(`Dumping database`);
+
+  if (!driver) driver = requireEngineDriver(connection);
+  const pool = systemConnection || (await connectUtility(driver, connection, 'read', { forceRowsAsObjects: true }));
+  console.log(`Connected.`);
+
+  const dumper = await driver.createBackupDumper(pool, {
+    outputFile,
+    databaseName,
+    schemaName,
+  });
+  await doDump(dumper);
+}
+
+module.exports = dumpDatabase;

package/src/shell/importDatabase.js

@@ -0,0 +1,57 @@
+const fs = require('fs');
+const requireEngineDriver = require('../utility/requireEngineDriver');
+const connectUtility = require('../utility/connectUtility');
+const { splitQueryStream } = require('dbgate-query-splitter/lib/splitQueryStream');
+const download = require('./download');
+const stream = require('stream');
+
+class ImportStream extends stream.Transform {
+  constructor(pool, driver) {
+    super({ objectMode: true });
+    this.pool = pool;
+    this.driver = driver;
+  }
+  async _transform(chunk, encoding, cb) {
+    try {
+      await this.driver.script(this.pool, chunk);
+    } catch (err) {
+      this.emit('error', err.message);
+    }
+    cb();
+  }
+  _flush(cb) {
+    this.push('finish');
+    cb();
+    this.emit('end');
+  }
+}
+
+function awaitStreamEnd(stream) {
+  return new Promise((resolve, reject) => {
+    stream.once('end', () => {
+      resolve(true);
+    });
+    stream.once('error', err => {
+      reject(err);
+    });
+  });
+}
+
+async function importDatabase({ connection = undefined, systemConnection = undefined, driver = undefined, inputFile }) {
+  console.log(`Importing database`);
+
+  if (!driver) driver = requireEngineDriver(connection);
+  const pool = systemConnection || (await connectUtility(driver, connection, 'write'));
+  console.log(`Connected.`);
+
+  const downloadedFile = await download(inputFile);
+
+  const fileStream = fs.createReadStream(downloadedFile, 'utf-8');
+  const splittedStream = splitQueryStream(fileStream, driver.getQuerySplitterOptions());
+  const importStream = new ImportStream(pool, driver);
+  // @ts-ignore
+  splittedStream.pipe(importStream);
+  await awaitStreamEnd(importStream);
+}
+
+module.exports = importDatabase;

package/src/shell/index.js

@@ -21,6 +21,8 @@ const executeQuery = require('./executeQuery');
 const loadFile = require('./loadFile');
 const deployDb = require('./deployDb');
 const initializeApiEnvironment = require('./initializeApiEnvironment');
+const dumpDatabase = require('./dumpDatabase');
+const importDatabase = require('./importDatabase');
 
 const dbgateApi = {
   queryReader,
@@ -45,6 +47,8 @@ const dbgateApi = {
   loadFile,
   deployDb,
   initializeApiEnvironment,
+  dumpDatabase,
+  importDatabase,
 };
 
 requirePlugin.initializeDbgateApi(dbgateApi);

package/src/utility/connectUtility.js

@@ -39,7 +39,7 @@ async function loadConnection(driver, storedConnection, connectionMode) {
   return storedConnection;
 }
 
-async function connectUtility(driver, storedConnection, connectionMode) {
+async function connectUtility(driver, storedConnection, connectionMode, additionalOptions = null) {
   const connectionLoaded = await loadConnection(driver, storedConnection, connectionMode);
 
   const connection = {
@@ -93,7 +93,7 @@ async function connectUtility(driver, storedConnection, connectionMode) {
     }
   }
 
-  const conn = await driver.connect(connection);
+  const conn = await driver.connect({ ...connection, ...additionalOptions });
   return conn;
 }
 

package/src/utility/directories.js

@@ -4,6 +4,7 @@ const fs = require('fs');
 const cleanDirectory = require('./cleanDirectory');
 const platformInfo = require('./platformInfo');
 const processArgs = require('./processArgs');
+const consoleObjectWriter = require('../shell/consoleObjectWriter');
 
 const createDirectories = {};
 const ensureDirectory = (dir, clean) => {
@@ -27,7 +28,7 @@ function datadirCore() {
   if (processArgs.workspaceDir) {
     return processArgs.workspaceDir;
   }
-  return path.join(os.homedir(), 'dbgate-data');
+  return path.join(os.homedir(), '.dbgate');
 }
 
 function datadir() {
@@ -112,6 +113,27 @@ function clearArchiveLinksCache() {
   archiveLinksCache = {};
 }
 
+function migrateDataDir() {
+  if (process.env.WORKSPACE_DIR) {
+    return;
+  }
+  if (processArgs.workspaceDir) {
+    return;
+  }
+
+  try {
+    const oldDir = path.join(os.homedir(), 'dbgate-data');
+    const newDir = path.join(os.homedir(), '.dbgate');
+    if (fs.existsSync(oldDir) && !fs.existsSync(newDir)) {
+      fs.renameSync(oldDir, newDir);
+    }
+  } catch (e) {
+    console.log('Error migrating data dir:', e.message);
+  }
+}
+
+migrateDataDir();
+
 module.exports = {
   datadir,
   jsldir,

package/src/utility/socket.js

@@ -1,6 +1,6 @@
 let sseResponse = null;
 let electronSender = null;
-let init = '';
+let init = [];
 
 module.exports = {
   setSseResponse(value) {
@@ -12,15 +12,25 @@ module.exports = {
   },
   emit(message, data) {
     if (electronSender) {
+      if (init.length > 0) {
+        for (const item of init) {
+          electronSender.send(item.message, item.data == null ? null : item.data);
+        }
+        init = [];
+      }
       electronSender.send(message, data == null ? null : data);
     } else if (sseResponse) {
-      if (init) {
-        sseResponse.write(init);
-        init = '';
+      if (init.length > 0) {
+        for (const item of init) {
+          sseResponse.write(
+            `event: ${item.message}\ndata: ${JSON.stringify(item.data == null ? null : item.data)}\n\n`
+          );
+        }
+        init = [];
       }
       sseResponse.write(`event: ${message}\ndata: ${JSON.stringify(data == null ? null : data)}\n\n`);
     } else {
-      init += sseResponse;
+      init.push([{ message, data }]);
     }
   },
   emitChanged(key) {