1432748401

Build Type

push

github

Committed by GitHub

Commit Message

fix!: Use SHA-256 for the config file name (#57)

Run Details

44 of 53 branches covered (83.02%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 1 file covered. (100.0%)

8 existing lines in 1 file now uncovered.

87 of 96 relevant lines covered (90.63%)

1256.04 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.12

/index.js

// this entire module is depressing. i should have spent my time learning
// how to patch v8 so that these options would just be available on the
// process object.

var os = require('os');
var fs = require('fs');
var path = require('path');
var crypto = require('crypto');
var execFile = require('child_process').execFile;
var configPath = require('./config-path.js')(process.platform);
var env = process.env;
var user = env.LOGNAME || env.USER || env.LNAME || env.USERNAME || '';
var exclusions = ['--help', '--completion_bash'];

// This number must be incremented whenever the generated cache file changes.
var CACHE_VERSION = 3;

var configfile = '.v8flags-' + CACHE_VERSION + '-' + process.versions.v8 +
  '.' + crypto.createHash('sha256').update(user).digest('hex') + '.json';

var failureMessage = [
  'Unable to cache a config file for v8flags to your home directory',
  'or a temporary folder. To fix this problem, please correct your',
  'environment by setting HOME=/path/to/home or TEMP=/path/to/temp.',
  'NOTE: the user running this must be able to access provided path.',
  'If all else fails, please open an issue here:',
  'http://github.com/tkellen/js-v8flags',
].join('\n');

function fail(err) {
  err.message += '\n\n' + failureMessage;
  return err;
}

function openConfig(cb) {
  fs.mkdir(configPath, function () {
    tryOpenConfig(path.join(configPath, configfile), function (err, fd) {
      if (err) {
        return tryOpenConfig(path.join(os.tmpdir(), configfile), cb);
      }
      return cb(null, fd);
    });
  });
}

function tryOpenConfig(configpath, cb) {
  try {
    // if the config file is valid, it should be json and therefore
    // node should be able to require it directly. if this doesn't
    // throw, we're done!
    var content = require(configpath);
    process.nextTick(function () {
      cb(null, content);
    });
  } catch (e) {
    // if requiring the config file failed, maybe it doesn't exist, or
    // perhaps it has become corrupted. instead of calling back with the
    // content of the file, call back with a file descriptor that we can
    // write the cached data to
    fs.open(configpath, 'w+', function (err, fd) {
      if (err) {
        return cb(err);
      }
      return cb(null, fd);
    });
  }
}

// Node <= 9 outputs _ in flags with multiple words, while node 10
// uses -. Both ways are accepted anyway, so always use `_` for better
// compatibility.
// We must not replace the first two --.
function normalizeFlagName(flag) {
  return '--' + flag.slice(4).replace(/-/g, '_');
}

// i can't wait for the day this whole module is obsolete because these
// options are available on the process object. this executes node with
// `--v8-options` and parses the result, returning an array of command
// line flags.
function getFlags(cb) {
  var errored = false;
  var pending = 0;
  var flags = [];

  runNode('--help');
  runNode('--v8-options');

  function runNode(option) {
    pending++;
    execFile(process.execPath, [option], function (execErr, result) {
      if (execErr || errored) {
        if (!errored) {
          errored = true;
          cb(execErr);
        }
        return;
      }

      var index = result.indexOf('\nOptions:');
      if (index >= 0) {
        var regexp = /^\s\s--[\w-]+/gm;
        regexp.lastIndex = index;
        var matchedFlags = result.match(regexp);
        if (matchedFlags) {
          flags = flags.concat(
            matchedFlags.map(normalizeFlagName).filter(function (name) {
              return exclusions.indexOf(name) === -1;
            })
          );
        }
      }

      if (--pending === 0) {
        cb(null, flags);
      }
    });
  }
}

// write some json to a file descriptor. if this fails, call back
// with both the error and the data that was meant to be written.
function writeConfig(fd, flags, cb) {
  var json = JSON.stringify(flags);
  var buf;
  if (Buffer.from && Buffer.from !== Uint8Array.from) {
    // Node.js 4.5.0 or newer
    buf = Buffer.from(json);
  } else {
    // Old Node.js versions
    // The typeof safeguard below is mostly against accidental copy-pasting
    // and code rewrite, it never happens as json is always a string here.
    if (typeof json === 'number') {
      throw new Error('Unexpected type number');
    }
    buf = new Buffer(json);
  }
  return fs.write(fd, buf, 0, buf.length, 0, function (writeErr) {
    fs.close(fd, function (closeErr) {
      var err = writeErr || closeErr;
      if (err) {
        return cb(fail(err), flags);
      }
      return cb(null, flags);
    });
  });
}

module.exports = function (cb) {
  // bail early if this is not node
  var isElectron = process.versions && process.versions.electron;
  if (isElectron) {
    return process.nextTick(function () {
      cb(null, []);
    });
  }

  // attempt to open/read cache file
  openConfig(function (openErr, result) {
    if (!openErr && typeof result !== 'number') {
      return cb(null, result);
    }
    // if the result is not an array, we need to go fetch
    // the flags by invoking node with `--v8-options`
    getFlags(function (flagsErr, flags) {
      // if there was an error fetching the flags, bail immediately
      if (flagsErr) {
        return cb(flagsErr);
      }
      // if there was a problem opening the config file for writing
      // throw an error but include the flags anyway so that users
      // can continue to execute (at the expense of having to fetch
      // flags on every run until they fix the underyling problem).
      if (openErr) {
        return cb(fail(openErr), flags);
      }
      // write the config file to disk so subsequent runs can read
      // flags out of a cache file.
      return writeConfig(result, flags, cb);
    });
  });
};

module.exports.configfile = configfile;
module.exports.configPath = configPath;

1	// this entire module is depressing. i should have spent my time learning
2	// how to patch v8 so that these options would just be available on the
3	// process object.
4
5	var os = require('os');	288✔
6	var fs = require('fs');	288✔
7	var path = require('path');	288✔
8	var crypto = require('crypto');	288✔
9	var execFile = require('child_process').execFile;	288✔
10	var configPath = require('./config-path.js')(process.platform);	288✔
11	var env = process.env;	288✔
12	var user = env.LOGNAME \|\| env.USER \|\| env.LNAME \|\| env.USERNAME \|\| '';	288✔
13	var exclusions = ['--help', '--completion_bash'];	288✔
14
15	// This number must be incremented whenever the generated cache file changes.
16	var CACHE_VERSION = 3;	288✔
17
18	var configfile = '.v8flags-' + CACHE_VERSION + '-' + process.versions.v8 +	288✔
19	'.' + crypto.createHash('sha256').update(user).digest('hex') + '.json';
20
21	var failureMessage = [	288✔
22	'Unable to cache a config file for v8flags to your home directory',
23	'or a temporary folder. To fix this problem, please correct your',
24	'environment by setting HOME=/path/to/home or TEMP=/path/to/temp.',
25	'NOTE: the user running this must be able to access provided path.',
26	'If all else fails, please open an issue here:',
27	'http://github.com/tkellen/js-v8flags',
28	].join('\n');
29
30	function fail(err) {
31	err.message += '\n\n' + failureMessage;	12✔
32	return err;	12✔
33	}
34
35	function openConfig(cb) {
36	fs.mkdir(configPath, function () {	164✔
37	tryOpenConfig(path.join(configPath, configfile), function (err, fd) {	164✔
38	if (err) {	164✔
39	return tryOpenConfig(path.join(os.tmpdir(), configfile), cb);	24✔
40	}
41	return cb(null, fd);	140✔
42	});
43	});
44	}
45
46	function tryOpenConfig(configpath, cb) {
47	try {	188✔
48	// if the config file is valid, it should be json and therefore
49	// node should be able to require it directly. if this doesn't
50	// throw, we're done!
51	var content = require(configpath);	188✔
52	process.nextTick(function () {	60✔
53	cb(null, content);	60✔
54	});
55	} catch (e) {
56	// if requiring the config file failed, maybe it doesn't exist, or
57	// perhaps it has become corrupted. instead of calling back with the
58	// content of the file, call back with a file descriptor that we can
59	// write the cached data to
60	fs.open(configpath, 'w+', function (err, fd) {	128✔
61	if (err) {	128✔
62	return cb(err);	36✔
63	}
64	return cb(null, fd);	92✔
65	});
66	}
67	}
68
69	// Node <= 9 outputs _ in flags with multiple words, while node 10
70	// uses -. Both ways are accepted anyway, so always use `_` for better
71	// compatibility.
72	// We must not replace the first two --.
73	function normalizeFlagName(flag) {
74	return '--' + flag.slice(4).replace(/-/g, '_');	53,200✔
75	}
76
77	// i can't wait for the day this whole module is obsolete because these
78	// options are available on the process object. this executes node with
79	// `--v8-options` and parses the result, returning an array of command
80	// line flags.
81	function getFlags(cb) {
82	var errored = false;	104✔
83	var pending = 0;	104✔
84	var flags = [];	104✔
85
86	runNode('--help');	104✔
87	runNode('--v8-options');	104✔
88
89	function runNode(option) {
90	pending++;	208✔
91	execFile(process.execPath, [option], function (execErr, result) {	208✔
92	if (execErr \|\| errored) {	208!
UNCOV 93	if (!errored) {	×
UNCOV 94	errored = true;	×
UNCOV 95	cb(execErr);	×
96	}
UNCOV 97	return;	×
98	}
99
100	var index = result.indexOf('\nOptions:');	208✔
101	if (index >= 0) {	208✔
102	var regexp = /^\s\s--[\w-]+/gm;	192✔
103	regexp.lastIndex = index;	192✔
104	var matchedFlags = result.match(regexp);	192✔
105	if (matchedFlags) {	192!
106	flags = flags.concat(	192✔
107	matchedFlags.map(normalizeFlagName).filter(function (name) {
108	return exclusions.indexOf(name) === -1;	53,200✔
109	})
110	);
111	}
112	}
113
114	if (--pending === 0) {	208✔
115	cb(null, flags);	104✔
116	}
117	});
118	}
119	}
120
121	// write some json to a file descriptor. if this fails, call back
122	// with both the error and the data that was meant to be written.
123	function writeConfig(fd, flags, cb) {
124	var json = JSON.stringify(flags);	92✔
125	var buf;
126	if (Buffer.from && Buffer.from !== Uint8Array.from) {	92!
127	// Node.js 4.5.0 or newer
128	buf = Buffer.from(json);	92✔
129	} else {
130	// Old Node.js versions
131	// The typeof safeguard below is mostly against accidental copy-pasting
132	// and code rewrite, it never happens as json is always a string here.
UNCOV 133	if (typeof json === 'number') {	×
UNCOV 134	throw new Error('Unexpected type number');	×
135	}
136	buf = new Buffer(json);	×
137	}
138	return fs.write(fd, buf, 0, buf.length, 0, function (writeErr) {	92✔
139	fs.close(fd, function (closeErr) {	92✔
140	var err = writeErr \|\| closeErr;	92✔
141	if (err) {	92!
UNCOV 142	return cb(fail(err), flags);	×
143	}
144	return cb(null, flags);	92✔
145	});
146	});
147	}
148
149	module.exports = function (cb) {	288✔
150	// bail early if this is not node
151	var isElectron = process.versions && process.versions.electron;	176✔
152	if (isElectron) {	176✔
153	return process.nextTick(function () {	12✔
154	cb(null, []);	12✔
155	});
156	}
157
158	// attempt to open/read cache file
159	openConfig(function (openErr, result) {	164✔
160	if (!openErr && typeof result !== 'number') {	164✔
161	return cb(null, result);	60✔
162	}
163	// if the result is not an array, we need to go fetch
164	// the flags by invoking node with `--v8-options`
165	getFlags(function (flagsErr, flags) {	104✔
166	// if there was an error fetching the flags, bail immediately
167	if (flagsErr) {	104!
UNCOV 168	return cb(flagsErr);	×
169	}
170	// if there was a problem opening the config file for writing
171	// throw an error but include the flags anyway so that users
172	// can continue to execute (at the expense of having to fetch
173	// flags on every run until they fix the underyling problem).
174	if (openErr) {	104✔
175	return cb(fail(openErr), flags);	12✔
176	}
177	// write the config file to disk so subsequent runs can read
178	// flags out of a cache file.
179	return writeConfig(result, flags, cb);	92✔
180	});
181	});
182	};
183
184	module.exports.configfile = configfile;	288✔
185	module.exports.configPath = configPath;	288✔

gulpjs / v8flags / 1432748401

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous