MM-70280 Applying dedup on channel subscription posts #1339
+359
−18
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| // Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved. | ||
| // See LICENSE.txt for license information. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "sync" | ||
| "sync/atomic" | ||
| "testing" | ||
| "time" | ||
|
|
||
| jira "github.com/andygrunwald/go-jira" | ||
| "github.com/mattermost/mattermost/server/public/model" | ||
| "github.com/mattermost/mattermost/server/public/plugin/plugintest" | ||
| "github.com/mattermost/mattermost/server/public/plugin/plugintest/mock" | ||
| "github.com/mattermost/mattermost/server/public/pluginapi" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func newTestChannelWebhook() *webhook { | ||
| return &webhook{ | ||
| JiraWebhook: &JiraWebhook{ | ||
| Issue: jira.Issue{ID: "10001", Key: "PROJ-1"}, | ||
| }, | ||
| headline: "Actor **commented** on PROJ-1", | ||
| } | ||
| } | ||
|
|
||
| // isDedupClaimOptions matches the KV options PostToChannel's dedup claim must | ||
| // use: an atomic write (no old value expected, since the key shouldn't yet | ||
| // exist) with the shared webhook dedup TTL. | ||
| func isDedupClaimOptions(opts model.PluginKVSetOptions) bool { | ||
| return opts.Atomic && opts.OldValue == nil && opts.ExpireInSeconds == int64(webhookDedupTTL/time.Second) | ||
| } | ||
|
|
||
| func TestPostToChannelDeduplicatesConcurrentDeliveries(t *testing.T) { | ||
| t.Run("concurrent deliveries for the same channel post only once", func(t *testing.T) { | ||
| api := &plugintest.API{} | ||
|
|
||
| var kvWinners atomic.Int32 | ||
| api.On("KVSetWithOptions", mock.AnythingOfType("string"), mock.Anything, mock.MatchedBy(isDedupClaimOptions)).Return(func(string, []byte, model.PluginKVSetOptions) (bool, *model.AppError) { | ||
|
Contributor
There was a problem hiding this comment. This stub matches the key with A map based fake makes them real tho var mu sync.Mutex
claimed := map[string]bool{}
api.On("KVSetWithOptions", mock.AnythingOfType("string"), mock.Anything, mock.MatchedBy(isDedupClaimOptions)).
Return(func(key string, _ []byte, _ model.PluginKVSetOptions) (bool, *model.AppError) {
mu.Lock()
defer mu.Unlock()
if claimed[key] {
return false, nil
}
claimed[key] = true
return true, nil
}) |
||
| if kvWinners.Add(1) == 1 { | ||
| return true, nil | ||
| } | ||
| return false, nil | ||
| }) | ||
| api.On("CreatePost", mock.AnythingOfType("*model.Post")).Return(&model.Post{Id: "post1"}, nil).Once() | ||
| api.On("LogDebug", mockAnythingOfTypeBatch("string", 3)...).Return() | ||
|
|
||
| p := &Plugin{} | ||
| p.SetAPI(api) | ||
| p.client = pluginapi.NewClient(api, p.Driver) | ||
|
|
||
| const callers = 25 | ||
| var wg sync.WaitGroup | ||
| wg.Add(callers) | ||
| start := make(chan struct{}) | ||
| for i := 0; i < callers; i++ { | ||
| go func() { | ||
| defer wg.Done() | ||
| <-start | ||
| _, _, err := newTestChannelWebhook().PostToChannel(p, "instance-1", "channel-1", "bot-user-id", "") | ||
| require.NoError(t, err) | ||
| }() | ||
| } | ||
| close(start) | ||
| wg.Wait() | ||
|
|
||
| api.AssertExpectations(t) | ||
| }) | ||
|
|
||
| t.Run("overlapping subscriptions on the same channel still post only once", func(t *testing.T) { | ||
| // Two subscriptions on the same channel produce identical webhook content | ||
| // but different subscription names; the dedup key must ignore the name. | ||
| api := &plugintest.API{} | ||
| var kvWinners atomic.Int32 | ||
| api.On("KVSetWithOptions", mock.AnythingOfType("string"), mock.Anything, mock.MatchedBy(isDedupClaimOptions)).Return(func(string, []byte, model.PluginKVSetOptions) (bool, *model.AppError) { | ||
| if kvWinners.Add(1) == 1 { | ||
| return true, nil | ||
| } | ||
| return false, nil | ||
| }).Twice() | ||
| api.On("CreatePost", mock.AnythingOfType("*model.Post")).Return(&model.Post{Id: "post1"}, nil).Once() | ||
| api.On("LogDebug", mockAnythingOfTypeBatch("string", 3)...).Return().Once() | ||
|
|
||
| p := &Plugin{} | ||
| p.SetAPI(api) | ||
| p.client = pluginapi.NewClient(api, p.Driver) | ||
|
|
||
| _, _, err := newTestChannelWebhook().PostToChannel(p, "instance-1", "channel-1", "bot-user-id", "subscription-a") | ||
| require.NoError(t, err) | ||
|
|
||
| post, _, err := newTestChannelWebhook().PostToChannel(p, "instance-1", "channel-1", "bot-user-id", "subscription-b") | ||
| require.NoError(t, err) | ||
| require.Nil(t, post) | ||
|
|
||
| api.AssertExpectations(t) | ||
| }) | ||
|
|
||
| t.Run("different channels each get their own post", func(t *testing.T) { | ||
| api := &plugintest.API{} | ||
| api.On("KVSetWithOptions", mock.AnythingOfType("string"), mock.Anything, mock.MatchedBy(isDedupClaimOptions)).Return(true, (*model.AppError)(nil)).Twice() | ||
|
Contributor
There was a problem hiding this comment. Same issue as the stub in the first subtest: this always returns |
||
| api.On("CreatePost", mock.AnythingOfType("*model.Post")).Return(&model.Post{Id: "post1"}, nil).Twice() | ||
|
|
||
| p := &Plugin{} | ||
| p.SetAPI(api) | ||
| p.client = pluginapi.NewClient(api, p.Driver) | ||
|
|
||
| _, _, err := newTestChannelWebhook().PostToChannel(p, "instance-1", "channel-1", "bot-user-id", "") | ||
| require.NoError(t, err) | ||
| _, _, err = newTestChannelWebhook().PostToChannel(p, "instance-1", "channel-2", "bot-user-id", "") | ||
| require.NoError(t, err) | ||
|
|
||
| api.AssertExpectations(t) | ||
| }) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The dedup key is claimed here but never released if CreatePost fails a few lines below. If the first of several duplicate deliveries claims the key and then fails to post some deliveries are skipped and the event is lost.
Suggest releasing the claim on the failure path when
claimedis true:PostNotifications has the same gap so a shared
releaseDedupKeyhelper may be cleaner than duplicating this.