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

server/platform/services/telemetry/mocks/ServerIface.go

@@ -0,0 +1,197 @@
+// Code generated by mockery v2.53.4. DO NOT EDIT.
+
+// Regenerate this file using `make telemetry-mocks`.
+
+package mocks
+
+import (
+	httpservice "github.com/mattermost/mattermost/server/public/shared/httpservice"
+	mock "github.com/stretchr/testify/mock"
+
+	model "github.com/mattermost/mattermost/server/public/model"
+
+	plugin "github.com/mattermost/mattermost/server/public/plugin"
+
+	request "github.com/mattermost/mattermost/server/public/shared/request"
+)
+
+// ServerIface is an autogenerated mock type for the ServerIface type
+type ServerIface struct {
+	mock.Mock
+}
+
+// Config provides a mock function with no fields
+func (_m *ServerIface) Config() *model.Config {
+	ret := _m.Called()
+
+	if len(ret) == 0 {
+		panic("no return value specified for Config")
+	}
+
+	var r0 *model.Config
+	if rf, ok := ret.Get(0).(func() *model.Config); ok {
+		r0 = rf()
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).(*model.Config)
+		}
+	}
+
+	return r0
+}
+
+// GetPluginsEnvironment provides a mock function with no fields
+func (_m *ServerIface) GetPluginsEnvironment() *plugin.Environment {
+	ret := _m.Called()
+
+	if len(ret) == 0 {
+		panic("no return value specified for GetPluginsEnvironment")
+	}
+
+	var r0 *plugin.Environment
+	if rf, ok := ret.Get(0).(func() *plugin.Environment); ok {
+		r0 = rf()
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).(*plugin.Environment)
+		}
+	}
+
+	return r0
+}
+
+// GetRoleByName provides a mock function with given fields: _a0, _a1
+func (_m *ServerIface) GetRoleByName(_a0 request.CTX, _a1 string) (*model.Role, *model.AppError) {
+	ret := _m.Called(_a0, _a1)
+
+	if len(ret) == 0 {
+		panic("no return value specified for GetRoleByName")
+	}
+
+	var r0 *model.Role
+	var r1 *model.AppError
+	if rf, ok := ret.Get(0).(func(request.CTX, string) (*model.Role, *model.AppError)); ok {
+		return rf(_a0, _a1)
+	}
+	if rf, ok := ret.Get(0).(func(request.CTX, string) *model.Role); ok {
+		r0 = rf(_a0, _a1)
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).(*model.Role)
+		}
+	}
+
+	if rf, ok := ret.Get(1).(func(request.CTX, string) *model.AppError); ok {
+		r1 = rf(_a0, _a1)
+	} else {
+		if ret.Get(1) != nil {
+			r1 = ret.Get(1).(*model.AppError)
+		}
+	}
+
+	return r0, r1
+}
+
+// GetSchemes provides a mock function with given fields: _a0, _a1, _a2
+func (_m *ServerIface) GetSchemes(_a0 string, _a1 int, _a2 int) ([]*model.Scheme, *model.AppError) {
+	ret := _m.Called(_a0, _a1, _a2)
+
+	if len(ret) == 0 {
+		panic("no return value specified for GetSchemes")
+	}
+
+	var r0 []*model.Scheme
+	var r1 *model.AppError
+	if rf, ok := ret.Get(0).(func(string, int, int) ([]*model.Scheme, *model.AppError)); ok {
+		return rf(_a0, _a1, _a2)
+	}
+	if rf, ok := ret.Get(0).(func(string, int, int) []*model.Scheme); ok {
+		r0 = rf(_a0, _a1, _a2)
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).([]*model.Scheme)
+		}
+	}
+
+	if rf, ok := ret.Get(1).(func(string, int, int) *model.AppError); ok {
+		r1 = rf(_a0, _a1, _a2)
+	} else {
+		if ret.Get(1) != nil {
+			r1 = ret.Get(1).(*model.AppError)
+		}
+	}
+
+	return r0, r1
+}
+
+// HTTPService provides a mock function with no fields
+func (_m *ServerIface) HTTPService() httpservice.HTTPService {
+	ret := _m.Called()
+
+	if len(ret) == 0 {
+		panic("no return value specified for HTTPService")
+	}
+
+	var r0 httpservice.HTTPService
+	if rf, ok := ret.Get(0).(func() httpservice.HTTPService); ok {
+		r0 = rf()
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).(httpservice.HTTPService)
+		}
+	}
+
+	return r0
+}
+
+// IsLeader provides a mock function with no fields
+func (_m *ServerIface) IsLeader() bool {
+	ret := _m.Called()
+
+	if len(ret) == 0 {
+		panic("no return value specified for IsLeader")
+	}
+
+	var r0 bool
+	if rf, ok := ret.Get(0).(func() bool); ok {
+		r0 = rf()
+	} else {
+		r0 = ret.Get(0).(bool)
+	}
+
+	return r0
+}
+
+// License provides a mock function with no fields
+func (_m *ServerIface) License() *model.License {
+	ret := _m.Called()
+
+	if len(ret) == 0 {
+		panic("no return value specified for License")
+	}
+
+	var r0 *model.License
+	if rf, ok := ret.Get(0).(func() *model.License); ok {
+		r0 = rf()
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).(*model.License)
+		}
+	}
+
+	return r0
+}
+
+// NewServerIface creates a new instance of ServerIface. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
+// The first argument is typically a *testing.T value.
+func NewServerIface(t interface {
+	mock.TestingT
+	Cleanup(func())
+}) *ServerIface {
+	mock := &ServerIface{}
+	mock.Mock.Test(t)
+
+	t.Cleanup(func() { mock.AssertExpectations(t) })
+
+	return mock
+}

server/platform/services/telemetry/telemetry.go

@@ -0,0 +1,70 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package telemetry
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/mattermost/mattermost/server/public/model"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
+	"github.com/mattermost/mattermost/server/v8/channels/store"
+)
+
+const (
+	DBAccessAttempts    = 3
+	DBAccessTimeoutSecs = 10
+)
+
+type ServerIface interface {
+	Config() *model.Config
+	IsLeader() bool
+}
+
+type TelemetryService struct {
+	srv      ServerIface
+	dbStore  store.Store
+	log      *mlog.Logger
+	ServerID string
+}
+
+func New(srv ServerIface, dbStore store.Store, log *mlog.Logger) (*TelemetryService, error) {
+	service := &TelemetryService{
+		srv:     srv,
+		dbStore: dbStore,
+		log:     log,
+	}
+
+	if err := service.ensureServerID(); err != nil {
+		return nil, fmt.Errorf("unable to ensure telemetry ID: %w", err)
+	}
+
+	return service, nil
+}
+
+func (ts *TelemetryService) ensureServerID() error {
+	if ts.ServerID != "" {
+		return nil
+	}
+
+	id := model.NewId()
+	var err error
+
+	for range DBAccessAttempts {
+		ts.log.Info("Ensuring the telemetry ID..")
+		systemID := &model.System{Name: model.SystemServerId, Value: id}
+		systemID, err = ts.dbStore.System().InsertIfExists(systemID)
+		if err != nil {
+			ts.log.Info("Unable to get/set the telemetry ID", mlog.Err(err))
+			time.Sleep(DBAccessTimeoutSecs * time.Second)
+			continue
+		}
+
+		ts.ServerID = systemID.Value
+		ts.log.Info("server ID is set", mlog.String("id", ts.ServerID))
+		return nil
+	}
+
+	return fmt.Errorf("unable to get the server ID: %w", err)
+}

server/platform/services/telemetry/telemetry_test.go

@@ -0,0 +1,97 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package telemetry
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+
+	"github.com/mattermost/mattermost/server/public/model"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
+	storeMocks "github.com/mattermost/mattermost/server/v8/channels/store/storetest/mocks"
+	"github.com/mattermost/mattermost/server/v8/platform/services/telemetry/mocks"
+)
+
+func TestEnsureServerID(t *testing.T) {
+	t.Run("test ID in database and does not run twice", func(t *testing.T) {
+		storeMock := &storeMocks.Store{}
+
+		systemStore := storeMocks.SystemStore{}
+		returnValue := &model.System{
+			Name:  model.SystemServerId,
+			Value: "test",
+		}
+		systemStore.On("InsertIfExists", mock.AnythingOfType("*model.System")).Return(returnValue, nil).Once()
+
+		storeMock.On("System").Return(&systemStore)
+
+		serverIfaceMock := &mocks.ServerIface{}
+
+		testLogger, _ := mlog.NewLogger()
+
+		telemetryService, err := New(serverIfaceMock, storeMock, testLogger)
+		require.NoError(t, err)
+
+		assert.Equal(t, "test", telemetryService.ServerID)
+
+		telemetryService.ensureServerID()
+		assert.Equal(t, "test", telemetryService.ServerID)
+
+		// No more calls to the store if we try to ensure it again
+		telemetryService.ensureServerID()
+		assert.Equal(t, "test", telemetryService.ServerID)
+	})
+
+	t.Run("new test ID created", func(t *testing.T) {
+		storeMock := &storeMocks.Store{}
+
+		systemStore := storeMocks.SystemStore{}
+		returnValue := &model.System{
+			Name: model.SystemServerId,
+		}
+
+		var generatedID string
+		systemStore.On("InsertIfExists", mock.AnythingOfType("*model.System")).Return(returnValue, nil).Once().Run(func(args mock.Arguments) {
+			s := args.Get(0).(*model.System)
+			returnValue.Value = s.Value
+			generatedID = s.Value
+		})
+		storeMock.On("System").Return(&systemStore)
+
+		serverIfaceMock := &mocks.ServerIface{}
+
+		testLogger, _ := mlog.NewLogger()
+
+		telemetryService, err := New(serverIfaceMock, storeMock, testLogger)
+		require.NoError(t, err)
+
+		assert.Equal(t, generatedID, telemetryService.ServerID)
+	})
+
+	t.Run("fail to save test ID", func(t *testing.T) {
+		if testing.Short() {
+			t.Skip("skipping test in short mode.")
+		}
+
+		storeMock := &storeMocks.Store{}
+
+		systemStore := storeMocks.SystemStore{}
+
+		insertError := errors.New("insert error")
+		systemStore.On("InsertIfExists", mock.AnythingOfType("*model.System")).Return(nil, insertError).Times(DBAccessAttempts)
+
+		storeMock.On("System").Return(&systemStore)
+
+		serverIfaceMock := &mocks.ServerIface{}
+
+		testLogger, _ := mlog.NewLogger()
+
+		_, err := New(serverIfaceMock, storeMock, testLogger)
+		require.Error(t, err)
+	})
+}