repl: make key of repl.write() optional always

In `.editor` mode, `repl.write()` would have crashed when the `key` argument was not present, because the overwritten `_ttyWrite` of REPLs doesn’t check for the absence of a second argument like `readline.write()` does. Since the docs indicate that the argument is optional, add a check paralleling the one in `readline.write()`. PR-URL: #9207 Reviewed-By: Prince John Wesley <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Nov 3, 2016 · 1c59cef · 1c59cef
1 parent 8211904
commit 1c59cef
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/lib/repl.js b/lib/repl.js
@@ -601,6 +601,7 @@ function REPLServer(prompt,
   // Wrap readline tty to enable editor mode
   const ttyWrite = self._ttyWrite.bind(self);
   self._ttyWrite = (d, key) => {
+    key = key || {};
     if (!self.editorMode || !self.terminal) {
       ttyWrite(d, key);
       return;

diff --git a/test/parallel/test-repl-.editor.js b/test/parallel/test-repl-.editor.js
@@ -8,16 +8,17 @@ const repl = require('repl');
 // \u001b[0J - Clear screen
 // \u001b[3G - Moves the cursor to 3rd column
 const terminalCode = '\u001b[1G\u001b[0J> \u001b[3G';
+const terminalCodeRegex = new RegExp(terminalCode.replace(/\[/g, '\\['), 'g');
 
-function run({input, output, event}) {
+function run({input, output, event, checkTerminalCodes = true}) {
   const stream = new common.ArrayStream();
   let found = '';
 
   stream.write = (msg) => found += msg.replace('\r', '');
 
-  const expected = `${terminalCode}.editor\n` +
-                   '// Entering editor mode (^D to finish, ^C to cancel)\n' +
-                   `${input}${output}\n${terminalCode}`;
+  let expected = `${terminalCode}.editor\n` +
+                 '// Entering editor mode (^D to finish, ^C to cancel)\n' +
+                 `${input}${output}\n${terminalCode}`;
 
   const replServer = repl.start({
     prompt: '> ',
@@ -31,6 +32,12 @@ function run({input, output, event}) {
   stream.emit('data', input);
   replServer.write('', event);
   replServer.close();
+
+  if (!checkTerminalCodes) {
+    found = found.replace(terminalCodeRegex, '').replace(/\n/g, '');
+    expected = expected.replace(terminalCodeRegex, '').replace(/\n/g, '');
+  }
+
   assert.strictEqual(found, expected);
 }
 
@@ -54,6 +61,12 @@ const tests = [
     input: '  var i = 1;\ni + 3',
     output: '\n4',
     event: {ctrl: true, name: 'd'}
+  },
+  {
+    input: '',
+    output: '',
+    checkTerminalCodes: false,
+    event: null,
   }
 ];