Enforce a style guide

.eslintignore

@@ -0,0 +1 @@
+static/js/*.min.js

.eslintrc-browser.js

@@ -0,0 +1,36 @@
+module.exports = {
+  "env": {
+    "browser": true,
+    "es6": false
+  },
+  "extends": [
+    "eslint:recommended",
+    "standard"
+  ],
+  "globals": {
+    "$": true,
+    "Dygraph": true,
+    "Scout": true,
+    "ajaxForm": true,
+    "updateFormStatus": true,
+  },
+  "rules": {
+    // Override some of standard js rules.
+    "semi": ["error", "always"],
+    "comma-dangle": [
+      "error", {
+        "arrays": "only-multiline",
+        "objects": "only-multiline",
+        "imports": "never",
+        "exports": "never",
+        "functions": "never",
+      }
+    ],
+
+    // Override some eslint base rules because we're using ES5.
+    "no-new": "off",
+
+    // Custom rules.
+    "no-console": ["error", {"allow": ["warn", "error"]}],
+  }
+};

.eslintrc-node.js

@@ -0,0 +1,25 @@
+module.exports = {
+  "env": {
+    "browser": false,
+    "es6": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:node/recommended",
+    "standard"
+  ],
+  "plugins": [
+    "node"
+  ],
+  "rules": {
+    // Override some of standard js rules
+    "semi": ["error", "always"],
+    "comma-dangle": ["error", "only-multiline"],
+    "camelcase": "off",
+    "no-var": "error",
+
+    // Override some eslint base rules because we're using node.
+    "no-console": "off",
+  }
+};

api/hosts-api.js

@@ -141,7 +141,6 @@ hostAPI.post({
     // No authentication.
     response.statusCode = 403; // Forbidden
     response.json({ error: 'Unauthorized' }, null, 2);
-    return;
 
     function createHost () {
       getHostProperties(properties => {

api/user-api.js

@@ -8,7 +8,6 @@ const configurations = require('../lib/configurations');
 const db = require('../lib/db');
 const log = require('../lib/log');
 const machines = require('../lib/machines');
-const users = require('../lib/users');
 
 // API resource to manage a Janitor user.
 const userAPI = module.exports = selfapi({

app.js

@@ -19,7 +19,6 @@ boot.executeInParallel([
   boot.ensureHttpsCertificates,
   boot.ensureDockerTlsCertificates
 ], () => {
-
   // You can customize these values in './db.json'.
   const hostname = db.get('hostname', 'localhost');
   const https = db.get('https');
@@ -495,11 +494,12 @@ boot.executeInParallel([
     }
 
     let key = '';
+    let match;
     switch (data.name) {
       case 'cloud9':
         // Extract a valid SSH public key from the user's input.
         // Regex adapted from https://gist.github.com/paranoiq/1932126.
-        var match = data.key.match(/ssh-rsa [\w+\/]+[=]{0,3}/);
+        match = data.key.match(/ssh-rsa [\w+/]+[=]{0,3}/);
         if (!match) {
           return end({ status: 'error', message: 'Invalid SSH key' });
         }
@@ -509,7 +509,7 @@ boot.executeInParallel([
 
       case 'cloud9user':
         // Cloud9 usernames consist of lowercase letters, numbers and '_' only.
-        var match = data.key.trim().match(/^[a-z0-9_]+$/);
+        match = data.key.trim().match(/^[a-z0-9_]+$/);
         if (!match) {
           return end({ status: 'error', message: 'Invalid Cloud9 username' });
         }

join.js

@@ -16,9 +16,8 @@ const sessions = require('./lib/sessions');
 const hostname = db.get('hostname', 'localhost');
 
 if (!hostname || hostname === 'localhost') {
-  log('[fail] cannot join cluster as [hostname = ' + hostname + ']: ' +
+  throw new Error('Cannot join cluster as [hostname = ' + hostname + ']: ' +
     'please fix the hostname in ./db.json and try again');
-  return;
 }
 
 log('[ok] will try to join cluster as [hostname = ' + hostname + ']');
@@ -256,18 +255,17 @@ function routeRequest (proxyParameters, request, response) {
   switch (proxy) {
     case 'https':
       routes.webProxy(request, response, { port, path });
-      return;
+      break;
 
     case 'none':
-      const url = 'https://' + hostname + ':' + port + path;
-      routes.redirect(response, url);
-      return;
+      routes.redirect(response, 'https://' + hostname + ':' + port + path);
+      break;
 
     default:
       log('[fail] unsupported proxy type:', proxy);
       response.statusCode = 500; // Internal Server Error
       response.end();
-      return;
+      break;
   }
 }
 

lib/boot.js

@@ -55,7 +55,7 @@ exports.forwardHttp = function (next) {
     response.end();
   });
 
-  forwarder.listen(ports.http , () => {
+  forwarder.listen(ports.http, () => {
     log('[ok] forwarding http:// → https://');
     next();
   });
@@ -263,7 +263,7 @@ exports.ensureDockerTlsCertificates = function (next) {
             return;
           }
 
-          fs.chmod(path, 0600 /* read + write by owner */, (error) => {
+          fs.chmod(path, 0o600 /* read + write by owner */, (error) => {
             if (error) {
               log('[fail] unable to protect ' + path, error);
               return;
@@ -292,6 +292,7 @@ exports.ensureDockerTlsCertificates = function (next) {
       return;
     }
 
+    // eslint-disable-next-line no-func-assign
     done = null;
     db.save();
     log('[ok] new docker-tls credentials installed');
@@ -344,4 +345,3 @@ exports.registerDockerClient = function (next) {
     next();
   });
 };
-

lib/certificates.js

@@ -1,9 +1,9 @@
 // Copyright © 2016 Jan Keromnes. All rights reserved.
 // The following code is covered by the AGPL-3.0 license.
 
-let child_process = require('child_process');
-let forge = require('node-forge');
-let letsencrypt = require('le-acme-core');
+const child_process = require('child_process');
+const forge = require('node-forge');
+const letsencrypt = require('le-acme-core');
 
 // ACME protocol client to interact with the Let's Encrypt service.
 let client = letsencrypt.ACME.create({
@@ -18,11 +18,9 @@ let letsEncryptChallengePrefix =
 // ACME protocol challenge tokens proving our identity to Let's Encrypt.
 let letsEncryptChallenges = {};
 
-
 // Verify if a given certificate in PEM format satisfies validity constraints.
 
 exports.isValid = function (parameters, enableDebug) {
-
   let debug = () => {
     if (enableDebug) {
       console.error(...arguments);
@@ -101,17 +99,13 @@ exports.isValid = function (parameters, enableDebug) {
   }
 
   return true;
-
 };
 
-
 // Generate an RSA public and private key pair in forge format (binary).
 
 exports.generateRSAKeyPair = function (callback) {
-
   // Generate a new 4096-bit RSA private key (up to 100x faster than forge).
   child_process.exec('openssl genrsa 4096', (error, stdout, stderr) => {
-
     if (error) {
       callback(error);
       return;
@@ -127,18 +121,13 @@ exports.generateRSAKeyPair = function (callback) {
       privateKey: privateKey,
       publicKey: publicKey
     });
-
   });
-
 };
 
-
 // Generate an SSH public and private key pair in OpenSSH format.
 
 exports.createSSHKeyPair = function (callback) {
-
   exports.generateRSAKeyPair((error, keypair) => {
-
     if (error) {
       callback(error);
       return;
@@ -156,16 +145,12 @@ exports.createSSHKeyPair = function (callback) {
     };
 
     callback(null, sshKeyPair);
-
   });
-
 };
 
-
 // Create a TLS certificate in PEM format.
 
 exports.createTLSCertificate = function (parameters, callback) {
-
   let commonName = parameters.commonName;
   let altNames = parameters.altNames || [];
   let basicConstraints = parameters.basicConstraints || null;
@@ -245,33 +230,26 @@ exports.createTLSCertificate = function (parameters, callback) {
   certificate.setExtensions(extensions);
 
   if (key) {
-
     // A private key was provided, use it to finalize the certificate.
     let privateKey = forge.pki.privateKeyFromPem(key);
     let publicKey = forge.pki.setRsaPublicKey(privateKey.n, privateKey.e);
     signOff({
       privateKey: privateKey,
       publicKey: publicKey
     });
-    return;
-
   } else {
-
     // No private key was provided, generate a new one for this certificate.
     exports.generateRSAKeyPair((error, keypair) => {
       if (error) {
         callback(error);
         return;
       }
       signOff(keypair);
-      return;
     });
-
   }
 
   // Use a given TLS key pair to sign and return the certificate.
   function signOff (keypair) {
-
     certificate.publicKey = keypair.publicKey;
 
     if (caKey) {
@@ -289,17 +267,12 @@ exports.createTLSCertificate = function (parameters, callback) {
     }
 
     callback(null, crt, key);
-    return;
-
   }
-
 };
 
-
 // Generate an HTTPS certificate using Let's Encrypt (https://letsencrypt.org/).
 
 exports.createHTTPSCertificate = function (parameters, callback) {
-
   let hostname = parameters.hostname;
   let accountEmail = parameters.accountEmail;
   let accountKey = parameters.accountKey || null;
@@ -345,7 +318,6 @@ exports.createHTTPSCertificate = function (parameters, callback) {
 
   // Wait for all required tasks to finish before proceding.
   function done () {
-
     if (!acmeUrls || !accountKey || !httpsKey) {
       // Some tasks are not finished yet. Let's wait.
       return;
@@ -369,6 +341,7 @@ exports.createHTTPSCertificate = function (parameters, callback) {
     }
 
     // All required tasks are now finished, destroy the `done` callback.
+    // eslint-disable-next-line no-func-assign
     done = null;
 
     // We can now actually request an HTTPS certificate from Let's Encrypt.
@@ -384,21 +357,16 @@ exports.createHTTPSCertificate = function (parameters, callback) {
       }
       callback(null, certificate, accountKey);
     });
-
   }
-
 };
 
-
 // Expose the URL prefix that Let's Encrypt will use to challenge our identity.
 
 exports.letsEncryptChallengePrefix = letsEncryptChallengePrefix;
 
-
 // Look for an identity token that satisfies the given Let's Encrypt challenge.
 
 exports.getLetsEncryptChallengeToken = function (url) {
-
   if (!url || !url.startsWith(letsEncryptChallengePrefix)) {
     // Not a Let's Encrypt challenge URL.
     return null;
@@ -412,14 +380,11 @@ exports.getLetsEncryptChallengeToken = function (url) {
   }
 
   return token;
-
 };
 
-
 // Register a new Let's Encrypt account.
 
 function registerLetsEncryptAccount (parameters, callback) {
-
   let accountEmail = parameters.accountEmail;
   let accountKey = parameters.accountKey;
   let acmeUrls = parameters.acmeUrls;
@@ -437,14 +402,11 @@ function registerLetsEncryptAccount (parameters, callback) {
   };
 
   client.registerNewAccount(options, callback);
-
 } // Don't export `registerLetsEncryptAccount`.
 
-
 // Request HTTPS certificate issuance by Let's Encrypt via the ACME protocol.
 
 function requestLetsEncryptCertificate (parameters, callback) {
-
   let hostname = parameters.hostname;
   let acmeUrls = parameters.acmeUrls;
   let accountKey = parameters.accountKey;
@@ -473,5 +435,4 @@ function requestLetsEncryptCertificate (parameters, callback) {
   };
 
   client.getCertificate(options, callback);
-
 } // Don't export `requestLetsEncryptCertificate`.