doc: readline.emitKeypressEvents note #9447

STRML · 2016-11-03T16:27:16Z

Affected core subsystem(s)

doc

Description of change

It is not noted in the docs that emitKeypressEvents is automatically called on any input stream where input.terminal or input.isTTY is true.

This can cause incompatibility with libraries that fire their own keypress events, like blessed.

I am working to fix the incompatibility but I thought it was worth noting in the docs.

Trott · 2016-11-03T20:04:09Z

doc/api/readline.md

@@ -447,6 +447,10 @@ autocompletion is disabled when copy-pasted input is detected.

 If the `stream` is a [TTY][], then it must be in raw mode.

+*Note* This is automatically called by any readline instance on its `input`,


A few small nitpicks:

Nit: Put a : after *Note* to match the other five instances in the doc: *Note*: This is automatically...

Nit: Remove the comma after input.

Was modeling that after the Note on L30 - I'll fix that too.

Trott · 2016-11-03T20:04:52Z

doc/api/readline.md

@@ -447,6 +447,10 @@ autocompletion is disabled when copy-pasted input is detected.

 If the `stream` is a [TTY][], then it must be in raw mode.

+*Note* This is automatically called by any readline instance on its `input`,
+if the `input` is a terminal. Cleaning up the readline does not stop the


Is there wording that might be more precise than "cleaning up"?

Yep - will fix

STRML · 2016-11-03T20:10:28Z

Amended

Trott · 2016-11-03T20:59:28Z

doc/api/readline.md

@@ -447,6 +447,10 @@ autocompletion is disabled when copy-pasted input is detected.

 If the `stream` is a [TTY][], then it must be in raw mode.

+*Note*: This is automatically called by any readline instance on its `input`
+if the `input` is a terminal. Closing the readline does not stop the `input`


Maybe this?:

Closing the readline instance does not...

...instead of:

Closing the readline does not...

Trott · 2016-11-03T21:04:53Z

Formatting etc. all LGTM. One tiny style nit. Maybe someone else can review that the content is correct, applies across all platforms, etc. (Judging from the git logs, perhaps one of @piscisaureus @rlidwka @isaacs @princejwesley?)

STRML · 2016-11-03T21:42:17Z

Thanks for the review. Updated again.

princejwesley · 2016-11-04T17:39:59Z

doc/api/readline.md

@@ -447,6 +447,10 @@ autocompletion is disabled when copy-pasted input is detected.

 If the `stream` is a [TTY][], then it must be in raw mode.

+*Note*: This is automatically called by any readline instance on its `input`


Note after code snippet ?

princejwesley · 2016-11-04T17:51:34Z

doc/api/readline.md

@@ -447,6 +447,10 @@ autocompletion is disabled when copy-pasted input is detected.

 If the `stream` is a [TTY][], then it must be in raw mode.

+*Note*: This is automatically called by any readline instance on its `input`
+if the `input` is a terminal. Closing the `readline` instance does not stop


@Trott Sounds like a bug to me.

function onNewListener(event) { if (event == 'keypress') { stream.on('data', onData); // +++++++++ MISSING +++++++++++ iface.once('close', () => { stream.removeListener('data', onData); }); // +++++++++++++++++++++++++++++ stream.removeListener('newListener', onNewListener); } }

Ping @Trott @princejwesley ... any further thoughts on this?

Not sure why I I'm being pinged on this (as opposed to anybody else) to be honest...

(Also not sure who a good person to ping about it would be, though. ¯\(ツ)/¯ )

(Also not sure who a good person to ping about it would be, though. ¯\(ツ)/¯ )

I think with hindsight we can say @addaleax would be a good person to ping 😉

Well … what I remember about these parts of the code mostly comes from reviewing ae17883, and that was a year ago. I guess at this point we don’t have any real readline experts…

jasnell · 2017-03-24T22:49:14Z

@nodejs/ctc ... anyone have thoughts on this?

fhinkel · 2017-05-26T19:18:21Z

There hasn't been any activity here. I'm closing this. Feel free to reopen (or ping a collaborator) if I closed this in error.

STRML · 2017-05-27T03:16:27Z

Please reopen. This bug is still valid, it's just that nobody reviewed it.

…

On May 26, 2017 3:19 PM, "F. Hinkelmann" ***@***.***> wrote: Closed #9447 <#9447>. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#9447 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABJFP1rDWVPuXAqJzA0gwd7GYBmHSDK8ks5r9yWogaJpZM4Komxd> .

Once the Readline interface is closed, the 'data' event listener should be removed. Refs: nodejs#9447 (comment)

gibfahn · 2017-05-28T14:30:16Z

Note: This is automatically called by any readline instance on its input if the input is a terminal.

This seems to be correct looking at the code, so that part LGTM

Closing the readline instance does not stop the input from emitting 'keypress' events.

I'd rather fix this than document it (assuming it's a bug), see #13266

Once the Readline interface is closed, the 'data' event listener should be removed. PR-URL: #13266 Ref: #9447 (comment) Reviewed-By: James M Snell <jasnell@gmail.com>

addaleax

This is not a bug, see #13560 (for a bit of explanation and a test that shows why we can’t remove the decoder once it’s there).

Thanks for catching this and sorry that this has been open so long! I’ll wait a bit to see if there’s any movement in the other issues (edit: before landing, I mean).

addaleax · 2017-06-10T17:17:09Z

Landed in ac34779, thank you for the PR!

PR-URL: #9447 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

MylesBorins · 2017-07-17T18:21:20Z

is this applicable to v6.x?

PR-URL: #9447 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

nodejs-github-bot added doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. labels Nov 3, 2016

This was referenced Nov 3, 2016

Use builtin 'readline'.emitKeypressEvents if available chjj/blessed#266

Open

Detect native stream keypress events and bail. chjj/blessed#267

Open

Trott reviewed Nov 3, 2016

View reviewed changes

STRML force-pushed the readline-keypress branch from 545597a to e42c50a Compare November 3, 2016 20:10

Trott reviewed Nov 3, 2016

View reviewed changes

doc: readline.emitKeypressEvents note

05f39ed

STRML force-pushed the readline-keypress branch from e42c50a to 05f39ed Compare November 3, 2016 21:41

princejwesley reviewed Nov 4, 2016

View reviewed changes

jasnell added the stalled Issues and PRs that are stalled. label Mar 24, 2017

refack force-pushed the master branch from 16073c0 to fbe946b Compare April 14, 2017 04:11

fhinkel closed this May 26, 2017

fhinkel reopened this May 27, 2017

gibfahn mentioned this pull request May 28, 2017

readline: clean up event listener in onNewListener #13266

Closed

3 tasks

gibfahn added a commit to gibfahn/node that referenced this pull request May 28, 2017

readline: clean up event listener in onNewListener

6d27376

Once the Readline interface is closed, the 'data' event listener should be removed. Refs: nodejs#9447 (comment)

addaleax approved these changes Jun 8, 2017

View reviewed changes

addaleax removed the stalled Issues and PRs that are stalled. label Jun 8, 2017

gibfahn approved these changes Jun 8, 2017

View reviewed changes

addaleax closed this Jun 10, 2017

addaleax pushed a commit that referenced this pull request Jun 10, 2017

doc: add readline.emitKeypressEvents note

ac34779

PR-URL: #9447 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

addaleax pushed a commit that referenced this pull request Jun 12, 2017

doc: add readline.emitKeypressEvents note

2c1133d

PR-URL: #9447 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

addaleax mentioned this pull request Jun 12, 2017

v8.1.1 proposal #13598

Merged

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

MylesBorins added the lts-watch-v6.x label Jul 17, 2017

MylesBorins pushed a commit that referenced this pull request Sep 19, 2017

doc: add readline.emitKeypressEvents note

594e3c2

PR-URL: #9447 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

MylesBorins added land-on-v6.x and removed lts-watch-v6.x labels Sep 19, 2017

MylesBorins mentioned this pull request Sep 20, 2017

v6.11.4 proposal #15506

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: readline.emitKeypressEvents note #9447

doc: readline.emitKeypressEvents note #9447

STRML commented Nov 3, 2016 •

edited

Loading

Trott Nov 3, 2016

STRML Nov 3, 2016

Trott Nov 3, 2016

STRML Nov 3, 2016

STRML commented Nov 3, 2016

Trott Nov 3, 2016

Trott commented Nov 3, 2016

STRML commented Nov 3, 2016

princejwesley Nov 4, 2016

princejwesley Nov 4, 2016

jasnell Jan 11, 2017

Trott Jan 11, 2017

Trott Jan 11, 2017

gibfahn Jun 8, 2017

addaleax Jun 8, 2017

jasnell commented Mar 24, 2017

fhinkel commented May 26, 2017

STRML commented May 27, 2017 via email

gibfahn commented May 28, 2017 •

edited

Loading

addaleax left a comment •

edited

Loading

addaleax commented Jun 10, 2017 •

edited

Loading

MylesBorins commented Jul 17, 2017

		@@ -447,6 +447,10 @@ autocompletion is disabled when copy-pasted input is detected.

		If the `stream` is a [TTY][], then it must be in raw mode.

		Note This is automatically called by any readline instance on its `input`,

		@@ -447,6 +447,10 @@ autocompletion is disabled when copy-pasted input is detected.

		If the `stream` is a [TTY][], then it must be in raw mode.

		Note: This is automatically called by any readline instance on its `input`

doc: readline.emitKeypressEvents note #9447

doc: readline.emitKeypressEvents note #9447

Conversation

STRML commented Nov 3, 2016 • edited Loading

Affected core subsystem(s)

Description of change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

STRML commented Nov 3, 2016

Choose a reason for hiding this comment

Trott commented Nov 3, 2016

STRML commented Nov 3, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell commented Mar 24, 2017

fhinkel commented May 26, 2017

STRML commented May 27, 2017 via email

gibfahn commented May 28, 2017 • edited Loading

addaleax left a comment • edited Loading

Choose a reason for hiding this comment

addaleax commented Jun 10, 2017 • edited Loading

MylesBorins commented Jul 17, 2017

STRML commented Nov 3, 2016 •

edited

Loading

gibfahn commented May 28, 2017 •

edited

Loading

addaleax left a comment •

edited

Loading

addaleax commented Jun 10, 2017 •

edited

Loading