Merge pull request #15 from WqyJh/feat-ping

feat: support websocket ping

Author: WqyJh

conn.go

@@ -58,6 +58,11 @@ func (c *Conn) ReadMessage(ctx context.Context) (ServerEvent, error) {
 	return event, nil
 }
 
+// Ping sends a ping message to the WebSocket connection.
+func (c *Conn) Ping(ctx context.Context) error {
+	return c.conn.Ping(ctx)
+}
+
 // ConnHandler is a handler for a connection to the OpenAI Realtime API.
 // It reads messages from the server in a standalone goroutine and calls the registered handlers.
 // It is the responsibility of the caller to call Start and Stop.

conn_test.go

@@ -22,6 +22,7 @@ type mockWebSocketConn struct {
 	writeMessageFunc func(ctx context.Context, messageType openairt.MessageType, data []byte) error
 	closeFunc        func() error
 	responseFunc     func() *http.Response
+	pingFunc         func(ctx context.Context) error
 }
 
 func (m *mockWebSocketConn) ReadMessage(ctx context.Context) (openairt.MessageType, []byte, error) {
@@ -40,6 +41,10 @@ func (m *mockWebSocketConn) Response() *http.Response {
 	return m.responseFunc()
 }
 
+func (m *mockWebSocketConn) Ping(ctx context.Context) error {
+	return m.pingFunc(ctx)
+}
+
 func TestConnect(t *testing.T) {
 	token := "mock-token"
 	model := "test-model"

contrib/ws-gorilla/go.mod

@@ -5,7 +5,7 @@ go 1.19
 // replace github.com/WqyJh/go-openai-realtime => ../../
 
 require (
-	github.com/WqyJh/go-openai-realtime v0.2.0-beta.2
+	github.com/WqyJh/go-openai-realtime v0.3.5-0.20250208091501-af3079f3fb2b
 	github.com/gorilla/websocket v1.5.3
 	github.com/stretchr/testify v1.9.0
 )
@@ -14,6 +14,5 @@ require (
 	github.com/coder/websocket v1.8.12 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/sashabaranov/go-openai v1.32.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

contrib/ws-gorilla/go.sum

@@ -1,5 +1,5 @@
-github.com/WqyJh/go-openai-realtime v0.2.0-beta.2 h1:4xD7O/IN5dQD2gKsiPzP1Prdu5HtCy25CChXep9kaIs=
-github.com/WqyJh/go-openai-realtime v0.2.0-beta.2/go.mod h1:nmUYODacQuObuh0DFSEIDfJM9L4ZFDRU/OEGYMryt60=
+github.com/WqyJh/go-openai-realtime v0.3.5-0.20250208091501-af3079f3fb2b h1:8teuz/JaWkMaqBrlIKF86EhHi0ajbJrm+shD1IXCvK8=
+github.com/WqyJh/go-openai-realtime v0.3.5-0.20250208091501-af3079f3fb2b/go.mod h1:nmUYODacQuObuh0DFSEIDfJM9L4ZFDRU/OEGYMryt60=
 github.com/coder/websocket v1.8.12 h1:5bUXkEPPIbewrnkU8LTCLVaxi4N4J8ahufH2vlo4NAo=
 github.com/coder/websocket v1.8.12/go.mod h1:LNVeNrXQZfe5qhS9ALED3uA+l5pPqvwXg3CKoDBB2gs=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
@@ -9,7 +9,6 @@ github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/ad
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/sashabaranov/go-openai v1.32.0 h1:Yk3iE9moX3RBXxrof3OBtUBrE7qZR0zF9ebsoO4zVzI=
-github.com/sashabaranov/go-openai v1.32.0/go.mod h1:lj5b/K+zjTSFxVLijLSTDZuP7adOgerWeFyZLUhAKRg=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=

contrib/ws-gorilla/ws_gorilla.go

@@ -118,3 +118,14 @@ func (c *WebSocketConn) Close() error {
 func (c *WebSocketConn) Response() *http.Response {
 	return c.resp
 }
+
+// Ping sends a ping message to the WebSocket connection.
+// It won't be blocked until the pong message is received.
+func (c *WebSocketConn) Ping(ctx context.Context) error {
+	deadline, ok := ctx.Deadline()
+	if ok {
+		_ = c.conn.SetWriteDeadline(deadline)
+	}
+
+	return c.conn.WriteControl(websocket.PingMessage, []byte{}, deadline)
+}

examples/go.mod

@@ -3,7 +3,7 @@ module github.com/WqyJh/go-openai-realtime/examples
 go 1.19
 
 require (
-	github.com/WqyJh/go-openai-realtime v0.3.0-alpha
+	github.com/WqyJh/go-openai-realtime v0.3.5-0.20250208091501-af3079f3fb2b
 	github.com/faiface/beep v1.1.0
 	github.com/gordonklaus/portaudio v0.0.0-20230709114228-aafa478834f5
 	github.com/sashabaranov/go-openai v1.32.0

examples/go.sum

@@ -1,6 +1,6 @@
 github.com/DATA-DOG/go-sqlmock v1.3.3/go.mod h1:f/Ixk793poVmq4qj/V1dPUg2JEAKC73Q5eFN3EC/SaM=
-github.com/WqyJh/go-openai-realtime v0.3.0-alpha h1:2IDh9xm3VLAXnmOtbOhv2/ytMceJYgj7Cw0e1TbqBpY=
-github.com/WqyJh/go-openai-realtime v0.3.0-alpha/go.mod h1:nmUYODacQuObuh0DFSEIDfJM9L4ZFDRU/OEGYMryt60=
+github.com/WqyJh/go-openai-realtime v0.3.5-0.20250208091501-af3079f3fb2b h1:8teuz/JaWkMaqBrlIKF86EhHi0ajbJrm+shD1IXCvK8=
+github.com/WqyJh/go-openai-realtime v0.3.5-0.20250208091501-af3079f3fb2b/go.mod h1:nmUYODacQuObuh0DFSEIDfJM9L4ZFDRU/OEGYMryt60=
 github.com/coder/websocket v1.8.12 h1:5bUXkEPPIbewrnkU8LTCLVaxi4N4J8ahufH2vlo4NAo=
 github.com/coder/websocket v1.8.12/go.mod h1:LNVeNrXQZfe5qhS9ALED3uA+l5pPqvwXg3CKoDBB2gs=
 github.com/d4l3k/messagediff v1.2.2-0.20190829033028-7e0a312ae40b/go.mod h1:Oozbb1TVXFac9FtSIxHBMnBCq2qeH/2KkEQxENCrlLo=

examples/text-only/main.go

@@ -6,6 +6,8 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"sync"
+	"time"
 
 	openairt "github.com/WqyJh/go-openai-realtime"
 )
@@ -19,6 +21,8 @@ func main() {
 		log.Fatal(err)
 	}
 
+	var sendLock sync.Mutex
+
 	// Teletype response
 	responseDeltaHandler := func(ctx context.Context, event openairt.ServerEvent) {
 		switch event.ServerEventType() {
@@ -48,6 +52,24 @@ func main() {
 		log.Fatal(err)
 	}
 
+	go func() {
+		for {
+			select {
+			case <-ctx.Done():
+				return
+			case <-time.After(30 * time.Second):
+				sendLock.Lock()
+				err := conn.Ping(ctx)
+				sendLock.Unlock()
+				if err != nil {
+					log.Printf("ping error: %v", err)
+				} else {
+					log.Printf("ping success")
+				}
+			}
+		}
+	}()
+
 	fmt.Println("Conversation")
 	fmt.Println("---------------------")
 	fmt.Print("> ")
@@ -56,6 +78,7 @@ func main() {
 		if s.Text() == "exit" || s.Text() == "quit" {
 			break
 		}
+		sendLock.Lock()
 		conn.SendMessage(ctx, &openairt.ConversationItemCreateEvent{
 			Item: openairt.MessageItem{
 				ID:     openairt.GenerateID("msg_", 10),
@@ -76,6 +99,7 @@ func main() {
 				MaxOutputTokens: 4000,
 			},
 		})
+		sendLock.Unlock()
 	}
 	conn.Close()
 	err = <-connHandler.Err()

ws.go

@@ -54,6 +54,9 @@ type WebSocketConn interface {
 	// Response returns the *http.Response of the WebSocket connection.
 	// Commonly used to get response headers.
 	Response() *http.Response
+
+	// Ping sends a ping message to the WebSocket connection.
+	Ping(ctx context.Context) error
 }
 
 // WebSocketDialer is a WebSocket connection dialer abstraction.

ws_coder.go

@@ -128,3 +128,9 @@ func (c *CoderWebSocketConn) Close() error {
 func (c *CoderWebSocketConn) Response() *http.Response {
 	return c.resp
 }
+
+// Ping sends a ping message to the WebSocket connection.
+// It would be blocked until the pong message is received or the ctx is done.
+func (c *CoderWebSocketConn) Ping(ctx context.Context) error {
+	return c.conn.Ping(ctx)
+}