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

[Access] Implement web socket handler for new web socket connection under /ws endpoint #6593

Open
Tracked by #6163
Guitarheroua opened this issue Oct 24, 2024 · 0 comments · May be fixed by #6630
Open
Tracked by #6163

[Access] Implement web socket handler for new web socket connection under /ws endpoint #6593

Guitarheroua opened this issue Oct 24, 2024 · 0 comments · May be fixed by #6630
Assignees
@illia-malachyn
Labels
S-Access

Comments

@Guitarheroua
Copy link
Contributor

Guitarheroua commented Oct 24, 2024 •
edited
Loading

Based on the Draft design of new WebSockets, a new WSBrokerHandler should be implemented as part of the new WebSocket subscription system, building upon the current WSHandler.

The new WSBrokerHandler should be created in router.go, similar to how the WSHandler is implemented. It can use a similar WSHandler approach:

flow-go/engine/access/rest/routes/websocket_handler.go

Lines 250 to 268 in 36f067d

func NewWSHandler(
logger zerolog.Logger,
api state_stream.API,
subscribeFunc SubscribeHandlerFunc,
chain flow.Chain,
stateStreamConfig backend.Config,
) *WSHandler {
handler := &WSHandler{
subscribeFunc: subscribeFunc,
api: api,
eventFilterConfig: stateStreamConfig.EventFilterConfig,
maxStreams: int32(stateStreamConfig.MaxGlobalStreams),
defaultHeartbeatInterval: stateStreamConfig.HeartbeatInterval,
activeStreamCount: atomic.NewInt32(0),
HttpHandler: NewHttpHandler(logger, chain),
}
return handler
}

A new AddPubSubRoute function should be added to router.go to separate the new WebSocket implementation from other REST API functionalities:

flow-go/engine/access/rest/routes/router.go

Lines 63 to 79 in ce74abc

func (b *RouterBuilder) AddWsRoutes(
stateStreamApi state_stream.API,
chain flow.Chain,
stateStreamConfig backend.Config,
) *RouterBuilder {
for _, r := range WSRoutes {
h := NewWSHandler(b.logger, stateStreamApi, r.Handler, chain, stateStreamConfig)
b.v1SubRouter.
Methods(r.Method).
Path(r.Pattern).
Name(r.Name).
Handler(h)
}
return b
}

The main difference in the creation of this handler is that it will use a single route with the Name "ws" and Pattern "/ws", but without a handler function, as specific subscriptions will be managed internally by the new WebSocketBroker.
@Guitarheroua Guitarheroua mentioned this issue Oct 24, 2024
Open
@Guitarheroua Guitarheroua changed the title [Access] Implement WSBrokerHandler component [Access] Implement web socket handler for new web socket connection under /ws endpoint Nov 12, 2024
@illia-malachyn illia-malachyn linked a pull request Nov 12, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@illia-malachyn illia-malachyn

Labels
S-Access
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add new websocket handler and skeleton for its deps The-K-R-O-K/flow-go
3 participants
@Guitarheroua @UlyanaAndrukhiv @illia-malachyn