server/public/ -- pre-requisite changes (#23278)

* invert depdendency: filestore -> model

* markdown: nolint:misspell

* inline jsonutils within model

* push model.GetInfoForBytes -> channels/app

* push channel/utils.CompileGo* -> plugin/utils

* push plugin/scheduler -> channels/jobs/plugins

* push utils.Copy(File|Dir) -> model

* oauthproiders/gitlab -> channels/app/oauthproviders/gitlab

* decouple plugin from einterfaces.MetricsInterface

* fix TestGetInfoForFile

* Revert "Run golangci in server CI (#23240)"

This reverts commit 349e5d4573.

* add model/utils

---------

Co-authored-by: Agniva De Sarker <agnivade@yahoo.co.in>

server/plugin/api_timer_layer_generated.go

@@ -11,14 +11,13 @@ import (
 	"net/http"
 	timePkg "time"
 
-	"github.com/mattermost/mattermost-server/server/v8/channels/einterfaces"
 	"github.com/mattermost/mattermost-server/server/v8/model"
 )
 
 type apiTimerLayer struct {
 	pluginID string
 	apiImpl  API
-	metrics  einterfaces.MetricsInterface
+	metrics  metricsInterface
 }
 
 func (api *apiTimerLayer) recordTime(startTime timePkg.Time, name string, success bool) {

server/plugin/environment.go

@@ -13,9 +13,8 @@ import (
 
 	"github.com/pkg/errors"
 
-	"github.com/mattermost/mattermost-server/server/v8/channels/einterfaces"
-	"github.com/mattermost/mattermost-server/server/v8/channels/utils"
 	"github.com/mattermost/mattermost-server/server/v8/model"
+	"github.com/mattermost/mattermost-server/server/v8/model/utils"
 	"github.com/mattermost/mattermost-server/server/v8/platform/shared/mlog"
 )
 
@@ -52,7 +51,7 @@ type Environment struct {
 	registeredPlugins      sync.Map
 	pluginHealthCheckJob   *PluginHealthCheckJob
 	logger                 *mlog.Logger
-	metrics                einterfaces.MetricsInterface
+	metrics                metricsInterface
 	newAPIImpl             apiImplCreatorFunc
 	dbDriver               Driver
 	pluginDir              string
@@ -67,7 +66,7 @@ func NewEnvironment(
 	pluginDir string,
 	webappPluginDir string,
 	logger *mlog.Logger,
-	metrics einterfaces.MetricsInterface,
+	metrics metricsInterface,
 ) (*Environment, error) {
 	return &Environment{
 		logger:          logger,

server/plugin/health_check_test.go

@@ -11,9 +11,9 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/mattermost/mattermost-server/server/v8/channels/utils"
 	"github.com/mattermost/mattermost-server/server/v8/model"
 	"github.com/mattermost/mattermost-server/server/v8/platform/shared/mlog"
+	"github.com/mattermost/mattermost-server/server/v8/plugin/utils"
 )
 
 func TestPluginHealthCheck(t *testing.T) {

server/plugin/hooks_timer_layer_generated.go

@@ -11,14 +11,13 @@ import (
 	"net/http"
 	timePkg "time"
 
-	"github.com/mattermost/mattermost-server/server/v8/channels/einterfaces"
 	"github.com/mattermost/mattermost-server/server/v8/model"
 )
 
 type hooksTimerLayer struct {
 	pluginID  string
 	hooksImpl Hooks
-	metrics   einterfaces.MetricsInterface
+	metrics   metricsInterface
 }
 
 func (hooks *hooksTimerLayer) recordTime(startTime timePkg.Time, name string, success bool) {

server/plugin/interface_generator/main.go

@@ -453,14 +453,13 @@ import (
 	"net/http"
 	timePkg "time"
 
-	"github.com/mattermost/mattermost-server/server/v8/channels/einterfaces"
 	"github.com/mattermost/mattermost-server/server/v8/model"
 )
 
 type apiTimerLayer struct {
 	pluginID string
 	apiImpl  API
-	metrics  einterfaces.MetricsInterface
+	metrics  metricsInterface
 }
 
 func (api *apiTimerLayer) recordTime(startTime timePkg.Time, name string, success bool) {
@@ -495,14 +494,13 @@ import (
 	"net/http"
 	timePkg "time"
 
-	"github.com/mattermost/mattermost-server/server/v8/channels/einterfaces"
 	"github.com/mattermost/mattermost-server/server/v8/model"
 )
 
 type hooksTimerLayer struct {
 	pluginID  string
 	hooksImpl Hooks
-	metrics   einterfaces.MetricsInterface
+	metrics   metricsInterface
 }
 
 func (hooks *hooksTimerLayer) recordTime(startTime timePkg.Time, name string, success bool) {

server/plugin/metrics.go

@@ -0,0 +1,11 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package plugin
+
+type metricsInterface interface {
+	ObservePluginHookDuration(pluginID, hookName string, success bool, elapsed float64)
+	ObservePluginMultiHookIterationDuration(pluginID string, elapsed float64)
+	ObservePluginMultiHookDuration(elapsed float64)
+	ObservePluginAPIDuration(pluginID, apiName string, success bool, elapsed float64)
+}

server/plugin/scheduler/scheduler.go

@@ -1,20 +0,0 @@
-// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
-// See LICENSE.txt for license information.
-
-package scheduler
-
-import (
-	"time"
-
-	"github.com/mattermost/mattermost-server/server/v8/channels/jobs"
-	"github.com/mattermost/mattermost-server/server/v8/model"
-)
-
-const schedFreq = 24 * time.Hour
-
-func MakeScheduler(jobServer *jobs.JobServer) model.Scheduler {
-	isEnabled := func(cfg *model.Config) bool {
-		return true
-	}
-	return jobs.NewPeriodicScheduler(jobServer, model.JobTypePlugins, schedFreq, isEnabled)
-}

server/plugin/scheduler/worker.go

@@ -1,104 +0,0 @@
-// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
-// See LICENSE.txt for license information.
-
-package scheduler
-
-import (
-	"github.com/mattermost/mattermost-server/server/v8/channels/jobs"
-	"github.com/mattermost/mattermost-server/server/v8/model"
-	"github.com/mattermost/mattermost-server/server/v8/platform/shared/mlog"
-)
-
-type AppIface interface {
-	DeleteAllExpiredPluginKeys() *model.AppError
-}
-
-type Worker struct {
-	name      string
-	stop      chan bool
-	stopped   chan bool
-	jobs      chan model.Job
-	jobServer *jobs.JobServer
-	app       AppIface
-}
-
-func MakeWorker(jobServer *jobs.JobServer, app AppIface) model.Worker {
-	worker := Worker{
-		name:      "Plugins",
-		stop:      make(chan bool, 1),
-		stopped:   make(chan bool, 1),
-		jobs:      make(chan model.Job),
-		jobServer: jobServer,
-		app:       app,
-	}
-
-	return &worker
-}
-
-func (worker *Worker) Run() {
-	mlog.Debug("Worker started", mlog.String("worker", worker.name))
-
-	defer func() {
-		mlog.Debug("Worker finished", mlog.String("worker", worker.name))
-		worker.stopped <- true
-	}()
-
-	for {
-		select {
-		case <-worker.stop:
-			mlog.Debug("Worker received stop signal", mlog.String("worker", worker.name))
-			return
-		case job := <-worker.jobs:
-			mlog.Debug("Worker received a new candidate job.", mlog.String("worker", worker.name))
-			worker.DoJob(&job)
-		}
-	}
-}
-
-func (worker *Worker) Stop() {
-	mlog.Debug("Worker stopping", mlog.String("worker", worker.name))
-	worker.stop <- true
-	<-worker.stopped
-}
-
-func (worker *Worker) JobChannel() chan<- model.Job {
-	return worker.jobs
-}
-
-func (worker *Worker) IsEnabled(cfg *model.Config) bool {
-	return true
-}
-
-func (worker *Worker) DoJob(job *model.Job) {
-	if claimed, err := worker.jobServer.ClaimJob(job); err != nil {
-		mlog.Info("Worker experienced an error while trying to claim job",
-			mlog.String("worker", worker.name),
-			mlog.String("job_id", job.Id),
-			mlog.String("error", err.Error()))
-		return
-	} else if !claimed {
-		return
-	}
-
-	if err := worker.app.DeleteAllExpiredPluginKeys(); err != nil {
-		mlog.Error("Worker: Failed to delete expired keys", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))
-		worker.setJobError(job, err)
-		return
-	}
-
-	mlog.Info("Worker: Job is complete", mlog.String("worker", worker.name), mlog.String("job_id", job.Id))
-	worker.setJobSuccess(job)
-}
-
-func (worker *Worker) setJobSuccess(job *model.Job) {
-	if err := worker.jobServer.SetJobSuccess(job); err != nil {
-		mlog.Error("Worker: Failed to set success for job", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))
-		worker.setJobError(job, err)
-	}
-}
-
-func (worker *Worker) setJobError(job *model.Job, appError *model.AppError) {
-	if err := worker.jobServer.SetJobError(job, appError); err != nil {
-		mlog.Error("Worker: Failed to set job error", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))
-	}
-}

server/plugin/supervisor.go

@@ -18,7 +18,6 @@ import (
 	plugin "github.com/hashicorp/go-plugin"
 	"github.com/pkg/errors"
 
-	"github.com/mattermost/mattermost-server/server/v8/channels/einterfaces"
 	"github.com/mattermost/mattermost-server/server/v8/model"
 	"github.com/mattermost/mattermost-server/server/v8/platform/shared/mlog"
 )
@@ -32,7 +31,7 @@ type supervisor struct {
 	hooksClient *hooksRPCClient
 }
 
-func newSupervisor(pluginInfo *model.BundleInfo, apiImpl API, driver Driver, parentLogger *mlog.Logger, metrics einterfaces.MetricsInterface) (retSupervisor *supervisor, retErr error) {
+func newSupervisor(pluginInfo *model.BundleInfo, apiImpl API, driver Driver, parentLogger *mlog.Logger, metrics metricsInterface) (retSupervisor *supervisor, retErr error) {
 	sup := supervisor{}
 	defer func() {
 		if retErr != nil {

server/plugin/supervisor_test.go

@@ -11,9 +11,9 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/mattermost/mattermost-server/server/v8/channels/utils"
 	"github.com/mattermost/mattermost-server/server/v8/model"
 	"github.com/mattermost/mattermost-server/server/v8/platform/shared/mlog"
+	"github.com/mattermost/mattermost-server/server/v8/plugin/utils"
 )
 
 func TestSupervisor(t *testing.T) {

server/plugin/utils/test_files_compiler.go

@@ -0,0 +1,73 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package utils
+
+import (
+	"bytes"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"runtime"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func CompileGo(t *testing.T, sourceCode, outputPath string) {
+	dir, err := os.MkdirTemp(".", "")
+	require.NoError(t, err)
+	defer os.RemoveAll(dir)
+
+	dir, err = filepath.Abs(dir)
+	require.NoError(t, err)
+
+	// Write out main.go given the source code.
+	main := filepath.Join(dir, "main.go")
+	err = os.WriteFile(main, []byte(sourceCode), 0600)
+	require.NoError(t, err)
+
+	_, sourceFile, _, ok := runtime.Caller(0)
+	require.True(t, ok)
+	serverPath := filepath.Dir(filepath.Dir(sourceFile))
+
+	out := &bytes.Buffer{}
+	cmd := exec.Command("go", "build", "-o", outputPath, main)
+	cmd.Dir = serverPath
+	cmd.Stdout = out
+	cmd.Stderr = out
+	err = cmd.Run()
+	if err != nil {
+		t.Log("Go compile errors:\n", out.String())
+	}
+	require.NoError(t, err, "failed to compile go")
+}
+
+func CompileGoTest(t *testing.T, sourceCode, outputPath string) {
+	dir, err := os.MkdirTemp(".", "")
+	require.NoError(t, err)
+	defer os.RemoveAll(dir)
+
+	dir, err = filepath.Abs(dir)
+	require.NoError(t, err)
+
+	// Write out main.go given the source code.
+	main := filepath.Join(dir, "main_test.go")
+	err = os.WriteFile(main, []byte(sourceCode), 0600)
+	require.NoError(t, err)
+
+	_, sourceFile, _, ok := runtime.Caller(0)
+	require.True(t, ok)
+	serverPath := filepath.Dir(filepath.Dir(sourceFile))
+
+	out := &bytes.Buffer{}
+	cmd := exec.Command("go", "test", "-c", "-o", outputPath, main)
+	cmd.Dir = serverPath
+	cmd.Stdout = out
+	cmd.Stderr = out
+	err = cmd.Run()
+	if err != nil {
+		t.Log("Go compile errors:\n", out.String())
+	}
+	require.NoError(t, err, "failed to compile go")
+}