feat: pubsub #5435
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| // Copyright 2026 The Swarm Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package api | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/hex" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "github.com/ethersphere/bee/v2/pkg/jsonhttp" | ||
| "github.com/ethersphere/bee/v2/pkg/pubsub" | ||
| "github.com/ethersphere/bee/v2/pkg/swarm" | ||
| "github.com/gorilla/mux" | ||
| "github.com/gorilla/websocket" | ||
| ma "github.com/multiformats/go-multiaddr" | ||
| ) | ||
|
|
||
| func (s *Service) pubsubWsHandler(w http.ResponseWriter, r *http.Request) { | ||
| logger := s.logger.WithName("pubsub").Build() | ||
|
|
||
| paths := struct { | ||
| Topic string `map:"topic" validate:"required"` | ||
| }{} | ||
| if response := s.mapStructure(mux.Vars(r), &paths); response != nil { | ||
| response("invalid path params", logger, w) | ||
| return | ||
| } | ||
|
|
||
| var topicAddr [32]byte | ||
| if decoded, err := hex.DecodeString(paths.Topic); err == nil && len(decoded) == swarm.HashSize { | ||
| copy(topicAddr[:], decoded) | ||
| } else { | ||
| h := swarm.NewHasher() | ||
| _, _ = h.Write([]byte(paths.Topic)) | ||
| copy(topicAddr[:], h.Sum(nil)) | ||
| } | ||
|
|
||
| peerMultiaddr := r.URL.Query().Get("peer") | ||
| if peerMultiaddr == "" { | ||
| jsonhttp.BadRequest(w, "missing peer query param") | ||
|
Contributor
There was a problem hiding this comment. query params are usually optional, and rest path parameters are mandatory. if the peer multiaddr is mandatory, it should be in the path params, and you avoid these sort of checks then |
||
| return | ||
| } | ||
| underlay, err := ma.NewMultiaddr(peerMultiaddr) | ||
| if err != nil { | ||
| logger.Info("invalid peer multiaddr", "value", peerMultiaddr, "error", err) | ||
| jsonhttp.BadRequest(w, "invalid peer query param") | ||
| return | ||
| } | ||
|
|
||
| var connectOpts pubsub.ConnectOptions | ||
|
|
||
| gsocEthAddrHex := r.URL.Query().Get("gsoc-eth-address") | ||
| gsocTopicHex := r.URL.Query().Get("gsoc-topic") | ||
| if gsocEthAddrHex != "" && gsocTopicHex != "" { | ||
| gsocOwner, err := hex.DecodeString(gsocEthAddrHex) | ||
| if err != nil { | ||
| jsonhttp.BadRequest(w, "invalid gsoc-eth-address query param") | ||
| return | ||
| } | ||
| gsocID, err := hex.DecodeString(gsocTopicHex) | ||
| if err != nil { | ||
| jsonhttp.BadRequest(w, "invalid gsoc-topic query param") | ||
| return | ||
| } | ||
| connectOpts.GsocOwner = gsocOwner | ||
| connectOpts.GsocID = gsocID | ||
| connectOpts.ReadWrite = true | ||
| } | ||
|
|
||
| headers := struct { | ||
|
Contributor
There was a problem hiding this comment. nit: i would suggest to put this part next to the other path parsing part at the top |
||
| KeepAlive int `map:"Swarm-Keep-Alive"` | ||
| }{} | ||
| if response := s.mapStructure(r.Header, &headers); response != nil { | ||
| response("invalid header params", logger, w) | ||
| return | ||
| } | ||
|
|
||
| // Connect to broker peer | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
|
Contributor
There was a problem hiding this comment. you lost the main api context here. so if the api shuts down, you don't know about it. you want to add another layer of cancellation over the existing parent context |
||
| mode, err := s.pubsubSvc.Connect(ctx, underlay, topicAddr, pubsub.ModeGSOCEphemeral, connectOpts) | ||
| if err != nil { | ||
| cancel() | ||
| logger.Info("pubsub connect failed", "error", err) | ||
| jsonhttp.InternalServerError(w, "pubsub connect failed") | ||
| return | ||
| } | ||
| // Upgrade to WebSocket | ||
| upgrader := websocket.Upgrader{ | ||
| ReadBufferSize: swarm.ChunkWithSpanSize, | ||
|
Contributor
There was a problem hiding this comment. can't this be bigger? see |
||
| WriteBufferSize: swarm.ChunkWithSpanSize, | ||
| CheckOrigin: s.checkOrigin, | ||
| } | ||
|
|
||
| logger.Info("upgrading to websocket") | ||
|
Contributor
There was a problem hiding this comment. this really gives 0 context (which api endpoint? which client?). suggesting to remove |
||
| conn, err := upgrader.Upgrade(w, r, nil) | ||
| if err != nil { | ||
| // Upgrade() hijacks the connection before returning an error, | ||
| // so do NOT write an HTTP response here. | ||
| cancel() | ||
| logger.Info("websocket upgrade failed", "error", err) | ||
| logger.Error(nil, "websocket upgrade failed") | ||
| return | ||
| } | ||
| logger.Info("websocket upgrade successful") | ||
|
|
||
|
|
||
| pingPeriod := time.Duration(headers.KeepAlive) * time.Second | ||
| if pingPeriod == 0 { | ||
| pingPeriod = time.Minute | ||
| } | ||
|
|
||
| isPublisher := connectOpts.ReadWrite | ||
|
|
||
|
|
||
| s.wsWg.Add(1) | ||
| go func() { | ||
| pubsub.ListeningWs(ctx, conn, pubsub.WsOptions{PingPeriod: pingPeriod, Cancel: cancel}, logger, mode, isPublisher) | ||
| cancel() | ||
| _ = conn.Close() | ||
|
Contributor
There was a problem hiding this comment. please use defer statements inside the closure before the |
||
| s.wsWg.Done() | ||
| }() | ||
| } | ||
|
|
||
| func (s *Service) pubsubListHandler(w http.ResponseWriter, r *http.Request) { | ||
| if s.pubsubSvc == nil { | ||
| jsonhttp.NotFound(w, "pubsub service not available") | ||
| return | ||
| } | ||
|
|
||
| topics := s.pubsubSvc.Topics() | ||
| jsonhttp.OK(w, struct { | ||
| Topics []pubsub.TopicInfo `json:"topics"` | ||
| }{ | ||
| Topics: topics, | ||
| }) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you please add some comments on what
topiccould be? there's zero comments on the handler and zero inline comments, which is not so nice to read (i'd rather not have to reach out to the openapi spec or BOS to check what a parameter might mean). ideally you can add a comment in the anonymous type on that field, explaining what it is.also just to be a little bit more specific. if a parameter is a hex address OR an arbitrary length string, then it is ONLY an arbitrary length string. whether someone, by convention, chooses to use one over the other, it is a bad practice to disambiguate them. i would suggest to have just one type and use it however using conventions. i.e. always hash the topic.