Mono repo -> Master (#22553)

Combines the following repositories into one:

https://github.com/mattermost/mattermost-server
https://github.com/mattermost/mattermost-webapp
https://github.com/mattermost/focalboard
https://github.com/mattermost/mattermost-plugin-playbooks

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

@@ -0,0 +1,147 @@
+// Code generated by mockery v1.0.0. DO NOT EDIT.
+
+// Regenerate this file using `make telemetry-mocks`.
+
+package mocks
+
+import (
+	httpservice "github.com/mattermost/mattermost-server/v6/server/platform/services/httpservice"
+	mock "github.com/stretchr/testify/mock"
+
+	model "github.com/mattermost/mattermost-server/v6/model"
+
+	plugin "github.com/mattermost/mattermost-server/v6/plugin"
+)
+
+// ServerIface is an autogenerated mock type for the ServerIface type
+type ServerIface struct {
+	mock.Mock
+}
+
+// Config provides a mock function with given fields:
+func (_m *ServerIface) Config() *model.Config {
+	ret := _m.Called()
+
+	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 given fields:
+func (_m *ServerIface) GetPluginsEnvironment() *plugin.Environment {
+	ret := _m.Called()
+
+	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
+func (_m *ServerIface) GetRoleByName(_a0 string) (*model.Role, *model.AppError) {
+	ret := _m.Called(_a0)
+
+	var r0 *model.Role
+	if rf, ok := ret.Get(0).(func(string) *model.Role); ok {
+		r0 = rf(_a0)
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).(*model.Role)
+		}
+	}
+
+	var r1 *model.AppError
+	if rf, ok := ret.Get(1).(func(string) *model.AppError); ok {
+		r1 = rf(_a0)
+	} 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)
+
+	var r0 []*model.Scheme
+	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)
+		}
+	}
+
+	var r1 *model.AppError
+	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 given fields:
+func (_m *ServerIface) HttpService() httpservice.HTTPService {
+	ret := _m.Called()
+
+	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 given fields:
+func (_m *ServerIface) IsLeader() bool {
+	ret := _m.Called()
+
+	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 given fields:
+func (_m *ServerIface) License() *model.License {
+	ret := _m.Called()
+
+	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
+}

server/boards/services/telemetry/telemetry.go

@@ -0,0 +1,159 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package telemetry
+
+import (
+	"os"
+	"strings"
+	"time"
+
+	rudder "github.com/rudderlabs/analytics-go"
+
+	"github.com/mattermost/mattermost-server/v6/server/boards/services/scheduler"
+
+	"github.com/mattermost/mattermost-server/v6/server/channels/utils"
+	"github.com/mattermost/mattermost-server/v6/server/platform/shared/mlog"
+)
+
+const (
+	rudderKey                  = "placeholder_rudder_key"
+	rudderDataplaneURL         = "placeholder_rudder_dataplane_url"
+	timeBetweenTelemetryChecks = 10 * time.Minute
+)
+
+type TrackerFunc func() (Tracker, error)
+
+type Tracker map[string]interface{}
+
+type Service struct {
+	trackers                   map[string]TrackerFunc
+	logger                     mlog.LoggerIFace
+	rudderClient               rudder.Client
+	telemetryID                string
+	timestampLastTelemetrySent time.Time
+}
+
+type RudderConfig struct {
+	RudderKey    string
+	DataplaneURL string
+}
+
+func New(telemetryID string, logger mlog.LoggerIFace) *Service {
+	service := &Service{
+		logger:      logger,
+		telemetryID: telemetryID,
+		trackers:    map[string]TrackerFunc{},
+	}
+
+	return service
+}
+
+func (ts *Service) RegisterTracker(name string, f TrackerFunc) {
+	ts.trackers[name] = f
+}
+
+func (ts *Service) getRudderConfig() RudderConfig {
+	if !strings.Contains(rudderKey, "placeholder") && !strings.Contains(rudderDataplaneURL, "placeholder") {
+		return RudderConfig{rudderKey, rudderDataplaneURL}
+	}
+	if os.Getenv("RUDDER_KEY") != "" && os.Getenv("RUDDER_DATAPLANE_URL") != "" {
+		return RudderConfig{os.Getenv("RUDDER_KEY"), os.Getenv("RUDDER_DATAPLANE_URL")}
+	}
+	return RudderConfig{}
+}
+
+func (ts *Service) sendDailyTelemetry(override bool) {
+	config := ts.getRudderConfig()
+	if (config.DataplaneURL != "" && config.RudderKey != "") || override {
+		ts.initRudder(config.DataplaneURL, config.RudderKey)
+
+		for name, tracker := range ts.trackers {
+			m, err := tracker()
+			if err != nil {
+				ts.logger.Error("Error fetching telemetry data", mlog.String("name", name), mlog.Err(err))
+				continue
+			}
+			ts.sendTelemetry(name, m)
+		}
+	}
+}
+
+func (ts *Service) sendTelemetry(event string, properties map[string]interface{}) {
+	if ts.rudderClient != nil {
+		var context *rudder.Context
+		_ = ts.rudderClient.Enqueue(rudder.Track{
+			Event:      event,
+			UserId:     ts.telemetryID,
+			Properties: properties,
+			Context:    context,
+		})
+	}
+}
+
+func (ts *Service) initRudder(endpoint, rudderKey string) {
+	if ts.rudderClient == nil {
+		config := rudder.Config{}
+		config.Logger = rudder.StdLogger(ts.logger.StdLogger(mlog.LvlFBTelemetry))
+		config.Endpoint = endpoint
+		// For testing
+		if endpoint != rudderDataplaneURL {
+			config.Verbose = true
+			config.BatchSize = 1
+		}
+		client, err := rudder.NewWithConfig(rudderKey, endpoint, config)
+		if err != nil {
+			ts.logger.Fatal("Failed to create Rudder instance")
+			return
+		}
+		_ = client.Enqueue(rudder.Identify{
+			UserId: ts.telemetryID,
+		})
+
+		ts.rudderClient = client
+	}
+}
+
+func (ts *Service) doTelemetryIfNeeded(firstRun time.Time) {
+	hoursSinceFirstServerRun := time.Since(firstRun).Hours()
+
+	// Send once every 10 minutes for the first hour
+	if hoursSinceFirstServerRun < 1 {
+		ts.doTelemetry()
+		return
+	}
+
+	// Send once every hour thereafter for the first 12 hours
+	if hoursSinceFirstServerRun <= 12 && time.Since(ts.timestampLastTelemetrySent) >= time.Hour {
+		ts.doTelemetry()
+		return
+	}
+
+	// Send at the 24 hour mark and every 24 hours after
+	if hoursSinceFirstServerRun > 12 && time.Since(ts.timestampLastTelemetrySent) >= 24*time.Hour {
+		ts.doTelemetry()
+		return
+	}
+}
+
+func (ts *Service) RunTelemetryJob(firstRunMillis int64) {
+	// Send on boot
+	ts.doTelemetry()
+	scheduler.CreateRecurringTask("Telemetry", func() {
+		ts.doTelemetryIfNeeded(utils.TimeFromMillis(firstRunMillis))
+	}, timeBetweenTelemetryChecks)
+}
+
+func (ts *Service) doTelemetry() {
+	ts.timestampLastTelemetrySent = time.Now()
+	ts.sendDailyTelemetry(false)
+}
+
+// Shutdown closes the telemetry client.
+func (ts *Service) Shutdown() error {
+	if ts.rudderClient != nil {
+		return ts.rudderClient.Close()
+	}
+
+	return nil
+}

server/boards/services/telemetry/telemetry_test.go

@@ -0,0 +1,117 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package telemetry
+
+import (
+	"bytes"
+	"encoding/json"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/mattermost/mattermost-server/v6/server/platform/shared/mlog"
+)
+
+func mockServer() (chan []byte, *httptest.Server) {
+	done := make(chan []byte, 1)
+
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		buf := bytes.NewBuffer(nil)
+		if _, err := io.Copy(buf, r.Body); err != nil {
+			panic(err)
+		}
+
+		var v interface{}
+		err := json.Unmarshal(buf.Bytes(), &v)
+		if err != nil {
+			panic(err)
+		}
+
+		b, err := json.MarshalIndent(v, "", "  ")
+		if err != nil {
+			panic(err)
+		}
+
+		// filter the identify message
+		if strings.Contains(string(b), `"type": "identify"`) {
+			return
+		}
+
+		done <- b
+	}))
+
+	return done, server
+}
+
+func TestTelemetry(t *testing.T) {
+	receiveChan, server := mockServer()
+
+	os.Setenv("RUDDER_KEY", "mock-test-rudder-key")
+	os.Setenv("RUDDER_DATAPLANE_URL", server.URL)
+
+	checkMockRudderServer := func(t *testing.T) {
+		// check mock rudder server got
+		got := string(<-receiveChan)
+		require.Contains(t, got, "mockTrackerKey")
+		require.Contains(t, got, "mockTrackerValue")
+	}
+
+	t.Run("Register tracker and run telemetry job", func(t *testing.T) {
+		service := New("mockTelemetryID", mlog.CreateConsoleTestLogger(false, mlog.LvlDebug))
+		service.RegisterTracker("mockTracker", func() (Tracker, error) {
+			return map[string]interface{}{
+				"mockTrackerKey": "mockTrackerValue",
+			}, nil
+		})
+
+		service.RunTelemetryJob(time.Now().UnixNano() / int64(time.Millisecond))
+		checkMockRudderServer(t)
+	})
+
+	t.Run("do telemetry if needed", func(t *testing.T) {
+		service := New("mockTelemetryID", mlog.CreateConsoleTestLogger(false, mlog.LvlDebug))
+		service.RegisterTracker("mockTracker", func() (Tracker, error) {
+			return map[string]interface{}{
+				"mockTrackerKey": "mockTrackerValue",
+			}, nil
+		})
+
+		firstRun := time.Now()
+		t.Run("Send once every 10 minutes for the first hour", func(t *testing.T) {
+			service.doTelemetryIfNeeded(firstRun.Add(-30 * time.Minute))
+			checkMockRudderServer(t)
+		})
+
+		t.Run("Send once every hour thereafter for the first 12 hours", func(t *testing.T) {
+			// firstRun is 2 hours ago and timestampLastTelemetrySent is hour ago
+			// need to do telemetry
+			service.timestampLastTelemetrySent = time.Now().Add(-time.Hour)
+			service.doTelemetryIfNeeded(firstRun.Add(-2 * time.Hour))
+			checkMockRudderServer(t)
+
+			// firstRun is 2 hours ago and timestampLastTelemetrySent is just now
+			// no need to do telemetry
+			service.doTelemetryIfNeeded(firstRun.Add(-2 * time.Hour))
+			require.Equal(t, 0, len(receiveChan))
+		})
+		t.Run("Send at the 24 hour mark and every 24 hours after", func(t *testing.T) {
+			// firstRun is 24 hours ago and timestampLastTelemetrySent is 24 hours ago
+			// need to do telemetry
+			service.timestampLastTelemetrySent = time.Now().Add(-24 * time.Hour)
+			service.doTelemetryIfNeeded(firstRun.Add(-24 * time.Hour))
+			checkMockRudderServer(t)
+
+			// firstRun is 24 hours ago and timestampLastTelemetrySent is just now
+			// no need to do telemetry
+			service.doTelemetryIfNeeded(firstRun.Add(-24 * time.Hour))
+			require.Equal(t, 0, len(receiveChan))
+		})
+	})
+}