Files
coder/coderd/audit/diff.go
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

70 lines
1.9 KiB
Go
Raw Normal View History

2022-04-25 13:57:59 -05:00
package audit
import (
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/idpsync"
2022-04-25 13:57:59 -05:00
)
// 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 Auditable interface {
database.APIKey |
database.Template |
database.TemplateVersion |
database.User |
database.WorkspaceTable |
2022-10-19 02:00:45 -05:00
database.GitSSHKey |
database.WorkspaceBuild |
database.AuditableGroup |
database.License |
database.WorkspaceProxy |
database.AuditOAuthConvertState |
2024-02-26 15:52:08 -08:00
database.HealthSettings |
database.NotificationsSettings |
2024-02-26 15:52:08 -08:00
database.OAuth2ProviderApp |
database.OAuth2ProviderAppSecret |
database.PrebuildsSettings |
database.CustomRole |
database.AuditableOrganizationMember |
database.Organization |
database.NotificationTemplate |
idpsync.OrganizationSyncSettings |
idpsync.GroupSyncSettings |
idpsync.RoleSyncSettings |
database.TaskTable |
database.AiSeatState
}
2022-04-25 13:57:59 -05:00
// Map is a map of changed fields in an audited resource. It maps field names to
// the old and new value for that field.
type Map map[string]OldNew
// OldNew is a pair of values representing the old value and the new value.
type OldNew struct {
Old any
New any
Secret bool
}
// Empty returns a default value of type T.
2022-04-25 13:57:59 -05:00
func Empty[T Auditable]() T {
var t T
return t
}
// Diff compares two auditable resources and produces a Map of the changed
// values.
func Diff[T Auditable](a Auditor, left, right T) Map { return a.diff(left, right) }
2022-04-25 13:57:59 -05:00
// Differ is used so the enterprise version can implement the diff function in
// the Auditor feature interface. Only types in the same package as the
// interface can implement unexported methods.
type Differ struct {
2025-03-26 01:56:39 -05:00
DiffFn func(old, newVal any) Map
2022-04-25 13:57:59 -05:00
}
//nolint:unused
2025-03-26 01:56:39 -05:00
func (d Differ) diff(old, newVal any) Map {
return d.DiffFn(old, newVal)
}