audit

Documentation

Index

• Constants
• Variables
• func Empty[T Auditable]() T
• type Action
  • func (t Action) String() string
• type Auditable
• type Map
  • func Diff[T Auditable](left, right T) Map
• type Table

Constants

const (
	// ActionIgnore ignores diffing for the field.
	ActionIgnore = "ignore"
	// ActionTrack includes the value in the diff if the value changed.
	ActionTrack = "track"
	// ActionSecret includes a zero value of the same type if the value changed.
	// It lets you indicate that a value changed, but without leaking its
	// contents.
	ActionSecret = "secret"
)

Variables

var AuditableResources = auditMap(map[any]map[string]Action{
	&database.User{}: {
		"id":              ActionIgnore,
		"email":           ActionTrack,
		"username":        ActionIgnore,
		"hashed_password": ActionSecret,
		"created_at":      ActionIgnore,
		"updated_at":      ActionIgnore,
		"status":          ActionTrack,
		"rbac_roles":      ActionTrack,
	},
	&database.Workspace{}: {
		"id":                 ActionIgnore,
		"created_at":         ActionIgnore,
		"updated_at":         ActionIgnore,
		"owner_id":           ActionIgnore,
		"template_id":        ActionIgnore,
		"deleted":            ActionIgnore,
		"name":               ActionIgnore,
		"autostart_schedule": ActionTrack,
		"autostop_schedule":  ActionTrack,
	},
})

AuditableResources contains a definitive list of all auditable resources and which fields are auditable.

Functions

func Empty

func Empty[T Auditable]() T

Types

type Action

type Action string

func (Action) String

func (t Action) String() string

type Auditable

type Auditable interface {
	database.User |
		database.Workspace
}

Auditable is mostly a marker interface. It contains a definitive list of all auditable types. If you want to audit a new type, first define it in AuditableResources, then add it to this interface.

type Map

type Map map[string]interface{}

TODO: this might need to be in the database package.

func Diff

func Diff[T Auditable](left, right T) Map

Diff compares two auditable resources and produces a Map of the changed values.

type Table

type Table map[string]map[string]Action

Table is a map of struct names to a map of field names that indicate that field's AuditType.