refactor: remove api header and use only query

Author: nugaon

openapi/Swarm.yaml

@@ -2434,7 +2434,7 @@ paths:
       summary: Connect to a pubsub topic via WebSocket
       description: |
         Opens a WebSocket connection to a pubsub topic. The connection acts as either a publisher (read+write)
-        or subscriber (read-only) depending on the presence of GSOC headers.
+        or subscriber (read-only) depending on the presence of GSOC query params.
         
         **WebSocket protocol:**
         - Inbound (client → node, publisher only): raw SOC payload `[sig:65B][span:8B][payload:N B]`

openapi/SwarmCommon.yaml

@@ -1303,28 +1303,28 @@ components:
       description: "ACT history Unix timestamp"
 
     SwarmPubsubPeer:
-      in: header
-      name: swarm-pubsub-peer
+      in: query
+      name: peer
       schema:
         type: string
       required: true
       description: "Multiaddress of the broker peer to connect to for pubsub"
 
     SwarmPubsubGsocEthAddress:
-      in: header
-      name: swarm-pubsub-gsoc-eth-address
+      in: query
+      name: gsoc-eth-address
       schema:
         $ref: "#/components/schemas/HexString"
       required: false
-      description: "GSOC owner Ethereum address (20 bytes, hex-encoded) for publisher role. Required together with swarm-pubsub-gsoc-topic to upgrade to publisher."
+      description: "GSOC owner Ethereum address (20 bytes, hex-encoded) for publisher role. Required together with gsoc-topic to upgrade to publisher."
 
     SwarmPubsubGsocTopic:
-      in: header
-      name: swarm-pubsub-gsoc-topic
+      in: query
+      name: gsoc-topic
       schema:
         $ref: "#/components/schemas/HexString"
       required: false
-      description: "GSOC topic identifier (hex) for publisher role. Required together with swarm-pubsub-gsoc-eth-address to upgrade to publisher."
+      description: "GSOC topic identifier (hex) for publisher role. Required together with gsoc-eth-address to upgrade to publisher."
 
   responses:
     "200":

pkg/api/api.go

@@ -94,14 +94,10 @@ const (
 	SwarmActTimestampHeader           = "Swarm-Act-Timestamp"
 	SwarmActPublisherHeader           = "Swarm-Act-Publisher"
 	SwarmActHistoryAddressHeader      = "Swarm-Act-History-Address"
-	SwarmPubsubPeerHeader             = "Swarm-Pubsub-Peer"
-	SwarmPubsubGsocEthAddressHeader   = "Swarm-Pubsub-Gsoc-Eth-Address"
-	SwarmPubsubGsocTopicHeader        = "Swarm-Pubsub-Gsoc-Topic"
-
-	ImmutableHeader = "Immutable"
-	GasPriceHeader  = "Gas-Price"
-	GasLimitHeader  = "Gas-Limit"
-	ETagHeader      = "ETag"
+	ImmutableHeader                   = "Immutable"
+	GasPriceHeader                    = "Gas-Price"
+	GasLimitHeader                    = "Gas-Limit"
+	ETagHeader                        = "ETag"
 
 	AuthorizationHeader        = "Authorization"
 	AcceptEncodingHeader       = "Accept-Encoding"
@@ -590,7 +586,6 @@ func (s *Service) corsHandler(h http.Handler) http.Handler {
 		SwarmRedundancyStrategyHeader, SwarmRedundancyFallbackModeHeader, SwarmChunkRetrievalTimeoutHeader, SwarmLookAheadBufferSizeHeader,
 		SwarmFeedIndexHeader, SwarmFeedIndexNextHeader, SwarmSocSignatureHeader, SwarmOnlyRootChunk, GasPriceHeader, GasLimitHeader, ImmutableHeader,
 		SwarmActHeader, SwarmActTimestampHeader, SwarmActPublisherHeader, SwarmActHistoryAddressHeader,
-		SwarmPubsubPeerHeader, SwarmPubsubGsocEthAddressHeader, SwarmPubsubGsocTopicHeader,
 	}
 	allowedHeadersStr := strings.Join(allowedHeaders, ", ")
 

pkg/api/pubsub.go

@@ -38,42 +38,31 @@ func (s *Service) pubsubWsHandler(w http.ResponseWriter, r *http.Request) {
 		copy(topicAddr[:], h.Sum(nil))
 	}
 
-	// Required: underlay multiaddr — accept from header or query param (browsers cannot set WS headers)
-	peerHeader := r.Header.Get(SwarmPubsubPeerHeader)
-	if peerHeader == "" {
-		peerHeader = r.URL.Query().Get("swarm-pubsub-peer")
-	}
-	if peerHeader == "" {
-		jsonhttp.BadRequest(w, "missing Swarm-Pubsub-Peer header")
+	peerMultiaddr := r.URL.Query().Get("peer")
+	if peerMultiaddr == "" {
+		jsonhttp.BadRequest(w, "missing peer query param")
 		return
 	}
-	underlay, err := ma.NewMultiaddr(peerHeader)
+	underlay, err := ma.NewMultiaddr(peerMultiaddr)
 	if err != nil {
-		logger.Info("invalid peer multiaddr", "value", peerHeader, "error", err)
-		jsonhttp.BadRequest(w, "invalid Swarm-Pubsub-Peer header")
+		logger.Info("invalid peer multiaddr", "value", peerMultiaddr, "error", err)
+		jsonhttp.BadRequest(w, "invalid peer query param")
 		return
 	}
 
-	// Optional: GSOC fields for Publisher upgrade — accept from header or query param
 	var connectOpts pubsub.ConnectOptions
 
-	gsocEthAddrHex := r.Header.Get(SwarmPubsubGsocEthAddressHeader)
-	if gsocEthAddrHex == "" {
-		gsocEthAddrHex = r.URL.Query().Get("swarm-pubsub-gsoc-eth-address")
-	}
-	gsocTopicHex := r.Header.Get(SwarmPubsubGsocTopicHeader)
-	if gsocTopicHex == "" {
-		gsocTopicHex = r.URL.Query().Get("swarm-pubsub-gsoc-topic")
-	}
+	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 Swarm-Pubsub-Gsoc-Eth-Address header")
+			jsonhttp.BadRequest(w, "invalid gsoc-eth-address query param")
 			return
 		}
 		gsocID, err := hex.DecodeString(gsocTopicHex)
 		if err != nil {
-			jsonhttp.BadRequest(w, "invalid Swarm-Pubsub-Gsoc-Topic header")
+			jsonhttp.BadRequest(w, "invalid gsoc-topic query param")
 			return
 		}
 		connectOpts.GsocOwner = gsocOwner