refactor(be): add log write service

Author: fiftin

api/helpers/event_log.go

@@ -2,7 +2,7 @@ package helpers
 
 import (
 	"github.com/semaphoreui/semaphore/db"
-	"github.com/semaphoreui/semaphore/util"
+	"github.com/semaphoreui/semaphore/pro_interfaces"
 	log "github.com/sirupsen/logrus"
 	"net/http"
 )
@@ -51,7 +51,9 @@ func EventLog(r *http.Request, action EventLogType, item EventLogItem) {
 		log.WithFields(logFields).Error("Failed to store event")
 	}
 
-	if err := util.Config.Log.Events.Write(util.EventLogRecord{
+	logWriter := GetFromContext(r, "log_writer").(pro_interfaces.LogWriteService)
+
+	if err := logWriter.WriteEventLog(pro_interfaces.EventLogRecord{
 		Action:        string(action),
 		ProjectID:     event.ProjectID,
 		UserID:        event.UserID,

cli/cmd/root.go

@@ -88,12 +88,14 @@ func runService() {
 	secretStorageService := server.NewSecretStorageService(store, accessKeyService)
 	environmentService := server.NewEnvironmentService(store, encryptionService)
 	subscriptionService := proServer.NewSubscriptionService(store, store)
+	logWriteService := proServer.NewLogWriteService()
 
 	taskPool := tasks.CreateTaskPool(
 		store,
 		inventoryService,
 		encryptionService,
 		accessKeyInstallationService,
+		logWriteService,
 	)
 
 	schedulePool := schedules.CreateSchedulePool(
@@ -143,6 +145,7 @@ func runService() {
 			r = helpers.SetContextValue(r, "store", store)
 			r = helpers.SetContextValue(r, "schedule_pool", schedulePool)
 			r = helpers.SetContextValue(r, "task_pool", &taskPool)
+			r = helpers.SetContextValue(r, "log_writer", logWriteService)
 			next.ServeHTTP(w, r)
 		})
 	})

pro/services/server/log_write_svc.go

@@ -0,0 +1,19 @@
+package server
+
+import "github.com/semaphoreui/semaphore/pro_interfaces"
+
+type LogWriteServiceImpl struct {
+}
+
+// NewLogWriteService creates a new instance of LogWriteServiceImpl.
+func NewLogWriteService() pro_interfaces.LogWriteService {
+	return &LogWriteServiceImpl{}
+}
+
+func (l *LogWriteServiceImpl) WriteEventLog(event pro_interfaces.EventLogRecord) error {
+	return nil
+}
+
+func (l *LogWriteServiceImpl) WriteTaskLog(task pro_interfaces.TaskLogRecord) error {
+	return nil
+}

pro_interfaces/log_write_svc.go

@@ -0,0 +1,28 @@
+package pro_interfaces
+
+import "github.com/semaphoreui/semaphore/pkg/task_logger"
+
+type LogWriteService interface {
+	WriteEventLog(event EventLogRecord) error
+	WriteTaskLog(task TaskLogRecord) error
+}
+
+type EventLogRecord struct {
+	Action        string  `json:"action"`
+	UserID        *int    `json:"user,omitempty"`
+	IntegrationID *int    `json:"integration,omitempty"`
+	ProjectID     *int    `json:"project,omitempty"`
+	Description   *string `json:"description,omitempty"`
+}
+
+type TaskLogRecord struct {
+	Username     string                 `json:"username,omitempty"`
+	TaskID       int                    `json:"task"`
+	ProjectID    int                    `json:"project"`
+	TemplateID   int                    `json:"template"`
+	TemplateName string                 `json:"template_name"`
+	UserID       *int                   `json:"user,omitempty"`
+	Description  *string                `json:"-"`
+	RunnerID     *int                   `json:"runner,omitempty"`
+	Status       task_logger.TaskStatus `json:"status"`
+}

services/tasks/TaskPool.go

@@ -5,6 +5,7 @@ import (
 	"github.com/semaphoreui/semaphore/pkg/random"
 	"github.com/semaphoreui/semaphore/pkg/tz"
 	"github.com/semaphoreui/semaphore/pro/pkg/stage_parsers"
+	"github.com/semaphoreui/semaphore/pro_interfaces"
 	"github.com/semaphoreui/semaphore/services/server"
 	"regexp"
 	"slices"
@@ -57,6 +58,7 @@ type TaskPool struct {
 	logger chan logRecord
 
 	store                  db.Store
+	logWriteService        pro_interfaces.LogWriteService
 	inventoryService       server.InventoryService
 	encryptionService      server.AccessKeyEncryptionService
 	keyInstallationService server.AccessKeyInstallationService
@@ -66,6 +68,28 @@ type TaskPool struct {
 	aliases map[string]*TaskRunner
 }
 
+func CreateTaskPool(
+	store db.Store,
+	inventoryService server.InventoryService,
+	encryptionService server.AccessKeyEncryptionService,
+	keyInstallationService server.AccessKeyInstallationService,
+	logWriteService pro_interfaces.LogWriteService,
+) TaskPool {
+	return TaskPool{
+		Queue:                  make([]*TaskRunner, 0), // queue of waiting tasks
+		register:               make(chan *TaskRunner), // add TaskRunner to queue
+		activeProj:             make(map[int]map[int]*TaskRunner),
+		RunningTasks:           make(map[int]*TaskRunner),   // working tasks
+		logger:                 make(chan logRecord, 10000), // store log records to database
+		store:                  store,
+		queueEvents:            make(chan PoolEvent),
+		aliases:                make(map[string]*TaskRunner),
+		inventoryService:       inventoryService,
+		encryptionService:      encryptionService,
+		logWriteService:        logWriteService,
+		keyInstallationService: keyInstallationService,
+	}
+}
 func (p *TaskPool) GetNumberOfRunningTasksOfRunner(runnerID int) (res int) {
 	for _, task := range p.RunningTasks {
 		if task.RunnerID == runnerID {
@@ -282,27 +306,6 @@ func (p *TaskPool) blocks(t *TaskRunner) bool {
 	return res
 }
 
-func CreateTaskPool(
-	store db.Store,
-	inventoryService server.InventoryService,
-	encryptionService server.AccessKeyEncryptionService,
-	keyInstallationService server.AccessKeyInstallationService,
-) TaskPool {
-	return TaskPool{
-		Queue:                  make([]*TaskRunner, 0), // queue of waiting tasks
-		register:               make(chan *TaskRunner), // add TaskRunner to queue
-		activeProj:             make(map[int]map[int]*TaskRunner),
-		RunningTasks:           make(map[int]*TaskRunner),   // working tasks
-		logger:                 make(chan logRecord, 10000), // store log records to database
-		store:                  store,
-		queueEvents:            make(chan PoolEvent),
-		aliases:                make(map[string]*TaskRunner),
-		inventoryService:       inventoryService,
-		encryptionService:      encryptionService,
-		keyInstallationService: keyInstallationService,
-	}
-}
-
 func (p *TaskPool) ConfirmTask(targetTask db.Task) error {
 	tsk := p.GetTask(targetTask.ID)
 

services/tasks/TaskRunner.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"github.com/semaphoreui/semaphore/db_lib"
 	"github.com/semaphoreui/semaphore/pkg/tz"
+	"github.com/semaphoreui/semaphore/pro_interfaces"
 	"github.com/semaphoreui/semaphore/services/tasks/hooks"
 	"os"
 	"strconv"
@@ -135,8 +136,8 @@ func (t *TaskRunner) createTaskEvent() {
 	if t.RunnerID > 0 {
 		runnerID = &t.RunnerID
 	}
-
-	if err := util.Config.Log.Tasks.Write(util.TaskLogRecord{
+	
+	if err := t.pool.logWriteService.WriteTaskLog(pro_interfaces.TaskLogRecord{
 		ProjectID:    t.Task.ProjectID,
 		TemplateID:   t.Template.ID,
 		TemplateName: t.Template.Name,

util/config.go

@@ -19,7 +19,6 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/semaphoreui/semaphore/pkg/task_logger"
 	"golang.org/x/crypto/bcrypt"
 	"gopkg.in/natefinch/lumberjack.v2"
 
@@ -144,14 +143,6 @@ type EventLogType struct {
 	Logger  *lumberjack.Logger `json:"logger,omitempty" env:"SEMAPHORE_EVENT_LOGGER"`
 }
 
-type EventLogRecord struct {
-	Action        string  `json:"action"`
-	UserID        *int    `json:"user,omitempty"`
-	IntegrationID *int    `json:"integration,omitempty"`
-	ProjectID     *int    `json:"project,omitempty"`
-	Description   *string `json:"description,omitempty"`
-}
-
 type FileLogFormat string
 
 const (
@@ -166,18 +157,6 @@ type TaskLogType struct {
 	ResultLogger *lumberjack.Logger `json:"result_logger,omitempty" env:"SEMAPHORE_TASK_RESULT_LOGGER"`
 }
 
-type TaskLogRecord struct {
-	Username     string                 `json:"username,omitempty"`
-	TaskID       int                    `json:"task"`
-	ProjectID    int                    `json:"project"`
-	TemplateID   int                    `json:"template"`
-	TemplateName string                 `json:"template_name"`
-	UserID       *int                   `json:"user,omitempty"`
-	Description  *string                `json:"-"`
-	RunnerID     *int                   `json:"runner,omitempty"`
-	Status       task_logger.TaskStatus `json:"status"`
-}
-
 type ConfigLog struct {
 	Events *EventLogType `json:"events,omitempty"`
 	Tasks  *TaskLogType  `json:"tasks,omitempty"`