src: port --bash-completion to C++ #25901

joyeecheung · 2019-02-03T03:59:00Z

So that it gets handle earlier and faster during the bootstrap
process.

Drive-by fixes:

Remove [has_eval_string] and [ssl_openssl_cert_store] from
the completion output

Before:

_node_complete() {
  local cur_word options
  cur_word="${COMP_WORDS[COMP_CWORD]}"
  if [[ "${cur_word}" == -* ]] ; then
    COMPREPLY=( $(compgen -W '--abort-on-uncaught-exception --experimental-report --perf-basic-prof --max-old-space-size --diagnostic-report-verbose --inspect-brk-node --inspect-port --diagnostic-report-filename --diagnostic-report-uncaught-exception --track-heap-objects --diagnostic-report-signal --tls-v1.1 --napi-modules --inspect-brk --tls-v1.0 --redirect-warnings --print --trace-deprecation --trace-event-file-pattern --check --perf-prof --preserve-symlinks --no-warnings --debug --no-deprecation --trace-warnings --expose-internals --diagnostic-report-on-signal --diagnostic-report-directory --pending-deprecation --experimental-worker --trace-sync-io --diagnostic-report-on-fatalerror --tls-cipher-list --no-force-async-hooks-checks --inspect --eval --loader --use-openssl-ca --preserve-symlinks-main --interactive --icu-data-dir --v8-options --require --use-bundled-ca --experimental-policy --version --experimental-vm-modules --prof-process --max-http-header-size [has_eval_string] --throw-deprecation --completion-bash --help --zero-fill-buffers --v8-pool-size [ssl_openssl_cert_store] --experimental-modules --http-parser --openssl-config --trace-event-categories --security-reverts --experimental-repl-await --stack-trace-limit --debug-brk --title --debug-port --prof-process --debug= -p -pe -v --inspect-brk= -i --print <arg> --inspect= --debug-brk= -e --inspect-brk-node= -c -h -r --trace-events-enabled' -- "${cur_word}") )
    return 0
  else
    COMPREPLY=( $(compgen -f "${cur_word}") )
    return 0
  fi
}
complete -F _node_complete node node_g

After:

_node_complete() {
  local cur_word options
  cur_word="${COMP_WORDS[COMP_CWORD]}"
  if [[ "${cur_word}" == -* ]] ; then
    COMPREPLY=( $(compgen -W '--abort-on-uncaught-exception --experimental-report --perf-basic-prof --max-old-space-size --diagnostic-report-verbose --inspect-brk-node --inspect-port --diagnostic-report-filename --diagnostic-report-uncaught-exception --track-heap-objects --diagnostic-report-signal --tls-v1.1 --napi-modules --inspect-brk --tls-v1.0 --redirect-warnings --print --trace-deprecation --trace-event-file-pattern --check --perf-prof --preserve-symlinks --no-warnings --debug --no-deprecation --trace-warnings --expose-internals --diagnostic-report-on-signal --diagnostic-report-directory --pending-deprecation --experimental-worker --trace-sync-io --diagnostic-report-on-fatalerror --tls-cipher-list --no-force-async-hooks-checks --inspect --eval --loader --use-openssl-ca --preserve-symlinks-main --interactive --icu-data-dir --v8-options --require --use-bundled-ca --experimental-policy --version --experimental-vm-modules --prof-process --max-http-header-size --throw-deprecation --completion-bash --help --zero-fill-buffers --v8-pool-size --experimental-modules --http-parser --openssl-config --trace-event-categories --security-reverts --experimental-repl-await --stack-trace-limit --debug-brk --title --debug-port --prof-process --debug= -p -pe -v --inspect-brk= -i --print <arg> --inspect= --debug-brk= -e --inspect-brk-node= -c -h -r --trace-events-enabled' -- "${cur_word}") )
    return 0
  else
    COMPREPLY=( $(compgen -f "${cur_word}") )
    return 0
  fi
}
complete -F _node_complete node node_g

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
commit message follows commit guidelines

nodejs-github-bot · 2019-02-03T03:59:02Z

@joyeecheung build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/2496/pipeline

addaleax

I'm wondering if keeping this in JS is worth it, because that makes it more accessible to people? I realize it's slower, but we encourage people to write the output to a file anyway, so I wouldn't do this for performance reasons

addaleax · 2019-02-03T14:07:12Z

src/node_options.h

@@ -400,6 +401,7 @@ class OptionsParser {
  friend class OptionsParser;

  friend void GetOptions(const v8::FunctionCallbackInfo<v8::Value>& args);
+  friend std::string GetBashCompletion();


This could also be a member of OptionsParser, right?

It can, but so is GetOptions() so I figured it's better to keep them consistent

joyeecheung · 2019-02-06T14:20:53Z

@addaleax IMO it is an overkill to implement --bash-completion in JS, and being in JS does not necessarily mean it's more accessible. This flag essentially just formats structured data from the binary into a string and prints it to stdout, there is no user input or error handling necessary. Implementing it in JS means it has to depend on a working v8 isolate and an Environment, and rely on proper serialization of a complicated v8::Object as well as a working stdout stream, those are all too complicated for a simple feature like --bash-completion. (In fact to remove [has_eval_string] and [ssl_openssl_cert_store] my first action was to debug GetOptions() since that's where all the complexities were, it was much easier to debug the loop in GetBashCompletion() to be honest, so moving the formatting in JS did not really make the implementation any more accessible if the source of data is in C++)

Being handled later in time (after bootstrap/node.js instead of directly in node::Init) also means that there is a mental burden when we add branches in the bootstrap (e.g. node-report) even though they do not really make sense for --bash-completion so we might as well just deal with it earlier and focus on cases that are more common in the bootstrap process - this is also the case for things like node --version.

joyeecheung · 2019-02-17T07:04:40Z

@addaleax: is your comment in #25901 (review) blocking?

addaleax · 2019-02-17T09:02:48Z

@joyeecheung No, it’s not :)

CI: https://ci.nodejs.org/job/node-test-pull-request/20830/

BridgeAR · 2019-03-05T17:20:46Z

@joyeecheung this needs a rebase

BridgeAR · 2019-03-27T16:59:06Z

Ping @joyeecheung

nodejs-github-bot · 2019-04-02T06:28:31Z

CI: https://ci.nodejs.org/job/node-test-pull-request/22116/

nodejs-github-bot · 2019-04-03T03:03:38Z

CI: https://ci.nodejs.org/job/node-test-pull-request/22152/

So that it gets handle earlier and faster during the bootstrap process. Drive-by fixes: - Remove `[has_eval_string]` and `[ssl_openssl_cert_store]` from the completion output - Set `kProfProcess` execution mode for `--prof-process` instead of `kPrintBashProcess` which is removed in this patch. - Append new line to the end of the output of --bash-completion

nodejs-github-bot · 2019-05-11T22:19:32Z

CI: https://ci.nodejs.org/job/node-test-pull-request/23053/

nodejs-github-bot · 2019-05-12T08:14:22Z

CI: https://ci.nodejs.org/job/node-test-pull-request/23056/

joyeecheung · 2019-05-12T08:47:14Z

Fixed the Windows failure. @devsnek @jasnell @addaleax can you take a look again? Thanks!

joyeecheung · 2019-05-20T10:01:32Z

Ping @devsnek @jasnell @addaleax

nodejs-github-bot · 2019-05-20T10:01:49Z

CI: https://ci.nodejs.org/job/node-test-pull-request/23222/

nodejs-github-bot · 2019-05-20T11:38:04Z

CI: https://ci.nodejs.org/job/node-test-pull-request/23226/

nodejs-github-bot · 2019-05-22T13:17:15Z

CI: https://ci.nodejs.org/job/node-test-pull-request/23272/

addaleax · 2019-05-22T20:41:42Z

@joyeecheung Since you pinged me – the code changes look good to me, but I’d still have a mild preference to keep this in JS because that does seem to be less complex to me. But as far as I’m concerned, this PR is ready to land 👍 (I can’t make out what the Windows failure is, so I’ll just start a resume CI…)

nodejs-github-bot · 2019-05-22T20:42:16Z

CI: https://ci.nodejs.org/job/node-test-pull-request/23282/

fhinkel · 2019-10-28T23:45:47Z

ping @joyeecheung

nodejs-github-bot · 2019-12-20T01:17:43Z

CI: https://ci.nodejs.org/job/node-test-pull-request/27824/

nodejs-github-bot · 2019-12-24T23:03:11Z

CI: https://ci.nodejs.org/job/node-test-pull-request/27926/

nodejs-github-bot · 2019-12-25T09:51:18Z

CI: https://ci.nodejs.org/job/node-test-pull-request/27932/

So that it gets handle earlier and faster during the bootstrap process. Drive-by fixes: - Remove `[has_eval_string]` and `[ssl_openssl_cert_store]` from the completion output - Set `kProfProcess` execution mode for `--prof-process` instead of `kPrintBashProcess` which is removed in this patch. - Append new line to the end of the output of --bash-completion PR-URL: #25901 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: James M Snell <[email protected]>

BridgeAR · 2019-12-25T21:16:30Z

Landed in 403c84a 🎉

So that it gets handle earlier and faster during the bootstrap process. Drive-by fixes: - Remove `[has_eval_string]` and `[ssl_openssl_cert_store]` from the completion output - Set `kProfProcess` execution mode for `--prof-process` instead of `kPrintBashProcess` which is removed in this patch. - Append new line to the end of the output of --bash-completion PR-URL: #25901 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: James M Snell <[email protected]>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. labels Feb 3, 2019

joyeecheung added the cli Issues and PRs related to the Node.js command line interface. label Feb 3, 2019

addaleax reviewed Feb 3, 2019

View reviewed changes

devsnek approved these changes Feb 6, 2019

View reviewed changes

jasnell approved these changes Feb 18, 2019

View reviewed changes

joyeecheung force-pushed the cpp-bash branch from b23997e to 6635c6e Compare April 2, 2019 06:27

joyeecheung mentioned this pull request Apr 2, 2019

CI failures: 20190330-20190402 nodejs/reliability#22

Closed

refack mentioned this pull request Apr 2, 2019

flaky: parallel/test-http2-* on Windows #20750

Closed

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 3, 2019

joyeecheung removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 3, 2019

joyeecheung force-pushed the cpp-bash branch from 6635c6e to 2911595 Compare May 11, 2019 20:35

joyeecheung force-pushed the cpp-bash branch from 2911595 to 3190ae1 Compare May 11, 2019 20:43

fixup! src: port --bash-completion to C++

bdfabf4

fixup! fixup! src: port --bash-completion to C++

e8986f0

Trott force-pushed the master branch from 1ecc406 to 49cf67e Compare September 17, 2019 16:51

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 20, 2019

BridgeAR closed this Dec 25, 2019

BridgeAR mentioned this pull request Jan 7, 2020

v13.6.0 proposal #31238

Merged

targos mentioned this pull request Jan 15, 2020

v12.15.0 release proposal #31368

Closed

MylesBorins mentioned this pull request Feb 8, 2020

v12.16.0 proposal #31691

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: port --bash-completion to C++ #25901

src: port --bash-completion to C++ #25901

joyeecheung commented Feb 3, 2019 •

edited

Loading

nodejs-github-bot commented Feb 3, 2019

addaleax left a comment

addaleax Feb 3, 2019

joyeecheung Feb 17, 2019

joyeecheung commented Feb 6, 2019 •

edited

Loading

joyeecheung commented Feb 17, 2019

addaleax commented Feb 17, 2019

BridgeAR commented Mar 5, 2019

BridgeAR commented Mar 27, 2019

nodejs-github-bot commented Apr 2, 2019

nodejs-github-bot commented Apr 3, 2019

nodejs-github-bot commented May 11, 2019

nodejs-github-bot commented May 12, 2019

joyeecheung commented May 12, 2019

joyeecheung commented May 20, 2019

nodejs-github-bot commented May 20, 2019

nodejs-github-bot commented May 20, 2019

nodejs-github-bot commented May 22, 2019

addaleax commented May 22, 2019

nodejs-github-bot commented May 22, 2019

fhinkel commented Oct 28, 2019

nodejs-github-bot commented Dec 20, 2019

nodejs-github-bot commented Dec 24, 2019

nodejs-github-bot commented Dec 25, 2019

BridgeAR commented Dec 25, 2019

src: port --bash-completion to C++ #25901

src: port --bash-completion to C++ #25901

Conversation

joyeecheung commented Feb 3, 2019 • edited Loading

Checklist

nodejs-github-bot commented Feb 3, 2019

addaleax left a comment

Choose a reason for hiding this comment

addaleax Feb 3, 2019

Choose a reason for hiding this comment

joyeecheung Feb 17, 2019

Choose a reason for hiding this comment

joyeecheung commented Feb 6, 2019 • edited Loading

joyeecheung commented Feb 17, 2019

addaleax commented Feb 17, 2019

BridgeAR commented Mar 5, 2019

BridgeAR commented Mar 27, 2019

nodejs-github-bot commented Apr 2, 2019

nodejs-github-bot commented Apr 3, 2019

nodejs-github-bot commented May 11, 2019

nodejs-github-bot commented May 12, 2019

joyeecheung commented May 12, 2019

joyeecheung commented May 20, 2019

nodejs-github-bot commented May 20, 2019

nodejs-github-bot commented May 20, 2019

nodejs-github-bot commented May 22, 2019

addaleax commented May 22, 2019

nodejs-github-bot commented May 22, 2019

fhinkel commented Oct 28, 2019

nodejs-github-bot commented Dec 20, 2019

nodejs-github-bot commented Dec 24, 2019

nodejs-github-bot commented Dec 25, 2019

BridgeAR commented Dec 25, 2019

joyeecheung commented Feb 3, 2019 •

edited

Loading

joyeecheung commented Feb 6, 2019 •

edited

Loading