feat: add `sockPath` option (`options.sockPath`) #1553

trescenzi · 2018-10-29T20:15:03Z

This is a version of #1289 that's up to date with master.

For Bugs and Features; did you add new tests?

The tests that were added in #1289 seem to exist in master now. I can add more specific tests if desired.

Motivation / Use-Case

copied from #1289; although I have the same motivation
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

Breaking Changes

None

Additional Info

There was discussion on #1289 about adding port and host to the socks options. I'm happy to do so if there's still interest. I didn't include it here though because this happens to be all I need.

jsf-clabot · 2018-10-29T21:09:16Z

All committers have signed the CLA.

alexander-akait

Looks good, need add tests

michael-ciniawsky

@trescenzi Thx in advance

michael-ciniawsky · 2018-10-30T12:15:03Z

examples/node-api-sock-path/README.md

@@ -0,0 +1,15 @@
+# Node.js API - Simple


Please remove all examples as we don't intend to maintain them in the future (#1469)

michael-ciniawsky · 2018-10-30T12:21:54Z

client-src/default/index.js

@@ -2,7 +2,7 @@

 /* global __resourceQuery WorkerGlobalScope self */
 /* eslint prefer-destructuring: off */
-
+const querystring = require('querystring');


Suggested change

const querystring = require('querystring');

const qs = require('querystring');

Disagree, no need rewrite full package name to short name.

qs also conflicts with another variable in the file, and eslint complains about shadowing. That's why it's been renamed from the original PR.

@trescenzi you did everything right, do not rename

client-src/default/index.js

michael-ciniawsky · 2018-10-30T12:28:33Z

lib/options.json

@@ -321,6 +324,7 @@
      "filename": "should be {String|RegExp|Function} (https://webpack.js.org/configuration/dev-server/#devserver-filename-)",
      "port": "should be {String|Number} (https://webpack.js.org/configuration/dev-server/#devserver-port)",
      "socket": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-socket)",
+      "sockPath": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-sockPath)",


This needs to be documented by opening a PR in docs repo please. Currently to URL redirects to the dev server 'landing page', which might be confusing for some and ultimately isn't really helpful

codecov · 2018-10-31T12:09:39Z

Codecov Report

Merging #1553 into master will increase coverage by 0.07%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #1553      +/-   ##
==========================================
+ Coverage   74.41%   74.49%   +0.07%     
==========================================
  Files          10       10              
  Lines         688      690       +2     
==========================================
+ Hits          512      514       +2     
  Misses        176      176

Impacted Files	Coverage Δ
lib/Server.js	`81.53% <100%> (+0.04%)`	⬆️
lib/utils/addEntries.js	`100% <100%> (ø)`	⬆️

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 11c9896...d252f19. Read the comment docs.

trescenzi · 2018-10-31T12:11:09Z

I've:

removed the example
added tests
fixed a bug noted while testing

Still need to update the webpack documentation itself with another PR.

Let me know if there's more to do here.

Also do you want these commits squashed or are they ok as is?

alexander-akait

Looks good, let's wait CI green, after merge need create PR in webpack docs repo

trescenzi · 2018-10-31T12:45:03Z

Huh so I was running the tests with a .only looks like they fail when run with all tests. I'll investigate that.

trescenzi · 2018-10-31T22:06:19Z

The test issues are only in node 11 it seems. I'm still investigating but there isn't anything obvious in the node 11 release notes that would indicate that child process would behave differently.

alexander-akait · 2018-11-01T09:52:17Z

@trescenzi can you reproducible test failed locally?

trescenzi · 2018-11-02T14:33:42Z

@evilebottnawi I can reproduce the hanging CLI tests locally. I'm busy over the next few days but I can take a look again on monday.

alexander-akait · 2018-11-02T14:35:13Z

@trescenzi can you provide details how you can reproduce problem?

trescenzi · 2018-11-02T15:01:07Z

@evilebottnawi all I have to do, on master, is:

> brew switch node 11.0.0
> rm -rf node_modules
> npm install
> npm test

Sometimes it hangs during the tests, sometimes it segfaults. I don't have issues with node 10.12.0.

alexander-akait · 2018-11-02T15:04:05Z

@trescenzi thanks!

trescenzi · 2018-11-27T13:54:08Z

My apologies I've been away from this for so long. I've got time over the next few days to figure out what's up and get this out.

odinho · 2018-12-04T22:27:40Z

@trescenzi If you rebase to newest master, Node 11 is disabled for now. I did see one hang on Node 10 too, but I don't run Mac OS X, so it was hard to debug.

I've opened a bug on node.js, if you potentially want to try this with llnode to get a full stack trace as commented in the bug: nodejs/node#24835

trescenzi · 2018-12-05T15:13:00Z

When I was trying to get the tests working before I made so updates to the tests for this change that used supertest more idiomatically instead of relying upon request. I've pushed these changes. Should just have to click the update branch button and this will be good to go. Waiting to click though in case it gets out of date again between now and when it's good to merge.

@odinho definitely interested in debugging node. It's been too long since I've attached gdb to a running process haha. Not sure if I have time this moment to do so though. I'll see when I end up today. The issues are still 100% reproducible in the tests just by switching to node 11.

trescenzi · 2018-12-11T19:01:02Z

Any updates here? As far as I'm aware it should be good to merge. Let me know if there's anything else I can do.

alexander-akait

Just couple questions and we can merge

alexander-akait · 2018-12-11T19:48:53Z

lib/Server.js

@@ -85,6 +85,7 @@ function Server (compiler, options = {}, _log) {

  this.watchOptions = options.watchOptions || {};
  this.contentBaseWatchers = [];
+  this.sockPath = `/${options.sockPath ? options.sockPath.replace(/^\/|\/$/g, '') : 'sockjs-node'}`;


Why we need .replace(/^\/|\/$/g, '')?

So this is largely to allow users to provide either: sockPath: '/this/is/a/path/' or sockPath: 'this/is/a/path' and have it behave the same way.

The leading slash gets added by this template string. Instead of checking if there's a leading slash and only adding one if there isn't one, this just always adds a leading slash and removes any if there is one.

The trailing slash is removed because it doesn't mean anything in this case and is likely a result of user error.

@trescenzi please add comment to code with this information in concise form, thanks

alexander-akait · 2018-12-11T19:51:03Z

client-src/default/index.js

@@ -196,7 +196,7 @@ const socketUrl = url.format({
  auth: urlParts.auth,
  hostname,
  port: urlParts.port,
-  pathname: urlParts.path == null || urlParts.path === '/' ? '/sockjs-node' : urlParts.path
+  pathname: urlParts.path == null || urlParts.path === '/' ? '/sockjs-node' : (querystring.parse(urlParts.path).sockPath || urlParts.path)


Why we need use querystring.parse here?

That I don't know the answer to. It was left over from the initial pr and I kinda just assumed was how stuff was done. Will investigate and come back with an answer.

@trescenzi thanks!

So what's happening here is that __resouceQuery gets the sockPath option passed in. This is then parsing that querystring and getting the sockPath option.

@trescenzi just add this comment to code 👍

zsalzbank · 2019-01-30T15:49:34Z

While waiting for this, I came up with a temporary workaround (assuming you are using webpack). You'll need the file in this gist: https://gist.github.com/zsalzbank/cdee4f852e4a89c116eb7a28491bbf63

Then, add the exported plugin to your babel plugins like so:

...
plugins: [
  require('sockjs-prefix-modification')('/my-prefix-path/').plugin
],
...

And before you import webpack-dev-server for your server, run the following:

require('sockjs-prefix-modification')('/my-prefix-path/').fixWebpackDevServer();

You'll need @babel/register and babel-plugin-search-and-replace in your devDependencies.

alexander-akait · 2019-01-30T16:03:24Z

/cc @trescenzi can you fix note from me above and we can merge

trescenzi · 2019-01-30T17:12:23Z

My apologies for taking forever to update this. It dropped off my radar. It should be good now.

I'm going to put up a PR against the docs site now.

trescenzi · 2019-01-30T17:20:31Z

Looks like the linting hung? It lints fine for me locally.

alexander-akait · 2019-01-30T17:21:00Z

@trescenzi yep, something wrong with travis ci, rerun CI

[Related PR](webpack/webpack-dev-server#1553)

cheapsteak added 6 commits October 26, 2018 16:49

explicit sockPath

01054e8

add sockPath to options

27fb6a5

fix: remove leading and trailing slashes for sockPath

4bbc1f6

add sockPath to auto-added entry points in /bin

e6ab166

add examples referencing kellyrmilligan’s pull/911

d52103b

fix test

4a07096

trescenzi requested review from alexander-akait and michael-ciniawsky as code owners October 29, 2018 20:15

fix lint errors + correct messed up rebase

4078156

alexander-akait requested changes Oct 30, 2018

View reviewed changes

michael-ciniawsky changed the title ~~Feature: Add SocksPath to config~~ feat: add sockPath option (options.sockPath) Oct 30, 2018

michael-ciniawsky suggested changes Oct 30, 2018

View reviewed changes

michael-ciniawsky added this to the 3.2.0 milestone Oct 30, 2018

michael-ciniawsky added priority: 4 (nice to have) severity: 4 (inconvenient) semver: minor type: feature status: pending pr: rework scope: ws(s) labels Oct 30, 2018

michael-ciniawsky mentioned this pull request Oct 30, 2018

feat(Server): add sockJsUrl option (options.sockJsUrl) #1335

Closed

5 tasks

trescenzi added 2 commits October 31, 2018 08:05

fix sockjs path formatting

745908f

remove example

c0faeeb

add sockpath tests

bd31f5a

trescenzi force-pushed the fix/socksjs-path-2 branch from 8351dd0 to bd31f5a Compare October 31, 2018 12:11

alexander-akait approved these changes Oct 31, 2018

View reviewed changes

chrisckc mentioned this pull request Nov 6, 2018

UseProxyToSpaDevelopmentServer doesn't auto-refresh browser using an Aurelia ClientApp with HMR aspnet/JavaScriptServices#1743

Closed

ehsanul mentioned this pull request Nov 21, 2018

[2.7.0] Recursive SockJS Errors #1021

Closed

evilebottnawi and others added 2 commits December 5, 2018 13:08

Merge branch 'master' into fix/socksjs-path-2

bf67dd6

Merge branch 'master' into fix/socksjs-path-2

8332f4f

refactor socket tests to use super test

a3d320e

trescenzi force-pushed the fix/socksjs-path-2 branch from 5a05b5e to a3d320e Compare December 5, 2018 15:15

Merge branch 'master' into fix/socksjs-path-2

f384993

alexander-akait requested changes Dec 11, 2018

View reviewed changes

Merge branch 'master' into fix/socksjs-path-2

7542c35

add comments for clarification about sockPath code

d252f19

trescenzi added a commit to trescenzi/webpack.js.org that referenced this pull request Jan 30, 2019

docs(devServer): add sockPath docs

8e950cc

[Related PR](webpack/webpack-dev-server#1553)

trescenzi mentioned this pull request Jan 30, 2019

docs(devServer): add sockPath docs webpack/webpack.js.org#2791

Merged

alexander-akait merged commit 4bf1f76 into webpack:master Jan 30, 2019

trescenzi deleted the fix/socksjs-path-2 branch January 30, 2019 18:51

carlosgeos pushed a commit to carlosgeos/webpack-dev-server that referenced this pull request Feb 26, 2019

feat: add sockPath option (options.sockPath) (webpack#1553)

9fc1476

	const querystring = require('querystring');
	const qs = require('querystring');

feat: add sockPath option (options.sockPath) #1553

feat: add sockPath option (options.sockPath) #1553

Conversation

trescenzi commented Oct 29, 2018

For Bugs and Features; did you add new tests?

Motivation / Use-Case

Breaking Changes

Additional Info

jsf-clabot commented Oct 29, 2018 • edited

alexander-akait left a comment

Choose a reason for hiding this comment

michael-ciniawsky left a comment

Choose a reason for hiding this comment

michael-ciniawsky Oct 30, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trescenzi Oct 30, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 31, 2018 • edited

Codecov Report

trescenzi commented Oct 31, 2018

alexander-akait left a comment

Choose a reason for hiding this comment

trescenzi commented Oct 31, 2018

trescenzi commented Oct 31, 2018

alexander-akait commented Nov 1, 2018

trescenzi commented Nov 2, 2018

alexander-akait commented Nov 2, 2018

trescenzi commented Nov 2, 2018

alexander-akait commented Nov 2, 2018

trescenzi commented Nov 27, 2018

odinho commented Dec 4, 2018

trescenzi commented Dec 5, 2018 • edited

trescenzi commented Dec 11, 2018

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

zsalzbank commented Jan 30, 2019 • edited

alexander-akait commented Jan 30, 2019

trescenzi commented Jan 30, 2019

trescenzi commented Jan 30, 2019

alexander-akait commented Jan 30, 2019 • edited

feat: add `sockPath` option (`options.sockPath`) #1553

feat: add `sockPath` option (`options.sockPath`) #1553

jsf-clabot commented Oct 29, 2018 •

edited

michael-ciniawsky Oct 30, 2018 •

edited

trescenzi Oct 30, 2018 •

edited

codecov bot commented Oct 31, 2018 •

edited

trescenzi commented Dec 5, 2018 •

edited

zsalzbank commented Jan 30, 2019 •

edited

alexander-akait commented Jan 30, 2019 •

edited