Merge pull request #73 from BitGo/BG-19296-enable-lint

Fix Tests and Lint

Author: tylerlevine

.drone.jsonnet

@@ -75,14 +75,13 @@ local step(
           "npm install",
         ],
       ),
-///      step(
-///        name = "lint",
-///        image = "node:10",
-///        failure = true,
-///        commands = [
-///          "npm run lint",
-///        ],
-///      ),
+      step(
+        name = "lint",
+        image = "node:10",
+        commands = [
+          "npm run lint",
+		],
+      ),
     ],
   ),
   pipeline(

.eslintrc.json

@@ -16,7 +16,7 @@
   },
   "rules": {
     "operator-linebreak": ["error", "before"],
-    "max-len": ["error", { "code": 256 } ],
+    "max-len": ["error", { "code": 120 } ],
     "indent": ["error", 2, {"SwitchCase": 1, "MemberExpression": "off"}],
     "linebreak-style": ["error", "unix"],
     "semi": ["error", "always"],

app/admin.js

@@ -26,7 +26,7 @@ const subparsers = parser.addSubparsers({
 
 const importKeys = subparsers.addParser('import', { addHelp: true });
 importKeys.addArgument(
-  [ 'file' ],
+  ['file'],
   {
     action: 'store',
     help: 'path to a list of public keys generated from admin.js generate'
@@ -59,12 +59,12 @@ signCommand.addArgument(
   }
 );
 signCommand.addArgument(
-    ['--path'],
-    {
-        action: 'store',
-        required: false,
-        help: 'optional derivation path to derive from the given key'
-    }
+  ['--path'],
+  {
+    action: 'store',
+    required: false,
+    help: 'optional derivation path to derive from the given key'
+  }
 );
 signCommand.addArgument(
   ['--confirm'],
@@ -161,20 +161,20 @@ generateKeysCommand.addArgument(
 
 subparsers.addParser('seed', {
   addHelp: true,
-  description: 'Generates a cryptographically secure random seed to be used for Stellar key derivation.\n' +
-    'Note: To generate a master key for non-Stellar coins, please install BitGo CLI and run "bitgo newkey"'
+  description: 'Generates a cryptographically secure random seed to be used for Stellar key derivation.\n'
+    + 'Note: To generate a master key for non-Stellar coins, please install BitGo CLI and run "bitgo newkey"'
 });
 
 const deriveKeyCommand = subparsers.addParser('derive', { addHelp: true });
 deriveKeyCommand.addArgument(
-  [ 'master' ],
+  ['master'],
   {
     action: 'store',
     help: 'xpub of the master key (starts with "xpub")'
   }
 );
 deriveKeyCommand.addArgument(
-  [ 'path' ],
+  ['path'],
   {
     action: 'store',
     help: 'derivation path of the wallet key (starts with "m/")'
@@ -230,7 +230,8 @@ const validateKey = function(key, type) {
 };
 
 const saveKeys = co(function *(keys, type) {
-  // this extracts the possible values directly from the Mongoose schema, which is considered the most accurate set of possible values
+  // this extracts the possible values directly from the Mongoose schema,
+  // which is considered the most accurate set of possible values
   const validTypes = MasterKey.schema.path('type').enumValues;
 
   if (!validTypes.includes(type)) {
@@ -246,7 +247,7 @@ const saveKeys = co(function *(keys, type) {
       path: key.path,
       signature: key.signature,
       keyCount: 0
-  }));
+    }));
 
   if (keyDocs.length === 0) {
     console.log('No valid public keys. Please re-generate and try again.');
@@ -265,7 +266,8 @@ const saveKeys = co(function *(keys, type) {
     console.log(`New capacity: ${availableKeys} available ${type} keys out of ${totalKeys} total ${type} keys.`);
   } catch (e) {
     console.log(e.message);
-    console.log('FAILED to import all public keys. This is usually caused by trying to import a public key that already exists in the database.');
+    console.log('FAILED to import all public keys. '
+      + 'This is usually caused by trying to import a public key that already exists in the database.');
   }
 });
 
@@ -277,7 +279,9 @@ const handleImportKeys = co(function *(args) {
     throw new Error('please specify the path to a CSV file containing the public keys to import');
   }
 
-  let keys = JSON.parse(fs.readFileSync(path, { encoding: 'utf8' }));
+  const file = yield fs.readFile(path, { encoding: 'utf8' });
+
+  let keys = JSON.parse(file);
 
   keys = formatKeysByType(keys, type);
 
@@ -294,7 +298,8 @@ const handleImportKeys = co(function *(args) {
  *   xlmSignature: "KOPASIK------PSDIFAPSDFOAF"
  *   path: "100"
  * }
- * If this key comes in, we can save it either as type xpub or xlm (depending on what the admin specifies on the command line)
+ * If this key comes in, we can save it either as type xpub or xlm
+ * (depending on what the admin specifies on the command line)
  * If the above key is imported as type 'xlm', we will change it to the following format:
  * {
  *   pub: "GSLKJASDFJASLFASDFAS"
@@ -316,9 +321,9 @@ const formatKeysByType = function(keys, type) {
       signature: type === 'xlm' ? key.xlmSignature : key.signature,
       path: key.path
     });
-  })
+  });
   return formattedkeys;
-}
+};
 
 const handleDeriveKey = function(args) {
   try {
@@ -364,7 +369,7 @@ const handleVerificationGet = co(function *(args) {
   }
 
   if (_.isUndefined(key.verificationInfo)) {
-    key.verificationInfo = '<N/A>'
+    key.verificationInfo = '<N/A>';
   }
 
   // if there are multiple lines, this aligns each line under the first line
@@ -411,15 +416,15 @@ const handleVerification = co(function *(args) {
   }
 });
 
-const handleRecoveryInfo = co(function *(args){
+const handleRecoveryInfo = co(function *(args) {
   const json = JSON.parse(fs.readFileSync(args.file));
   const pub = json.backupKey;
   const walletkey = yield WalletKey.findOne({ pub });
   const masterkey = yield MasterKey.findOne({ pub: walletkey.masterKey });
   json.masterkey = masterkey.pub;
   json.masterkeypath = masterkey.path;
   json.walletkeypath = walletkey.path;
-  const filename = args.file.substring(0,args.file.length - 5) + '-prepared.json';
+  const filename = args.file.substring(0, args.file.length - 5) + '-prepared.json';
   console.log('got info... writing file ' + filename);
   fs.writeFileSync(filename, JSON.stringify(json, null, 2));
   console.log('done.');
@@ -429,7 +434,7 @@ const requireDB = function() {
   MasterKey = require('./models/masterkey.js');
   WalletKey = require('./models/walletkey.js');
   db = require('./db.js');
-}
+};
 
 const run = co(function *(testArgs) {
   const args = parser.parseArgs(testArgs);
@@ -440,7 +445,7 @@ const run = co(function *(testArgs) {
       yield handleImportKeys(args);
       break;
     case 'sign':
-      signingTool.handleSign(args);
+      yield signingTool.handleSign(args);
       break;
     case 'derive':
       handleDeriveKey(args);
@@ -466,4 +471,4 @@ const run = co(function *(testArgs) {
 });
 
 // For admin script and unit testing of functions
-module.exports = { run, validateKey, saveKeys, db , requireDB };
+module.exports = { run, validateKey, saveKeys, db, requireDB };

app/app.js

@@ -1,6 +1,8 @@
 const express = require('express');
 const bodyParser = require('body-parser');
+const fs = require('fs');
 const morgan = require('morgan');
+const path = require('path');
 
 const utils = require('./utils');
 const krs = require('./krs');

app/krs.js

@@ -18,7 +18,7 @@ const WalletKey = require('./models/walletkey');
  * @param state: 'created' when the key is first created
  */
 const notifyEndpoint = co(function *(key, state) {
-  const generateHMAC = function(xpub){
+  const generateHMAC = function(xpub) {
     const hmac = crypto.createHmac('sha256', process.config.provider.secret);
     hmac.update(xpub);
     return hmac.digest('hex');
@@ -37,7 +37,7 @@ const notifyEndpoint = co(function *(key, state) {
         state: state,
         xpub: xpub,
         hmac: hmac
-      })
+      });
   } catch (e) {
     console.log('error connecting to webhook');
   }
@@ -60,7 +60,8 @@ const sendDatabaseLowWarning = co(function *(availableKeys, type) {
 const provisionMasterKey = co(function *(coin, customerId) {
   const keyType = process.config.supportedcoins[coin];
 
-  const key = yield MasterKey.findOneAndUpdate({ coin: null, customerId: null, type: keyType }, { coin: coin, customerId: customerId, type: keyType });
+  const key = yield MasterKey.findOneAndUpdate({ coin: null, customerId: null, type: keyType },
+    { coin: coin, customerId: customerId, type: keyType });
 
   if (!key) {
     throw utils.ErrorResponse(500, `no available ${keyType} keys`);
@@ -83,7 +84,7 @@ const provisionMasterKey = co(function *(coin, customerId) {
  */
 const getMasterXpub = co(function *(coin, customerId) {
 
-  if(process.config.neverReuseMasterKey) {
+  if (process.config.neverReuseMasterKey) {
     return provisionMasterKey(coin, customerId);
   }
 
@@ -128,8 +129,8 @@ exports.provisionKey = co(function *(req) {
     if (!req.body.requesterId && !req.body.requesterSecret) {
       throw utils.ErrorResponse(401, 'this krs requires you to send a requesterId and requesterSecret to get a key');
     }
-    if (!process.config.requesterAuth.clients[req.body.requesterId] ||
-        process.config.requesterAuth.clients[req.body.requesterId] !== req.body.requesterSecret) {
+    if (!process.config.requesterAuth.clients[req.body.requesterId]
+        || process.config.requesterAuth.clients[req.body.requesterId] !== req.body.requesterSecret) {
       throw utils.ErrorResponse(401, 'invalid requesterSecret');
     }
   }
@@ -193,7 +194,7 @@ exports.provisionKey = co(function *(req) {
     custom: key.custom,
     masterKeySig: masterKey.signature,
     pub: key.pub
-  }
+  };
 
   return response;
 });

app/models/masterkey.js

@@ -7,7 +7,7 @@ const masterKeySchema = new mongoose.Schema({
   customerId: { type: String },
   pub: { type: String },
   path: { type: String },
-  signature: {type: String},
+  signature: { type: String },
   keyCount: { type: Number }
 });