Sending back more information in BadResponseError (#184)

* returning body for error

* minor

* spacing

* updating verb and excluding macos-latest for v1.23 in test and build workflows

* removing adding to v1

* changes to build and test yml

---------

Co-authored-by: Ashwini Raja <[email protected]>

Author: ashwini-raja

.github/workflows/build.yml

@@ -7,8 +7,8 @@ jobs:
   build:
     strategy:
       matrix:
-        go-version: ["1.23.x", "1.24.x"]
-        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        go-version: ["1.24.x", "1.25.x"]
+        os: [ ubuntu-latest ]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Harden the runner (Audit all outbound calls)

.github/workflows/test.yml

@@ -7,8 +7,8 @@ jobs:
   test:
     strategy:
       matrix:
-        go-version: ["1.23.x", "1.24.x"]
-        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        go-version: ["1.24.x", "1.25.x"]
+        os: [ ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Harden the runner (Audit all outbound calls)

.gitignore

@@ -21,3 +21,6 @@ go.work.sum
 # IDE files
 *idea
 *iml
+
+# vscode
+.vscode

v2/client_test.go

@@ -189,3 +189,35 @@ func TestCanDoubleSubscribe(t *testing.T) {
 
 	wg.Wait()
 }
+
+func TestErrorParsing(t *testing.T) {
+	server := gobayeuxtest.NewServer(t, gobayeuxtest.WithHandshakeError(true))
+	if err := server.Start(context.Background()); err != nil {
+		t.Fatalf("failed to start test server (%v)", err)
+	}
+
+	client, err := gobayeux.NewClient(
+		"https://example.com",
+		gobayeux.WithHTTPTransport(server),
+	)
+	if err != nil {
+		t.Fatalf("failed to create client (%v)", err)
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	defer cancel()
+
+	errs := client.Start(ctx)
+	err = <-errs
+	if err == nil {
+		t.Fatal("expected an error when connecting")
+	}
+
+	if err.Error() != `expected 200 response from bayeux server, got 400 with status 'Bad Request' and body '"{\"error\":\"Invalid request\"}"'` {
+		t.Errorf("expected different error when connecting; got %v", err)
+	}
+
+	if err := server.Stop(context.Background()); err != nil {
+		t.Fatalf("failed to stop test server (%v)", err)
+	}
+}

v2/errors.go

@@ -153,9 +153,10 @@ type BadResponseError struct {
 
 func (e BadResponseError) Error() string {
 	return fmt.Sprintf(
-		"expected 200 response from bayeux server, got %d with status '%s'",
+		"expected 200 response from bayeux server, got %d with status '%s' and body '%q'",
 		e.StatusCode,
 		e.Status,
+		e.Body,
 	)
 }
 

v2/internal/gobayeuxtest/server.go

@@ -40,13 +40,22 @@ type Server struct {
 	mu      sync.Mutex
 	running bool
 	subs    map[string][]gobayeux.Channel
+
+	handshakeError bool
 }
 
-func NewServer(logger Logger) *Server {
-	return &Server{
+func NewServer(logger Logger, opts ...ServerOpts) *Server {
+	server := &Server{
 		log:  logger,
 		subs: make(map[string][]gobayeux.Channel),
 	}
+
+	for _, opt := range opts {
+		opt.apply(server)
+	}
+
+	return server
+
 }
 
 func (s *Server) Start(context.Context) error {
@@ -101,6 +110,13 @@ func (s *Server) RoundTrip(req *http.Request) (*http.Response, error) {
 	for _, msg := range msgs {
 		switch msg.Channel {
 		case "/meta/handshake":
+			if s.handshakeError {
+				return &http.Response{
+					StatusCode: http.StatusBadRequest,
+					Status:     http.StatusText(http.StatusBadRequest),
+					Body:       io.NopCloser(bytes.NewReader([]byte(`{"error":"Invalid request"}`))),
+				}, nil
+			}
 			replies = append(replies, &gobayeux.Message{
 				Channel:                  "/meta/handshake",
 				Version:                  msg.Version,

v2/internal/gobayeuxtest/server_opts.go

@@ -0,0 +1,17 @@
+package gobayeuxtest
+
+type ServerOpts interface {
+	apply(s *Server)
+}
+
+type serverOptFn func(s *Server)
+
+func (opt serverOptFn) apply(s *Server) {
+	opt(s)
+}
+
+func WithHandshakeError(handshakeError bool) ServerOpts {
+	return serverOptFn(func(s *Server) {
+		s.handshakeError = handshakeError
+	})
+}