688e5ed6fdThis change removes `common.noop` from the Node.js internal testing
common module.
Over the last few weeks, I've grown to dislike the `common.noop`
abstraction.
First, new (and experienced) contributors are unaware of it and so it
results in a large number of low-value nits on PRs. It also increases
the number of things newcomers and infrequent contributors have to be
aware of to be effective on the project.
Second, it is confusing. Is it a singleton/property or a getter? Which
should be expected? This can lead to subtle and hard-to-find bugs. (To
my knowledge, none have landed on master. But I also think it's only a
matter of time.)
Third, the abstraction is low-value in my opinion. What does it really
get us? A case could me made that it is without value at all.
Lastly, and this is minor, but the abstraction is wordier than not using
the abstraction. `common.noop` doesn't save anything over `() => {}`.
So, I propose removing it.
PR-URL: https://github.com/nodejs/node/pull/12822
Backport-PR-URL: https://github.com/nodejs/node/pull/14174
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Refael Ackermann <refack@gmail.com>
108 lines
2.7 KiB
JavaScript
108 lines
2.7 KiB
JavaScript
'use strict';
|
|
const common = require('../common');
|
|
const assert = require('assert');
|
|
const join = require('path').join;
|
|
const fs = require('fs');
|
|
|
|
common.refreshTmpDir();
|
|
|
|
const repl = require('repl');
|
|
|
|
const works = [['inner.one'], 'inner.o'];
|
|
|
|
const putIn = new common.ArrayStream();
|
|
const testMe = repl.start('', putIn);
|
|
|
|
|
|
const testFile = [
|
|
'var top = function() {',
|
|
'var inner = {one:1};'
|
|
];
|
|
const saveFileName = join(common.tmpDir, 'test.save.js');
|
|
|
|
// input some data
|
|
putIn.run(testFile);
|
|
|
|
// save it to a file
|
|
putIn.run(['.save ' + saveFileName]);
|
|
|
|
// the file should have what I wrote
|
|
assert.strictEqual(fs.readFileSync(saveFileName, 'utf8'), testFile.join('\n') +
|
|
'\n');
|
|
|
|
{
|
|
// save .editor mode code
|
|
const cmds = [
|
|
'function testSave() {',
|
|
'return "saved";',
|
|
'}'
|
|
];
|
|
const putIn = new common.ArrayStream();
|
|
const replServer = repl.start('', putIn);
|
|
|
|
putIn.run(['.editor']);
|
|
putIn.run(cmds);
|
|
replServer.write('', {ctrl: true, name: 'd'});
|
|
|
|
putIn.run([`.save ${saveFileName}`]);
|
|
replServer.close();
|
|
assert.strictEqual(fs.readFileSync(saveFileName, 'utf8'),
|
|
`${cmds.join('\n')}\n`);
|
|
}
|
|
|
|
// make sure that the REPL data is "correct"
|
|
// so when I load it back I know I'm good
|
|
testMe.complete('inner.o', function(error, data) {
|
|
assert.deepStrictEqual(data, works);
|
|
});
|
|
|
|
// clear the REPL
|
|
putIn.run(['.clear']);
|
|
|
|
// Load the file back in
|
|
putIn.run(['.load ' + saveFileName]);
|
|
|
|
// make sure that the REPL data is "correct"
|
|
testMe.complete('inner.o', function(error, data) {
|
|
assert.deepStrictEqual(data, works);
|
|
});
|
|
|
|
// clear the REPL
|
|
putIn.run(['.clear']);
|
|
|
|
let loadFile = join(common.tmpDir, 'file.does.not.exist');
|
|
|
|
// should not break
|
|
putIn.write = function(data) {
|
|
// make sure I get a failed to load message and not some crazy error
|
|
assert.strictEqual(data, 'Failed to load:' + loadFile + '\n');
|
|
// eat me to avoid work
|
|
putIn.write = () => {};
|
|
};
|
|
putIn.run(['.load ' + loadFile]);
|
|
|
|
// throw error on loading directory
|
|
loadFile = common.tmpDir;
|
|
putIn.write = function(data) {
|
|
assert.strictEqual(data, `Failed to load:${loadFile} is not a valid file\n`);
|
|
putIn.write = () => {};
|
|
};
|
|
putIn.run(['.load ' + loadFile]);
|
|
|
|
// clear the REPL
|
|
putIn.run(['.clear']);
|
|
|
|
// NUL (\0) is disallowed in filenames in UNIX-like operating systems and
|
|
// Windows so we can use that to test failed saves
|
|
const invalidFileName = join(common.tmpDir, '\0\0\0\0\0');
|
|
|
|
// should not break
|
|
putIn.write = function(data) {
|
|
// make sure I get a failed to save message and not some other error
|
|
assert.strictEqual(data, 'Failed to save:' + invalidFileName + '\n');
|
|
// reset to no-op
|
|
putIn.write = () => {};
|
|
};
|
|
|
|
// save it to a file
|
|
putIn.run(['.save ' + invalidFileName]);
|