audit

type AdditionalFields struct {
	WorkspaceName  string               `json:"workspace_name"`
	BuildNumber    string               `json:"build_number"`
	BuildReason    database.BuildReason `json:"build_reason"`
	WorkspaceOwner string               `json:"workspace_owner"`
	WorkspaceID    uuid.UUID            `json:"workpace_id"`
}

type Auditable interface {
	database.APIKey |
		database.Template |
		database.TemplateVersion |
		database.User |
		database.Workspace |
		database.GitSSHKey |
		database.WorkspaceBuild |
		database.AuditableGroup |
		database.License |
		database.WorkspaceProxy |
		database.AuditOAuthConvertState |
		database.HealthSettings |
		database.OAuth2ProviderApp |
		database.OAuth2ProviderAppSecret
}

type Auditor interface {
	Export(ctx context.Context, alog database.AuditLog) error
	// contains filtered or unexported methods
}

type BackgroundAuditParams[T Auditable] struct {
	Audit Auditor
	Log   slog.Logger

	UserID           uuid.UUID
	RequestID        uuid.UUID
	Status           int
	Action           database.AuditAction
	OrganizationID   uuid.UUID
	IP               string
	AdditionalFields json.RawMessage

	New T
	Old T
}

type Baggage interface {
	Props() ([]baggage.Property, error)
}

type Differ struct {
	DiffFn func(old, new any) Map
}

type Map map[string]OldNew

type MockAuditor struct {
	// contains filtered or unexported fields
}

type OldNew struct {
	Old    any
	New    any
	Secret bool
}

type Request[T Auditable] struct {
	Old T
	New T

	// UserID is an optional field can be passed in when the userID cannot be
	// determined from the API Key such as in the case of login, when the audit
	// log is created prior the API Key's existence.
	UserID uuid.UUID

	// Action is an optional field can be passed in if the AuditAction must be
	// overridden such as in the case of new user authentication when the Audit
	// Action is 'register', not 'login'.
	Action database.AuditAction
	// contains filtered or unexported fields
}

type RequestParams struct {
	Audit Auditor
	Log   slog.Logger

	// OrganizationID is only provided when possible. If an audit resource extends
	// beyond the org scope, leave this as the nil uuid.
	OrganizationID   uuid.UUID
	Request          *http.Request
	Action           database.AuditAction
	AdditionalFields json.RawMessage
}

type WorkspaceBuildBaggage struct {
	IP string
}