refactor: unify Redis-related types and reduce duplication

- Removed redundant Redis-related types (Packet, Request, Response) from multiple files - Centralized definitions of RedisPacket, RedisRequest, and RedisResponse in the `types` package
zishang520 · Oct 11, 2024 · 883b793 · 883b793
1 parent f59e0a7
commit 883b793
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 46 deletions.
diff --git a/adapter/redis-adapter-type.go b/adapter/redis-adapter-type.go
@@ -6,25 +6,15 @@ import (
 
 	"github.com/zishang520/engine.io/v2/types"
 	"github.com/zishang520/engine.io/v2/utils"
-	"github.com/zishang520/socket.io-go-parser/v2/parser"
 	_types "github.com/zishang520/socket.io-go-redis/types"
 	"github.com/zishang520/socket.io/v2/adapter"
 	"github.com/zishang520/socket.io/v2/socket"
 )
 
 type (
-	Request struct {
-		Type      adapter.MessageType    `json:"type,omitempty" msgpack:"type,omitempty"`
-		RequestId string                 `json:"requestId,omitempty" msgpack:"requestId,omitempty"`
-		Rooms     []socket.Room          `json:"rooms,omitempty" msgpack:"rooms,omitempty"`
-		Opts      *adapter.PacketOptions `json:"opts,omitempty" msgpack:"opts,omitempty"`
-		Sid       socket.SocketId        `json:"sid,omitempty" msgpack:"sid,omitempty"`
-		Room      socket.Room            `json:"room,omitempty" msgpack:"room,omitempty"`
-		Close     bool                   `json:"close,omitempty" msgpack:"close,omitempty"`
-		Uid       adapter.ServerId       `json:"uid,omitempty" msgpack:"uid,omitempty"`
-		Data      []any                  `json:"data,omitempty" msgpack:"data,omitempty"`
-		Packet    *parser.Packet         `json:"packet,omitempty" msgpack:"packet,omitempty"`
-	}
+	Packet = _types.RedisPacket
+
+	Request = _types.RedisRequest
 
 	RedisRequest struct {
 		Type      adapter.MessageType
@@ -37,15 +27,7 @@ type (
 		Responses *types.Slice[any]
 	}
 
-	Response struct {
-		Type        adapter.MessageType       `json:"type,omitempty" msgpack:"type,omitempty"`
-		RequestId   string                    `json:"requestId,omitempty" msgpack:"requestId,omitempty"`
-		Rooms       []socket.Room             `json:"rooms,omitempty" msgpack:"rooms,omitempty"`
-		Sockets     []*adapter.SocketResponse `json:"sockets,omitempty" msgpack:"sockets,omitempty"`
-		Data        []any                     `json:"data,omitempty" msgpack:"data,omitempty"`
-		ClientCount uint64                    `json:"clientcount,omitempty" msgpack:"clientcount,omitempty"`
-		Packet      []any                     `json:"packet,omitempty" msgpack:"packet,omitempty"`
-	}
+	Response = _types.RedisResponse
 
 	AckRequest = adapter.ClusterAckRequest
 

diff --git a/adapter/redis-adapter.go b/adapter/redis-adapter.go
@@ -209,7 +209,7 @@ func (r *redisAdapter) onMessage(pattern string, channel string, msg []byte) {
 		return
 	}
 
-	var packet *_types.Packet
+	var packet *Packet
 	if err := r.parser.Decode(msg, &packet); err != nil {
 		redis_log.Debug("error decoding message: %v", err)
 		return
@@ -581,7 +581,7 @@ func (r *redisAdapter) Broadcast(packet *parser.Packet, opts *socket.BroadcastOp
 	onlyLocal := opts != nil && opts.Flags != nil && opts.Flags.Local
 
 	if !onlyLocal {
-		if msg, err := r.parser.Encode(&_types.Packet{
+		if msg, err := r.parser.Encode(&Packet{
 			Uid:    r.Uid(),
 			Packet: packet,
 			Opts:   adapter.EncodeOptions(opts),

diff --git a/emitter/broadcast-operator.go b/emitter/broadcast-operator.go
@@ -126,7 +126,7 @@ func (b *BroadcastOperator) Emit(ev string, args ...any) error {
 		Flags:  b.flags,
 	}
 
-	msg, err := b.broadcastOptions.Parser.Encode(&_types.Packet{
+	msg, err := b.broadcastOptions.Parser.Encode(&Packet{
 		Uid:    UID,
 		Packet: packet,
 		Opts:   opts,
@@ -150,7 +150,7 @@ func (b *BroadcastOperator) Emit(ev string, args ...any) error {
 
 // Makes the matching socket instances join the specified rooms
 func (b *BroadcastOperator) SocketsJoin(rooms ...socket.Room) error {
-	request, err := json.Marshal(&EmitMessage{
+	request, err := json.Marshal(&Request{
 		Type: _types.REMOTE_JOIN,
 		Opts: &adapter.PacketOptions{
 			Rooms:  b.rooms.Keys(),
@@ -167,7 +167,7 @@ func (b *BroadcastOperator) SocketsJoin(rooms ...socket.Room) error {
 
 // Makes the matching socket instances leave the specified rooms
 func (b *BroadcastOperator) SocketsLeave(rooms ...socket.Room) error {
-	request, err := json.Marshal(&EmitMessage{
+	request, err := json.Marshal(&Request{
 		Type: _types.REMOTE_LEAVE,
 		Opts: &adapter.PacketOptions{
 			Rooms:  b.rooms.Keys(),
@@ -184,7 +184,7 @@ func (b *BroadcastOperator) SocketsLeave(rooms ...socket.Room) error {
 
 // Makes the matching socket instances disconnect
 func (b *BroadcastOperator) DisconnectSockets(state bool) error {
-	request, err := json.Marshal(&EmitMessage{
+	request, err := json.Marshal(&Request{
 		Type: _types.REMOTE_DISCONNECT,
 		Opts: &adapter.PacketOptions{
 			Rooms:  b.rooms.Keys(),

diff --git a/emitter/emitter-type.go b/emitter/emitter-type.go
@@ -2,8 +2,6 @@ package emitter
 
 import (
 	"github.com/zishang520/socket.io-go-redis/types"
-	"github.com/zishang520/socket.io/v2/adapter"
-	"github.com/zishang520/socket.io/v2/socket"
 )
 
 type (
@@ -14,16 +12,9 @@ type (
 		Parser           types.Parser
 	}
 
-	EmitMessage struct {
-		Type  adapter.MessageType    `json:"type,omitempty" msgpack:"type,omitempty"`
-		Opts  *adapter.PacketOptions `json:"opts,omitempty" msgpack:"opts,omitempty"`
-		Close bool                   `json:"close,omitempty" msgpack:"close,omitempty"`
-		Rooms []socket.Room          `json:"rooms,omitempty" msgpack:"rooms,omitempty"`
-	}
+	Packet = types.RedisPacket
 
-	ServerSideEmitMessage struct {
-		Uid  adapter.ServerId    `json:"uid,omitempty" msgpack:"uid,omitempty"`
-		Type adapter.MessageType `json:"type,omitempty" msgpack:"type,omitempty"`
-		Data []any               `json:"data,omitempty" msgpack:"data,omitempty"`
-	}
+	Request = types.RedisRequest
+
+	Response = types.RedisResponse
 )
diff --git a/emitter/emitter.go b/emitter/emitter.go
@@ -124,7 +124,7 @@ func (e *Emitter) ServerSideEmit(args ...any) error {
 			return errors.New("Acknowledgements are not supported")
 		}
 	}
-	request, err := json.Marshal(&ServerSideEmitMessage{
+	request, err := json.Marshal(&Request{
 		Uid:  UID,
 		Type: types.SERVER_SIDE_EMIT,
 		Data: args,

diff --git a/emitter/emitter_test.go b/emitter/emitter_test.go
@@ -37,7 +37,7 @@ func TestEmitter(t *testing.T) {
 	redisClient := types.NewRedisClient(context.TODO(), redis.NewClient(&redis.Options{
 		Addr:     "localhost:6379",
 		Username: "",
-		Password: "",
+		Password: "root",
 		DB:       0,
 	}))
 
@@ -101,7 +101,7 @@ func TestBroadcastOperator(t *testing.T) {
 	redisClient := types.NewRedisClient(context.TODO(), redis.NewClient(&redis.Options{
 		Addr:     "localhost:6379",
 		Username: "",
-		Password: "",
+		Password: "root",
 		DB:       0,
 	}))
 
@@ -114,7 +114,7 @@ func TestBroadcastOperator(t *testing.T) {
 
 	t.Run("Emit", func(t *testing.T) {
 		if err := b.Emit("test", "data", "data"); err != nil {
-			t.Fatal(`emit.Emit() value must be nil`)
+			t.Fatalf(`emit.Emit() value must be nil: %v`, err)
 		}
 	})
 

diff --git a/types/type.go b/types/type.go
@@ -3,15 +3,39 @@ package types
 import (
 	"github.com/zishang520/socket.io-go-parser/v2/parser"
 	"github.com/zishang520/socket.io/v2/adapter"
+	"github.com/zishang520/socket.io/v2/socket"
 )
 
 type (
-	Packet struct {
+	RedisPacket struct {
 		Uid    adapter.ServerId       `json:"uid,omitempty" msgpack:"uid,omitempty"`
 		Packet *parser.Packet         `json:"packet,omitempty" msgpack:"packet,omitempty"`
 		Opts   *adapter.PacketOptions `json:"opts,omitempty" msgpack:"opts,omitempty"`
 	}
 
+	RedisRequest struct {
+		Type      adapter.MessageType    `json:"type,omitempty" msgpack:"type,omitempty"`
+		RequestId string                 `json:"requestId,omitempty" msgpack:"requestId,omitempty"`
+		Rooms     []socket.Room          `json:"rooms,omitempty" msgpack:"rooms,omitempty"`
+		Opts      *adapter.PacketOptions `json:"opts,omitempty" msgpack:"opts,omitempty"`
+		Sid       socket.SocketId        `json:"sid,omitempty" msgpack:"sid,omitempty"`
+		Room      socket.Room            `json:"room,omitempty" msgpack:"room,omitempty"`
+		Close     bool                   `json:"close,omitempty" msgpack:"close,omitempty"`
+		Uid       adapter.ServerId       `json:"uid,omitempty" msgpack:"uid,omitempty"`
+		Data      []any                  `json:"data,omitempty" msgpack:"data,omitempty"`
+		Packet    *parser.Packet         `json:"packet,omitempty" msgpack:"packet,omitempty"`
+	}
+
+	RedisResponse struct {
+		Type        adapter.MessageType       `json:"type,omitempty" msgpack:"type,omitempty"`
+		RequestId   string                    `json:"requestId,omitempty" msgpack:"requestId,omitempty"`
+		Rooms       []socket.Room             `json:"rooms,omitempty" msgpack:"rooms,omitempty"`
+		Sockets     []*adapter.SocketResponse `json:"sockets,omitempty" msgpack:"sockets,omitempty"`
+		Data        []any                     `json:"data,omitempty" msgpack:"data,omitempty"`
+		ClientCount uint64                    `json:"clientcount,omitempty" msgpack:"clientcount,omitempty"`
+		Packet      []any                     `json:"packet,omitempty" msgpack:"packet,omitempty"`
+	}
+
 	Parser interface {
 		Encode(any) ([]byte, error)
 		Decode([]byte, any) error