feat(server/client): made progress option available to API #1961

knagaitsev · 2019-06-04T03:53:01Z

For Bugs and Features; did you add new tests?

Yes

Motivation / Use-Case

GSoC Goal: #1960

The main goal of this is to remove functionality from bin/webpack-dev-server and into the API. This is the first step, moving ProgressPlugin usage over to the API.

As a side effect of this, I discovered that the CLI-specific part was using argv.profile. To not make this a breaking change, I added a profile option as well, so that it can get passed into the API.

Breaking Changes

Despite not being documented, you could use the progress option on API before. However, it only outputted progress to the client console. Now, progress is also outputted to the command line.

Additional Info

New documentation will be needed for profile option, along with changes to progress option

codecov · 2019-06-04T03:57:51Z

Codecov Report

Merging #1961 into master will increase coverage by 0.97%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##           master    #1961      +/-   ##
==========================================
+ Coverage   92.77%   93.75%   +0.97%     
==========================================
  Files          29       29              
  Lines        1149     1152       +3     
  Branches      327      328       +1     
==========================================
+ Hits         1066     1080      +14     
+ Misses         79       70       -9     
+ Partials        4        2       -2

Impacted Files	Coverage Δ
lib/Server.js	`95.16% <100%> (+2.65%)`	⬆️
lib/utils/createConfig.js	`91.07% <50%> (-0.75%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f611304...279077f. Read the comment docs.

knagaitsev · 2019-06-04T04:17:10Z

Need to change paths for new test after this is merged: #1958

hiroppy · 2019-06-04T06:32:10Z

test/e2e/Progress.test.js

+    });
+
+    afterAll((done) => {
+      testServer.close(done);


fs.unlinkSync(cssFilePath);

need to add fs.unlinkSync(cssFilePath);

alexander-akait

Need resolve couple problems

alexander-akait · 2019-06-04T09:49:14Z

lib/Server.js

@@ -91,6 +91,7 @@ class Server {
    // TODO this.<property> is deprecated (remove them in next major release.) in favor this.options.<property>
    this.hot = this.options.hot || this.options.hotOnly;
    this.headers = this.options.headers;
+    this.profile = !!this.options.profile;


this.options.profile, don't use this.<option> it is unnecessary and all this.<option> will be removed in next major release

alexander-akait · 2019-06-04T09:50:03Z

lib/Server.js

@@ -147,6 +148,10 @@ class Server {
  }

  setupProgressPlugin() {
+    new webpack.ProgressPlugin({
+      profile: this.profile,
+    }).apply(this.compiler);


hm, we really need two plugins? I think we can use one instance of plugin

I think 2 are needed since one supplies a custom handler but the other uses the default handler: https://github.com/webpack/webpack/blob/master/lib/ProgressPlugin.js#L103

hm, we need investigate this and tests this, looks like we setup two progress plugin and it can be invalid usage

@evilebottnawi Wouldn't it be the equivalent of two plugins tapping into the exact same events? Assuming the plugin was made properly.

@evilebottnawi Are my changes here causing the Windows CI problems? I'm unsure why progress plugin outputs stuff to stderr, but maybe that is causing a problem? https://github.com/webpack/webpack/blob/master/lib/ProgressPlugin.js#L49

No need !! we already validate this only as boolean, so no need convert to boolean again

hiroppy · 2019-06-04T18:23:20Z

test/e2e/Progress.test.js

+    });
+
+    describe('on browser client', () => {
+      jest.setTimeout(30000);


need to delete after #1965 is merged

knagaitsev · 2019-06-05T21:49:09Z

What is wrong with Windows CI?

alexander-akait · 2019-06-11T10:21:06Z

Something leak on windows due jest freeze, we need investigate this

knagaitsev · 2019-06-11T21:32:44Z

I think the problem is that ProgressPlugin probably does not guarantee the same output each time, so I should do a more generalized test on e2e client to see that it is outputting some progress data. I think the hanging can be solved via the solution here: #2018

hiroppy · 2019-06-11T21:43:40Z

test/e2e/Progress.test.js

+        'body { background-color: rgb(0, 0, 255); }'
+      );
+      const options = {
+        port: 9000,


this test should use a port variable

hiroppy · 2019-06-11T21:43:59Z

test/e2e/Progress.test.js

+    });
+
+    afterAll((done) => {
+      testServer.close(done);


need to add fs.unlinkSync(cssFilePath);

alexander-akait · 2019-06-13T11:23:39Z

test/e2e/Progress.test.js

+                return testExp.test(line);
+              });
+              // eslint-disable-next-line no-undefined
+              expect(match).not.toEqual(undefined);


Maybe using snapshots for this?

@evilebottnawi It is not outputting the same thing each time, like differences in numbers and such.

alexander-akait

Two notes. Good work

alexander-akait · 2019-06-13T15:08:35Z

lib/Server.js

@@ -147,6 +148,10 @@ class Server {
  }

  setupProgressPlugin() {
+    new webpack.ProgressPlugin({
+      profile: this.profile,
+    }).apply(this.compiler);


No need !! we already validate this only as boolean, so no need convert to boolean again

alexander-akait · 2019-06-13T15:09:54Z

test/cli/cli.test.js

+        expect(output.code).toEqual(0);
+        // should profile
+        expect(
+          output.stderr.includes('ms after chunk modules optimization')


I think better use here snapshot for easy updating, changing string is more difficult

I will try, last time output did not always match though

We can implement helper for tests what remove unnecessary stuff from output to keep snapshot small and testable

We can implement helper for tests what remove unnecessary stuff from output to keep snapshot small and testable

I will try that.

No need !! we already validate this only as boolean, so no need convert to boolean again

It could be undefined though.

Thanks, you are right 👍

knagaitsev · 2019-06-13T16:56:01Z

Testing with full snapshot again, last time there were some inconsistencies in output for a few CI builds though.

knagaitsev · 2019-06-13T18:35:37Z

@evilebottnawi take a look at CI, there are minor differences in console output like one line getting printed twice or lines not getting printed. That's why I said snapshot is difficult.

alexander-akait

/cc @hiroppy

alexander-akait · 2019-06-14T10:14:38Z

lib/options.json

@@ -422,6 +425,7 @@
      "pfx": "should be {String|Buffer} (https://webpack.js.org/configuration/dev-server/#devserverpfx)",
      "pfxPassphrase": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserverpfxpassphrase)",
      "port": "should be {Number|String|Null} (https://webpack.js.org/configuration/dev-server/#devserverport)",
+      "profile": "should be {Boolean}",


Please put link here to avoid changing in future

alexander-akait · 2019-06-14T10:16:55Z

/cc @Loonride hm, okay, let's change this on regexp/string test

hiroppy · 2019-06-14T11:49:20Z

CI fails https://dev.azure.com/webpack/webpack-dev-server/_build/results?buildId=3998&view=ms.vss-test-web.build-test-results-tab

codecov-io · 2019-06-14T17:57:12Z

Codecov Report

Merging #1961 into master will increase coverage by 0.92%.
The diff coverage is 90%.

@@            Coverage Diff             @@
##           master    #1961      +/-   ##
==========================================
+ Coverage   92.92%   93.84%   +0.92%     
==========================================
  Files          32       32              
  Lines        1201     1202       +1     
  Branches      335      336       +1     
==========================================
+ Hits         1116     1128      +12     
+ Misses         81       72       -9     
+ Partials        4        2       -2

Impacted Files	Coverage Δ
lib/Server.js	`95.39% <100%> (+2.61%)`	⬆️
lib/utils/createConfig.js	`91.07% <50%> (-0.75%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f984e53...0b898ec. Read the comment docs.

knagaitsev · 2019-06-14T18:08:17Z

Hmm still can't pass CI though. I tried to choose a pretty generic RegExp, surprised it is not getting outputted in some cases

codecov · 2019-07-01T10:10:08Z

Codecov Report

Merging #1961 into master will increase coverage by 0.91%.
The diff coverage is 90%.

@@            Coverage Diff             @@
##           master    #1961      +/-   ##
==========================================
+ Coverage   93.53%   94.45%   +0.91%     
==========================================
  Files          32       32              
  Lines        1207     1208       +1     
  Branches      332      333       +1     
==========================================
+ Hits         1129     1141      +12     
+ Misses         74       65       -9     
+ Partials        4        2       -2

Impacted Files	Coverage Δ
lib/Server.js	`96.92% <100%> (+2.62%)`	⬆️
lib/utils/createConfig.js	`91.15% <50%> (-0.75%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fa78347...ae7d586. Read the comment docs.

) * feat(server/client): made progress option available to API * test(client): switched snapshot test to single line confirmation * refactor(server): removed this.profile * test(client): fixed progress test css path * test(client): remove jest timeout * test(e2e): change how use of progress on client checked * test(e2e): moved css unlink into afterAll * test(e2e): use port assigner * test(client): add full progress snapshot * test(client): reg exp progress test * test(client): check end of progress updates in console * test(client): more generalized test reg exp * test(client): test to isolate ci problem * test(client): made custom progress plugin to test * test(client): new progress plugin multi handler test * test(client): more testing to identify progress problem * test(client): test with 1 progress plugin * test(client): new console.log to test sending of data * feat(server): re-add two progress plugins * test(client): revert to original changes * test(progress): added progress and profile option tests * fix(test): fix profile test port map

knagaitsev requested review from alexander-akait and hiroppy as code owners June 4, 2019 03:53

hiroppy requested changes Jun 4, 2019

View reviewed changes

alexander-akait requested changes Jun 4, 2019

View reviewed changes

knagaitsev force-pushed the progress-option branch from 3801460 to b54ffe8 Compare June 4, 2019 15:31

hiroppy reviewed Jun 4, 2019

View reviewed changes

knagaitsev force-pushed the progress-option branch from b54ffe8 to e7c8dfa Compare June 4, 2019 19:27

alexander-akait closed this Jun 6, 2019

alexander-akait reopened this Jun 6, 2019

knagaitsev force-pushed the progress-option branch from e7c8dfa to 7da92fc Compare June 8, 2019 20:26

hiroppy requested changes Jun 11, 2019

View reviewed changes

alexander-akait reviewed Jun 13, 2019

View reviewed changes

alexander-akait requested changes Jun 13, 2019

View reviewed changes

knagaitsev force-pushed the progress-option branch from e0f3d40 to 279077f Compare June 13, 2019 16:55

alexander-akait previously approved these changes Jun 14, 2019

View reviewed changes

knagaitsev dismissed alexander-akait’s stale review via 3e06e8d June 14, 2019 17:57

knagaitsev force-pushed the progress-option branch from 279077f to 3e06e8d Compare June 14, 2019 17:57

alexander-akait previously approved these changes Jun 14, 2019

View reviewed changes

knagaitsev dismissed alexander-akait’s stale review via 20b2310 June 14, 2019 19:37

fix(test): fix profile test port map

0b898ec

knagaitsev dismissed hiroppy’s stale review via 0b898ec June 29, 2019 00:11

knagaitsev force-pushed the progress-option branch from 92f61c4 to 0b898ec Compare June 29, 2019 00:11

alexander-akait closed this Jul 1, 2019

alexander-akait reopened this Jul 1, 2019

alexander-akait approved these changes Jul 1, 2019

View reviewed changes

hiroppy added 2 commits July 1, 2019 16:13

Merge branch 'master' into progress-option

0eaae0f

Merge branch 'master' into progress-option

ae7d586

hiroppy approved these changes Jul 1, 2019

View reviewed changes

hiroppy changed the title ~~Make progress option available to API~~ feat(server/client): made progress option available to API Jul 1, 2019

hiroppy merged commit 56274e4 into webpack:master Jul 1, 2019

knagaitsev added gsoc Google Summer of Code scope: cli labels Aug 13, 2019

snyk-bot mentioned this pull request Aug 30, 2019

[Snyk] Upgrade webpack-dev-server from 3.2.1 to 3.8.0 iliutastoica/casino-demo-vue-search#4

Closed

snyk-bot mentioned this pull request Nov 1, 2019

[Snyk] Upgrade webpack-dev-server from 3.1.14 to 3.9.0 nbv1982/material-ui#4

Open

This was referenced Dec 14, 2019

[Snyk] Upgrade webpack-dev-server from 3.3.1 to 3.9.0 hamidraza/zcui-vue-pwa#102

Open

[Snyk] Upgrade webpack-dev-server from 3.1.14 to 3.9.0 jakeherp/burger-builder#12

Open

This was referenced Feb 22, 2020

[Snyk] Upgrade webpack-dev-server from 3.2.1 to 3.10.2 saurabharch/react-ecommerce#5

Open

[Snyk] Upgrade webpack-dev-server from 3.1.14 to 3.10.2 raindigi/eShopOnContainers#2

Open

snyk-bot mentioned this pull request Mar 5, 2020

[Snyk] Upgrade webpack-dev-server from 3.1.10 to 3.10.3 sarvaniupadrasta/learnReact#2

Open

vpetersson mentioned this pull request Mar 6, 2020

[Snyk] Upgrade webpack-dev-server from 3.1.14 to 3.10.3 WoTTsecurity/api#757

Closed

snyk-bot mentioned this pull request Mar 21, 2020

[Snyk] Upgrade webpack-dev-server from 2.9.4 to 3.10.3 lwojcik/sc2pte-panel-frontend#85

Closed

snyk-bot mentioned this pull request Apr 4, 2020

[Snyk] Upgrade webpack-dev-server from 3.7.2 to 3.10.3 CollageLabs/collagelabs.org#60

Merged

This was referenced May 5, 2020

[Snyk] Upgrade webpack-dev-server from 3.1.8 to 3.10.3 Barnstorm-Online/barnstorm-cli#6

Open

[Snyk] Upgrade webpack-dev-server from 3.1.14 to 3.10.3 hzhz/material-ui#5

Open

feat(server/client): made progress option available to API #1961

feat(server/client): made progress option available to API #1961

Conversation

knagaitsev commented Jun 4, 2019

For Bugs and Features; did you add new tests?

Motivation / Use-Case

Breaking Changes

Additional Info

codecov bot commented Jun 4, 2019 • edited Loading

Codecov Report

knagaitsev commented Jun 4, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexander-akait left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

knagaitsev commented Jun 5, 2019

alexander-akait commented Jun 11, 2019

knagaitsev commented Jun 11, 2019

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

alexander-akait left a 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

Choose a reason for hiding this comment

knagaitsev commented Jun 13, 2019

knagaitsev commented Jun 13, 2019

alexander-akait left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexander-akait commented Jun 14, 2019

hiroppy commented Jun 14, 2019

codecov-io commented Jun 14, 2019 • edited by codecov bot Loading

Codecov Report

knagaitsev commented Jun 14, 2019

codecov bot commented Jul 1, 2019 • edited Loading

Codecov Report

codecov bot commented Jun 4, 2019 •

edited

Loading

codecov-io commented Jun 14, 2019 •

edited by codecov bot

Loading

codecov bot commented Jul 1, 2019 •

edited

Loading