MM-21987 Resolve mentions in slash commands (#13762)
* Create infrastructure to manage mentions
Two new files have been added (along with their tests); namely:
- model/at_mentions.go: utilities to parse and manage mentions; for the moment,
it just contains a regex and a couple of functions to parse possible mentions
and to post-process them, but it can be extended in the future.
- model/mention_map.go: it contains two new types (UserMentionMap and
ChannelMentionMap) that both have FromURLValues and ToURLValues. These types
can be used when adding the mentions to the payload of the plugin slash
commands.
* Extend custom commands payload with mentions
Two couples of new fields are added to the payload; namely:
- user_mentions and user_mentions_ids: two aligned arrays of the same length
containing all the different @-mentions found in the command: the i-th element
of user_mentions_ids is the user identifier of the i-th element of
user_mentions.
- channel_mentions and channel_mentions_ids: two aligned arrays of the same
length containing all the different ~-mentions found in the command: the i-th
element of channel_mentions_ids is the channel identifier of the i-th element
of channel_mentions.
* Fix shadowing of variables and redundant return
* Fix shadowing of variable
* Address review comments (HT @lieut-data)
- Improvements in mentionsToTeamMembers and mentionsToPublicChannels:
- Scope implementation details inside the functions.
- Improve goroutines synchronization by using a sync.WaitGroup.
- Retry lookup of username only if the returned error is http.StatusCode,
so we can return early if the error is more severe.
- Invert check in PossibleAtMentions to improve readability.
- Make user and channel mention keys private to the module.
- Allow the specification of an empty map of mentions in
(Channel|User)MentionsFromURLValues when both mentions keys are absent.
- Replace custom functions in tests with require.Equal on maps.
* Test functions to parse mentions from messages
* Extend plugin commands payload with mentions
* Add functions to CommandArgs to add mentions
The functions make sure that the maps are initialized before adding any value.
* Address review comments (HT @lieut-data)
- Adds a mlog.Warn to avoid burying the error when the user is not found.
- Improve readability in loop populating the mention map by moving the
initialization of the map closer to the loop and by iterating over the channel
itself, not over its length.
* File was not gofmt-ed with -s
* Close channel when all goroutines are finished
* Again, all code should be checked with gofmt -s
* Refactor code out of a goroutine
This change helps improve the readability of the code and does not affect its
overall performance. Less complexity is always better.
* Close channel and iterate over its range
Adapt mentionsToPublicChannels to have the same structure in the management
of the mentions channel as in mentionsToTeamMembers.
* Adapt mentionsToTeamMembers to new App
Commit 17523fa changed the App structure, making the *Server field
private, which is now accessed through the Srv() function.
Co-authored-by: mattermod <mattermod@users.noreply.github.com>
Этот коммит содержится в:
Alejandro García Montoro
коммит произвёл
GitHub
GitHub
родитель
5d928b4f94
Коммит
2bec92a404
235
model/mention_map_test.go
Обычный файл
235
model/mention_map_test.go
Обычный файл
@@ -0,0 +1,235 @@
|
||||
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
||||
// See LICENSE.txt for license information.
|
||||
|
||||
package model
|
||||
|
||||
import (
|
||||
"net/url"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestUserMentionMapFromURLValues(t *testing.T) {
|
||||
fixture := []struct {
|
||||
values url.Values
|
||||
expected UserMentionMap
|
||||
error bool
|
||||
}{
|
||||
{
|
||||
url.Values{},
|
||||
UserMentionMap{},
|
||||
false,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
userMentionsKey: []string{},
|
||||
userMentionsIdsKey: []string{},
|
||||
},
|
||||
UserMentionMap{},
|
||||
false,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
userMentionsKey: []string{"one", "two", "three"},
|
||||
userMentionsIdsKey: []string{"oneId", "twoId", "threeId"},
|
||||
},
|
||||
UserMentionMap{
|
||||
"one": "oneId",
|
||||
"two": "twoId",
|
||||
"three": "threeId",
|
||||
},
|
||||
false,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
"wrongKey": []string{"one", "two", "three"},
|
||||
userMentionsIdsKey: []string{"oneId", "twoId", "threeId"},
|
||||
},
|
||||
nil,
|
||||
true,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
userMentionsKey: []string{"one", "two", "three"},
|
||||
"wrongKey": []string{"oneId", "twoId", "threeId"},
|
||||
},
|
||||
nil,
|
||||
true,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
userMentionsKey: []string{"one", "two"},
|
||||
userMentionsIdsKey: []string{"justone"},
|
||||
},
|
||||
nil,
|
||||
true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, data := range fixture {
|
||||
actualMap, actualError := UserMentionMapFromURLValues(data.values)
|
||||
if data.error {
|
||||
require.Error(t, actualError)
|
||||
require.Nil(t, actualMap)
|
||||
} else {
|
||||
require.NoError(t, actualError)
|
||||
require.Equal(t, actualMap, data.expected)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestUserMentionMap_ToURLValues(t *testing.T) {
|
||||
fixture := []struct {
|
||||
mentionMap UserMentionMap
|
||||
expected url.Values
|
||||
}{
|
||||
{
|
||||
UserMentionMap{},
|
||||
url.Values{},
|
||||
},
|
||||
{
|
||||
UserMentionMap{"user": "id"},
|
||||
url.Values{
|
||||
userMentionsKey: []string{"user"},
|
||||
userMentionsIdsKey: []string{"id"},
|
||||
},
|
||||
},
|
||||
{
|
||||
UserMentionMap{"one": "id1", "two": "id2", "three": "id3"},
|
||||
url.Values{
|
||||
userMentionsKey: []string{"one", "two", "three"},
|
||||
userMentionsIdsKey: []string{"id1", "id2", "id3"},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, data := range fixture {
|
||||
actualValues := data.mentionMap.ToURLValues()
|
||||
|
||||
// require.EqualValues does not work here directly on the url.Values, as
|
||||
// the slices in the map values may be in different order; what we need to
|
||||
// check is that the pairs are preserved, which can be checked converting
|
||||
// back to a map with FromURLValues. We check that the test is well-formed
|
||||
// by converting back the expected url.Values too.
|
||||
require.Equal(t, len(actualValues), len(data.expected))
|
||||
|
||||
actualMentionMap, actualErr := UserMentionMapFromURLValues(actualValues)
|
||||
expectedMentionMap, expectedErr := UserMentionMapFromURLValues(data.expected)
|
||||
|
||||
require.Equal(t, actualErr, expectedErr)
|
||||
require.Equal(t, actualMentionMap, expectedMentionMap)
|
||||
}
|
||||
}
|
||||
|
||||
func TestChannelMentionMapFromURLValues(t *testing.T) {
|
||||
fixture := []struct {
|
||||
values url.Values
|
||||
expected ChannelMentionMap
|
||||
error bool
|
||||
}{
|
||||
{
|
||||
url.Values{},
|
||||
ChannelMentionMap{},
|
||||
false,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
channelMentionsKey: []string{},
|
||||
channelMentionsIdsKey: []string{},
|
||||
},
|
||||
ChannelMentionMap{},
|
||||
false,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
channelMentionsKey: []string{"one", "two", "three"},
|
||||
channelMentionsIdsKey: []string{"oneId", "twoId", "threeId"},
|
||||
},
|
||||
ChannelMentionMap{
|
||||
"one": "oneId",
|
||||
"two": "twoId",
|
||||
"three": "threeId",
|
||||
},
|
||||
false,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
"wrongKey": []string{"one", "two", "three"},
|
||||
channelMentionsIdsKey: []string{"oneId", "twoId", "threeId"},
|
||||
},
|
||||
nil,
|
||||
true,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
channelMentionsKey: []string{"one", "two", "three"},
|
||||
"wrongKey": []string{"oneId", "twoId", "threeId"},
|
||||
},
|
||||
nil,
|
||||
true,
|
||||
},
|
||||
{
|
||||
url.Values{
|
||||
channelMentionsKey: []string{"one", "two"},
|
||||
channelMentionsIdsKey: []string{"justone"},
|
||||
},
|
||||
nil,
|
||||
true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, data := range fixture {
|
||||
actualMap, actualError := ChannelMentionMapFromURLValues(data.values)
|
||||
if data.error {
|
||||
require.Error(t, actualError)
|
||||
require.Nil(t, actualMap)
|
||||
} else {
|
||||
require.NoError(t, actualError)
|
||||
require.Equal(t, actualMap, data.expected)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestChannelMentionMap_ToURLValues(t *testing.T) {
|
||||
fixture := []struct {
|
||||
mentionMap ChannelMentionMap
|
||||
expected url.Values
|
||||
}{
|
||||
{
|
||||
ChannelMentionMap{},
|
||||
url.Values{},
|
||||
},
|
||||
{
|
||||
ChannelMentionMap{"user": "id"},
|
||||
url.Values{
|
||||
channelMentionsKey: []string{"user"},
|
||||
channelMentionsIdsKey: []string{"id"},
|
||||
},
|
||||
},
|
||||
{
|
||||
ChannelMentionMap{"one": "id1", "two": "id2", "three": "id3"},
|
||||
url.Values{
|
||||
channelMentionsKey: []string{"one", "two", "three"},
|
||||
channelMentionsIdsKey: []string{"id1", "id2", "id3"},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, data := range fixture {
|
||||
actualValues := data.mentionMap.ToURLValues()
|
||||
|
||||
// require.EqualValues does not work here directly on the url.Values, as
|
||||
// the slices in the map values may be in different order; what we need to
|
||||
// check is that the pairs are preserved, which can be checked converting
|
||||
// back to a map with FromURLValues. We check that the test is well-formed
|
||||
// by converting back the expected url.Values too.
|
||||
require.Equal(t, len(actualValues), len(data.expected))
|
||||
|
||||
actualMentionMap, actualErr := ChannelMentionMapFromURLValues(actualValues)
|
||||
expectedMentionMap, expectedErr := ChannelMentionMapFromURLValues(data.expected)
|
||||
|
||||
require.Equal(t, actualErr, expectedErr)
|
||||
require.Equal(t, actualMentionMap, expectedMentionMap)
|
||||
}
|
||||
}
|
||||
Ссылка в новой задаче
Block a user