upstream/mattermost
1
0
Fork 0
mirror of https://github.com/mattermost/mattermost.git synced 2026-02-18 18:18:23 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Unexport fields in WebSocketEvent (#17912)

Browse source 
Automatic Merge
This commit is contained in:
Agniva De Sarker 2021-07-13 20:05:02 +05:30 committed by Claudio Costa
parent f49b5dc440
commit f35b025bea
5 changed files with 61 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
api4/channel_test.go
View file

@ -2501,8 +2501,8 @@ func TestUpdateChannelMemberSchemeRoles(t *testing.T) {
for waiting {
select {
case event := <-WebSocketClient.EventChannel:
if event.Event == model.WebsocketEventChannelMemberUpdated {
require.Equal(t, model.WebsocketEventChannelMemberUpdated, event.Event)
if event.EventType() == model.WebsocketEventChannelMemberUpdated {
require.Equal(t, model.WebsocketEventChannelMemberUpdated, event.EventType())
waiting = false
}
case <-timeout:

4
api4/post_test.go
View file

@ -167,8 +167,8 @@ func TestCreatePost(t *testing.T) {
for eventsToGo > 0 {
select {
case event := <-WebSocketClient.EventChannel:
if event.Event == model.WebsocketEventEphemeralMessage {
require.Equal(t, model.WebsocketEventEphemeralMessage, event.Event)
if event.EventType() == model.WebsocketEventEphemeralMessage {
require.Equal(t, model.WebsocketEventEphemeralMessage, event.EventType())
eventsToGo = eventsToGo - 1
}
case <-timeout:

2
app/web_conn_test.go
View file

@ -256,7 +256,7 @@ func TestWebConnDrainDeadQueue(t *testing.T) {
_, buf, err = conn.ReadMessage()
ev := model.WebSocketEventFromJson(bytes.NewReader(buf))
require.LessOrEqual(t, int(i), limit)
assert.Equal(t, i, ev.Sequence)
assert.Equal(t, i, ev.GetSequence())
i++
}
if _, ok := err.(*websocket.CloseError); !ok {

83
model/websocket_message.go
View file

@ -105,13 +105,11 @@ type webSocketEventJSON struct {
Sequence int64 `json:"seq"`
}
// **NOTE**: Direct access to WebSocketEvent fields is deprecated. They will be
// made unexported in next major version release. Provided getter functions should be used instead.
type WebSocketEvent struct {
Event string // Deprecated: use EventType()
Data map[string]interface{} // Deprecated: use GetData()
Broadcast *WebsocketBroadcast // Deprecated: use GetBroadcast()
Sequence int64 // Deprecated: use GetSequence()
event string
data map[string]interface{}
broadcast *WebsocketBroadcast
sequence int64
precomputedJSON *precomputedWebSocketEventJSON
}
@ -119,9 +117,9 @@ type WebSocketEvent struct {
// This makes ToJson much more efficient when sending the same event to multiple connections.
func (ev *WebSocketEvent) PrecomputeJSON() *WebSocketEvent {
copy := ev.Copy()
event, _ := json.Marshal(copy.Event)
data, _ := json.Marshal(copy.Data)
broadcast, _ := json.Marshal(copy.Broadcast)
event, _ := json.Marshal(copy.event)
data, _ := json.Marshal(copy.data)
broadcast, _ := json.Marshal(copy.broadcast)
copy.precomputedJSON = &precomputedWebSocketEventJSON{
Event: json.RawMessage(event),
Data: json.RawMessage(data),
@ -131,78 +129,85 @@ func (ev *WebSocketEvent) PrecomputeJSON() *WebSocketEvent {
}
func (ev *WebSocketEvent) Add(key string, value interface{}) {
ev.Data[key] = value
ev.data[key] = value
}
func NewWebSocketEvent(event, teamId, channelId, userId string, omitUsers map[string]bool) *WebSocketEvent {
return &WebSocketEvent{Event: event, Data: make(map[string]interface{}),
Broadcast: &WebsocketBroadcast{TeamId: teamId, ChannelId: channelId, UserId: userId, OmitUsers: omitUsers}}
return &WebSocketEvent{
event: event,
data: make(map[string]interface{}),
broadcast: &WebsocketBroadcast{
TeamId: teamId,
ChannelId: channelId,
UserId: userId,
OmitUsers: omitUsers},
}
}
func (ev *WebSocketEvent) Copy() *WebSocketEvent {
copy := &WebSocketEvent{
Event: ev.Event,
Data: ev.Data,
Broadcast: ev.Broadcast,
Sequence: ev.Sequence,
event: ev.event,
data: ev.data,
broadcast: ev.broadcast,
sequence: ev.sequence,
precomputedJSON: ev.precomputedJSON,
}
return copy
}
func (ev *WebSocketEvent) GetData() map[string]interface{} {
return ev.Data
return ev.data
}
func (ev *WebSocketEvent) GetBroadcast() *WebsocketBroadcast {
return ev.Broadcast
return ev.broadcast
}
func (ev *WebSocketEvent) GetSequence() int64 {
return ev.Sequence
return ev.sequence
}
func (ev *WebSocketEvent) SetEvent(event string) *WebSocketEvent {
copy := ev.Copy()
copy.Event = event
copy.event = event
return copy
}
func (ev *WebSocketEvent) SetData(data map[string]interface{}) *WebSocketEvent {
copy := ev.Copy()
copy.Data = data
copy.data = data
return copy
}
func (ev *WebSocketEvent) SetBroadcast(broadcast *WebsocketBroadcast) *WebSocketEvent {
copy := ev.Copy()
copy.Broadcast = broadcast
copy.broadcast = broadcast
return copy
}
func (ev *WebSocketEvent) SetSequence(seq int64) *WebSocketEvent {
copy := ev.Copy()
copy.Sequence = seq
copy.sequence = seq
return copy
}
func (ev *WebSocketEvent) IsValid() bool {
return ev.Event != ""
return ev.event != ""
}
func (ev *WebSocketEvent) EventType() string {
return ev.Event
return ev.event
}
func (ev *WebSocketEvent) ToJson() string {
if ev.precomputedJSON != nil {
return fmt.Sprintf(`{"event": %s, "data": %s, "broadcast": %s, "seq": %d}`, ev.precomputedJSON.Event, ev.precomputedJSON.Data, ev.precomputedJSON.Broadcast, ev.Sequence)
return fmt.Sprintf(`{"event": %s, "data": %s, "broadcast": %s, "seq": %d}`, ev.precomputedJSON.Event, ev.precomputedJSON.Data, ev.precomputedJSON.Broadcast, ev.GetSequence())
}
b, _ := json.Marshal(webSocketEventJSON{
ev.Event,
ev.Data,
ev.Broadcast,
ev.Sequence,
ev.event,
ev.data,
ev.broadcast,
ev.sequence,
})
return string(b)
}
@ -211,15 +216,15 @@ func (ev *WebSocketEvent) ToJson() string {
func (ev *WebSocketEvent) Encode(enc *json.Encoder) error {
if ev.precomputedJSON != nil {
return enc.Encode(json.RawMessage(
fmt.Sprintf(`{"event": %s, "data": %s, "broadcast": %s, "seq": %d}`, ev.precomputedJSON.Event, ev.precomputedJSON.Data, ev.precomputedJSON.Broadcast, ev.Sequence),
fmt.Sprintf(`{"event": %s, "data": %s, "broadcast": %s, "seq": %d}`, ev.precomputedJSON.Event, ev.precomputedJSON.Data, ev.precomputedJSON.Broadcast, ev.sequence),
))
}
return enc.Encode(webSocketEventJSON{
ev.Event,
ev.Data,
ev.Broadcast,
ev.Sequence,
ev.event,
ev.data,
ev.broadcast,
ev.sequence,
})
}
@ -229,7 +234,7 @@ func WebSocketEventFromJson(data io.Reader) *WebSocketEvent {
if err := json.NewDecoder(data).Decode(&o); err != nil {
return nil
}
ev.Event = o.Event
ev.event = o.Event
if u, ok := o.Data["user"]; ok {
// We need to convert to and from JSON again
// because the user is in the form of a map[string]interface{}.
@ -239,9 +244,9 @@ func WebSocketEventFromJson(data io.Reader) *WebSocketEvent {
}
o.Data["user"] = UserFromJson(bytes.NewReader(buf))
}
ev.Data = o.Data
ev.Broadcast = o.Broadcast
ev.Sequence = o.Sequence
ev.data = o.Data
ev.broadcast = o.Broadcast
ev.sequence = o.Sequence
return &ev
}

27
model/websocket_message_test.go
View file

@ -35,26 +35,23 @@ func TestWebSocketEventImmutable(t *testing.T) {
if new == m {
require.Fail(t, "pointers should not be the same")
}
require.NotEqual(t, m.Event, new.Event)
require.Equal(t, new.Event, "new_event")
require.Equal(t, new.Event, new.EventType())
require.NotEqual(t, m.EventType(), new.EventType())
require.Equal(t, new.EventType(), "new_event")
new = m.SetSequence(45)
if new == m {
require.Fail(t, "pointers should not be the same")
}
require.NotEqual(t, m.Sequence, new.Sequence)
require.Equal(t, new.Sequence, int64(45))
require.Equal(t, new.Sequence, new.GetSequence())
require.NotEqual(t, m.GetSequence(), new.GetSequence())
require.Equal(t, new.GetSequence(), int64(45))
broadcast := &WebsocketBroadcast{}
new = m.SetBroadcast(broadcast)
if new == m {
require.Fail(t, "pointers should not be the same")
}
require.NotEqual(t, m.Broadcast, new.Broadcast)
require.Equal(t, new.Broadcast, broadcast)
require.Equal(t, new.Broadcast, new.GetBroadcast())
require.NotEqual(t, m.GetBroadcast(), new.GetBroadcast())
require.Equal(t, new.GetBroadcast(), broadcast)
data := map[string]interface{}{
"key": "val",
@ -65,8 +62,8 @@ func TestWebSocketEventImmutable(t *testing.T) {
require.Fail(t, "pointers should not be the same")
}
require.NotEqual(t, m, new)
require.Equal(t, new.Data, data)
require.Equal(t, new.Data, new.GetData())
require.Equal(t, new.data, data)
require.Equal(t, new.data, new.GetData())
copy := m.Copy()
if copy == m {
@ -81,10 +78,10 @@ func TestWebSocketEventFromJson(t *testing.T) {
data := `{"event": "test", "data": {"key": "val"}, "seq": 45, "broadcast": {"user_id": "userid"}}`
ev = WebSocketEventFromJson(strings.NewReader(data))
require.NotNil(t, ev, "should have parsed")
require.Equal(t, ev.Event, "test")
require.Equal(t, ev.Sequence, int64(45))
require.Equal(t, ev.Data, map[string]interface{}{"key": "val"})
require.Equal(t, ev.Broadcast, &WebsocketBroadcast{UserId: "userid"})
require.Equal(t, ev.EventType(), "test")
require.Equal(t, ev.GetSequence(), int64(45))
require.Equal(t, ev.data, map[string]interface{}{"key": "val"})
require.Equal(t, ev.GetBroadcast(), &WebsocketBroadcast{UserId: "userid"})
}
func TestWebSocketResponse(t *testing.T) {