team/server/channels/app/metrics_test.go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

package app

import (
	"fmt"
	"testing"

	"github.com/mattermost/mattermost/server/public/model"
	"github.com/mattermost/mattermost/server/v8/channels/app/platform"
	"github.com/mattermost/mattermost/server/v8/enterprise/metrics"
	"github.com/prometheus/client_golang/prometheus"
	prometheusModels "github.com/prometheus/client_model/go"
	"github.com/stretchr/testify/require"
)

func configureMetrics(th *TestHelper) {
	th.App.Srv().SetLicense(nil) // clear license
	th.App.UpdateConfig(func(cfg *model.Config) {
		*cfg.MetricsSettings.Enable = true
		*cfg.MetricsSettings.ListenAddress = ":0"
	})
	th.App.Srv().SetLicense(model.NewTestLicense("metrics"))
}

func TestMobileMetrics(t *testing.T) {
	mainHelper.Parallel(t)
	th := SetupEnterprise(t, StartMetrics)

	configureMetrics(th)
	mi := th.App.Metrics()

	miImpl, ok := mi.(*metrics.MetricsInterfaceImpl)
	require.True(t, ok, fmt.Sprintf("App.Metrics is not *MetricsInterfaceImpl, but %T", mi))
	m := &prometheusModels.Metric{}

	for _, platform := range []string{"ios", "android"} {
		ttcc := []struct {
			name         string
			histogramVec *prometheus.HistogramVec
			elapsed      float64
			metricName   model.MetricType
		}{
			{
				name:         "load duration",
				histogramVec: miImpl.MobileClientLoadDuration,
				elapsed:      5001,
				metricName:   model.MobileClientLoadDuration,
			},
			{
				name:         "channel switch duration",
				histogramVec: miImpl.MobileClientChannelSwitchDuration,
				elapsed:      501,
				metricName:   model.MobileClientChannelSwitchDuration,
			},
			{
				name:         "team switch duration",
				histogramVec: miImpl.MobileClientTeamSwitchDuration,
				elapsed:      301,
				metricName:   model.MobileClientTeamSwitchDuration,
			},
		}

		histograms := []*model.MetricSample{}
		var start float64 = 125
		end := start + float64(len(ttcc))
		// Precheck
		for _, tc := range ttcc {
			actualMetric, err := tc.histogramVec.GetMetricWith(prometheus.Labels{"platform": platform})
			require.NoError(t, err)
			require.NoError(t, actualMetric.(prometheus.Histogram).Write(m))
			require.Equal(t, uint64(0), m.Histogram.GetSampleCount())
			require.Equal(t, 0.0, m.Histogram.GetSampleSum())
			histograms = append(histograms, &model.MetricSample{
				Metric: tc.metricName,
				Value:  tc.elapsed,
			})
		}

		appErr := th.App.RegisterPerformanceReport(th.Context, &model.PerformanceReport{
			Version:  "0.1.0",
			ClientID: "",
			Labels: map[string]string{
				"platform": platform,
			},
			Start:      start,
			End:        end,
			Counters:   []*model.MetricSample{},
			Histograms: histograms,
		})
		require.Nil(t, appErr)

		// After check
		for _, tc := range ttcc {
			actualMetric, err := tc.histogramVec.GetMetricWith(prometheus.Labels{"platform": platform})
			require.NoError(t, err)
			require.NoError(t, actualMetric.(prometheus.Histogram).Write(m))
			require.Equal(t, uint64(1), m.Histogram.GetSampleCount())
			require.InDelta(t, tc.elapsed/1000, m.Histogram.GetSampleSum(), 0.001, "not equal value in %s", tc.name)
		}
	}
}

func TestCountNotificationMetrics(t *testing.T) {
	mainHelper.Parallel(t)
	th := SetupEnterprise(t, StartMetrics)

	configureMetrics(th)
	mi := th.App.Metrics()

	miImpl, ok := mi.(*metrics.MetricsInterfaceImpl)
	require.True(t, ok, fmt.Sprintf("App.Metrics is not *MetricsInterfaceImpl, but %T", mi))

	counterValue := func() float64 {
		counter, err := miImpl.NotificationTotalCounters.GetMetricWith(prometheus.Labels{
			"type":     string(model.NotificationTypePush),
			"platform": "ios",
		})
		require.NoError(t, err)
		m := &prometheusModels.Metric{}
		require.NoError(t, counter.Write(m))
		return m.Counter.GetValue()
	}

	t.Run("counts when notification metrics are enabled", func(t *testing.T) {
		th.App.UpdateConfig(func(cfg *model.Config) {
			*cfg.MetricsSettings.EnableNotificationMetrics = true
		})

		before := counterValue()
		th.App.CountNotification(model.NotificationTypePush, "ios")
		require.Equal(t, before+1, counterValue())
	})

	t.Run("does not count when notification metrics are disabled", func(t *testing.T) {
		th.App.UpdateConfig(func(cfg *model.Config) {
			*cfg.MetricsSettings.EnableNotificationMetrics = false
		})

		before := counterValue()
		th.App.CountNotification(model.NotificationTypePush, "ios")
		require.Equal(t, before, counterValue())
	})
}

func TestWebsocketNotificationCounter(t *testing.T) {
	mainHelper.Parallel(t)
	th := SetupEnterprise(t, StartMetrics)

	configureMetrics(th)
	mi := th.App.Metrics()

	miImpl, ok := mi.(*metrics.MetricsInterfaceImpl)
	require.True(t, ok, fmt.Sprintf("App.Metrics is not *MetricsInterfaceImpl, but %T", mi))

	counterValue := func() float64 {
		counter, err := miImpl.NotificationTotalCounters.GetMetricWith(prometheus.Labels{
			"type":     string(model.NotificationTypeWebsocket),
			"platform": model.NotificationNoPlatform,
		})
		require.NoError(t, err)
		m := &prometheusModels.Metric{}
		require.NoError(t, counter.Write(m))
		return m.Counter.GetValue()
	}

	hook := &postedAckBroadcastHook{}
	userID := model.NewId()
	webConn := &platform.WebConn{
		UserId:    userID,
		Platform:  th.Server.Platform(),
		PostedAck: true,
	}
	webConn.Active.Store(true)
	webConn.SetSession(&model.Session{})

	// Process an acked broadcast that reaches incrementWebsocketCounter.
	ackPostedBroadcast := func() {
		msg := platform.MakeHookedWebSocketEvent(model.NewWebSocketEvent(model.WebsocketEventPosted, "", "", "", nil, ""))
		err := hook.Process(msg, webConn, map[string]any{
			"posted_user_id": model.NewId(),
			"channel_type":   model.ChannelTypeOpen,
			"users":          []string{userID},
		})
		require.NoError(t, err)
		require.True(t, msg.Event().GetData()["should_ack"].(bool))
	}

	t.Run("counts when notification metrics are enabled", func(t *testing.T) {
		th.App.UpdateConfig(func(cfg *model.Config) {
			*cfg.MetricsSettings.EnableNotificationMetrics = true
		})

		before := counterValue()
		ackPostedBroadcast()
		require.Equal(t, before+1, counterValue())
	})

	t.Run("does not count when notification metrics are disabled", func(t *testing.T) {
		th.App.UpdateConfig(func(cfg *model.Config) {
			*cfg.MetricsSettings.EnableNotificationMetrics = false
		})

		before := counterValue()
		ackPostedBroadcast()
		require.Equal(t, before, counterValue())
	})
}