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 enable-ws flag in server command #152

Merged
merged 3 commits into from
Sep 1, 2022
Merged

Conversation

DarianShawn
Copy link
Collaborator

Description

The WebSocket enpoint was enabled by default, it would consumes too many connections of the RPC node when exposed in the Internet.

This PR adds the enable-ws flag to the server command, and disable the WebSocket endpoint by default.

Changes include

  • Bugfix (non-breaking change that solves an issue)
  • Hotfix (change that solves an urgent issue, and requires immediate attention)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (change that is not backwards-compatible and/or changes current functionality)

Checklist

  • I have assigned this PR to myself
  • I have added at least 1 reviewer
  • I have added the relevant labels
  • I have updated the official documentation
  • I have added sufficient documentation in code

Testing

  • I have tested this code with the official test suite
  • I have tested this code manually

Manual tests

  • setup a new dev mode server, using enable-ws flag or without it.
  • Use WebSocket client, connect to localhost WebSocket endpoint.

We should not be able to connect to ws://localhost:8545/ws endpoint when enable-ws flag not set. And vice versa.

Documentation update

Would update the documentation when new released done.

@DarianShawn DarianShawn added the feature New update to Dogechain label Aug 30, 2022
@DarianShawn DarianShawn added this to the Release 1.2.0 milestone Aug 30, 2022
@DarianShawn DarianShawn self-assigned this Aug 30, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #152 (5dc5810) into dev (dae96a0) will decrease coverage by 0.00%.
The diff coverage is 25.00%.

@@            Coverage Diff             @@
##              dev     #152      +/-   ##
==========================================
- Coverage   51.63%   51.63%   -0.01%     
==========================================
  Files         112      112              
  Lines       16586    16588       +2     
==========================================
+ Hits         8565     8566       +1     
  Misses       7287     7287              
- Partials      734      735       +1     
Impacted Files Coverage Δ
jsonrpc/jsonrpc.go 16.94% <25.00%> (-0.77%) ⬇️
protocol/syncer.go 66.80% <0.00%> (+0.41%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@DarianShawn DarianShawn force-pushed the feature/websocket-flag branch from 5dc5810 to c9e5d04 Compare September 1, 2022 10:49
Copy link
Collaborator

@abrahamcruise321 abrahamcruise321 left a comment

Choose a reason for hiding this comment

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

ok.

@abrahamcruise321 abrahamcruise321 merged commit e52a8b4 into dev Sep 1, 2022
@abrahamcruise321 abrahamcruise321 deleted the feature/websocket-flag branch September 1, 2022 10:58
@github-actions github-actions bot locked and limited conversation to collaborators Sep 1, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature New update to Dogechain
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a new flag for enabling WebSocket which should be false by default
3 participants