Add metric warning support (announcement bar and DM) (#14483)

* Admin. Advisory: Add warning for number of active users metric status

Co-authored-by: Catalin Tomai <catalin.tomai@mattermost.com>

model/bot.go

@@ -13,9 +13,10 @@ import (
 )
 
 const (
-	BOT_DISPLAY_NAME_MAX_RUNES = USER_FIRST_NAME_MAX_RUNES
-	BOT_DESCRIPTION_MAX_RUNES  = 1024
-	BOT_CREATOR_ID_MAX_RUNES   = KEY_VALUE_PLUGIN_ID_MAX_RUNES // UserId or PluginId
+	BOT_DISPLAY_NAME_MAX_RUNES   = USER_FIRST_NAME_MAX_RUNES
+	BOT_DESCRIPTION_MAX_RUNES    = 1024
+	BOT_CREATOR_ID_MAX_RUNES     = KEY_VALUE_PLUGIN_ID_MAX_RUNES // UserId or PluginId
+	BOT_WARN_METRIC_BOT_USERNAME = "mattermost-advisor"
 )
 
 // Bot is a special type of User meant for programmatic interactions.

model/config.go

@@ -47,6 +47,7 @@ const (
 	GENERIC_NO_CHANNEL_NOTIFICATION = "generic_no_channel"
 	GENERIC_NOTIFICATION            = "generic"
 	GENERIC_NOTIFICATION_SERVER     = "https://push-test.mattermost.com"
+	MM_SUPPORT_ADDRESS              = "support@mattermost.com"
 	FULL_NOTIFICATION               = "full"
 	ID_LOADED_NOTIFICATION          = "id_loaded"
 

model/post.go

@@ -64,6 +64,7 @@ const (
 
 	POST_PROPS_MENTION_HIGHLIGHT_DISABLED = "mentionHighlightDisabled"
 	POST_PROPS_GROUP_HIGHLIGHT_DISABLED   = "disable_group_highlight"
+	POST_SYSTEM_WARN_METRIC_STATUS        = "warn_metric_status"
 )
 
 var AT_MENTION_PATTEN = regexp.MustCompile(`\B@`)
@@ -312,7 +313,8 @@ func (o *Post) IsValid(maxPostSize int) *AppError {
 		POST_CHANNEL_RESTORED,
 		POST_CHANGE_CHANNEL_PRIVACY,
 		POST_ME,
-		POST_ADD_BOT_TEAMS_CHANNELS:
+		POST_ADD_BOT_TEAMS_CHANNELS,
+		POST_SYSTEM_WARN_METRIC_STATUS:
 	default:
 		if !strings.HasPrefix(o.Type, POST_CUSTOM_TYPE_PREFIX) {
 			return NewAppError("Post.IsValid", "model.post.is_valid.type.app_error", nil, "id="+o.Type, http.StatusBadRequest)

model/system.go

@@ -10,16 +10,26 @@ import (
 )
 
 const (
-	SYSTEM_DIAGNOSTIC_ID                  = "DiagnosticId"
-	SYSTEM_RAN_UNIT_TESTS                 = "RanUnitTests"
-	SYSTEM_LAST_SECURITY_TIME             = "LastSecurityTime"
-	SYSTEM_ACTIVE_LICENSE_ID              = "ActiveLicenseId"
-	SYSTEM_LAST_COMPLIANCE_TIME           = "LastComplianceTime"
-	SYSTEM_ASYMMETRIC_SIGNING_KEY         = "AsymmetricSigningKey"
-	SYSTEM_POST_ACTION_COOKIE_SECRET      = "PostActionCookieSecret"
-	SYSTEM_INSTALLATION_DATE_KEY          = "InstallationDate"
-	SYSTEM_FIRST_SERVER_RUN_TIMESTAMP_KEY = "FirstServerRunTimestamp"
-	SYSTEM_CLUSTER_ENCRYPTION_KEY         = "ClusterEncryptionKey"
+	SYSTEM_DIAGNOSTIC_ID                          = "DiagnosticId"
+	SYSTEM_RAN_UNIT_TESTS                         = "RanUnitTests"
+	SYSTEM_LAST_SECURITY_TIME                     = "LastSecurityTime"
+	SYSTEM_ACTIVE_LICENSE_ID                      = "ActiveLicenseId"
+	SYSTEM_LAST_COMPLIANCE_TIME                   = "LastComplianceTime"
+	SYSTEM_ASYMMETRIC_SIGNING_KEY                 = "AsymmetricSigningKey"
+	SYSTEM_POST_ACTION_COOKIE_SECRET              = "PostActionCookieSecret"
+	SYSTEM_INSTALLATION_DATE_KEY                  = "InstallationDate"
+	SYSTEM_FIRST_SERVER_RUN_TIMESTAMP_KEY         = "FirstServerRunTimestamp"
+	SYSTEM_CLUSTER_ENCRYPTION_KEY                 = "ClusterEncryptionKey"
+	SYSTEM_WARN_METRIC_NUMBER_OF_ACTIVE_USERS_200 = "warn_metric_number_of_active_users_200"
+	SYSTEM_WARN_METRIC_NUMBER_OF_ACTIVE_USERS_400 = "warn_metric_number_of_active_users_400"
+	SYSTEM_WARN_METRIC_NUMBER_OF_ACTIVE_USERS_500 = "warn_metric_number_of_active_users_500"
+)
+
+const (
+	WARN_METRIC_STATUS_LIMIT_REACHED = "true"
+	WARN_METRIC_STATUS_RUNONCE       = "runonce"
+	WARN_METRIC_STATUS_ACK           = "ack"
+	WARN_METRIC_STATUS_STORE_PREFIX  = "warn_metric_"
 )
 
 type System struct {
@@ -70,3 +80,78 @@ func ServerBusyStateFromJson(r io.Reader) *ServerBusyState {
 	json.NewDecoder(r).Decode(&sbs)
 	return sbs
 }
+
+var WarnMetricsTable = map[string]WarnMetric{
+	SYSTEM_WARN_METRIC_NUMBER_OF_ACTIVE_USERS_200: {
+		Id:        SYSTEM_WARN_METRIC_NUMBER_OF_ACTIVE_USERS_200,
+		Limit:     200,
+		IsBotOnly: true,
+		IsRunOnce: true,
+	},
+	SYSTEM_WARN_METRIC_NUMBER_OF_ACTIVE_USERS_400: {
+		Id:        SYSTEM_WARN_METRIC_NUMBER_OF_ACTIVE_USERS_400,
+		Limit:     400,
+		IsBotOnly: true,
+		IsRunOnce: true,
+	},
+	SYSTEM_WARN_METRIC_NUMBER_OF_ACTIVE_USERS_500: {
+		Id:        SYSTEM_WARN_METRIC_NUMBER_OF_ACTIVE_USERS_500,
+		Limit:     500,
+		IsBotOnly: false,
+		IsRunOnce: false,
+	},
+}
+
+type WarnMetric struct {
+	Id        string
+	Limit     int64
+	IsBotOnly bool
+	IsRunOnce bool
+}
+
+type WarnMetricDisplayTexts struct {
+	BotTitle       string
+	BotMessageBody string
+	BotMailToBody  string
+	EmailBody      string
+}
+type WarnMetricStatus struct {
+	Id          string `json:"id"`
+	Limit       int64  `json:"limit"`
+	Acked       bool   `json:"acked"`
+	StoreStatus string `json:"store_status,omitempty"`
+}
+
+func (wms *WarnMetricStatus) ToJson() string {
+	b, _ := json.Marshal(wms)
+	return string(b)
+}
+
+func WarnMetricStatusFromJson(data io.Reader) *WarnMetricStatus {
+	var o WarnMetricStatus
+	if err := json.NewDecoder(data).Decode(&o); err != nil {
+		return nil
+	} else {
+		return &o
+	}
+}
+
+func MapWarnMetricStatusToJson(o map[string]*WarnMetricStatus) string {
+	b, _ := json.Marshal(o)
+	return string(b)
+}
+
+type SendWarnMetricAck struct {
+	ForceAck bool `json:"forceAck"`
+}
+
+func (swma *SendWarnMetricAck) ToJson() string {
+	b, _ := json.Marshal(swma)
+	return string(b)
+}
+
+func SendWarnMetricAckFromJson(r io.Reader) *SendWarnMetricAck {
+	var swma *SendWarnMetricAck
+	json.NewDecoder(r).Decode(&swma)
+	return swma
+}

model/websocket_message.go

@@ -66,6 +66,8 @@ const (
 	WEBSOCKET_EVENT_SIDEBAR_CATEGORY_UPDATED                 = "sidebar_category_updated"
 	WEBSOCKET_EVENT_SIDEBAR_CATEGORY_DELETED                 = "sidebar_category_deleted"
 	WEBSOCKET_EVENT_SIDEBAR_CATEGORY_ORDER_UPDATED           = "sidebar_category_order_updated"
+	WEBSOCKET_WARN_METRIC_STATUS_RECEIVED                    = "warn_metric_status_received"
+	WEBSOCKET_WARN_METRIC_STATUS_REMOVED                     = "warn_metric_status_removed"
 )
 
 type WebSocketMessage interface {