dcp-worker 3.2.19 → 3.2.21

package/bin/dcp-evaluator-start

@@ -12,6 +12,8 @@
 function main() {
   const { clearLine, cursorTo } = require('readline');
   const path = require('path');
+  const fs = require('fs');
+  const os = require('os');
   const dcpConfig = require('dcp/dcp-config');
   const dcpClientDir = path.dirname(require.resolve('dcp-client'));
   var evaluator;
@@ -29,6 +31,7 @@ function main() {
         .option('port', {
           alias: ['p'],
           desc: 'Port to listen on',
+          deprecated: true,
           default: Number(dcpConfig.evaluator.listen.port),
         })
         .option('stdio', {
@@ -47,6 +50,7 @@ function main() {
         })
         .option('evaluator-lib-dir', {
           alias: ['l'],
+          deprecated: true,
           desc: 'Location of evaluator libraries',
           default: dcpConfig.evaluator.libDir || undefined
         })
@@ -83,10 +87,16 @@ function main() {
           alias: ['v'],
           desc: 'Generate verbose output',
         })
+        .option('pidFileLoc', {
+          alias: ['f'],
+          desc: 'Location for dcp-evaluator PID file',
+        })
         .options('debugLogLevel', {
           alias: ['d'],
+          deprecated: true,
           desc: 'Log level for evaluator output (max 8)',
         })
+        .epilogue("To pass arguments to the evaluator, make sure to separate your arguments with a '--'. For example: 'dcp-evaluator-start -p 9000 -- --options=--max-old-space-size=2048'")
         .wrap(process.stdout.columns || 80)
         .strict()
         .argv;
@@ -109,14 +119,19 @@ function main() {
   let args = [];    /* Command-line arguments to pass to evaluator */
   let files = [];   /* Startup files passed to evaluator as supplementary arguments */
 
-  if (!options.stdio)
+  if (!options.stdio && options.port) {
+    console.warn(`Note: --port (-p) is deprecated. Please pass this argument to the evalutor 'dcp-evaluator-start ... -- -p ${options.port}'`);
     args = args.concat(['-p', options.port]);
+  }
   if (options.evaluatorLibDir) {
+    console.warn(`Note: --evaluator-lib-dir (-l) is deprecated. Please pass this argument to the evalutor 'dcp-evaluator-start ... -- -l ${options.evaluatorLibDir}'`);
     options.evaluatorLibDir = path.resolve(options.prefix, 'etc', options.evaluatorLibDir);
     args = args.concat(['-l', options.evaluatorLibDir]);
   }
-  if (options.debugLogLevel)
+  if (options.debugLogLevel){
+    console.warn(`Note: --debugLogLevel (-d) is deprecated. Please pass this argument to the evalutor 'dcp-evaluator-start ... -- --debug ${options.debugLogLevel}'`);
     args = args.concat(['-d'], options.debugLogLevel)
+  }
   if (options._)
     args = args.concat(options._);
 
@@ -190,6 +205,9 @@ function main() {
     console.log('');
   }
 
+  if (options.pidFileLoc)
+    memoizePid(options.pidFileLoc)
+
   if (options.verbose) {
     console.log('. cwd:', path.join(options.prefix));
     console.log('. run:', [evaluator].concat(args).concat(files).map(a => `"${a}"`).join(' '));
@@ -229,5 +247,106 @@ if (!localConfig.scheduler)
 localConfig.bundle.location = false;
 localConfig.scheduler.configLocation = false;
 Object.assign(dcpConfig, require('dcp/utils').leafMerge(dcpConfig, localConfig));
+
+// Create the PID file for the worker
+function memoizePid(dir)
+{
+  const path = require('path');
+  const fs = require('fs');
+  const program = path.basename(require.main.filename, '.js');
+  let location;
+  let filename;
+  let fileType = '.pid';
+
+  // Set default location for pid file
+  let DEFAULT_PID_LOC;
+  if (fs.existsSync('/var/dcp/run'))
+    DEFAULT_PID_LOC = '/var/dcp/run/';
+  else if (fs.existsSync('/var/run'))
+    DEFAULT_PID_LOC = '/var/run/';
+  else
+    DEFAULT_PID_LOC = require('os').tmpdir();
+
+  if (dir.length && dir.length > 0)
+  {
+    if (fs.existsSync(dir))
+    {
+      if (fs.statSync(dir).isDirectory())
+      {
+        location = dir;
+        filename = program;
+      }
+      else
+      {
+        console.warn('Previous PID file was not cleaned up');
+        location = path.dirname(dir);
+        filename = path.basename(dir);
+        fileType = '';
+      }
+    }
+    else if (dir.endsWith(path.sep))
+    {
+      location = dir;
+      filename = program;
+    }
+    else
+    {
+      location = path.dirname(dir)
+      filename = path.basename(dir);
+      fileType = '';
+    }
+  }
+  else
+  {
+    location = DEFAULT_PID_LOC;
+    filename = program;
+  }
+  
+  const pidfile = path.join(
+    location,
+    filename + fileType
+  )
+  try
+  {
+    if (fs.existsSync(pidfile))
+    {
+      const oldPid = fs.readFileSync(pidfile, 'utf8')
+      console.warn(`Warning: Previous invocation${oldPid.length ? ' pid#' + parseInt(String(oldPid)) : ''} did not remove ${pidfile}`);
+    }
+    else
+      memoizePid.fd = fs.openSync(pidfile, 'wx');
+
+    fs.writeSync(memoizePid.fd, Buffer.from(process.pid + '\n'), 0);
+  }
+  catch (error)
+  {
+    console.warn(`Warning: Could not create pidfile at ${pidfile} (${error.code || error.message})`);
+    
+    if (typeof memoizePid.fd === 'number')
+    {
+      fs.closeSync(memoizePid.fd);
+      delete memoizePid.fd;
+    }
+    return;
+  }
+
+  function exitHandler()
+  {
+    try
+    {
+      fs.unlinkSync(pidfile);
+      fs.closeSync(memoizePid.fd);
+      delete memoizePid.fd;
+    }
+    catch (error)
+    {
+      console.warn(`Warning: Could not remove pidfile at ${pidfile} (${error.code})`);
+    }
+  }
+  
+  // Cleanup PID file
+  require('dcp/signal-handler').init();
+  process.on('dcpExit', exitHandler);
+}
 main();
 

package/bin/dcp-worker

@@ -15,6 +15,15 @@ const fs = require('fs');
 // Set to true to try to understand unhandled rejection.
 const ANALYZE_UNHANDELD_REJECTION = false;
 
+// Set default location for pid file
+let DEFAULT_PID_LOC;
+if (fs.existsSync('/var/dcp/run'))
+  DEFAULT_PID_LOC = '/var/dcp/run/';
+else if (fs.existsSync('/var/run'))
+  DEFAULT_PID_LOC = '/var/run/';
+else
+  DEFAULT_PID_LOC = os.tmpdir();
+
 const TOTAL_CPU_VCORES = os.cpus().length;
 const DEFAULT_CORES = TOTAL_CPU_VCORES - 1;
 var worker, dcpConfig;
@@ -174,7 +183,12 @@ async function main () {
         describe: 'If set, dump the configuration and exit',
         type: 'boolean',
         hidden: true,
-      }
+      },
+      pidFileLoc: {
+        alias: 'f',
+        describe: 'If set, location to generate the worker pid file',
+        normalize: true
+      },
     })
   .strict()
   .wrap(process.stdout.columns || 80)
@@ -220,6 +234,8 @@ async function startWorking(cliArgs) {
   else
     paymentAddress = (await wallet.get()).address;
 
+  if (cliArgs.pidFileLoc)
+    memoizePid(cliArgs.pidFileLoc)
 
   // Different ways to get the identity: 
   let identityKeystore = false;
@@ -528,6 +544,86 @@ async function startWorking(cliArgs) {
   return exitcode;
 }
 
+// Create the PID file for the worker
+function memoizePid(dir)
+{
+  const path = require('path');
+  const program = path.basename(require.main.filename, '.js');
+  let location;
+  let filename;
+
+  if (dir.length && dir.length > 0)
+  {
+    location = path.dirname(dir);
+    if (fs.existsSync(dir))
+    {
+      if (fs.statSync(dir).isDirectory())
+        filename = program;
+      else
+      {
+        console.warn('Previous PID file was not cleaned up');
+        filename = path.basename(dir);
+      }
+    }
+    else if (dir.endsWith(path.sep))
+      filename = program;
+    else
+      filename = path.basename(dir);
+  }
+  else
+  {
+    location = DEFAULT_PID_LOC;
+    filename = program;
+  }
+
+  const pidfile = path.join(
+    location,
+    filename + '.pid'
+  )
+  try
+  {
+    if (fs.existsSync(pidfile))
+    {
+      const oldPid = fs.readFileSync(pidfile, 'utf8')
+      console.warn(`Warning: Previous invocation${oldPid.length ? ' pid#' + parseInt(String(oldPid)) : ''} did not remove ${pidfile}`);
+    }
+    else
+      memoizePid.fd = fs.openSync(pidfile, 'wx');
+
+    fs.writeSync(memoizePid.fd, Buffer.from(process.pid + '\n'), 0);
+  }
+  catch (error)
+  {
+    console.warn(`Warning: Could not create pidfile at ${pidfile} (${error.code || error.message})`);
+    
+    if (typeof memoizePid.fd === 'number')
+    {
+      fs.closeSync(memoizePid.fd);
+      delete memoizePid.fd;
+    }
+    return;
+  }
+
+  
+
+  function exitHandler()
+  {
+    try
+    {
+      fs.unlinkSync(pidfile);
+      fs.closeSync(memoizePid.fd);
+      delete memoizePid.fd;
+    }
+    catch (error)
+    {
+      console.warn(`Warning: Could not remove pidfile at ${pidfile} (${error.code})`);
+    }
+  }
+  
+  // Cleanup PID file
+  process.on('dcpExit', exitHandler);
+}
+
 /** 
  * Unhandled rejection handler: __must not ever throw no matter what__.
  * If we hit an unhandled rejection, we are by definition no longer confident of our program state, meaning that

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcp-worker",
-  "version": "3.2.19",
+  "version": "3.2.21",
   "description": "JavaScript portion of DCP Workers for Node.js",
   "main": "bin/dcp-worker",
   "keywords": [
@@ -36,7 +36,7 @@
     "blessed-contrib": "^4.11.0",
     "bravojs": "^1.0.16",
     "chalk": "^4.1.0",
-    "dcp-client": "^4.2.24",
+    "dcp-client": "^4.2.26",
     "semver": "^7.3.8"
   },
   "optionalDependencies": {