mirror of
https://github.com/mattermost/mattermost.git
synced 2026-05-28 04:35:04 -04:00
5566604e03
* MM-68838: ping restored plugin remote immediately on re-register RegisterPluginForSharedChannels' restore branch updated the row but did not call PingNow, leaving the restored remote offline until the next pingLoop tick (up to PingFreq, default 1 minute). The new-connection branch already calls PingNow; the restore branch now mirrors it so sync attempts immediately after a plugin restart no longer fail with "offline remote cluster". * MM-68838: gob-encode error returns in apiRPCServer.ReceiveSharedChannelAttachmentSyncMsg The apiRPCServer wrapper for ReceiveSharedChannelAttachmentSyncMsg assigned the hook's error return directly to the gob-encoded response struct. When the framework's App.ReceiveSharedChannelAttachmentSyncMsg returned an error wrapped with %w (*fmt.wrapError, an unexported type), gob refused to encode it and the RPC server broke the connection with "type not registered for interface: fmt.wrapError". Every subsequent plugin/server RPC call then returned the zero-value response struct, causing plugins that dereferenced the nil returns to crash. Apply the existing encodableError() helper so the returned error becomes a gob-safe ErrorString, matching every other apiRPCServer method in this file.
46 lines
1.8 KiB
Go
46 lines
1.8 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/gob"
|
|
"errors"
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// TestReceiveSharedChannelAttachmentSyncMsgReturns_GobRoundTrip pins the fix
|
|
// for the gob-encoding bug in apiRPCServer.ReceiveSharedChannelAttachmentSyncMsg.
|
|
// The hook may return errors wrapped with fmt.Errorf("...%w", err), producing
|
|
// values of the unexported type *fmt.wrapError that gob refuses to encode.
|
|
// The RPC server must run the error through encodableError before assigning
|
|
// it to the returns struct. Without that, the RPC connection breaks and
|
|
// every subsequent plugin to server call returns zero values.
|
|
func TestReceiveSharedChannelAttachmentSyncMsgReturns_GobRoundTrip(t *testing.T) {
|
|
wrapped := fmt.Errorf("attachment sync failed: %w", errors.New("upstream boom"))
|
|
|
|
t.Run("raw wrapped error fails to gob-encode (reproduces the bug)", func(t *testing.T) {
|
|
returns := Z_ReceiveSharedChannelAttachmentSyncMsgReturns{B: wrapped}
|
|
|
|
var buf bytes.Buffer
|
|
err := gob.NewEncoder(&buf).Encode(&returns)
|
|
require.Error(t, err, "raw *fmt.wrapError must not be gob-encodable; if this assertion ever fails the bug guarded by encodableError no longer exists")
|
|
require.Contains(t, err.Error(), "fmt.wrapError")
|
|
})
|
|
|
|
t.Run("encodableError-wrapped error round-trips through gob", func(t *testing.T) {
|
|
returns := Z_ReceiveSharedChannelAttachmentSyncMsgReturns{B: encodableError(wrapped)}
|
|
|
|
var buf bytes.Buffer
|
|
require.NoError(t, gob.NewEncoder(&buf).Encode(&returns))
|
|
|
|
var decoded Z_ReceiveSharedChannelAttachmentSyncMsgReturns
|
|
require.NoError(t, gob.NewDecoder(&buf).Decode(&decoded))
|
|
require.Error(t, decoded.B)
|
|
require.Equal(t, wrapped.Error(), decoded.B.Error())
|
|
})
|
|
}
|