fix(client): Make public path on client match dev server publicPath #2055

knagaitsev · 2019-06-22T18:47:54Z

For Bugs and Features; did you add new tests?

Yes

Motivation / Use-Case

This creates an absolute URL based on provided devServer.publicPath, host, port, etc., then it sets __webpack_public_path__ on the client to this absolute URL. This forces the client to request hot-update.json from the correct location.

This works because hot-update.json is requested from the webpack public path here: https://github.com/webpack/webpack/blob/master/lib/web/JsonpMainTemplate.runtime.js#L31 ($require$.p is public path).

The client must be informed of publicPath, so I pass it to the client using resource query along with sockHost, sockPort, sockPath. I did some work to improve tests and how these options are encoded/decoded through the resource query.

Breaking Changes

Now, the __webpack_public_path__ will be set to an absolute URL.

Additional Info

codecov · 2019-06-22T18:51:31Z

Codecov Report

Merging #2055 into next will increase coverage by 0.15%.
The diff coverage is 96.62%.

@@            Coverage Diff             @@
##             next    #2055      +/-   ##
==========================================
+ Coverage   93.88%   94.04%   +0.15%     
==========================================
  Files          34       38       +4     
  Lines        1276     1327      +51     
  Branches      363      379      +16     
==========================================
+ Hits         1198     1248      +50     
+ Misses         71       70       -1     
- Partials        7        9       +2

Impacted Files	Coverage Δ
client-src/clients/BaseClient.js	`69.23% <ø> (-5.77%)`	⬇️
client-src/clients/SockJSClient.js	`60.00% <ø> (-1.54%)`	⬇️
client-src/clients/WebsocketClient.js	`58.97% <ø> (+1.07%)`	⬆️
client-src/default/utils/getCurrentScriptSource.js	`100.00% <ø> (ø)`
client-src/default/utils/reloadApp.js	`100.00% <ø> (ø)`
lib/utils/createConfig.js	`98.19% <0.00%> (+1.73%)`	⬆️
client-src/default/index.js	`91.66% <83.33%> (-0.56%)`	⬇️
lib/Server.js	`97.19% <95.45%> (-0.13%)`	⬇️
lib/utils/startUnixSocket.js	`96.55% <96.55%> (ø)`
client-src/default/overlay.js	`96.82% <100.00%> (-0.15%)`	⬇️
... and 16 more

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 7daff1d...df594ad. Read the comment docs.

alexander-akait

/cc @hiroppy

alexander-akait

Need dicussion

alexander-akait · 2019-06-24T09:36:27Z

client-src/default/index.js

@@ -9,6 +9,9 @@ const { log, setLogLevel } = require('./utils/log');
 const sendMessage = require('./utils/sendMessage');
 const reloadApp = require('./utils/reloadApp');
 const createSocketUrl = require('./utils/createSocketUrl');
+const updatePublicPath = require('./utils/updatePublicPath');
+
+updatePublicPath(__resourceQuery);


I am afraid what we change global variable and it is can break code in some rare case, maybe we can rewrite this on using own variable like:

const resourceQuery = getPublicPath(__resourceQuery);

You mean the changing of the global variable __webpack_public_path__, right?

Good point, but the problem is that hot-update.json is being requested using the global public path variable here: https://github.com/webpack/webpack/blob/master/lib/web/JsonpMainTemplate.runtime.js#L31, so that global public path variable needs to be changed, or else we need to modify core webpack.

I think it is safe enough to do this:

__webpack_public_path__ = __webpack_public_path__ || publicPath;

so if it is already set, we will not change it.

jsf-clabot · 2019-08-10T05:37:07Z

Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
3 out of 4 committers have signed the CLA.

✅ hiroppy
✅ Loonride
✅ EslamHiko
❌ renovate[bot]

Because opn was renamed to open.

…k#1998) ISSUE: webpack#1901

…ack#2178)

* feat(server): add stdin for api * test(stdin): switch to async await tests for stdin * test(cli): use await timer

* feat(server): made user callback async, remove cli listen redundancy * test(server): added server listen method async callback tests * test(server): create options object using spread operator * chore(server): fix comment spelling

* refactor: update snapshot & change clientSocketOptions type to Object * refactor: union sockHost, sockPath and sockPort in clientSocketOptions * refactor: remove console.error

jony89 · 2019-11-07T12:10:24Z

Hey, thanks for the PR this is really needed. as the functionality for publicPath is broken now.

alexander-akait · 2019-11-07T12:13:40Z

Only in next major release, sorry it is breaking change

jony89 · 2019-11-07T12:34:39Z

Only in next major release, sorry it is breaking change

sure but can this at least be merged for some of us that want to start work with the next branch?

alexander-akait · 2019-11-07T12:54:51Z

@jony89 yep, we will do this in near future (now we are working on next release webpack-dev-middleware, so it will be updated too)

jony89 · 2019-11-28T13:18:45Z

Hey, 21 days pass, any progress? can I help with anything?

knagaitsev requested review from alexander-akait and hiroppy as code owners June 22, 2019 18:47

alexander-akait requested changes Jun 24, 2019

View reviewed changes

knagaitsev force-pushed the public-path-fix branch from 072936b to da316ac Compare August 10, 2019 05:37

knagaitsev changed the base branch from master to next August 10, 2019 05:37

knagaitsev added gsoc Google Summer of Code pr: next labels Aug 13, 2019

knagaitsev force-pushed the public-path-fix branch from da316ac to 83148d0 Compare August 16, 2019 14:55

seancrater mentioned this pull request Aug 19, 2019

devServer ignore port param when load chunks #1717

Closed

2 tasks

knagaitsev closed this Aug 20, 2019

knagaitsev reopened this Aug 20, 2019

hiroppy and others added 16 commits September 10, 2019 07:52

chore: don't support Node6 (webpack#1976)

06f6c53

refactor(client): make use of ESM instead of CJS (webpack#1967)

af76891

chore(deps): update dependency ws to v7 (webpack#1834)

fad833a

chore(deps): update dependency file-loader to v4 (webpack#1971)

b32f7a3

chore(deps): update dependency chokidar to v3 (webpack#1902)

342fa6a

chore(deps): introduce open and remove opn (webpack#1865)

7901428

Because opn was renamed to open.

chore: fix tests (webpack#1997)

898461a

test: make use of async/await (webpack#1996)

7526664

feat(client): delete none and warning from clientLogLevel (webpac…

ec86384

…k#1998) ISSUE: webpack#1901

chore: fix code from master

742aa13

chore(deps): update dependency p-retry to v4 (webpack#2009)

b136055

fix(options): delete none and warning from optinos.json

50b99b6

chore(deps): update url-loader to 2.1.0

5c0dced

test: update syntax

1679797

refactor(server): remove some variables of options (webpack#2175)

c600b0e

chore(deps): update del, supports-color, import-local and execa (webp…

27b1913

…ack#2178)

knagaitsev added 2 commits September 10, 2019 08:23

feat(server): add stdin option to API (webpack#2186)

e819cfe

* feat(server): add stdin for api * test(stdin): switch to async await tests for stdin * test(cli): use await timer

refactor(server): move socket handling into server.listen (webpack#2061)

64036a0

hiroppy force-pushed the next branch from babdf28 to 64036a0 Compare September 10, 2019 03:13

knagaitsev force-pushed the public-path-fix branch from 83148d0 to 1a48c43 Compare September 15, 2019 02:53

pmmmwh mentioned this pull request Sep 23, 2019

[Meta] Releasing this Plugin as "Fast Refresh" capable pmmmwh/react-refresh-webpack-plugin#1

Open

42 tasks

knagaitsev and others added 5 commits September 24, 2019 21:41

Union sock options (webpack#2047)

fe80fa4

* refactor: update snapshot & change clientSocketOptions type to Object * refactor: union sockHost, sockPath and sockPort in clientSocketOptions * refactor: remove console.error

test(client): added and improved tests for public path updating

54a7c77

test(client): updated cli and index tests

ed5ee20

refactor(client): updated to latest module importing

df594ad

knagaitsev mentioned this pull request Sep 25, 2019

hot-update.json 404 (Not Found) #1385

Closed

2 tasks

knagaitsev force-pushed the public-path-fix branch from 1a48c43 to df594ad Compare September 25, 2019 16:50

hiroppy force-pushed the next branch 3 times, most recently from c54ae99 to edfcfd6 Compare December 19, 2019 09:07

pmmmwh mentioned this pull request Dec 22, 2019

Get websocket port from document.currentScript if possible pmmmwh/react-refresh-webpack-plugin#30

Closed

hiroppy force-pushed the next branch 2 times, most recently from 4408469 to dc1c72f Compare December 24, 2019 05:53

alexander-akait force-pushed the next branch 2 times, most recently from d14892a to 5f1ad3b Compare January 31, 2020 15:58

pmmmwh mentioned this pull request Mar 2, 2020

404 with http://localhost:3000/sockjs-node/info?t=... pmmmwh/react-refresh-webpack-plugin#43

Closed

alexander-akait closed this Feb 27, 2021

alexander-akait deleted the branch webpack:next February 27, 2021 15:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(client): Make public path on client match dev server publicPath #2055

fix(client): Make public path on client match dev server publicPath #2055

knagaitsev commented Jun 22, 2019

codecov bot commented Jun 22, 2019 •

edited

alexander-akait left a comment •

edited

alexander-akait left a comment

alexander-akait Jun 24, 2019

knagaitsev Jun 24, 2019 •

edited

jsf-clabot commented Aug 10, 2019 •

edited

jony89 commented Nov 7, 2019

alexander-akait commented Nov 7, 2019

jony89 commented Nov 7, 2019

alexander-akait commented Nov 7, 2019

jony89 commented Nov 28, 2019

fix(client): Make public path on client match dev server publicPath #2055

fix(client): Make public path on client match dev server publicPath #2055

Conversation

knagaitsev commented Jun 22, 2019

For Bugs and Features; did you add new tests?

Motivation / Use-Case

Breaking Changes

Additional Info

codecov bot commented Jun 22, 2019 • edited

Codecov Report

alexander-akait left a comment • edited

Choose a reason for hiding this comment

alexander-akait left a comment

Choose a reason for hiding this comment

alexander-akait Jun 24, 2019

Choose a reason for hiding this comment

knagaitsev Jun 24, 2019 • edited

Choose a reason for hiding this comment

jsf-clabot commented Aug 10, 2019 • edited

jony89 commented Nov 7, 2019

alexander-akait commented Nov 7, 2019

jony89 commented Nov 7, 2019

alexander-akait commented Nov 7, 2019

jony89 commented Nov 28, 2019

codecov bot commented Jun 22, 2019 •

edited

alexander-akait left a comment •

edited

knagaitsev Jun 24, 2019 •

edited

jsf-clabot commented Aug 10, 2019 •

edited