repl: preserve preview on ESCAPE key press

meixg · danielleadams · commit e668efac6b92 · 2023-07-06T11:09:26.000-04:00
Fix: #46876 PR-URL: #46878 Fixes: #46876 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
diff --git a/lib/internal/repl/utils.js b/lib/internal/repl/utils.js
@@ -363,7 +363,7 @@ function setupPreview(repl, contextSymbol, bufferSymbol, active) {
     }, () => callback(new ERR_INSPECTOR_NOT_AVAILABLE()));
   }
 
-  const showPreview = () => {
+  const showPreview = (showCompletion = true) => {
     // Prevent duplicated previews after a refresh.
     if (inputPreview !== null || !repl.isCompletionEnabled) {
       return;
@@ -379,8 +379,10 @@ function setupPreview(repl, contextSymbol, bufferSymbol, active) {
     hasCompletions = false;
 
     // Add the autocompletion preview.
-    const insertPreview = false;
-    showCompletionPreview(repl.line, insertPreview);
+    if (showCompletion) {
+      const insertPreview = false;
+      showCompletionPreview(repl.line, insertPreview);
+    }
 
     // Do not preview if the command is buffered.
     if (repl[bufferSymbol]) {
diff --git a/lib/repl.js b/lib/repl.js
@@ -995,9 +995,8 @@ function REPLServer(prompt,
       clearPreview(key);
       if (!reverseSearch(d, key)) {
         ttyWrite(d, key);
-        if (key.name !== 'escape') {
-          showPreview();
-        }
+        const showCompletionPreview = key.name !== 'escape';
+        showPreview(showCompletionPreview);
       }
       return;
     }
diff --git a/test/parallel/test-repl-history-navigation.js b/test/parallel/test-repl-history-navigation.js
@@ -614,6 +614,24 @@ const tests = [
     ],
     clean: false
   },
+  {
+    // Test that preview should not be removed when pressing ESCAPE key
+    env: { NODE_REPL_HISTORY: defaultHistoryPath },
+    skip: !process.features.inspector,
+    test: [
+      '1+1',
+      ESCAPE,
+      ENTER,
+    ],
+    expected: [
+      prompt, ...'1+1',
+      '\n// 2',
+      '\n// 2',
+      '2\n',
+      prompt,
+    ],
+    clean: false
+  },
 ];
 const numtests = tests.length;
 

Original file line number	Diff line number	Diff line change
`@@ -995,9 +995,8 @@ function REPLServer(prompt,`
`995`	`995`	`clearPreview(key);`
`996`	`996`	`if (!reverseSearch(d, key)) {`
`997`	`997`	`ttyWrite(d, key);`
`998`		`- if (key.name !== 'escape') {`
`999`		`- showPreview();`
`1000`		`- }`
	`998`	`+ const showCompletionPreview = key.name !== 'escape';`
	`999`	`+ showPreview(showCompletionPreview);`
`1001`	`1000`	`}`
`1002`	`1001`	`return;`
`1003`	`1002`	`}`