node/test/parallel/test-readline-promises-csi.mjs
Tobias Nießen dd52c05046 test: avoid deep comparisons with literals
Comparing any value to any non-RegExp literal or undefined using
strictEqual (or notStrictEqual) passes if and only if deepStrictEqual
(or notDeepStrictEqual, respectively) passes.

Unnecessarily using deep comparisons adds confusion.

This patch adds an ESLint rule that forbids the use of deepStrictEqual
and notDeepStrictEqual when the expected value (i.e., the second
argument) is a non-RegExp literal or undefined.

For reference, an ESTree literal is defined as follows.

    extend interface Literal <: Expression {
        type: "Literal";
        value: string | boolean | null | number | RegExp | bigint;
    }

The value `undefined` is an `Identifier` with `name: 'undefined'`.

PR-URL: https://github.com/nodejs/node/pull/40634
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Voltrex <mohammadkeyvanzade94@gmail.com>
2021-11-02 10:11:49 +00:00

164 lines
4.1 KiB
JavaScript

// Flags: --expose-internals
import '../common/index.mjs';
import assert from 'assert';
import { Readline } from 'readline/promises';
import { Writable } from 'stream';
import utils from 'internal/readline/utils';
const { CSI } = utils;
const INVALID_ARG = {
name: 'TypeError',
code: 'ERR_INVALID_ARG_TYPE',
};
class TestWritable extends Writable {
data = '';
_write(chunk, encoding, callback) {
this.data += chunk.toString();
callback();
}
}
[
undefined, null,
0, 1, 1n, 1.1, NaN, Infinity,
true, false,
Symbol(),
'', '1',
[], {}, () => {},
].forEach((arg) =>
assert.throws(() => new Readline(arg), INVALID_ARG)
);
{
const writable = new TestWritable();
const readline = new Readline(writable);
await readline.clearScreenDown().commit();
assert.deepStrictEqual(writable.data, CSI.kClearScreenDown);
await readline.clearScreenDown().commit();
writable.data = '';
await readline.clearScreenDown().rollback();
assert.strictEqual(writable.data, '');
writable.data = '';
await readline.clearLine(-1).commit();
assert.deepStrictEqual(writable.data, CSI.kClearToLineBeginning);
writable.data = '';
await readline.clearLine(1).commit();
assert.deepStrictEqual(writable.data, CSI.kClearToLineEnd);
writable.data = '';
await readline.clearLine(0).commit();
assert.deepStrictEqual(writable.data, CSI.kClearLine);
writable.data = '';
await readline.clearLine(-1).commit();
assert.deepStrictEqual(writable.data, CSI.kClearToLineBeginning);
await readline.clearLine(0, null).commit();
// Nothing is written when moveCursor 0, 0
for (const set of
[
[0, 0, ''],
[1, 0, '\x1b[1C'],
[-1, 0, '\x1b[1D'],
[0, 1, '\x1b[1B'],
[0, -1, '\x1b[1A'],
[1, 1, '\x1b[1C\x1b[1B'],
[-1, 1, '\x1b[1D\x1b[1B'],
[-1, -1, '\x1b[1D\x1b[1A'],
[1, -1, '\x1b[1C\x1b[1A'],
]) {
writable.data = '';
await readline.moveCursor(set[0], set[1]).commit();
assert.deepStrictEqual(writable.data, set[2]);
writable.data = '';
await readline.moveCursor(set[0], set[1]).commit();
assert.deepStrictEqual(writable.data, set[2]);
}
await readline.moveCursor(1, 1, null).commit();
writable.data = '';
[
undefined, null,
true, false,
Symbol(),
'', '1',
[], {}, () => {},
].forEach((arg) =>
assert.throws(() => readline.cursorTo(arg), INVALID_ARG)
);
assert.strictEqual(writable.data, '');
writable.data = '';
assert.throws(() => readline.cursorTo('a', 'b'), INVALID_ARG);
assert.strictEqual(writable.data, '');
writable.data = '';
assert.throws(() => readline.cursorTo('a', 1), INVALID_ARG);
assert.strictEqual(writable.data, '');
writable.data = '';
assert.throws(() => readline.cursorTo(1, 'a'), INVALID_ARG);
assert.strictEqual(writable.data, '');
writable.data = '';
await readline.cursorTo(1).commit();
assert.strictEqual(writable.data, '\x1b[2G');
writable.data = '';
await readline.cursorTo(1, 2).commit();
assert.strictEqual(writable.data, '\x1b[3;2H');
writable.data = '';
await readline.cursorTo(1, 2).commit();
assert.strictEqual(writable.data, '\x1b[3;2H');
writable.data = '';
await readline.cursorTo(1).cursorTo(1, 2).commit();
assert.strictEqual(writable.data, '\x1b[2G\x1b[3;2H');
writable.data = '';
await readline.cursorTo(1).commit();
assert.strictEqual(writable.data, '\x1b[2G');
// Verify that cursorTo() rejects if x or y is NaN.
[1.1, NaN, Infinity].forEach((arg) => {
assert.throws(() => readline.cursorTo(arg), {
code: 'ERR_OUT_OF_RANGE',
name: 'RangeError',
});
});
[1.1, NaN, Infinity].forEach((arg) => {
assert.throws(() => readline.cursorTo(1, arg), {
code: 'ERR_OUT_OF_RANGE',
name: 'RangeError',
});
});
assert.throws(() => readline.cursorTo(NaN, NaN), {
code: 'ERR_OUT_OF_RANGE',
name: 'RangeError',
});
}
{
const error = new Error();
const writable = new class extends Writable {
_write() { throw error; }
}();
const readline = new Readline(writable);
await assert.rejects(readline.cursorTo(1).commit(), error);
}