Speed up editor detection on Windows #2711

levrik · 2017-07-02T15:49:34Z

Follow up to #2552

We could improve that by launching a PowerShell at the beginning in the background and just pipe the commands in then. This would require to switch to a Promise/callback-based implementation of the whole feature. I would pick that up in a second PR later on if you're okay with it 🙂

Time measurement for getting process list (on my machine): ~300ms

One question: Should we launch the PowerShell on the first click in the error overlay (current implementation) or directly on server start (first click would be faster already then)?

gaearon · 2017-07-02T16:34:02Z

It's fine to do on start if it's not blocking the first compilation.

levrik · 2017-07-02T16:35:09Z

@gaearon Can you give me some hint where to put that best?

gaearon · 2017-07-02T16:36:31Z

In success callback of start.js maybe?

before ~600ms after ~300ms

levrik · 2017-07-02T17:19:22Z

@gaearon Ready for review.

gaearon · 2017-07-02T17:28:00Z

packages/react-scripts/scripts/start.js

      }
      console.log(chalk.cyan('Starting the development server...\n'));
      openBrowser(urls.localUrlForBrowser);
+      if (process.platform === 'win32') {


I think this would still block the first compilation, no? It would be nice to check this (e.g. by artificially putting an infinite loop into the launching code). Perhaps setTimeout would help?

Just tested the time overhead:

console.time('start'); if (process.platform === 'win32') { const { launchPowerShellAgent, } = require('react-dev-utils/launchEditor'); launchPowerShellAgent(); console.timeEnd('start'); }

Output was start: 4.349ms

But, yes, it would still "block" the first compilation.

Oh, I guess the difference is smaller because we're not actually waiting for process output?

Yep, right. We're just waiting for the process to gets created.

levrik · 2017-07-29T18:07:50Z

@gaearon Friendly ping 🙂

gaearon · 2017-07-30T15:02:54Z

I'm not very happy with win32-specific code in start script. It could confuse somebody who ejects. Can we do this in some other way? For example, maybe we could start it lazily whenever the launch editor middleware is created for the first time. Then it would stay an implementation detail without leaking into the script code.

gaearon

Let's make this part of the middleware code, and not add specific calls to start.js.

levrik · 2017-07-30T15:53:20Z

@gaearon Okay. Moved it into middleware.js. Besides that the PowerShell agent now only gets started if REACT_EDITOR is not set.

gaearon · 2017-07-30T16:30:00Z

packages/react-error-overlay/middleware.js

 module.exports = function createLaunchEditorMiddleware() {
+  if (process.platform === 'win32' && !process.env.REACT_EDITOR) {
+    const { launchPowerShellAgent } = require('react-dev-utils/launchEditor');
+    launchPowerShellAgent();


Can this ever fail?

Fails silent if powershell.exe was not found.

Let's call it tryLaunchPowerShellAgent to make it clear it's always safe to call.

Or wait. Just tested it again. It seems to break the display of the information about the editor integration if powershell.exe is not found. I look into that :)

Okay. Fixed.

gaearon · 2017-07-30T20:05:43Z

I'll try to review next week. Please ping me on Wednesday.

levrik · 2017-08-09T12:38:46Z

@gaearon Friendly Wednesday ping.

Just realized that you meant the last Wednesday und not this. Somehow got confused there. Sorry.

gaearon · 2017-08-26T21:00:22Z

packages/react-dev-utils/launchEditor.js

+    return new Promise(resolve => {
+      this.on('resolve', data => {
+        resolve(data);
+        this.removeAllListeners('resolve');


Are there any possible race conditions here? What if we call invoke twice before it resolves? Will both be resolved correctly?

Uhm. I will test that next weekend 🙂

gaearon · 2017-09-06T14:47:17Z

@levrik Friendly ping back :-)

…etection-win

levrik · 2017-09-07T20:00:43Z

@gaearon Sorry, had a busy week and forgot about this.
Just checked and found out that the current implementation has serious issues for cases like you described (or rather the implementation was a bit shitty).
Working on a better implementation now.

gaearon · 2017-09-08T12:49:24Z

Is this ready for another review?

levrik · 2017-09-08T13:08:12Z

@gaearon Yes. Totally!
The issues with the response-mapping are resolved.

gaearon · 2017-09-08T13:18:30Z

packages/react-dev-utils/launchEditor.js

 const chalk = require('chalk');
 const shellQuote = require('shell-quote');

+// Inspired by https://github.com/rannn505/node-powershell


Any reason we're not just using it?

In that module you have an method addCommand and an method invoke.
With addCommand you can add one to many commands and execute them with invoke at once, getting the output of all commands. I wanted a clear connection between a command and its result.

Maybe we could send a pull request to the module, adding an execute shortcut which calls addCommand and invoke?

gaearon · 2017-09-08T13:20:37Z

packages/react-dev-utils/launchEditor.js

+
+  invoke(cmd) {
+    return new Promise(resolve => {
+      const eventName = 'resolve' + ++this._resolveCounter;


Can you try without using EventEmitter? I find code built on events (especially with dynamic names) easy to mess up by accidentally triggering or listening to a wrong event. I would prefer plain callback lists.

levrik · 2018-01-15T19:11:02Z

@gaearon Sorry that nothing happened here anymore. Quick question: Would you like to get these improvements in? I'm not sure if it's worth it.

gaearon · 2018-01-15T19:17:50Z

Yes, totally!

levrik · 2018-01-15T20:34:28Z

Closed in favor of #3808

facebook-github-bot added the CLA Signed label Jul 2, 2017

levrik changed the title ~~Speed up editor detection on Windows on subsequent clicks~~ [WIP] Speed up editor detection on Windows on subsequent clicks Jul 2, 2017

levrik closed this Jul 2, 2017

levrik reopened this Jul 2, 2017

levrik force-pushed the speed-up-editor-detection-win branch 2 times, most recently from e8f2be6 to e0fefca Compare July 2, 2017 16:24

levrik force-pushed the speed-up-editor-detection-win branch from 5a86215 to 5add09c Compare July 2, 2017 17:00

levrik changed the title ~~[WIP] Speed up editor detection on Windows on subsequent clicks~~ [WIP] Speed up editor detection on Windows Jul 2, 2017

levrik changed the title ~~[WIP] Speed up editor detection on Windows~~ Speed up editor detection on Windows Jul 2, 2017

levrik force-pushed the speed-up-editor-detection-win branch 5 times, most recently from 35e7f29 to 30b2293 Compare July 2, 2017 17:14

Speed up editor detection on Windows

cd28840

before ~600ms after ~300ms

levrik force-pushed the speed-up-editor-detection-win branch from 30b2293 to cd28840 Compare July 2, 2017 17:17

gaearon reviewed Jul 2, 2017

View reviewed changes

gaearon suggested changes Jul 30, 2017

View reviewed changes

levrik added 2 commits July 30, 2017 17:51

Launch PowerShell agent in on middleware-creation

39289bb

Only launch PowerShell agent if no editor is configured

55dca23

gaearon reviewed Jul 30, 2017

View reviewed changes

Fixed issue with Promise-based editor detection and cleaned up code

5785eaf

levrik force-pushed the speed-up-editor-detection-win branch from b46e366 to 5785eaf Compare July 30, 2017 17:37

gaearon reviewed Aug 26, 2017

View reviewed changes

Merge remote-tracking branch 'upstream/master' into speed-up-editor-d…

5b2f6ae

…etection-win

levrik force-pushed the speed-up-editor-detection-win branch from 2e0b738 to 2a0560b Compare September 7, 2017 20:14

Fixed mapping of PS output to right Promise

1a7907f

levrik force-pushed the speed-up-editor-detection-win branch from 2a0560b to 1a7907f Compare September 7, 2017 20:17

gaearon reviewed Sep 8, 2017

View reviewed changes

gaearon added this to the 2.0.0 milestone Jan 15, 2018

gaearon changed the base branch from master to next January 15, 2018 19:17

levrik mentioned this pull request Jan 15, 2018

Use wmic to get process list on Windows #3808

Merged

levrik closed this Jan 15, 2018

lock bot locked and limited conversation to collaborators Jan 20, 2019

Uh oh!

Speed up editor detection on Windows #2711

Speed up editor detection on Windows #2711

Uh oh!

Conversation

levrik commented Jul 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gaearon commented Jul 2, 2017

Uh oh!

levrik commented Jul 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gaearon commented Jul 2, 2017

Uh oh!

levrik commented Jul 2, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

levrik Jul 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

levrik commented Jul 29, 2017

Uh oh!

gaearon commented Jul 30, 2017

Uh oh!

gaearon left a comment

Choose a reason for hiding this comment

Uh oh!

levrik commented Jul 30, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gaearon commented Jul 30, 2017

Uh oh!

levrik commented Aug 9, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gaearon commented Sep 6, 2017

Uh oh!

levrik commented Sep 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gaearon commented Sep 8, 2017

Uh oh!

levrik commented Sep 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

levrik Sep 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Timer Sep 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

levrik commented Jul 2, 2017 •

edited

Loading

levrik commented Jul 2, 2017 •

edited

Loading

levrik Jul 2, 2017 •

edited

Loading

levrik commented Sep 7, 2017 •

edited

Loading

levrik commented Sep 8, 2017 •

edited

Loading

levrik Sep 8, 2017 •

edited

Loading

Timer Sep 8, 2017 •

edited

Loading