Files
zeekay 8feb24ea1f One name for this fork, and it is ours
The server module named github.com/hanzoai/team/server/v8 — a path that
resolves to the retired workspace's repository, not this one — while
server/public still published github.com/mattermost/mattermost/server/public.
Both are github.com/hanzoteam/server/... now, which is where this code
actually lives.

That second half is what made the binary unbootable. Upstream's public path
stayed claimed by upstream, mattermost-plugin-ai imported it, and the build
linked public/model twice; public/plugin's gob.Register then ran twice under
one name and panicked at init, before main. Reverting the rename traded the
brand for a working binary. Rebranding the plugin alongside it needs no such
trade: the agents fork is github.com/hanzoteam/agents/v2 against our public
module, so no module named mattermost/mattermost is in the graph at all.

Measured: `go list -deps ./cmd/mattermost` names exactly one public/model, and
it is ours.
2026-08-28 23:35:36 -07:00

228 lines
8.6 KiB
Go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
package api4
import (
"net/http"
"testing"
"time"
"github.com/hanzoteam/server/server/public/model"
"github.com/hanzoteam/server/server/public/plugin/plugintest/mock"
"github.com/hanzoteam/server/server/v8/channels/app"
"github.com/hanzoteam/server/server/v8/channels/app/platform"
"github.com/hanzoteam/server/server/v8/einterfaces"
"github.com/hanzoteam/server/server/v8/einterfaces/mocks"
"github.com/stretchr/testify/require"
)
func setupMetricsMock() *mocks.MetricsInterface {
metricsMock := &mocks.MetricsInterface{}
metricsMock.On("IncrementWebsocketEvent", mock.AnythingOfType("model.WebsocketEventType")).Return()
metricsMock.On("IncrementWebSocketBroadcastBufferSize", mock.AnythingOfType("string"), mock.AnythingOfType("float64")).Return()
metricsMock.On("DecrementWebSocketBroadcastBufferSize", mock.AnythingOfType("string"), mock.AnythingOfType("float64")).Return()
metricsMock.On("IncrementMemCacheInvalidationCounter", mock.AnythingOfType("string")).Return()
metricsMock.On("IncrementMemCacheMissCounter", mock.AnythingOfType("string")).Return()
metricsMock.On("IncrementMemCacheHitCounter", mock.AnythingOfType("string")).Return()
metricsMock.On("GetLoggerMetricsCollector").Return(nil)
metricsMock.On("IncrementMemCacheHitCounterSession").Return()
metricsMock.On("IncrementHTTPError").Return()
metricsMock.On("IncrementHTTPRequest").Return()
metricsMock.On("ObserveAPIEndpointDuration", mock.AnythingOfType("string"), mock.AnythingOfType("string"), mock.AnythingOfType("string"), mock.AnythingOfType("string"), mock.AnythingOfType("string"), mock.AnythingOfType("float64")).Return()
metricsMock.On("ObserveRedisEndpointDuration", mock.AnythingOfType("string"), mock.AnythingOfType("string"), mock.AnythingOfType("float64")).Return()
metricsMock.On("Register").Return()
return metricsMock
}
func TestSubmitMetrics(t *testing.T) {
t.Run("unauthenticated user should not submit metrics", func(t *testing.T) {
th := Setup(t)
_, err := th.Client.Logout(th.Context.Context())
require.NoError(t, err)
resp, err := th.Client.SubmitClientMetrics(th.Context.Context(), nil)
require.Error(t, err)
require.Equal(t, http.StatusUnauthorized, resp.StatusCode)
})
// if the metrics is not enabled on server, we don't want to return
// an error code.
t.Run("metrics not enabled", func(t *testing.T) {
th := Setup(t)
resp, err := th.Client.SubmitClientMetrics(th.Context.Context(), nil)
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.StatusCode)
})
t.Run("metrics enabled but invalid version", func(t *testing.T) {
metricsMock := setupMetricsMock()
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return metricsMock
})
t.Cleanup(func() {
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return nil
})
})
th := SetupEnterpriseWithServerOptions(t, []app.Option{app.StartMetrics})
// enable metrics and add the license
th.App.Srv().SetLicense(model.NewTestLicense())
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.Enable = true })
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.ListenAddress = ":0" })
resp, err := th.Client.SubmitClientMetrics(th.Context.Context(), &model.PerformanceReport{
Version: "0.1",
})
require.Error(t, err)
require.Equal(t, http.StatusBadRequest, resp.StatusCode)
})
t.Run("metrics enabled and valid", func(t *testing.T) {
metricsMock := setupMetricsMock()
metricsMock.On("IncrementClientLongTasks",
mock.AnythingOfType("string"),
mock.AnythingOfType("string"),
mock.AnythingOfType("string"),
mock.AnythingOfType("float64")).Return()
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return metricsMock
})
t.Cleanup(func() {
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return nil
})
})
th := SetupEnterpriseWithServerOptions(t, []app.Option{app.StartMetrics})
// enable metrics and add the license
th.App.Srv().SetLicense(model.NewTestLicense())
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.Enable = true })
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.ListenAddress = ":0" })
resp, err := th.Client.SubmitClientMetrics(th.Context.Context(), &model.PerformanceReport{
Version: "0.1",
Start: float64(time.Now().Add(-1 * time.Minute).UnixMilli()),
End: float64(time.Now().UnixMilli()),
Counters: []*model.MetricSample{
{Metric: model.ClientLongTasks, Value: 1},
},
})
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.StatusCode)
})
t.Run("metrics enabled but client metrics are disabled", func(t *testing.T) {
metricsMock := setupMetricsMock()
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return metricsMock
})
t.Cleanup(func() {
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return nil
})
})
th := SetupEnterpriseWithServerOptions(t, []app.Option{app.StartMetrics})
// enable metrics and add the license
th.App.Srv().SetLicense(model.NewTestLicense())
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.Enable = true })
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.EnableClientMetrics = false })
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.ListenAddress = ":0" })
resp, err := th.Client.SubmitClientMetrics(th.Context.Context(), &model.PerformanceReport{
Version: "0.1",
Start: float64(time.Now().Add(-1 * time.Minute).UnixMilli()),
End: float64(time.Now().UnixMilli()),
Counters: []*model.MetricSample{
{Metric: model.ClientLongTasks, Value: 1},
},
})
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.StatusCode)
})
t.Run("metrics recorded for API errors", func(t *testing.T) {
metricsMock := setupMetricsMock()
metricsMock.On("IncrementClientLongTasks",
mock.AnythingOfType("string"),
mock.AnythingOfType("string"),
mock.AnythingOfType("string"),
mock.AnythingOfType("float64")).Return()
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return metricsMock
})
t.Cleanup(func() {
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return nil
})
})
th := SetupEnterpriseWithServerOptions(t, []app.Option{app.StartMetrics})
// enable metrics and add the license
th.App.Srv().SetLicense(model.NewTestLicense())
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.Enable = true })
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.ListenAddress = ":0" })
_, resp, err := th.Client.CreatePost(th.Context.Context(), &model.Post{
ChannelId: model.NewId(),
})
require.Error(t, err)
require.Equal(t, http.StatusForbidden, resp.StatusCode)
metricsMock.AssertCalled(t, "IncrementHTTPRequest")
metricsMock.AssertCalled(t, "IncrementHTTPError")
})
t.Run("metrics recorded for URL length limit errors", func(t *testing.T) {
metricsMock := setupMetricsMock()
metricsMock.On("IncrementClientLongTasks",
mock.AnythingOfType("string"),
mock.AnythingOfType("string"),
mock.AnythingOfType("string"),
mock.AnythingOfType("float64")).Return()
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return metricsMock
})
t.Cleanup(func() {
platform.RegisterMetricsInterface(func(_ *platform.PlatformService, _, _ string) einterfaces.MetricsInterface {
return nil
})
})
th := SetupEnterpriseWithServerOptions(t, []app.Option{app.StartMetrics})
// enable metrics and add the license
th.App.Srv().SetLicense(model.NewTestLicense())
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.Enable = true })
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.MetricsSettings.ListenAddress = ":0" })
th.App.UpdateConfig(func(cfg *model.Config) { *cfg.ServiceSettings.MaximumURLLength = 1 })
_, resp, err := th.Client.CreatePost(th.Context.Context(), &model.Post{
ChannelId: model.NewId(),
})
require.Error(t, err)
require.Equal(t, http.StatusRequestURITooLong, resp.StatusCode)
metricsMock.AssertCalled(t, "IncrementHTTPRequest")
metricsMock.AssertCalled(t, "IncrementHTTPError")
})
}