backend renaming and more docs

coder · coadler · May 9, 2022 · May 5, 2022 · May 9, 2022 · May 9, 2022
commit a60c1f7263e0ec79567995b814f1380005ce62af
diff --git a/coderd/audit/backends/postgres.go b/coderd/audit/backends/postgres.go
@@ -9,7 +9,7 @@ import (
 	"github.com/coder/coder/coderd/database"
 )
 
-type pgBackend struct {
+type postgresBackend struct {
 	// internal indicates if the exporter is exporting to the Postgres database
 	// that the rest of Coderd uses. Since this is a generic Postgres exporter,
 	// we make different decisions to store the audit log based on if it's
@@ -18,19 +18,19 @@ type pgBackend struct {
 	db       database.Store
 }
 
-func NewPGBackend(db database.Store, internal bool) audit.Backend {
-	return &pgBackend{db: db, internal: internal}
+func NewPostgres(db database.Store, internal bool) audit.Backend {
+	return &postgresBackend{db: db, internal: internal}
 }
 
-func (b *pgBackend) Decision() audit.FilterDecision {
+func (b *postgresBackend) Decision() audit.FilterDecision {
 	if b.internal {
 		return audit.FilterDecisionStore
 	}
 
 	return audit.FilterDecisionExport
 }
 
-func (b *pgBackend) Export(ctx context.Context, alog database.AuditLog) error {
+func (b *postgresBackend) Export(ctx context.Context, alog database.AuditLog) error {
 	_, err := b.db.InsertAuditLog(ctx, database.InsertAuditLogParams{
 		ID:             alog.ID,
 		Time:           alog.Time,

diff --git a/coderd/audit/backends/postgres_test.go b/coderd/audit/backends/postgres_test.go
@@ -24,7 +24,7 @@ func TestPostgresBackend(t *testing.T) {
 		var (
 			ctx, cancel = context.WithCancel(context.Background())
 			db          = databasefake.New()
-			pgb         = backends.NewPGBackend(db, true)
+			pgb         = backends.NewPostgres(db, true)
 			alog        = randomAuditLog()
 		)
 		defer cancel()

diff --git a/coderd/audit/backends/slog.go b/coderd/audit/backends/slog.go
@@ -14,7 +14,7 @@ type slogBackend struct {
 	log slog.Logger
 }
 
-func NewSlogBackend(logger slog.Logger) audit.Backend {
+func NewSlog(logger slog.Logger) audit.Backend {
 	return slogBackend{log: logger}
 }
 

diff --git a/coderd/audit/backends/slog_test.go b/coderd/audit/backends/slog_test.go
@@ -21,7 +21,7 @@ func TestSlogBackend(t *testing.T) {
 
 			sink    = &fakeSink{}
 			logger  = slog.Make(sink)
-			backend = backends.NewSlogBackend(logger)
+			backend = backends.NewSlog(logger)
 
 			alog = randomAuditLog()
 		)

diff --git a/coderd/audit/exporter.go b/coderd/audit/exporter.go
@@ -8,27 +8,31 @@ import (
 	"github.com/coder/coder/coderd/database"
 )
 
-// Backends can accept and store or send audit logs elsewhere.
+// Backends can store or send audit logs to arbitrary locations.
 type Backend interface {
 	// Decision determines the FilterDecisions that the backend tolerates.
 	Decision() FilterDecision
 	// Export sends an audit log to the backend.
 	Export(ctx context.Context, alog database.AuditLog) error
 }
 
-// Exporter exports audit logs to an arbitrary amount of backends.
+// Exporter exports audit logs to an arbitrary list of backends.
 type Exporter struct {
 	filter   Filter
 	backends []Backend
 }
 
+// NewExporter creates an exporter from the given filter and backends.
 func NewExporter(filter Filter, backends ...Backend) *Exporter {
 	return &Exporter{
 		filter:   filter,
 		backends: backends,
 	}
 }
 
+// Export exports and audit log. Before exporting to a backend, it uses the
+// filter to determine if the backend tolerates the audit log. If not, it is
+// dropped.
 func (e *Exporter) Export(ctx context.Context, alog database.AuditLog) error {
 	for _, backend := range e.backends {
 		decision, err := e.filter.Check(ctx, alog)