nodejs / nodejs/node

REPL: dot-commands produce SyntaxError inside multi-line input

Ouverte
#63,864 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

repl
Langage dominant
JavaScript
Étoiles
122k
Forks
37.3k
Merge moyen
4 j 2 h
PR mergées (30 j)
283

Description

Version

any v24.1.0+

Platform
Tested on:
Microsoft Windows NT 10.0.19045.0 x64;
WSL2 Debian;
Subsystem

REPL

What steps will reproduce the bug?

printf "function a() {\n.break\n" | node -i
printf "function a() {\n.exit\n" | node -i
printf "function a() {\n.help\n" | node -i

How often does it reproduce? Is there a required condition?

Always. Required condition: any registered dot-command typed as the first line after a Recoverable error if self.terminal === true. This includes both real interactive TTYs and node -i with piped stdin.

What is the expected behavior? Why is that the expected behavior?
Welcome to Node.js v24.0.2.
Type ".help" for more information.
> function a() {
| .exit
Welcome to Node.js v24.0.2.
Type ".help" for more information.
> function a() {
| .break
>
Welcome to Node.js v24.0.2.
Type ".help" for more information.
> function a() {
| .help
.break    Sometimes you get stuck, this gets you out
.clear    Alias for .break
.editor   Enter editor mode
.exit     Exit the REPL
.help     Print this help message
.load     Load JS from a file into the REPL session
.save     Save all evaluated commands in this REPL session to a file
Press Ctrl+C to abort current expression, Ctrl+D to exit the REPL
|
What do you see instead?
Welcome to Node.js v24.1.0.
Type ".help" for more information.
> function a() {
| .exit
.exit
^
Uncaught SyntaxError: Unexpected token '.'
Welcome to Node.js v24.1.0.
Type ".help" for more information.
> function a() {
| .break
.break
^
Uncaught SyntaxError: Unexpected token '.'
Welcome to Node.js v24.1.0.
Type ".help" for more information.
> function a() {
| .help
.help
^
Uncaught SyntaxError: Unexpected token '.'
Additional information

The expected behavior is dot-commands working in multi-line mode. Since 24.1.0 they do not. Only changes to TTY multi-line input behavior in 24.1.0 were introduced by #58003.
Bisect:

git checkout v24.1.0
./configure
make -j2 node > /dev/null 2>/dev/null 
printf "function a(){\n.break\n" | ./node -i

git checkout 629a954477^
make -j2 node > /dev/null 2>/dev/null
printf "function a(){\n.break\n" | ./node -i

git checkout 629a954477
make -j2 node > /dev/null 2>/dev/null
printf "function a(){\n.break\n" | ./node -i

Hunk level bisect:

git checkout 629a954477
make -j2 node >/dev/null 2>/dev/null

printf "n\nn\nn\nn\ny\nn\n" | git checkout -p 629a954477^ -- lib/repl.js
make -j2 node >/dev/null 2>/dev/null
printf "function a() {\n.break\n" | ./node -i

particular hunk introducing the bug:

@@ -943,33 +941,15 @@ function REPLServer(prompt,
       }

       // If error was SyntaxError and not JSON.parse error
-      if (e) {
-        if (e instanceof Recoverable && !sawCtrlD) {
-          // Start buffering data like that:
-          // {
-          // ...  x: 1
-          // ... }
+      // We can start a multiline command
+      if (e instanceof Recoverable && !sawCtrlD) {
+        if (self.terminal) {
+          self[kAddNewLineOnTTY]();
+        } else {
           self[kBufferedCommandSymbol] += cmd + '\n';
           self.displayPrompt();
-          return;
-        }
-      }
-
-      // In the next two if blocks, we do not use os.EOL instead of '\n'
-      // because on Windows it is '\r\n'
-      if (StringPrototypeIncludes(cmd, '\n')) { // If you are editing a multiline command
-        self.history[0] = self[kNormalizeHistoryLineEndings](cmd, '\n', '\r');
-      } else if (self[kBufferedCommandSymbol]) { // If a new multiline command was entered
-        // Remove the first N lines from the self.history array
-        // where N is the number of lines in the buffered command
-
-        const lines = StringPrototypeSplit(self[kBufferedCommandSymbol], '\n');
-        self.history = ArrayPrototypeSlice(self.history, lines.length);
-        lines[lines.length - 1] = cmd;
-        const newHistoryLine = ArrayPrototypeJoin(ArrayPrototypeReverse(lines), '\r');
-        if (self.history[0] !== newHistoryLine) {
-          ArrayPrototypeUnshift(self.history, newHistoryLine);
         }
+        return;
       }

       if (e) {

Reason:

  1. The change in handling of Recoverable error shifts the TTY multi-line handling into self[kAddNewLineOnTTY]();.
  2. It causes onLine(cmd) handler to be called with the whole multi-line buffer in cmd.
  3. That results in the REPL keyword check failing - instead of checking the first character in ".break" it checks the first character in "function a() {\r.break". (\n becomes \r in kAddHistory, not relevant to the bug)
  4. Which leads to REPL keywords being passed to eval where they produce SyntaxError: Unexpected token '.'.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez dans lib/repl.js, en vous concentrant sur le chemin Recoverable-error, kAddNewLineOnTTY et le gestionnaire onLine(cmd). Reproduisez le problème avec les commandes printf fournies en utilisant node -i, puis suivez le cheminement de l’entrée multiligne mise en mémoire tampon jusqu’à la vérification des commandes à point. Le travail est terminé lorsque .break, .clear, .exit et .help fonctionnent dans une entrée multiligne sans produire de SyntaxError.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, nodejs
Domaine
cli
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Clairement spécifiée
Accessibilité débutants
72/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.