Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a way to stop servers #386

Merged
merged 7 commits into from
Jun 24, 2021
Merged

Add a way to stop servers #386

merged 7 commits into from
Jun 24, 2021

Conversation

popzxc
Copy link
Contributor

@popzxc popzxc commented Jun 16, 2021

I didn't dig into stopping all the active subscriptions, since I'm not sure whether it must be a part of the public interface (it's not a trivial matter, since the interface provides flexibility to implement subscription maintenance in any way you want, and doing something without proper notification to user may result in a bad DevEx).

@popzxc
Copy link
Contributor Author

popzxc commented Jun 16, 2021

Related to #377 (not sure whether resolves or not)

@niklasad1
Copy link
Member

Related to #377 (not sure whether resolves or not)

Cool,
Indeed, this PR closes #377 and is what we want.

I will take a look at later today or tomorrow.

Copy link
Member

@niklasad1 niklasad1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM,

For WebSockets the connection will be reset and that should be sufficient I think, then for subscriptions we will send a message when each subscription is closed but I guess we could test it with our WebSocket client to be sure how it's handled when the server is closed.

For HTTP then hyper will take care of that for us and I suppose all pending requests/futures then are "waited" to completed then it's terminated (no new requests are accepted)?

@popzxc
Copy link
Contributor Author

popzxc commented Jun 17, 2021

I suppose all pending requests/futures are completed then it's terminated (no new requests are accepted)

Yep, that's my understanding as well.

@niklasad1 niklasad1 mentioned this pull request Jun 21, 2021
13 tasks
Copy link
Contributor

@dvdplm dvdplm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a bit of duplication happening now between ws and http servers. Not something we need to tackle here ofc, but it'd be good to start thinking about what a better way would be.

http-server/src/server.rs Outdated Show resolved Hide resolved
.expect("Server stopped with an error");

// After server was stopped, attempt to stop it again should result in an error.
assert!(stop_handle.stop().with_default_timeout().await.unwrap().is_err());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we assert that we actually get the AlreadyStopped error here? I get that it is the only possible error, but if the code is ever changed in the future this may not be true anymore.

ws-server/src/server.rs Outdated Show resolved Hide resolved
Copy link
Member

@niklasad1 niklasad1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry I didn't realize that StopHandle was not exported when I reviewed the PR initially because mod server is private thus those must be exported to be usable.

Follow-up for us to investigate is if it makes sense to cancel the background task for that already started connection too.

@niklasad1 niklasad1 merged commit c93b1e7 into paritytech:master Jun 24, 2021
@popzxc popzxc deleted the stop-servers branch June 24, 2021 10:03
dvdplm added a commit that referenced this pull request Jul 6, 2021
* master: (21 commits)
  New proc macro (#387)
  Streaming RpcParams parsing (#401)
  Set allowed Host header values (#399)
  Synchronization-less async connections in ws-server (#388)
  [ws server]: terminate already established connection(s) when the server is stopped (#396)
  feat: customizable JSON-RPC error codes via new enum variant on `CallErrror` (#394)
  [ci]: test each individual crate's manifest (#392)
  Add a way to stop servers (#386)
  [jsonrpsee types]: unify a couple of types + more tests (#389)
  Update roadmap link in readme (#390)
  Cross-origin protection (#375)
  Method aliases + RpcModule: Clone (#383)
  Use criterion's async bencher (#385)
  Async/subscription benches (#372)
  send text (#374)
  Fix link to ws server in README.md (#373)
  Concat -> simple push (#370)
  Add missing `rt` feature (#369)
  Release prep for v0.2 (#368)
  chore(scripts): publish script (#354)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants