team/server/public/model/job.go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

package model

import (
	"net/http"

	"github.com/mattermost/mattermost/server/public/utils/timeutils"
)

const (
	JobTypeDataRetention                 = "data_retention"
	JobTypeMessageExport                 = "message_export"
	JobTypeCLIMessageExport              = "cli_message_export"
	JobTypeElasticsearchPostIndexing     = "elasticsearch_post_indexing"
	JobTypeElasticsearchPostAggregation  = "elasticsearch_post_aggregation"
	JobTypeLdapSync                      = "ldap_sync"
	JobTypeMigrations                    = "migrations"
	JobTypePlugins                       = "plugins"
	JobTypeExpiryNotify                  = "expiry_notify"
	JobTypeProductNotices                = "product_notices"
	JobTypeActiveUsers                   = "active_users"
	JobTypeImportProcess                 = "import_process"
	JobTypeImportDelete                  = "import_delete"
	JobTypeExportProcess                 = "export_process"
	JobTypeExportDelete                  = "export_delete"
	JobTypeCloud                         = "cloud"
	JobTypeResendInvitationEmail         = "resend_invitation_email"
	JobTypeExtractContent                = "extract_content"
	JobTypeLastAccessiblePost            = "last_accessible_post"
	JobTypeLastAccessibleFile            = "last_accessible_file"
	JobTypeUpgradeNotifyAdmin            = "upgrade_notify_admin"
	JobTypeTrialNotifyAdmin              = "trial_notify_admin"
	JobTypePostPersistentNotifications   = "post_persistent_notifications"
	JobTypeInstallPluginNotifyAdmin      = "install_plugin_notify_admin"
	JobTypeHostedPurchaseScreening       = "hosted_purchase_screening"
	JobTypeS3PathMigration               = "s3_path_migration"
	JobTypeCleanupDesktopTokens          = "cleanup_desktop_tokens"
	JobTypeDeleteEmptyDraftsMigration    = "delete_empty_drafts_migration"
	JobTypeRefreshMaterializedViews      = "refresh_materialized_views"
	JobTypeDeleteOrphanDraftsMigration   = "delete_orphan_drafts_migration"
	JobTypeExportUsersToCSV              = "export_users_to_csv"
	JobTypeDeleteDmsPreferencesMigration = "delete_dms_preferences_migration"
	JobTypeMobileSessionMetadata         = "mobile_session_metadata"
	JobTypeAccessControlSync             = "access_control_sync"
	JobTypeAccessControlTeamSync         = "access_control_team_sync"
	JobTypePushProxyAuth                 = "push_proxy_auth"
	JobTypeRecap                         = "recap"
	JobTypeDeleteExpiredPosts            = "delete_expired_posts"
	JobTypeAutoTranslationRecovery       = "autotranslation_recovery"
	JobTypeCleanupExpiredAccessTokens    = "cleanup_expired_access_tokens"
	JobTypeNotifyExpiringAccessTokens    = "notify_expiring_access_tokens"

	JobStatusPending         = "pending"
	JobStatusInProgress      = "in_progress"
	JobStatusSuccess         = "success"
	JobStatusError           = "error"
	JobStatusCancelRequested = "cancel_requested"
	JobStatusCanceled        = "canceled"
	JobStatusWarning         = "warning"
)

var AllJobTypes = [...]string{
	JobTypeDataRetention,
	JobTypeMessageExport,
	JobTypeElasticsearchPostIndexing,
	JobTypeElasticsearchPostAggregation,
	JobTypeLdapSync,
	JobTypeMigrations,
	JobTypePlugins,
	JobTypeExpiryNotify,
	JobTypeProductNotices,
	JobTypeActiveUsers,
	JobTypeImportProcess,
	JobTypeImportDelete,
	JobTypeExportProcess,
	JobTypeExportDelete,
	JobTypeCloud,
	JobTypeExtractContent,
	JobTypeLastAccessiblePost,
	JobTypeLastAccessibleFile,
	JobTypeCleanupDesktopTokens,
	JobTypeCleanupExpiredAccessTokens,
	JobTypeNotifyExpiringAccessTokens,
	JobTypeRefreshMaterializedViews,
	JobTypeMobileSessionMetadata,
}

type Job struct {
	Id             string    `json:"id"`
	Type           string    `json:"type"`
	Priority       int64     `json:"priority"`
	CreateAt       int64     `json:"create_at"`
	StartAt        int64     `json:"start_at"`
	LastActivityAt int64     `json:"last_activity_at"`
	Status         string    `json:"status"`
	Progress       int64     `json:"progress"`
	Data           StringMap `json:"data"`
}

func (j *Job) Auditable() map[string]any {
	return map[string]any{
		"id":               j.Id,
		"type":             j.Type,
		"priority":         j.Priority,
		"create_at":        j.CreateAt,
		"start_at":         j.StartAt,
		"last_activity_at": j.LastActivityAt,
		"status":           j.Status,
		"progress":         j.Progress,
		"data":             j.Data, // TODO do we want this here
	}
}

func (j *Job) MarshalYAML() (any, error) {
	return struct {
		Id             string    `yaml:"id"`
		Type           string    `yaml:"type"`
		Priority       int64     `yaml:"priority"`
		CreateAt       string    `yaml:"create_at"`
		StartAt        string    `yaml:"start_at"`
		LastActivityAt string    `yaml:"last_activity_at"`
		Status         string    `yaml:"status"`
		Progress       int64     `yaml:"progress"`
		Data           StringMap `yaml:"data"`
	}{
		Id:             j.Id,
		Type:           j.Type,
		Priority:       j.Priority,
		CreateAt:       timeutils.FormatMillis(j.CreateAt),
		StartAt:        timeutils.FormatMillis(j.StartAt),
		LastActivityAt: timeutils.FormatMillis(j.LastActivityAt),
		Status:         j.Status,
		Progress:       j.Progress,
		Data:           j.Data,
	}, nil
}

func (j *Job) UnmarshalYAML(unmarshal func(any) error) error {
	out := struct {
		Id             string    `yaml:"id"`
		Type           string    `yaml:"type"`
		Priority       int64     `yaml:"priority"`
		CreateAt       string    `yaml:"create_at"`
		StartAt        string    `yaml:"start_at"`
		LastActivityAt string    `yaml:"last_activity_at"`
		Status         string    `yaml:"status"`
		Progress       int64     `yaml:"progress"`
		Data           StringMap `yaml:"data"`
	}{}

	err := unmarshal(&out)
	if err != nil {
		return err
	}

	createAt, err := timeutils.ParseFormatedMillis(out.CreateAt)
	if err != nil {
		return err
	}
	updateAt, err := timeutils.ParseFormatedMillis(out.StartAt)
	if err != nil {
		return err
	}
	deleteAt, err := timeutils.ParseFormatedMillis(out.LastActivityAt)
	if err != nil {
		return err
	}

	*j = Job{
		Id:             out.Id,
		Type:           out.Type,
		Priority:       out.Priority,
		CreateAt:       createAt,
		StartAt:        updateAt,
		LastActivityAt: deleteAt,
		Status:         out.Status,
		Progress:       out.Progress,
		Data:           out.Data,
	}
	return nil
}

func (j *Job) IsValid() *AppError {
	if !IsValidId(j.Id) {
		return NewAppError("Job.IsValid", "model.job.is_valid.id.app_error", nil, "id="+j.Id, http.StatusBadRequest)
	}

	if j.CreateAt == 0 {
		return NewAppError("Job.IsValid", "model.job.is_valid.create_at.app_error", nil, "id="+j.Id, http.StatusBadRequest)
	}

	validStatus := IsValidJobStatus(j.Status)
	if !validStatus {
		return NewAppError("Job.IsValid", "model.job.is_valid.status.app_error", nil, "id="+j.Id, http.StatusBadRequest)
	}

	return nil
}

func (j *Job) IsValidStatusChange(newStatus string) bool {
	currentStatus := j.Status

	switch currentStatus {
	case JobStatusInProgress:
		return newStatus == JobStatusPending || newStatus == JobStatusCancelRequested
	case JobStatusPending:
		return newStatus == JobStatusCancelRequested
	case JobStatusCancelRequested:
		return newStatus == JobStatusCanceled
	}

	return false
}

func IsValidJobStatus(status string) bool {
	switch status {
	case JobStatusPending,
		JobStatusInProgress,
		JobStatusSuccess,
		JobStatusError,
		JobStatusWarning,
		JobStatusCancelRequested,
		JobStatusCanceled:
	default:
		return false
	}

	return true
}

func IsValidJobType(jobType string) bool {
	for _, t := range AllJobTypes {
		if t == jobType {
			return true
		}
	}

	return false
}

func (j *Job) LogClone() any {
	return j.Auditable()
}

type Worker interface {
	Run()
	Stop()
	JobChannel() chan<- Job
	IsEnabled(cfg *Config) bool
}