mirror of
https://github.com/hanzoai/team.git
synced 2026-09-30 01:57:35 +00:00
Harrison HealeyandGitHub
96a31d15f2
* MM-54238 Initial implementation * MM-54238 Move websocket hook into app package * MM-54238 Add tests for mentions in posted websocket messages * Fix styling * Fix other styling * Idiomatic ID naming for new code * Fix more styles * Separate hooks to add mentions and followers * Improved error handling for invalid types in hooks * Rename HasChanges to ShouldProcess * Pass broadcast hooks through hubStart * Add test helper for asserting json unmarshaling * Fix missing arguments in tests * Ensure broadcast hooks are sent across the cluster and not to users * Ensure tests actually cover following a post * Fix code broken by merge * Go vet again... * Deep copy event before processing it with hooks * Replace RemoveBroadcastHooks with WithoutBroadcastHooks * Address feedback * Add helper to fix type information for hook args * Wrap WebSocketEvent and simplify BroadcastHook * Address feedback * Address feedback
207 lines
5.5 KiB
Go
207 lines
5.5 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package platform
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/mattermost/mattermost/server/public/model"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
const broadcastTest = "test_broadcast_hook"
|
|
|
|
type testBroadcastHook struct{}
|
|
|
|
func (h *testBroadcastHook) Process(msg *HookedWebSocketEvent, webConn *WebConn, args map[string]any) error {
|
|
if args["makes_changes"].(bool) {
|
|
changesMade, _ := msg.Get("changes_made").(int)
|
|
msg.Add("changes_made", changesMade+1)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func TestRunBroadcastHooks(t *testing.T) {
|
|
hub := &Hub{
|
|
broadcastHooks: map[string]BroadcastHook{
|
|
broadcastTest: &testBroadcastHook{},
|
|
},
|
|
}
|
|
webConn := &WebConn{}
|
|
|
|
t.Run("should not allocate a new object when no hooks are passed", func(t *testing.T) {
|
|
event := model.NewWebSocketEvent(model.WebsocketEventPosted, "", "", "", nil, "")
|
|
|
|
result := hub.runBroadcastHooks(event, webConn, nil, nil)
|
|
|
|
assert.Same(t, event, result)
|
|
})
|
|
|
|
t.Run("should not allocate a new object when a hook is not making changes", func(t *testing.T) {
|
|
event := model.NewWebSocketEvent(model.WebsocketEventPosted, "", "", "", nil, "")
|
|
|
|
hookIDs := []string{
|
|
broadcastTest,
|
|
}
|
|
hookArgs := []map[string]any{
|
|
{
|
|
"makes_changes": false,
|
|
},
|
|
}
|
|
|
|
result := hub.runBroadcastHooks(event, webConn, hookIDs, hookArgs)
|
|
|
|
assert.Same(t, event, result)
|
|
})
|
|
|
|
t.Run("should allocate a new object and remove when a hook makes changes", func(t *testing.T) {
|
|
event := model.NewWebSocketEvent(model.WebsocketEventPosted, "", "", "", nil, "")
|
|
|
|
hookIDs := []string{
|
|
broadcastTest,
|
|
}
|
|
hookArgs := []map[string]any{
|
|
{
|
|
"makes_changes": true,
|
|
},
|
|
}
|
|
|
|
result := hub.runBroadcastHooks(event, webConn, hookIDs, hookArgs)
|
|
|
|
assert.NotSame(t, event, result)
|
|
assert.NotSame(t, event.GetData(), result.GetData())
|
|
assert.Equal(t, map[string]any{}, event.GetData())
|
|
assert.Equal(t, result.GetData(), map[string]any{
|
|
"changes_made": 1,
|
|
})
|
|
})
|
|
|
|
t.Run("should not allocate a new object when multiple hooks are not making changes", func(t *testing.T) {
|
|
event := model.NewWebSocketEvent(model.WebsocketEventPosted, "", "", "", nil, "")
|
|
|
|
hookIDs := []string{
|
|
broadcastTest,
|
|
broadcastTest,
|
|
broadcastTest,
|
|
}
|
|
hookArgs := []map[string]any{
|
|
{
|
|
"makes_changes": false,
|
|
},
|
|
{
|
|
"makes_changes": false,
|
|
},
|
|
{
|
|
"makes_changes": false,
|
|
},
|
|
}
|
|
|
|
result := hub.runBroadcastHooks(event, webConn, hookIDs, hookArgs)
|
|
|
|
assert.Same(t, event, result)
|
|
})
|
|
|
|
t.Run("should be able to make changes from only one of make hooks", func(t *testing.T) {
|
|
event := model.NewWebSocketEvent(model.WebsocketEventPosted, "", "", "", nil, "")
|
|
|
|
var hookIDs []string
|
|
var hookArgs []map[string]any
|
|
for i := 0; i < 10; i++ {
|
|
hookIDs = append(hookIDs, broadcastTest)
|
|
hookArgs = append(hookArgs, map[string]any{
|
|
"makes_changes": i == 6,
|
|
})
|
|
}
|
|
|
|
result := hub.runBroadcastHooks(event, webConn, hookIDs, hookArgs)
|
|
|
|
assert.NotSame(t, event, result)
|
|
assert.NotSame(t, event.GetData(), result.GetData())
|
|
assert.Equal(t, event.GetData(), map[string]any{})
|
|
assert.Equal(t, result.GetData(), map[string]any{
|
|
"changes_made": 1,
|
|
})
|
|
})
|
|
|
|
t.Run("should be able to make changes from multiple hooks", func(t *testing.T) {
|
|
event := model.NewWebSocketEvent(model.WebsocketEventPosted, "", "", "", nil, "")
|
|
|
|
var hookIDs []string
|
|
var hookArgs []map[string]any
|
|
for i := 0; i < 10; i++ {
|
|
hookIDs = append(hookIDs, broadcastTest)
|
|
hookArgs = append(hookArgs, map[string]any{
|
|
"makes_changes": true,
|
|
})
|
|
}
|
|
|
|
result := hub.runBroadcastHooks(event, webConn, hookIDs, hookArgs)
|
|
|
|
assert.NotSame(t, event, result)
|
|
assert.NotSame(t, event.GetData(), result.GetData())
|
|
assert.Equal(t, event.GetData(), map[string]any{})
|
|
assert.Equal(t, result.GetData(), map[string]any{
|
|
"changes_made": 10,
|
|
})
|
|
})
|
|
|
|
t.Run("should not remove precomputed JSON when a hook doesn't make changes", func(t *testing.T) {
|
|
event := model.NewWebSocketEvent(model.WebsocketEventPosted, "", "", "", nil, "")
|
|
event = event.PrecomputeJSON()
|
|
|
|
// Ensure that the event has precomputed JSON because changes aren't included when ToJSON is called again
|
|
originalJSON, _ := event.ToJSON()
|
|
event.Add("data", 1234)
|
|
eventJSON, _ := event.ToJSON()
|
|
require.Equal(t, string(originalJSON), string(eventJSON))
|
|
|
|
hookIDs := []string{
|
|
broadcastTest,
|
|
}
|
|
hookArgs := []map[string]any{
|
|
{
|
|
"makes_changes": false,
|
|
},
|
|
}
|
|
|
|
result := hub.runBroadcastHooks(event, webConn, hookIDs, hookArgs)
|
|
|
|
eventJSON, _ = event.ToJSON()
|
|
assert.Equal(t, string(originalJSON), string(eventJSON))
|
|
|
|
resultJSON, _ := result.ToJSON()
|
|
assert.Equal(t, originalJSON, resultJSON)
|
|
})
|
|
|
|
t.Run("should remove precomputed JSON when a hook makes changes", func(t *testing.T) {
|
|
event := model.NewWebSocketEvent(model.WebsocketEventPosted, "", "", "", nil, "")
|
|
event = event.PrecomputeJSON()
|
|
|
|
// Ensure that the event has precomputed JSON because changes aren't included when ToJSON is called again
|
|
originalJSON, _ := event.ToJSON()
|
|
event.Add("data", 1234)
|
|
eventJSON, _ := event.ToJSON()
|
|
require.Equal(t, originalJSON, eventJSON)
|
|
|
|
hookIDs := []string{
|
|
broadcastTest,
|
|
}
|
|
hookArgs := []map[string]any{
|
|
{
|
|
"makes_changes": true,
|
|
},
|
|
}
|
|
|
|
result := hub.runBroadcastHooks(event, webConn, hookIDs, hookArgs)
|
|
|
|
eventJSON, _ = event.ToJSON()
|
|
assert.Equal(t, string(originalJSON), string(eventJSON))
|
|
|
|
resultJSON, _ := result.ToJSON()
|
|
assert.NotEqual(t, originalJSON, resultJSON)
|
|
})
|
|
}
|