Panic fix on gorilla ws when connection lost.

fix linter errors with shadow checking
upgrade linter

.github/workflows/lint.yml

@@ -12,16 +12,16 @@ permissions:
 jobs:
  golangci:
  permissions:
- contents: read  # for actions/checkout to fetch code
- pull-requests: read  # for golangci/golangci-lint-action to fetch pull requests
+ contents: read # for actions/checkout to fetch code
+ pull-requests: read # for golangci/golangci-lint-action to fetch pull requests
  name: lint
  runs-on: ubuntu-latest
  steps:
- - uses: actions/setup-go@v3
+ - uses: actions/setup-go@v5
  with:
- go-version: '>=1.18'
- - uses: actions/checkout@v3
+ go-version: ">=1.18"
+ - uses: actions/checkout@v4
  - name: golangci-lint
- uses: golangci/golangci-lint-action@v3
+ uses: golangci/golangci-lint-action@v5
  with:
  args: --timeout=5m

.golangci.yml

@@ -34,15 +34,16 @@ linters-settings:
  - condition
  - return
  ignored-numbers:
- - '0'
- - '1'
- - '2'
- - '3'
+ - "0"
+ - "1"
+ - "2"
+ - "3"
  ignored-functions:
  - strings.SplitN
 
  govet:
- check-shadowing: true
+ enable:
+ - shadow
  lll:
  line-length: 140
  misspell:

db.go

@@ -32,6 +32,12 @@ func New(url string, connection conn.Connection) (*DB, error) {
  return &DB{connection}, nil
 }
 
+// Initialize initializes the connection to the database.
+// Can return an error if the connection fails on runtime.
+func (db *DB) Initialize() error {
+ return db.conn.Initialize()
+}
+
 // --------------------------------------------------
 // Public methods
 // --------------------------------------------------

db_test.go

@@ -121,6 +121,15 @@ func (s *SurrealDBTestSuite) openConnection() *surrealdb.DB {
  impl := s.connImplementations[s.name]
  require.NotNil(s.T(), impl)
  db, err := surrealdb.New(url, impl)
+
+ go func(s *SurrealDBTestSuite) {
+ connErr := db.Initialize()
+ if connErr != nil {
+ fmt.Println(connErr)
+ require.NoError(s.T(), connErr)
+ }
+ }(s)
+
  s.Require().NoError(err)
  return db
 }

internal/mock/mock.go

@@ -7,13 +7,16 @@ import (
  "github.com/surrealdb/surrealdb.go/pkg/model"
 )
 
-type ws struct {
-}
+type ws struct{}
 
 func (w *ws) Connect(url string) (conn.Connection, error) {
  return w, nil
 }
 
+func (w *ws) Initialize() error {
+ return nil
+}
+
 func (w *ws) Send(method string, params []interface{}) (interface{}, error) {
  return nil, nil
 }

pkg/conn/conn.go

@@ -4,6 +4,7 @@ import "github.com/surrealdb/surrealdb.go/pkg/model"
 
 type Connection interface {
  Connect(url string) (Connection, error)
+ Initialize() error
  Send(method string, params []interface{}) (interface{}, error)
  Close() error
  LiveNotifications(id string) (chan model.Notification, error)

pkg/conn/gorilla/gorilla.go

@@ -4,6 +4,7 @@ import (
  "encoding/json"
  "errors"
  "fmt"
+ "io"
  "net"
  "reflect"
  "strconv"
@@ -73,10 +74,13 @@ func (ws *WebSocket) Connect(url string) (conn.Connection, error) {
  }
  }
 
- ws.initialize()
  return ws, nil
 }
 
+func (ws *WebSocket) Initialize() error {
+ return ws.initialize()
+}
+
 func (ws *WebSocket) SetTimeOut(timeout time.Duration) *WebSocket {
  ws.Option = append(ws.Option, func(ws *WebSocket) error {
  ws.Timeout = timeout
@@ -234,26 +238,29 @@ func (ws *WebSocket) write(v interface{}) error {
  return ws.Conn.WriteMessage(gorilla.TextMessage, data)
 }
 
-func (ws *WebSocket) initialize() {
- go func() {
- for {
- select {
- case <-ws.close:
- return
- default:
- var res rpc.RPCResponse
- err := ws.read(&res)
- if err != nil {
- if errors.Is(err, net.ErrClosed) {
- break
- }
- ws.logger.Error(err.Error())
- continue
+func (ws *WebSocket) initialize() error {
+ for {
+ select {
+ case <-ws.close:
+ return nil
+ default:
+ var res rpc.RPCResponse
+ err := ws.read(&res)
+ if err != nil {
+ // this needed because gorilla not shudown gracefully
+ if errors.Is(err, net.ErrClosed) {
+ return nil
+ }
+ // returns error if connection drop in fly
+ if gorilla.IsUnexpectedCloseError(err) {
+ return io.ErrClosedPipe
  }
- go ws.handleResponse(res)
+ ws.logger.Error(err.Error())
+ continue
  }
+ go ws.handleResponse(res)
  }
- }()
+ }
 }
 
 func (ws *WebSocket) handleResponse(res rpc.RPCResponse) {