From 1714af2b01103134e35fbc337709fdc4c966cf10 Mon Sep 17 00:00:00 2001
From: Ben Schumacher <ben.schumacher@mattermost.com>
Date: Thu, 2 Mar 2023 19:59:23 +0100
Subject: [PATCH] Add plugin cluster event method

---
 client.go       |  4 +++-
 cluster.go      | 23 +++++++++++++++++++++++
 cluster_test.go | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 75 insertions(+), 1 deletion(-)
 create mode 100644 cluster.go
 create mode 100644 cluster_test.go

diff --git a/client.go b/client.go
index 44ded1d..04c34f3 100644
--- a/client.go
+++ b/client.go
@@ -11,8 +11,9 @@ type Client struct {
 	api plugin.API
 
 	Bot           BotService
-	Configuration ConfigurationService
 	Channel       ChannelService
+	Cluster       ClusterService
+	Configuration ConfigurationService
 	SlashCommand  SlashCommandService
 	OAuth         OAuthService
 	Emoji         EmojiService
@@ -41,6 +42,7 @@ func NewClient(api plugin.API, driver plugin.Driver) *Client {
 
 		Bot:           BotService{api: api},
 		Channel:       ChannelService{api: api},
+		Cluster:       ClusterService{api: api},
 		Configuration: ConfigurationService{api: api},
 		SlashCommand:  SlashCommandService{api: api},
 		OAuth:         OAuthService{api: api},
diff --git a/cluster.go b/cluster.go
new file mode 100644
index 0000000..09a58e3
--- /dev/null
+++ b/cluster.go
@@ -0,0 +1,23 @@
+package pluginapi
+
+import (
+	"github.com/mattermost/mattermost-server/v6/model"
+	"github.com/mattermost/mattermost-server/v6/plugin"
+)
+
+// ClusterService exposes methods to interact with cluster nodes.
+type ClusterService struct {
+	api plugin.API
+}
+
+// ClusterService broadcasts a plugin event to all other running instances of
+// the calling plugin that are present in the cluster.
+//
+// This method is used to allow plugin communication in a High-Availability cluster.
+// The receiving side should implement the OnPluginClusterEvent hook
+// to receive events sent through this method.
+//
+// Minimum server version: 5.36
+func (c *ClusterService) PublishPluginEvent(ev model.PluginClusterEvent, opts model.PluginClusterEventSendOptions) error {
+	return c.api.PublishPluginClusterEvent(ev, opts)
+}
diff --git a/cluster_test.go b/cluster_test.go
new file mode 100644
index 0000000..68041ad
--- /dev/null
+++ b/cluster_test.go
@@ -0,0 +1,49 @@
+package pluginapi_test
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/mattermost/mattermost-server/v6/model"
+	"github.com/mattermost/mattermost-server/v6/plugin/plugintest"
+
+	pluginapi "github.com/mattermost/mattermost-plugin-api"
+)
+
+func TestPublishPluginClusterEvent(t *testing.T) {
+	t.Run("success", func(t *testing.T) {
+		api := &plugintest.API{}
+		defer api.AssertExpectations(t)
+		client := pluginapi.NewClient(api, &plugintest.Driver{})
+
+		api.On("PublishPluginClusterEvent",
+			model.PluginClusterEvent{Id: "someID", Data: []byte("foo")},
+			model.PluginClusterEventSendOptions{SendType: model.PluginClusterEventSendTypeReliable},
+		).Return(nil)
+
+		err := client.Cluster.PublishPluginEvent(
+			model.PluginClusterEvent{Id: "someID", Data: []byte("foo")},
+			model.PluginClusterEventSendOptions{SendType: model.PluginClusterEventSendTypeReliable},
+		)
+		require.NoError(t, err)
+	})
+
+	t.Run("failure", func(t *testing.T) {
+		api := &plugintest.API{}
+		defer api.AssertExpectations(t)
+		client := pluginapi.NewClient(api, &plugintest.Driver{})
+
+		api.On("PublishPluginClusterEvent",
+			model.PluginClusterEvent{Id: "someID", Data: []byte("foo")},
+			model.PluginClusterEventSendOptions{SendType: model.PluginClusterEventSendTypeReliable},
+		).Return(errors.New("someError"))
+
+		err := client.Cluster.PublishPluginEvent(
+			model.PluginClusterEvent{Id: "someID", Data: []byte("foo")},
+			model.PluginClusterEventSendOptions{SendType: model.PluginClusterEventSendTypeReliable},
+		)
+		require.Error(t, err)
+	})
+}