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.

Sign up for GitHub

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

Jump to bottom

Add option for websocket message size limit #2266

Merged
merged 11 commits into from
May 21, 2024
Merged

Add option for websocket message size limit #2266

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6a1f54d
Add option for websocket message size limit
Tristan-Wilson Apr 30, 2024
9dda8ef
Merge branch 'master' into wsMessageSizeLimit
Tristan-Wilson May 1, 2024
dc706bf
Increase default websocket size limit
Tristan-Wilson May 10, 2024
3b0ea4a
Merge branch 'master' into wsMessageSizeLimit
Tristan-Wilson May 10, 2024
a303472
Merge branch 'master' into wsMessageSizeLimit
Tristan-Wilson May 10, 2024
da8144f
Merge branch 'master' into wsMessageSizeLimit
Tristan-Wilson May 10, 2024
725ec52
Merge branch 'master' into wsMessageSizeLimit
Tristan-Wilson May 10, 2024
69a3e9f
Merge branch 'master' into wsMessageSizeLimit
Tristan-Wilson May 13, 2024
a1f43a3
Merge branch 'master' into wsMessageSizeLimit
joshuacolvin0 May 13, 2024
8874a66
Merge branch 'master' into wsMessageSizeLimit
Tristan-Wilson May 14, 2024
7f7177b
Merge branch 'master' into wsMessageSizeLimit
tsahee May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions cmd/conf/chain.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ var L1ConnectionConfigDefault = rpcclient.ClientConfig{
Timeout: time.Minute,
ConnectionWait: time.Minute,
ArgLogLimit: 2048,
// Use geth's unexported wsDefaultReadLimit from rpc/websocket.go
WebsocketMessageSizeLimit: 32 * 1024 * 1024,
}

var L1ConfigDefault = ParentChainConfig{
Expand Down
29 changes: 17 additions & 12 deletions util/rpcclient/rpcclient.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@ import (
)

type ClientConfig struct {
URL string `json:"url,omitempty" koanf:"url"`
JWTSecret string `json:"jwtsecret,omitempty" koanf:"jwtsecret"`
Timeout time.Duration `json:"timeout,omitempty" koanf:"timeout" reload:"hot"`
Retries uint `json:"retries,omitempty" koanf:"retries" reload:"hot"`
ConnectionWait time.Duration `json:"connection-wait,omitempty" koanf:"connection-wait"`
ArgLogLimit uint `json:"arg-log-limit,omitempty" koanf:"arg-log-limit" reload:"hot"`
RetryErrors string `json:"retry-errors,omitempty" koanf:"retry-errors" reload:"hot"`
RetryDelay time.Duration `json:"retry-delay,omitempty" koanf:"retry-delay"`
URL string `json:"url,omitempty" koanf:"url"`
JWTSecret string `json:"jwtsecret,omitempty" koanf:"jwtsecret"`
Timeout time.Duration `json:"timeout,omitempty" koanf:"timeout" reload:"hot"`
Retries uint `json:"retries,omitempty" koanf:"retries" reload:"hot"`
ConnectionWait time.Duration `json:"connection-wait,omitempty" koanf:"connection-wait"`
ArgLogLimit uint `json:"arg-log-limit,omitempty" koanf:"arg-log-limit" reload:"hot"`
RetryErrors string `json:"retry-errors,omitempty" koanf:"retry-errors" reload:"hot"`
RetryDelay time.Duration `json:"retry-delay,omitempty" koanf:"retry-delay"`
WebsocketMessageSizeLimit int64 `json:"websocket-message-size-limit,omitempty" koanf:"websocket-message-size-limit"`

retryErrors *regexp.Regexp
}
Expand All @@ -46,8 +47,9 @@ func (c *ClientConfig) Validate() error {
type ClientConfigFetcher func() *ClientConfig

var TestClientConfig = ClientConfig{
URL: "self",
JWTSecret: "",
URL: "self",
JWTSecret: "",
WebsocketMessageSizeLimit: 32 * 1024 * 1024,
}

var DefaultClientConfig = ClientConfig{
Expand All @@ -56,6 +58,8 @@ var DefaultClientConfig = ClientConfig{
Retries: 3,
RetryErrors: "websocket: close.*|dial tcp .*|.*i/o timeout|.*connection reset by peer|.*connection refused",
ArgLogLimit: 2048,
// Use geth's unexported wsDefaultReadLimit from rpc/websocket.go
WebsocketMessageSizeLimit: 32 * 1024 * 1024,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's increase this to 256 MiB (for the other websocket clients as well). All of these websocket clients are expecting the server to be honest.

}

func RPCClientAddOptions(prefix string, f *flag.FlagSet, defaultConfig *ClientConfig) {
Expand All @@ -67,6 +71,7 @@ func RPCClientAddOptions(prefix string, f *flag.FlagSet, defaultConfig *ClientCo
f.Uint(prefix+".retries", defaultConfig.Retries, "number of retries in case of failure(0 mean one attempt)")
f.String(prefix+".retry-errors", defaultConfig.RetryErrors, "Errors matching this regular expression are automatically retried")
f.Duration(prefix+".retry-delay", defaultConfig.RetryDelay, "delay between retries")
f.Int64(prefix+".websocket-message-size-limit", defaultConfig.WebsocketMessageSizeLimit, "websocket message size limit used by the RPC client. 0 means no limit")
}

type RpcClient struct {
Expand Down Expand Up @@ -256,9 +261,9 @@ func (c *RpcClient) Start(ctx_in context.Context) error {
var err error
var client *rpc.Client
if jwt == nil {
client, err = rpc.DialContext(ctx, url)
client, err = rpc.DialOptions(ctx, url, rpc.WithWebsocketMessageSizeLimit(c.config().WebsocketMessageSizeLimit))
Copy link
Contributor

Choose a reason for hiding this comment

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

let's test here if WebsocketMessageSizeLimit == 0 (it can happen e.g. for validation-server-configs). If it's 0 either use default or don't apply rpc.WithWebsocketMessageSizeLimit

Copy link
Member Author

Choose a reason for hiding this comment

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

0 will use default https://github.com/OffchainLabs/go-ethereum/blob/master/rpc/websocket.go#L254

(see also
https://github.com/OffchainLabs/go-ethereum/blob/master/rpc/client.go#L216
https://github.com/OffchainLabs/go-ethereum/blob/master/rpc/client_opt.go#L72)

} else {
client, err = rpc.DialOptions(ctx, url, rpc.WithHTTPAuth(node.NewJWTAuth([32]byte(*jwt))))
client, err = rpc.DialOptions(ctx, url, rpc.WithHTTPAuth(node.NewJWTAuth([32]byte(*jwt))), rpc.WithWebsocketMessageSizeLimit(c.config().WebsocketMessageSizeLimit))
}
cancelCtx()
if err == nil {
Expand Down
Loading