@nginstack/engine-node 78.0.1 → 78.0.8

package/lib/Engine.js

@@ -1,535 +1,535 @@
-const child_process = require('child_process');
-const path = require('path');
-const fs = require('fs');
-const del = require('del');
-const request = require('request');
-const getPort = require('get-port');
-const sleep = require('thread-sleep');
-const findUp = require('find-up');
-const dotenv = require('dotenv');
-const crypto = require('crypto');
-const os = require('os');
-const tmp = require('tmp');
-const net = require('net');
-
-tmp.setGracefulCleanup();
-
-const ENGINE_APP = os.platform() == 'win32' ? 'engine.exe' : 'engine';
-const NGINT_APP_PATH = '/bin/win64/ngint.exe';
-const EXIT_CODE_RESTART_REQUIRED = 4;
-const ENGINE_STATUS_URL = '/api/service-status/v1/status';
-const ENGINE_DOWNLOAD_URL = `/dist/${ENGINE_APP}`;
-const ENGINE_STARTUP_TIMEOUT = 15 * 60000; // 15 minutes
-const ENGINE_SHUTDOWN_TIMEOUT = 30000; // 30 seconds
-const STATUS_MONITOR_INTERVAL = 500;
-const UPDATE_INTERVAL = 30000; // 30 seconds
-const INSTANCE_ID_LENGTH = 32;
-
-/**
- * @typedef {Object} EngineOptions
- * @param {number=} startupTimeout Time limit in milliseconds used to wait the Engine
- * startup.
- * @param {number=} httpPort HTTP port to be used by the new Engine process. If not
- * informed, a random port will be used.
- * @param {Array<string>=} jazArchives JAZ files to be included into
- * Union File System (UFS). If the informed path is a directory, it will load all JAZ files
- * contained in it.
- * @param {string=} jazSearchPath Directory containing JAZ files that will be loaded
- * by the Engine.
- * @param {Array<string>=} ufsDirectories Directories to be included into
- * Union File System (UFS).
- * @param {boolean=} disableIdoSyncToDisk Disable IDO sync to disk to gain writing
- * performance on DBCache. This options increases the risk of dbCache data corruption if the
- * Engine is stopped forcefully.
- * @param {string=} instanceId Engine instance id. This option should be used exclusively to
- * create Engine instances with stable ids for testing purposes. Instance ids are 32 caracteres
- * strings.
- * @param {boolean=} v8 Use V8 as default JavaScript runtime.
- * @param {boolean=} redirectLogsToStdout Redirect Engines logs to console stdout.
- */
-
-class Engine {
-
-  /**
-   * Creates a new Engine wrapper that can be used to control a nginstack Engine process.
-   * @param {string} installPath Directory where the Engine will be installed.
-   * @param {string} serverUrl URL of the Engine used to server the database.
-   * @param {string} dbName Database name.
-   * @param {EngineOptions=} opt_options Advanced options of this class.
-   */
-  constructor(installPath, serverUrl, dbName, opt_options) {
-    const options = opt_options || {};
-    this.serverUrl = serverUrl;
-    this.dbName = dbName;
-    this.installPath = installPath;
-    this.enginePath = path.join(this.installPath, ENGINE_APP);
-    this.ngintPath_ = path.join(this.installPath, NGINT_APP_PATH);
-    this.logsPath = path.join(this.installPath, 'logs');
-    this.process_ = null;
-    this.lastStatusCode_ = 0;
-    this.monitorEnabled_ = false;
-    this.monitorTimeoutId_ = null;
-    this.httpPort = options.httpPort || 0;
-    this.useRandomHttpPort_ = !this.httpPort;
-    this.jazArchives_ = options.jazArchives || [];
-    this.jazSearchPath_ = options.jazSearchPath || '';
-    this.ufsDirectories_ = options.ufsDirectories || [];
-    this.disableIdoSyncToDisk_ = options.disableIdoSyncToDisk || false;
-    this.v8_ = options.v8 || false;
-    this.startupTimeout = options.startupTimeout || ENGINE_STARTUP_TIMEOUT;
-    this.startedSuccessfully = false;
-    this.inShutdown_ = false;
-    this.redirectLogsToStdout_ = options.redirectLogsToStdout || false;
-    this.onEngineClose_ = null;
-    if (options.instanceId) {
-      if (options.instanceId.length === INSTANCE_ID_LENGTH) {
-        this.instanceId_ = options.instanceId;
-      } else {
-        throw new Error(`Invalid instanceId (${options.instanceId}). Inform a string ` +
-          `with length ${INSTANCE_ID_LENGTH}.`);
-      }
-    }
-  }
-
-  /**
-   * Returns true if the Engine is installed in the informed install path.
-   * @return {boolean}
-   */
-  get installed() {
-    return fs.existsSync(this.enginePath);
-  }
-
-  /**
-   * Returns true if the Engine was started and if it is capable to respond HTTP requests.
-   * @return {boolean}
-   */
-  get running() {
-    return this.process_ !== null && this.lastStatusCode_ === 200;
-  }
-
-  /**
-   * URL that can be used to do HTTP requests to this Engine.
-   * @return {string}
-   */
-  get url() {
-    return 'http://127.0.0.1:' + this.httpPort;
-  }
-
-  /**
-   * Starts the Engine status monitor, used to discover if the Engine is running.
-   * @private
-   */
-  startStatusMonitor_() {
-    if (this.monitorTimeoutId_) {
-      clearTimeout(this.monitorTimeoutId_);
-      this.monitorTimeoutId_ = null;
-    }
-    this.monitorEnabled_ = true;
-    request.get(`http://127.0.0.1:${this.httpPort}${ENGINE_STATUS_URL}`, (_error, response) => {
-      if (response && response.statusCode) {
-        this.lastStatusCode_ = response.statusCode;
-        if (this.lastStatusCode_ === 500 && !this.inShutdown_) {
-          console.info(`Engine response (${response.statusCode}):\n${response.body}`);
-        }
-      } else {
-        this.lastStatusCode_ = null;
-      }
-      if (this.monitorEnabled_) {
-        this.monitorTimeoutId_ = setTimeout(this.startStatusMonitor_.bind(this),
-          STATUS_MONITOR_INTERVAL);
-      }
-    });
-  }
-
-  /**
-   * Stops the Engine status monitor, started previously by {@link #startStatusMonitor_}.
-   * @private
-   */
-  stopStatusMonitor_() {
-    this.monitorEnabled_ = false;
-    if (this.monitorTimeoutId_) {
-      clearTimeout(this.monitorTimeoutId_);
-      this.monitorTimeoutId_ = null;
-    }
-  }
-
-  /**
-   * Starts the monitoring of the Engine logs files. The log files output will be redirected to
-   * console.
-   * @return {string} Path to the logger configuration that should be used by Engine to
-   * enable the redirection of the logs outputs to the console.
-   * @private
-   */
-  startLogsMonitoring_() {
-    if (this.tempLogConfigFile_ || this.logsServer_) {
-      this.stopLogsMonitoring_();
-    }
-
-    this.tempLogConfigFile_ = tmp.fileSync({
-      prefix: 'log-',
-      postfix: '.config',
-      detachDescriptor: true
-    });
-    try {
-      let localSocketPath;
-      let serverName;
-      if (process.platform === 'win32') {
-        serverName = path.basename(this.tempLogConfigFile_.name);
-        localSocketPath = path.join('\\\\.\\pipe', serverName);
-      } else {
-        localSocketPath = this.tempLogConfigFile_.name + '.socket';
-        serverName = localSocketPath;
-      }
-
-      this.logsServer_ = net.createServer((client) => {
-        client.on('data', data => {
-          const text = data.toString('utf-8').trim();
-          if (text) {
-            console.log(text);
-          }
-        });
-      });
-      this.logsServer_.on('error', err => console.error('Error on local socket:', err));
-      this.logsServer_.listen(localSocketPath);
-
-      fs.writeFileSync(this.tempLogConfigFile_.fd,
-        'logger.appender.localSocket=LocalSocketAppender\n' +
-        `logger.appender.localSocket.serverName=${serverName}\n` +
-        'logger.appender.localSocket.layout=PatternLayout\n' +
-        'logger.appender.localSocket.layout.pattern=%d %.8t [%p] %c - %m %e%n\n' +
-        'logger.appender.localSocket.layout.dateFormat=dd/mm hh:nn:ss\n' +
-        'logger.appender.localSocket.filter1=PriorityFilter\n' +
-        'logger.appender.localSocket.filter1.match=PROGRESS\n' +
-        'logger.appender.localSocket.filter1.onMatch=DENY\n' +
-        'logger.appender.localSocket.filter1.onMismatch=NEUTRAL\n' +
-        'logger.additive.ngin=true\n' +
-        'logger.rootCategory=INFO,default,progress,jsdebugger,localSocket'
-      );
-
-    } finally {
-      fs.closeSync(this.tempLogConfigFile_.fd);
-    }
-
-    return this.tempLogConfigFile_.name;
-  }
-
-  /**
-   * Stops the monitoring of the Engine logs files.
-   * @private
-   */
-  stopLogsMonitoring_() {
-    if (this.tempLogConfigFile_) {
-      this.tempLogConfigFile_.removeCallback();
-      this.tempLogConfigFile_ = null;
-    }
-    if (this.logsServer_) {
-      this.logsServer_.close();
-      this.logsServer_ = null;
-    }
-  }
-
-  /**
-   * Downloads the Engine and install it into the informed install path.
-   * @return {Promise}
-   */
-  install() {
-    return new Promise((resolve, reject) => {
-      if (this.installed) {
-        resolve();
-      } else {
-        fs.mkdir(this.installPath, { recursive: true }, (err) => {
-          if (err && err.code !== 'EEXIST') {
-            reject(err);
-          } else {
-            let httpUrl = this.serverUrl;
-            if (!httpUrl.startsWith('http://') && !httpUrl.startsWith('https://')) {
-              httpUrl = 'http://' + httpUrl;
-            }
-            request.get(new URL(ENGINE_DOWNLOAD_URL, httpUrl).toString())
-              .pipe(fs.createWriteStream(this.enginePath))
-              .on('close', () => {
-                if (os.platform() != 'win32') {
-                  fs.chmodSync(path.join(this.installPath, ENGINE_APP), '755');
-                }
-                resolve();
-              })
-              .on('error', (reqErr) => {
-                reject(reqErr);
-              });
-          }
-        });
-      }
-    });
-  }
-
-  /**
-   * Remove all files of the informed install path.
-   * @return {Promise}
-   */
-  uninstall() {
-    return del(this.installPath.replace(/\\/g, '/'), {
-      force: true
-    });
-  }
-
-  /**
-   * Starts the Engine and wait for it to be able to handle HTTP requests. It will wait the full
-   * load and synchronization of the Engine DBCache.
-   * @return {Promise}
-   */
-  start() {
-    if (this.instanceId_) {
-      const dirPath = path.resolve(this.installPath, 'conf');
-      if (!fs.existsSync(dirPath)) {
-        fs.mkdirSync(dirPath, { recursive: true });
-      }
-      fs.writeFileSync(path.resolve(dirPath, 'engine_id.dat'), this.instanceId_);
-    }
-    return this.install().then(() => {
-      if (this.useRandomHttpPort_) {
-        return getPort();
-      } else {
-        return Promise.resolve(this.httpPort);
-      }
-    }).then(port => {
-      this.httpPort = port;
-      return new Promise((resolve, reject) => {
-        console.info(`Starting Engine process at port ${this.httpPort}. Server: ${this.serverUrl}` +
-           `. Database: ${this.dbName}. Path: "${this.installPath}".`);
-        const args = [this.serverUrl, this.dbName,
-          '--disableAutoRestart',
-          '--disableGui',
-          '--httpPort=' + this.httpPort];
-
-        const jazArchives = this.jazSearchPath_ && fs.existsSync(this.jazSearchPath_)
-          ? fs.readdirSync(this.jazSearchPath_)
-            .filter(name => name.endsWith('.jaz'))
-            .map(name => path.resolve(this.jazSearchPath_, name))
-          : [];
-
-        (jazArchives.concat(this.jazArchives_)).forEach(jazPath => {
-          args.push('--jazArchive=\'' + jazPath + '\'');
-        });
-
-        this.ufsDirectories_.forEach(dirPath => {
-          args.push('--ufsDirectory=\'' + dirPath + '\'');
-        });
-        if (this.disableIdoSyncToDisk_) {
-          args.push('--disableIdoSyncToDisk');
-        }
-        if (this.v8_) {
-          args.push('-v8');
-        }
-
-        if (this.redirectLogsToStdout_) {
-          const logConfig = this.startLogsMonitoring_();
-          args.push('--additionalLoggerConfig=\'' + logConfig + '\'');
-        }
-
-        this.inShutdown_ = false;
-        this.process_ = child_process.spawn(path.join(this.installPath, ENGINE_APP),
-          args,
-          {
-            cwd: this.installPath,
-            windowsHide: true
-          });
-
-        this.process_.on('error', (err) => {
-          console.error('Error starting Engine process:', err);
-        });
-
-        this.process_.stdout.on('data', (data) => {
-          console.info(`Engine stdout: ${data}`);
-        });
-
-        this.process_.stderr.on('data', (data) => {
-          console.error(`Engine stderr: ${data}`);
-        });
-
-        let intervalId = null;
-
-        this.process_.on('close', (code) => {
-          this.stopStatusMonitor_();
-          if (this.redirectLogsToStdout_) {
-            this.stopLogsMonitoring_();
-          }
-          if (intervalId) {
-            clearInterval(intervalId);
-            intervalId = null;
-          }
-          console.info(`Engine process exited with code ${code || 0}`);
-          this.process_ = null;
-          this.lastStatusCode_ = 0;
-          this.httpPort = 0;
-          if (code === EXIT_CODE_RESTART_REQUIRED) {
-            console.info('Engine restart was required to finish the upgrade');
-            sleep(UPDATE_INTERVAL);
-            this.start().then(resolve, reject);
-          } else {
-            if (!this.startedSuccessfully) {
-              const msg = `Engine startup failed with error code ${code || 0}`;
-              console.error(msg);
-              reject(new Error(msg));
-            }
-            if (this.onEngineClose_) {
-              this.onEngineClose_();
-            }
-          }
-          this.startedSuccessfully = false;
-        });
-
-        this.startStatusMonitor_();
-        intervalId = setInterval(() => {
-          if (this.process_ && this.monitorEnabled_) {
-            if (this.lastStatusCode_) {
-              if (this.lastStatusCode_ === 200) {
-                this.startedSuccessfully = true;
-                clearInterval(intervalId);
-                intervalId = null;
-                resolve();
-              } else if (this.lastStatusCode_ === 500) {
-                clearInterval(intervalId);
-                intervalId = null;
-                const msg = 'Unexpected Engine status code: ' + this.lastStatusCode_;
-                console.error(msg);
-                this.sendShutdownCommand_();
-                reject(new Error(msg));
-              }
-            }
-          } else {
-            if (intervalId) {
-              clearInterval(intervalId);
-              intervalId = null;
-            }
-          }
-        }, STATUS_MONITOR_INTERVAL);
-      });
-    });
-  }
-
-  /**
-   * Stops the Engine process.
-   * @return {Promise}
-   */
-  stop() {
-    console.info('Engine stop requested');
-    return new Promise(resolve => {
-      if (this.running) {
-        this.onEngineClose_ = () => {
-          console.info('Engine stopped');
-          if (this.redirectLogsToStdout_) {
-            // Defers the resolve call to give time to log watching to be finished
-            setTimeout(resolve, 20);
-          } else {
-            resolve();
-          }
-          this.inShutdown_ = false;
-        };
-        this.sendShutdownCommand_();
-      } else {
-        resolve();
-      }
-    });
-  }
-
-  /**
-   * Request a graceful shutdown to Engine. If request fails, send a force kill command.
-   * @private
-   */
-  sendShutdownCommand_() {
-    if (this.process_) {
-      let forceKill = true;
-      this.inShutdown_ = true;
-      if (os.platform() == 'win32') {
-        if (fs.existsSync(this.ngintPath_)) {
-          try {
-            console.info('Shutdown command sent to Engine process');
-            child_process.execFileSync(
-              this.ngintPath_,
-              ['shutdown', this.process_.pid, ENGINE_SHUTDOWN_TIMEOUT],
-              {
-                cwd: this.installPath,
-                windowsHide: true
-              }
-            );
-            forceKill = false;
-          } catch (e) {
-            console.error('Error stopping Engine', e);
-          }
-        } else {
-          console.info('ngint was not found');
-        }
-      } else {
-        process.kill(this.process_.pid, 'SIGTERM');
-      }
-      if (forceKill) {
-        console.info('Kill signal sent to Engine process');
-        this.process_.kill();
-        this.process_ = null;
-      }
-    }
-  }
-
-  /**
-   * Creates a new Engine instance using the ".env" config file on the repository root.
-   *
-   * The Engine will be installed on `<root-dir>/.engine/<database-name>` directory. If was not
-   * informed the option `jazSearchPath` it will load all JAZ files inside the
-   * `<root-dir>/.build` directory (or "build" directory if ".build" does not exists). The
-   * option `disableIdoSyncToDisk` will be enabled by default.
-   *
-   * See the site https://nginstack.com for the more details about the adopted repository
-   * conventions.
-   * @param {EngineOptions=} options Advanced Engine options.
-   */
-  static newUsingWorkspaceConfig(options) {
-    options = options || {};
-    const workspacePath = getWorkspacePath();
-    dotenv.config({
-      path: path.resolve(workspacePath, '.env')
-    });
-
-    if (!('jazSearchPath' in options)) {
-      let jazSearchPath = path.resolve(workspacePath, '.build');
-      if (!fs.existsSync(jazSearchPath)) {
-        // Compatibility with previous build directory name
-        jazSearchPath = path.resolve(workspacePath, 'build');
-      }
-      if (fs.existsSync(jazSearchPath)) {
-        options.jazSearchPath = jazSearchPath;
-      }
-    }
-    if (!('disableIdoSyncToDisk' in options)) {
-      options.disableIdoSyncToDisk = true;
-    }
-    options.v8 = options.v8 || process.argv.includes('-v8');
-    options.instanceId = Engine.formatWorkspaceInstanceId();
-
-    return new Engine(
-      path.resolve(workspacePath, '.engine', process.env.ENGINE_DATABASE),
-      process.env.ENGINE_URL,
-      process.env.ENGINE_DATABASE,
-      options
-    );
-  }
-
-  /**
-   * Creates an stable Engine instance id using the hostname and the workspace path.
-   */
-  static formatWorkspaceInstanceId() {
-    const hash = crypto.createHash('sha256');
-    hash.update(os.hostname());
-    hash.update(getWorkspacePath());
-    return ('_' + hash.digest('hex').toUpperCase()).substring(0, INSTANCE_ID_LENGTH);
-  }
-}
-
-function getWorkspacePath() {
-  let workspacePath = findUp.sync('.git', { type: 'directory' });
-  if (!workspacePath) {
-    workspacePath = findUp.sync('package.json');
-  }
-  return path.dirname(workspacePath);
-}
-
-module.exports = Engine;
+const child_process = require('child_process');
+const path = require('path');
+const fs = require('fs');
+const del = require('del');
+const request = require('request');
+const getPort = require('get-port');
+const sleep = require('thread-sleep');
+const findUp = require('find-up');
+const dotenv = require('dotenv');
+const crypto = require('crypto');
+const os = require('os');
+const tmp = require('tmp');
+const net = require('net');
+
+tmp.setGracefulCleanup();
+
+const ENGINE_APP = os.platform() == 'win32' ? 'engine.exe' : 'engine';
+const NGINT_APP_PATH = '/bin/win64/ngint.exe';
+const EXIT_CODE_RESTART_REQUIRED = 4;
+const ENGINE_STATUS_URL = '/api/service-status/v1/status';
+const ENGINE_DOWNLOAD_URL = `/dist/${ENGINE_APP}`;
+const ENGINE_STARTUP_TIMEOUT = 15 * 60000; // 15 minutes
+const ENGINE_SHUTDOWN_TIMEOUT = 30000; // 30 seconds
+const STATUS_MONITOR_INTERVAL = 500;
+const UPDATE_INTERVAL = 30000; // 30 seconds
+const INSTANCE_ID_LENGTH = 32;
+
+/**
+ * @typedef {Object} EngineOptions
+ * @param {number=} startupTimeout Time limit in milliseconds used to wait the Engine
+ * startup.
+ * @param {number=} httpPort HTTP port to be used by the new Engine process. If not
+ * informed, a random port will be used.
+ * @param {Array<string>=} jazArchives JAZ files to be included into
+ * Union File System (UFS). If the informed path is a directory, it will load all JAZ files
+ * contained in it.
+ * @param {string=} jazSearchPath Directory containing JAZ files that will be loaded
+ * by the Engine.
+ * @param {Array<string>=} ufsDirectories Directories to be included into
+ * Union File System (UFS).
+ * @param {boolean=} disableIdoSyncToDisk Disable IDO sync to disk to gain writing
+ * performance on DBCache. This options increases the risk of dbCache data corruption if the
+ * Engine is stopped forcefully.
+ * @param {string=} instanceId Engine instance id. This option should be used exclusively to
+ * create Engine instances with stable ids for testing purposes. Instance ids are 32 caracteres
+ * strings.
+ * @param {boolean=} v8 Use V8 as default JavaScript runtime.
+ * @param {boolean=} redirectLogsToStdout Redirect Engines logs to console stdout.
+ */
+
+class Engine {
+
+  /**
+   * Creates a new Engine wrapper that can be used to control a nginstack Engine process.
+   * @param {string} installPath Directory where the Engine will be installed.
+   * @param {string} serverUrl URL of the Engine used to server the database.
+   * @param {string} dbName Database name.
+   * @param {EngineOptions=} opt_options Advanced options of this class.
+   */
+  constructor(installPath, serverUrl, dbName, opt_options) {
+    const options = opt_options || {};
+    this.serverUrl = serverUrl;
+    this.dbName = dbName;
+    this.installPath = installPath;
+    this.enginePath = path.join(this.installPath, ENGINE_APP);
+    this.ngintPath_ = path.join(this.installPath, NGINT_APP_PATH);
+    this.logsPath = path.join(this.installPath, 'logs');
+    this.process_ = null;
+    this.lastStatusCode_ = 0;
+    this.monitorEnabled_ = false;
+    this.monitorTimeoutId_ = null;
+    this.httpPort = options.httpPort || 0;
+    this.useRandomHttpPort_ = !this.httpPort;
+    this.jazArchives_ = options.jazArchives || [];
+    this.jazSearchPath_ = options.jazSearchPath || '';
+    this.ufsDirectories_ = options.ufsDirectories || [];
+    this.disableIdoSyncToDisk_ = options.disableIdoSyncToDisk || false;
+    this.v8_ = options.v8 || false;
+    this.startupTimeout = options.startupTimeout || ENGINE_STARTUP_TIMEOUT;
+    this.startedSuccessfully = false;
+    this.inShutdown_ = false;
+    this.redirectLogsToStdout_ = options.redirectLogsToStdout || false;
+    this.onEngineClose_ = null;
+    if (options.instanceId) {
+      if (options.instanceId.length === INSTANCE_ID_LENGTH) {
+        this.instanceId_ = options.instanceId;
+      } else {
+        throw new Error(`Invalid instanceId (${options.instanceId}). Inform a string ` +
+          `with length ${INSTANCE_ID_LENGTH}.`);
+      }
+    }
+  }
+
+  /**
+   * Returns true if the Engine is installed in the informed install path.
+   * @return {boolean}
+   */
+  get installed() {
+    return fs.existsSync(this.enginePath);
+  }
+
+  /**
+   * Returns true if the Engine was started and if it is capable to respond HTTP requests.
+   * @return {boolean}
+   */
+  get running() {
+    return this.process_ !== null && this.lastStatusCode_ === 200;
+  }
+
+  /**
+   * URL that can be used to do HTTP requests to this Engine.
+   * @return {string}
+   */
+  get url() {
+    return 'http://127.0.0.1:' + this.httpPort;
+  }
+
+  /**
+   * Starts the Engine status monitor, used to discover if the Engine is running.
+   * @private
+   */
+  startStatusMonitor_() {
+    if (this.monitorTimeoutId_) {
+      clearTimeout(this.monitorTimeoutId_);
+      this.monitorTimeoutId_ = null;
+    }
+    this.monitorEnabled_ = true;
+    request.get(`http://127.0.0.1:${this.httpPort}${ENGINE_STATUS_URL}`, (_error, response) => {
+      if (response && response.statusCode) {
+        this.lastStatusCode_ = response.statusCode;
+        if (this.lastStatusCode_ === 500 && !this.inShutdown_) {
+          console.info(`Engine response (${response.statusCode}):\n${response.body}`);
+        }
+      } else {
+        this.lastStatusCode_ = null;
+      }
+      if (this.monitorEnabled_) {
+        this.monitorTimeoutId_ = setTimeout(this.startStatusMonitor_.bind(this),
+          STATUS_MONITOR_INTERVAL);
+      }
+    });
+  }
+
+  /**
+   * Stops the Engine status monitor, started previously by {@link #startStatusMonitor_}.
+   * @private
+   */
+  stopStatusMonitor_() {
+    this.monitorEnabled_ = false;
+    if (this.monitorTimeoutId_) {
+      clearTimeout(this.monitorTimeoutId_);
+      this.monitorTimeoutId_ = null;
+    }
+  }
+
+  /**
+   * Starts the monitoring of the Engine logs files. The log files output will be redirected to
+   * console.
+   * @return {string} Path to the logger configuration that should be used by Engine to
+   * enable the redirection of the logs outputs to the console.
+   * @private
+   */
+  startLogsMonitoring_() {
+    if (this.tempLogConfigFile_ || this.logsServer_) {
+      this.stopLogsMonitoring_();
+    }
+
+    this.tempLogConfigFile_ = tmp.fileSync({
+      prefix: 'log-',
+      postfix: '.config',
+      detachDescriptor: true
+    });
+    try {
+      let localSocketPath;
+      let serverName;
+      if (process.platform === 'win32') {
+        serverName = path.basename(this.tempLogConfigFile_.name);
+        localSocketPath = path.join('\\\\.\\pipe', serverName);
+      } else {
+        localSocketPath = this.tempLogConfigFile_.name + '.socket';
+        serverName = localSocketPath;
+      }
+
+      this.logsServer_ = net.createServer((client) => {
+        client.on('data', data => {
+          const text = data.toString('utf-8').trim();
+          if (text) {
+            console.log(text);
+          }
+        });
+      });
+      this.logsServer_.on('error', err => console.error('Error on local socket:', err));
+      this.logsServer_.listen(localSocketPath);
+
+      fs.writeFileSync(this.tempLogConfigFile_.fd,
+        'logger.appender.localSocket=LocalSocketAppender\n' +
+        `logger.appender.localSocket.serverName=${serverName}\n` +
+        'logger.appender.localSocket.layout=PatternLayout\n' +
+        'logger.appender.localSocket.layout.pattern=%d %.8t [%p] %c - %m %e%n\n' +
+        'logger.appender.localSocket.layout.dateFormat=dd/mm hh:nn:ss\n' +
+        'logger.appender.localSocket.filter1=PriorityFilter\n' +
+        'logger.appender.localSocket.filter1.match=PROGRESS\n' +
+        'logger.appender.localSocket.filter1.onMatch=DENY\n' +
+        'logger.appender.localSocket.filter1.onMismatch=NEUTRAL\n' +
+        'logger.additive.ngin=true\n' +
+        'logger.rootCategory=INFO,default,progress,jsdebugger,localSocket'
+      );
+
+    } finally {
+      fs.closeSync(this.tempLogConfigFile_.fd);
+    }
+
+    return this.tempLogConfigFile_.name;
+  }
+
+  /**
+   * Stops the monitoring of the Engine logs files.
+   * @private
+   */
+  stopLogsMonitoring_() {
+    if (this.tempLogConfigFile_) {
+      this.tempLogConfigFile_.removeCallback();
+      this.tempLogConfigFile_ = null;
+    }
+    if (this.logsServer_) {
+      this.logsServer_.close();
+      this.logsServer_ = null;
+    }
+  }
+
+  /**
+   * Downloads the Engine and install it into the informed install path.
+   * @return {Promise}
+   */
+  install() {
+    return new Promise((resolve, reject) => {
+      if (this.installed) {
+        resolve();
+      } else {
+        fs.mkdir(this.installPath, { recursive: true }, (err) => {
+          if (err && err.code !== 'EEXIST') {
+            reject(err);
+          } else {
+            let httpUrl = this.serverUrl;
+            if (!httpUrl.startsWith('http://') && !httpUrl.startsWith('https://')) {
+              httpUrl = 'http://' + httpUrl;
+            }
+            request.get(new URL(ENGINE_DOWNLOAD_URL, httpUrl).toString())
+              .pipe(fs.createWriteStream(this.enginePath))
+              .on('close', () => {
+                if (os.platform() != 'win32') {
+                  fs.chmodSync(path.join(this.installPath, ENGINE_APP), '755');
+                }
+                resolve();
+              })
+              .on('error', (reqErr) => {
+                reject(reqErr);
+              });
+          }
+        });
+      }
+    });
+  }
+
+  /**
+   * Remove all files of the informed install path.
+   * @return {Promise}
+   */
+  uninstall() {
+    return del(this.installPath.replace(/\\/g, '/'), {
+      force: true
+    });
+  }
+
+  /**
+   * Starts the Engine and wait for it to be able to handle HTTP requests. It will wait the full
+   * load and synchronization of the Engine DBCache.
+   * @return {Promise}
+   */
+  start() {
+    if (this.instanceId_) {
+      const dirPath = path.resolve(this.installPath, 'conf');
+      if (!fs.existsSync(dirPath)) {
+        fs.mkdirSync(dirPath, { recursive: true });
+      }
+      fs.writeFileSync(path.resolve(dirPath, 'engine_id.dat'), this.instanceId_);
+    }
+    return this.install().then(() => {
+      if (this.useRandomHttpPort_) {
+        return getPort();
+      } else {
+        return Promise.resolve(this.httpPort);
+      }
+    }).then(port => {
+      this.httpPort = port;
+      return new Promise((resolve, reject) => {
+        console.info(`Starting Engine process at port ${this.httpPort}. Server: ${this.serverUrl}` +
+           `. Database: ${this.dbName}. Path: "${this.installPath}".`);
+        const args = [this.serverUrl, this.dbName,
+          '--disableAutoRestart',
+          '--disableGui',
+          '--httpPort=' + this.httpPort];
+
+        const jazArchives = this.jazSearchPath_ && fs.existsSync(this.jazSearchPath_)
+          ? fs.readdirSync(this.jazSearchPath_)
+            .filter(name => name.endsWith('.jaz'))
+            .map(name => path.resolve(this.jazSearchPath_, name))
+          : [];
+
+        (jazArchives.concat(this.jazArchives_)).forEach(jazPath => {
+          args.push('--jazArchive=\'' + jazPath + '\'');
+        });
+
+        this.ufsDirectories_.forEach(dirPath => {
+          args.push('--ufsDirectory=\'' + dirPath + '\'');
+        });
+        if (this.disableIdoSyncToDisk_) {
+          args.push('--disableIdoSyncToDisk');
+        }
+        if (this.v8_) {
+          args.push('-v8');
+        }
+
+        if (this.redirectLogsToStdout_) {
+          const logConfig = this.startLogsMonitoring_();
+          args.push('--additionalLoggerConfig=\'' + logConfig + '\'');
+        }
+
+        this.inShutdown_ = false;
+        this.process_ = child_process.spawn(path.join(this.installPath, ENGINE_APP),
+          args,
+          {
+            cwd: this.installPath,
+            windowsHide: true
+          });
+
+        this.process_.on('error', (err) => {
+          console.error('Error starting Engine process:', err);
+        });
+
+        this.process_.stdout.on('data', (data) => {
+          console.info(`Engine stdout: ${data}`);
+        });
+
+        this.process_.stderr.on('data', (data) => {
+          console.error(`Engine stderr: ${data}`);
+        });
+
+        let intervalId = null;
+
+        this.process_.on('close', (code) => {
+          this.stopStatusMonitor_();
+          if (this.redirectLogsToStdout_) {
+            this.stopLogsMonitoring_();
+          }
+          if (intervalId) {
+            clearInterval(intervalId);
+            intervalId = null;
+          }
+          console.info(`Engine process exited with code ${code || 0}`);
+          this.process_ = null;
+          this.lastStatusCode_ = 0;
+          this.httpPort = 0;
+          if (code === EXIT_CODE_RESTART_REQUIRED) {
+            console.info('Engine restart was required to finish the upgrade');
+            sleep(UPDATE_INTERVAL);
+            this.start().then(resolve, reject);
+          } else {
+            if (!this.startedSuccessfully) {
+              const msg = `Engine startup failed with error code ${code || 0}`;
+              console.error(msg);
+              reject(new Error(msg));
+            }
+            if (this.onEngineClose_) {
+              this.onEngineClose_();
+            }
+          }
+          this.startedSuccessfully = false;
+        });
+
+        this.startStatusMonitor_();
+        intervalId = setInterval(() => {
+          if (this.process_ && this.monitorEnabled_) {
+            if (this.lastStatusCode_) {
+              if (this.lastStatusCode_ === 200) {
+                this.startedSuccessfully = true;
+                clearInterval(intervalId);
+                intervalId = null;
+                resolve();
+              } else if (this.lastStatusCode_ === 500) {
+                clearInterval(intervalId);
+                intervalId = null;
+                const msg = 'Unexpected Engine status code: ' + this.lastStatusCode_;
+                console.error(msg);
+                this.sendShutdownCommand_();
+                reject(new Error(msg));
+              }
+            }
+          } else {
+            if (intervalId) {
+              clearInterval(intervalId);
+              intervalId = null;
+            }
+          }
+        }, STATUS_MONITOR_INTERVAL);
+      });
+    });
+  }
+
+  /**
+   * Stops the Engine process.
+   * @return {Promise}
+   */
+  stop() {
+    console.info('Engine stop requested');
+    return new Promise(resolve => {
+      if (this.running) {
+        this.onEngineClose_ = () => {
+          console.info('Engine stopped');
+          if (this.redirectLogsToStdout_) {
+            // Defers the resolve call to give time to log watching to be finished
+            setTimeout(resolve, 20);
+          } else {
+            resolve();
+          }
+          this.inShutdown_ = false;
+        };
+        this.sendShutdownCommand_();
+      } else {
+        resolve();
+      }
+    });
+  }
+
+  /**
+   * Request a graceful shutdown to Engine. If request fails, send a force kill command.
+   * @private
+   */
+  sendShutdownCommand_() {
+    if (this.process_) {
+      let forceKill = true;
+      this.inShutdown_ = true;
+      if (os.platform() == 'win32') {
+        if (fs.existsSync(this.ngintPath_)) {
+          try {
+            console.info('Shutdown command sent to Engine process');
+            child_process.execFileSync(
+              this.ngintPath_,
+              ['shutdown', this.process_.pid, ENGINE_SHUTDOWN_TIMEOUT],
+              {
+                cwd: this.installPath,
+                windowsHide: true
+              }
+            );
+            forceKill = false;
+          } catch (e) {
+            console.error('Error stopping Engine', e);
+          }
+        } else {
+          console.info('ngint was not found');
+        }
+      } else {
+        process.kill(this.process_.pid, 'SIGTERM');
+      }
+      if (forceKill) {
+        console.info('Kill signal sent to Engine process');
+        this.process_.kill();
+        this.process_ = null;
+      }
+    }
+  }
+
+  /**
+   * Creates a new Engine instance using the ".env" config file on the repository root.
+   *
+   * The Engine will be installed on `<root-dir>/.engine/<database-name>` directory. If was not
+   * informed the option `jazSearchPath` it will load all JAZ files inside the
+   * `<root-dir>/.build` directory (or "build" directory if ".build" does not exists). The
+   * option `disableIdoSyncToDisk` will be enabled by default.
+   *
+   * See the site https://nginstack.com for the more details about the adopted repository
+   * conventions.
+   * @param {EngineOptions=} options Advanced Engine options.
+   */
+  static newUsingWorkspaceConfig(options) {
+    options = options || {};
+    const workspacePath = getWorkspacePath();
+    dotenv.config({
+      path: path.resolve(workspacePath, '.env')
+    });
+
+    if (!('jazSearchPath' in options)) {
+      let jazSearchPath = path.resolve(workspacePath, '.build');
+      if (!fs.existsSync(jazSearchPath)) {
+        // Compatibility with previous build directory name
+        jazSearchPath = path.resolve(workspacePath, 'build');
+      }
+      if (fs.existsSync(jazSearchPath)) {
+        options.jazSearchPath = jazSearchPath;
+      }
+    }
+    if (!('disableIdoSyncToDisk' in options)) {
+      options.disableIdoSyncToDisk = true;
+    }
+    options.v8 = options.v8 || process.argv.includes('-v8');
+    options.instanceId = Engine.formatWorkspaceInstanceId();
+
+    return new Engine(
+      path.resolve(workspacePath, '.engine', process.env.ENGINE_DATABASE),
+      process.env.ENGINE_URL,
+      process.env.ENGINE_DATABASE,
+      options
+    );
+  }
+
+  /**
+   * Creates an stable Engine instance id using the hostname and the workspace path.
+   */
+  static formatWorkspaceInstanceId() {
+    const hash = crypto.createHash('sha256');
+    hash.update(os.hostname());
+    hash.update(getWorkspacePath());
+    return ('_' + hash.digest('hex').toUpperCase()).substring(0, INSTANCE_ID_LENGTH);
+  }
+}
+
+function getWorkspacePath() {
+  let workspacePath = findUp.sync('.git', { type: 'directory' });
+  if (!workspacePath) {
+    workspacePath = findUp.sync('package.json');
+  }
+  return path.dirname(workspacePath);
+}
+
+module.exports = Engine;