feat: add sockPath option (options.sockPath)

[cheapsteak]

• This is a bugfix
• This is a code refactor
• This is a test update
• This is a typo fix
• This is a metadata update

For Bugs and Features; did you add new tests?

Added new tests for addDevServerEntrypoints

I've added examples referenced from #911

I've tested this against the breaking example provided in 2.7.0 and it doesn't suffer the same failure.

Motivation / Use-Case

Similar motivations as #911.

We also have multiple apps being developed behind a reverse proxy (in our case a docker composed nginx). Each app is served from a top-level sub-directory (can't use root path), e.g. host/app-part-one, host/app-another-piece

Not sure if v3 fixes this and not sure how long until v3 comes out. This should fix our use case and shouldn't break anything else in the mean time

Breaking Changes

None

Additional Info

It doesn't rely on the publicPath value, but unfortunately the sockPath value has to be passed twice, once in the devServer option (this is what Server.js uses to determine what prefix to listen at), and once again in the entry resource url as a query parameter (this is what client/index.js uses to determine where to send requests to)

[jsf-clabot]

All committers have signed the CLA.

[codecov]

Codecov Report

Merging #1289 into master will increase coverage by 2.78%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #1289      +/-   ##
==========================================
+ Coverage   75.72%   78.51%   +2.78%     
==========================================
  Files           5        5              
  Lines         482      484       +2     
  Branches      156      158       +2     
==========================================
+ Hits          365      380      +15     
+ Misses        117      104      -13

Impacted Files	Coverage Δ
lib/Server.js	82.02% <100%> (+0.05%)	⬆️
lib/util/addDevServerEntrypoints.js	94.11% <100%> (+81.61%)	⬆️

---

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 83c1625...a4f35e3. Read the comment docs.

[burtek]

@cheapsteak Does this allow to explicitely set hostname or at least port for socket? I need the socket to connect to a dev server on localhost:3000 from inside another dev site hosted on localhost:80

[cheapsteak]

@burtek unfortunately that is not part of this PR

I believe you should be able to reference my changes and add additional fields for what you'd need (e.g. sockPort and sockHost)

[burtek]

@cheapsteak got it, thanks for answer

[Jokero]

Also found that I need a way to change the port for sockjs)

[Jokero]

Ah, you don't use inline mode. Otherwise there is already public option https://webpack.js.org/configuration/dev-server/#devserver-public

[cheapsteak]

The public option only affects where the client tries to connect to, but the server is hard coded to listen at '/sockjs-node'

[iphands]

The Motivation / Use-Case is spot on here! Thanks @cheapsteak

I believe you should be able to reference my changes and add additional fields for what you'd need (e.g. sockPort and sockHost)

That part could be a separate PR, but it is also very much needed! The reverse proxy can use a completely different hostname and port. For me the hostname override is not needed... I think setting the w-d-s host to makes the behavior change such that the override is not necessary, that might be accidental behavior though.

[flyyang]

What's the status of this PR?

[iphands]

@flyyang I converted the project I am working on to use webpack-serve. That project seemed to do the "right thing" regarding proxied web sockets (for hot reloading) straight out of the box.

[codecov]

Codecov Report

Merging #1289 into master will increase coverage by 2.78%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #1289      +/-   ##
==========================================
+ Coverage   75.72%   78.51%   +2.78%     
==========================================
  Files           5        5              
  Lines         482      484       +2     
  Branches      156      158       +2     
==========================================
+ Hits          365      380      +15     
+ Misses        117      104      -13

Impacted Files	Coverage Δ
lib/Server.js	82.02% <100%> (+0.05%)	⬆️
lib/util/addDevServerEntrypoints.js	94.11% <100%> (+81.61%)	⬆️

---

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 83c1625...a4f35e3. Read the comment docs.

[trescenzi]

Hi what's the status of this PR? Seems like it fell out because webpack-serve was doing the right thing. But now that webpack-serve is deprecated in favor of webpack-dev-server. Is there any chance this could get merged?

I'd be happy to help get it up to date with master and make the changes, host/port, mentioned in this comment.

[THernandez03]

@cheapsteak Does this allow to explicitely set hostname or at least port for socket? I need the socket to connect to a dev server on localhost:3000 from inside another dev site hosted on localhost:80

That should be very nice too, be able to determine the entire url of the socket, not only the path.

[alexander-akait]

Need rebase or create new Pr

[trescenzi]

@evilebottnawi I've got it up to date in my fork. Don't want to just commandeer this though. Especially without confirmation it'll be accepted.

[cheapsteak]

Commandeer away! I'll close this PR