snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

server/public/model/cluster_message.go

@@ -0,0 +1,140 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package model
+
+import (
+	"encoding/json"
+
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
+)
+
+type ClusterEvent string
+
+const (
+	ClusterEventNone                                        ClusterEvent = "none"
+	ClusterEventPublish                                     ClusterEvent = "publish"
+	ClusterEventUpdateStatus                                ClusterEvent = "update_status"
+	ClusterEventInvalidateAllCaches                         ClusterEvent = "inv_all_caches"
+	ClusterEventInvalidateCacheForReactions                 ClusterEvent = "inv_reactions"
+	ClusterEventInvalidateCacheForChannelMembersNotifyProps ClusterEvent = "inv_channel_members_notify_props"
+	ClusterEventInvalidateCacheForChannelByName             ClusterEvent = "inv_channel_name"
+	ClusterEventInvalidateCacheForChannel                   ClusterEvent = "inv_channel"
+	ClusterEventInvalidateCacheForChannelGuestCount         ClusterEvent = "inv_channel_guest_count"
+	ClusterEventInvalidateCacheForUser                      ClusterEvent = "inv_user"
+	ClusterEventInvalidateWebConnCacheForUser               ClusterEvent = "inv_user_teams"
+	ClusterEventClearSessionCacheForUser                    ClusterEvent = "clear_session_user"
+	ClusterEventInvalidateCacheForRoles                     ClusterEvent = "inv_roles"
+	ClusterEventInvalidateCacheForRolePermissions           ClusterEvent = "inv_role_permissions"
+	ClusterEventInvalidateCacheForProfileByIds              ClusterEvent = "inv_profile_ids"
+	ClusterEventInvalidateCacheForAllProfiles               ClusterEvent = "inv_all_profiles"
+	ClusterEventInvalidateCacheForProfileInChannel          ClusterEvent = "inv_profile_in_channel"
+	ClusterEventInvalidateCacheForSchemes                   ClusterEvent = "inv_schemes"
+	ClusterEventInvalidateCacheForFileInfos                 ClusterEvent = "inv_file_infos"
+	ClusterEventInvalidateCacheForWebhooks                  ClusterEvent = "inv_webhooks"
+	ClusterEventInvalidateCacheForEmojisById                ClusterEvent = "inv_emojis_by_id"
+	ClusterEventInvalidateCacheForEmojisIdByName            ClusterEvent = "inv_emojis_id_by_name"
+	ClusterEventInvalidateCacheForChannelFileCount          ClusterEvent = "inv_channel_file_count"
+	ClusterEventInvalidateCacheForChannelPinnedpostsCounts  ClusterEvent = "inv_channel_pinnedposts_counts"
+	ClusterEventInvalidateCacheForChannelMemberCounts       ClusterEvent = "inv_channel_member_counts"
+	ClusterEventInvalidateCacheForChannelsMemberCount       ClusterEvent = "inv_channels_member_count"
+	ClusterEventInvalidateCacheForLastPosts                 ClusterEvent = "inv_last_posts"
+	ClusterEventInvalidateCacheForLastPostTime              ClusterEvent = "inv_last_post_time"
+	ClusterEventInvalidateCacheForPostsUsage                ClusterEvent = "inv_posts_usage"
+	ClusterEventInvalidateCacheForTeams                     ClusterEvent = "inv_teams"
+	ClusterEventInvalidateCacheForContentFlagging           ClusterEvent = "inv_content_flagging"
+	ClusterEventInvalidateCacheForDeliveryTracking          ClusterEvent = "inv_delivery_tracking"
+	ClusterEventInvalidateCacheForSessionAttributes         ClusterEvent = "inv_session_attributes"
+	ClusterEventUpdateSessionAttributes                     ClusterEvent = "update_session_attributes"
+	ClusterEventInvalidateCacheForPropertyFields            ClusterEvent = "inv_property_fields"
+	ClusterEventInvalidateCacheForAutoTranslation           ClusterEvent = "inv_autotranslation"
+	ClusterEventInvalidateCacheForReadReceipts              ClusterEvent = "inv_read_receipts"
+	ClusterEventInvalidateCacheForTemporaryPosts            ClusterEvent = "inv_temporary_posts"
+	ClusterEventClearSessionCacheForAllUsers                ClusterEvent = "inv_all_user_sessions"
+	ClusterEventInstallPlugin                               ClusterEvent = "install_plugin"
+	ClusterEventRemovePlugin                                ClusterEvent = "remove_plugin"
+	ClusterEventPluginEvent                                 ClusterEvent = "plugin_event"
+	ClusterEventInvalidateCacheForTermsOfService            ClusterEvent = "inv_terms_of_service"
+	ClusterEventInvalidateCacheForUserAutoTranslation       ClusterEvent = "inv_user_autotranslation"
+	ClusterEventInvalidateCacheForPostTranslationEtag       ClusterEvent = "inv_post_translation_etag"
+	ClusterEventInvalidateCacheForAccessControlPolicyEtag   ClusterEvent = "inv_access_control_policy_etag"
+	ClusterEventInvalidateCacheForUserPropertyValuesEpoch   ClusterEvent = "inv_user_property_values_epoch"
+	ClusterEventAutoTranslationTask                         ClusterEvent = "autotranslation_task"
+	ClusterEventBusyStateChanged                            ClusterEvent = "busy_state_change"
+	// Note: if you are adding a new event, please also add it in the slice of
+	// m.ClusterEventMap in metrics/metrics.go file.
+
+	// Gossip communication
+	ClusterGossipEventRequestGetLogs                = "gossip_request_get_logs"
+	ClusterGossipEventResponseGetLogs               = "gossip_response_get_logs"
+	ClusterGossipEventRequestGenerateSupportPacket  = "gossip_request_generate_support_packet"
+	ClusterGossipEventResponseGenerateSupportPacket = "gossip_response_generate_support_packet"
+	ClusterGossipEventRequestGetClusterStats        = "gossip_request_cluster_stats"
+	ClusterGossipEventResponseGetClusterStats       = "gossip_response_cluster_stats"
+	ClusterGossipEventRequestGetPluginStatuses      = "gossip_request_plugin_statuses"
+	ClusterGossipEventResponseGetPluginStatuses     = "gossip_response_plugin_statuses"
+	ClusterGossipEventRequestSaveConfig             = "gossip_request_save_config"
+	ClusterGossipEventResponseSaveConfig            = "gossip_response_save_config"
+	ClusterGossipEventRequestWebConnCount           = "gossip_request_webconn_count"
+	ClusterGossipEventResponseWebConnCount          = "gossip_response_webconn_count"
+	ClusterGossipEventRequestWSQueues               = "gossip_request_ws_queues"
+	ClusterGossipEventResponseWSQueues              = "gossip_response_ws_queues"
+
+	// SendTypes for ClusterMessage.
+	ClusterSendBestEffort = "best_effort"
+	ClusterSendReliable   = "reliable"
+)
+
+type ClusterMessage struct {
+	Event            ClusterEvent      `json:"event"`
+	SendType         string            `json:"-"`
+	WaitForAllToSend bool              `json:"-"`
+	Data             []byte            `json:"data,omitempty"`
+	Props            map[string]string `json:"props,omitempty"`
+}
+
+// LogFields returns structured log fields describing the message.
+// For ClusterEventPublish, it partially unmarshals Data to extract WebSocket
+// event context. This is intentionally called only on error paths.
+func (m *ClusterMessage) LogFields() []mlog.Field {
+	fields := []mlog.Field{
+		mlog.String("event", string(m.Event)),
+		mlog.String("send_type", m.SendType),
+		mlog.Int("data_len", len(m.Data)),
+	}
+
+	switch m.Event {
+	case ClusterEventPublish:
+		var header struct {
+			Event     string `json:"event"`
+			Broadcast struct {
+				ChannelId string          `json:"channel_id"`
+				TeamId    string          `json:"team_id"`
+				OmitUsers map[string]bool `json:"omit_users"`
+			} `json:"broadcast"`
+		}
+		if err := json.Unmarshal(m.Data, &header); err == nil {
+			if header.Event != "" {
+				fields = append(fields, mlog.String("ws_event", header.Event))
+			}
+			if header.Broadcast.ChannelId != "" {
+				fields = append(fields, mlog.String("channel_id", header.Broadcast.ChannelId))
+			}
+			if header.Broadcast.TeamId != "" {
+				fields = append(fields, mlog.String("team_id", header.Broadcast.TeamId))
+			}
+			if n := len(header.Broadcast.OmitUsers); n > 0 {
+				fields = append(fields, mlog.Int("omit_users_len", n))
+			}
+		}
+	case ClusterEventPluginEvent:
+		if pluginID := m.Props["PluginID"]; pluginID != "" {
+			fields = append(fields, mlog.String("plugin_id", pluginID))
+		}
+		if eventID := m.Props["EventID"]; eventID != "" {
+			fields = append(fields, mlog.String("event_id", eventID))
+		}
+	}
+
+	return fields
+}