refactor: transportMode and client URL options #3260

alexander-akait · 2021-05-06T17:24:02Z

For Bugs and Features; did you add new tests?

WIP

Motivation / Use-Case

I want to split #3181 on multiple PRs/commits

We will implement (this PR) { options.transportMode: { server: { type: 'ws', options: { path: '/ws' } } } } and { options.transportMode: { client: { type: 'ws', options: { path: '/ws' } } } }, now we can pass options to websocket server, also should fix devServer.sockPath #2535, so you can pass
Move client.host/client.port to options.transportMode.client.options
Union transportMode and client options we need discussion here how better name this option, we have server (i.e. all top level options like host, port and etc), websocket server (i.e. ws/sockjs packages and options, for example options.transportMode.server.options.path) and client (i.e. websocket API/sockjs client and options for client like client.overlay/client.logging/etc), and here we have problems our options mixed between options.transportMode.client and top level client (step 2 partial fix it, but I think we can simplify it and do it better)

/cc @webpack/cli-team

Breaking Changes

Yes

Additional Info

Need fix CLI args
Need fix examples and docs

evenstensberg

Lgtm. Nice comments on new code as well👏🏽

snitin315

Looks great! Let's fix CI 🚀

alexander-akait · 2021-05-07T13:39:58Z

I found better way without big changes

alexander-akait · 2021-05-13T19:16:17Z

Hard...

Now we have more clearly options:

webSocketServer allow to set host/port/path (host and port is not supported by sockjs), it allow to run socket server even on other host and port, not only change path, by default we use noServer mode, but if you provide host or port it will be separate server, it is really very flexible
Also we have client.host/client.port/client.path, it change only URL to socket server, it is not change websocket server options, i.e. if you set webSocketServer.options.path: '/custom' it will create web socket server and will accept connection on by this path, if you set client.path: '/custom' it just change URL to websocket server i.e. new WebSocket(url) in browser. DO we really need this (maybe we have cases with proxy?)?

It's all pretty flexible but may be slightly misleading. Maybe somebody have ideas how to improve this (renaming/clear description/etc).

alexander-akait · 2021-05-13T19:34:45Z

/cc @snitin315 maybe you have ideas too

snitin315 · 2021-05-13T19:44:54Z

The change looks good to me. I think we can roll it in next beta release for more feedback and see if developers files any complaints or finds it confusing.

alexander-akait · 2021-05-13T19:49:18Z

Maybe we don't need client.host/client.port/client.path, I tried to find case where it can be useful...

alexander-akait · 2021-05-13T22:54:45Z

@snitin315 Found cases, I think we need better name, maybe client.webSocketHost/etc, but still misleading, we need to find an explicit name that indicates that this does not change the web socket server host/port/path, but used only for creating URL to websocket server, i.e. https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket

alexander-akait · 2021-05-13T22:58:13Z

I'll try to figure it out by tomorrow, I will be glad for any help, we need to finish the release as soon as possible...

snitin315 · 2021-05-14T04:16:03Z

@snitin315 Found cases, I think we need better name, maybe client.webSocketHost/etc, but still misleading, we need to find an explicit name that indicates that this does not change the web socket server host/port/path, but used only for creating URL to websocket server, i.e. https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket

Maybe webSocketURLHost or webSocketURLExclusiveHost etc and we can add in the description it's only for URL. Anyway let's do it separate I can create PR for the same. Let me know.

In the meantime, I will fix the tests here.

alexander-akait · 2021-05-14T12:09:34Z

Yep, let's solve separately, also we need refactor our logic to inject and remove public in favor webSocketURLHost/etc

…port-mode-options' into refactor-client-and-server-transport-mode-options # Conflicts: # test/server/__snapshots__/transportMode-option.test.js.snap.webpack5

alexander-akait · 2021-05-14T12:39:12Z

I will finish PR, we need rewrite some tests + add more them, give me 30-40 minutes

alexander-akait · 2021-05-14T13:01:09Z

test/fixtures/dev-server/default-config.js

@@ -9,12 +9,9 @@ module.exports = {
  entry: resolve(__dirname, './foo.js'),
  devServer: {
    client: {
+      transport: 'sockjs',


@snitin315 Again, here you do the same problem as do other developers, client.transport for only client, it is not create sockjs server, we need search better name for this, you should not set sockjs/ws server using this options, it is only if you want create custom web socket client

I see we need configure webSocketServer here.

Yep, I am working on it, most of tests are good, anyway we need refactor many tests, I will create roadmap for rc for tests and how we need rewrite them

codecov · 2021-05-14T17:40:53Z

Codecov Report

Merging #3260 (8e62861) into master (8283a97) will decrease coverage by 0.01%.
The diff coverage is 98.24%.

@@            Coverage Diff             @@
##           master    #3260      +/-   ##
==========================================
- Coverage   95.56%   95.54%   -0.02%     
==========================================
  Files          34       34              
  Lines        1241     1258      +17     
  Branches      354      356       +2     
==========================================
+ Hits         1186     1202      +16     
- Misses         51       52       +1     
  Partials        4        4

Impacted Files	Coverage Δ
lib/Server.js	`95.62% <ø> (-0.20%)`	⬇️
lib/servers/WebsocketServer.js	`94.11% <ø> (ø)`
lib/utils/getSocketServerImplementation.js	`90.47% <88.88%> (ø)`
lib/servers/SockJSServer.js	`94.73% <100.00%> (+0.61%)`	⬆️
lib/utils/DevServerPlugin.js	`98.82% <100.00%> (+0.07%)`	⬆️
lib/utils/getSocketClientPath.js	`100.00% <100.00%> (ø)`
lib/utils/normalizeOptions.js	`100.00% <100.00%> (ø)`

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 8283a97...8e62861. Read the comment docs.

alexander-akait · 2021-05-15T12:40:41Z

@snitin315 @anshumanv let's finish this firstly before merge other, each rebase is harder and harder

…options

…port-mode-options' into refactor-client-and-server-transport-mode-options

anshumanv · 2021-05-15T12:43:29Z

Yep lets focus to get this in first 👍

anshumanv

👍

alexander-akait requested review from anshumanv, hiroppy, knagaitsev and snitin315 as code owners May 6, 2021 17:24

evenstensberg previously approved these changes May 6, 2021

View reviewed changes

snitin315 reviewed May 7, 2021

View reviewed changes

alexander-akait dismissed evenstensberg’s stale review via 1c0cce5 May 13, 2021 19:06

snitin315 force-pushed the refactor-client-and-server-transport-mode-options branch from b8ba623 to b1bb5c1 Compare May 14, 2021 10:13

alexander-akait mentioned this pull request May 14, 2021

feat: implement dev server as plugin #3251

Closed

6 tasks

snitin315 force-pushed the refactor-client-and-server-transport-mode-options branch 2 times, most recently from e08f597 to d6f9a30 Compare May 14, 2021 12:09

alexander-akait and others added 7 commits May 14, 2021 17:40

refactor: transportMode and client URL options

e9dbf7b

refactor: fix console.log usage

1d0082e

refactor: options

11700c5

refactor: transportMode and client URL options

e5e1f06

refactor: fix console.log usage

c98aa56

refactor: options

470d7af

test: updates

b4e38a0

snitin315 force-pushed the refactor-client-and-server-transport-mode-options branch from d6f9a30 to b4e38a0 Compare May 14, 2021 12:14

alexander-akait added 2 commits May 14, 2021 15:15

refactor: transportMode and client URL options

1378303

refactor: options

9c6dc65

snitin315 and others added 2 commits May 14, 2021 15:16

test: updates

b55e44f

Merge remote-tracking branch 'origin/refactor-client-and-server-trans…

fa9e4d2

…port-mode-options' into refactor-client-and-server-transport-mode-options # Conflicts: # test/server/__snapshots__/transportMode-option.test.js.snap.webpack5

snitin315 force-pushed the refactor-client-and-server-transport-mode-options branch from b4e38a0 to 4d5307b Compare May 14, 2021 12:17

test: update schema

81a4f7a

alexander-akait commented May 14, 2021

View reviewed changes

test: update schema

7405bb6

alexander-akait force-pushed the refactor-client-and-server-transport-mode-options branch from 4d5307b to 7405bb6 Compare May 14, 2021 14:45

alexander-akait added 4 commits May 14, 2021 19:36

style: fix prettier

eb1eb6b

test: fix

b11d4cc

test: fix

62978af

test: fix only

42878ef

test: fix

c2a4403

alexander-akait and others added 3 commits May 15, 2021 15:41

Merge branch 'master' into refactor-client-and-server-transport-mode-…

e57809e

…options

Merge remote-tracking branch 'origin/refactor-client-and-server-trans…

1fafc69

…port-mode-options' into refactor-client-and-server-transport-mode-options

test: fix

8e62861

snitin315 approved these changes May 15, 2021

View reviewed changes

anshumanv approved these changes May 15, 2021

View reviewed changes

alexander-akait merged commit 7632956 into master May 15, 2021

alexander-akait deleted the refactor-client-and-server-transport-mode-options branch May 15, 2021 14:37

Uh oh!

refactor: transportMode and client URL options #3260

refactor: transportMode and client URL options #3260

Uh oh!

Conversation

alexander-akait commented May 6, 2021

For Bugs and Features; did you add new tests?

Motivation / Use-Case

Breaking Changes

Additional Info

Uh oh!

evenstensberg left a comment

Choose a reason for hiding this comment

Uh oh!

snitin315 left a comment

Choose a reason for hiding this comment

Uh oh!

alexander-akait commented May 7, 2021

Uh oh!

alexander-akait commented May 13, 2021

Uh oh!

alexander-akait commented May 13, 2021

Uh oh!

snitin315 commented May 13, 2021

Uh oh!

alexander-akait commented May 13, 2021

Uh oh!

alexander-akait commented May 13, 2021

Uh oh!

alexander-akait commented May 13, 2021

Uh oh!

snitin315 commented May 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alexander-akait commented May 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alexander-akait commented May 14, 2021

Uh oh!

alexander-akait May 14, 2021

Choose a reason for hiding this comment

Uh oh!

snitin315 May 14, 2021

Choose a reason for hiding this comment

Uh oh!

alexander-akait May 14, 2021 • 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!

codecov bot commented May 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

alexander-akait commented May 15, 2021

Uh oh!

anshumanv commented May 15, 2021

Uh oh!

anshumanv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

snitin315 commented May 14, 2021 •

edited

Loading

alexander-akait commented May 14, 2021 •

edited

Loading

alexander-akait May 14, 2021 •

edited

Loading

codecov bot commented May 14, 2021 •

edited

Loading