Small improvements.

metal-stack · Aug 23, 2024 · 5c3a30c · 5c3a30c
1 parent 7855e39
commit 5c3a30c
Show file tree

Hide file tree

Showing 6 changed files with 147 additions and 78 deletions.
diff --git a/auditing/auditing-interceptor.go b/auditing/auditing-interceptor.go
@@ -71,7 +71,7 @@ func UnaryServerInterceptor(a Auditing, logger *slog.Logger, shouldAudit func(fu
 		auditReqContext.StatusCode = statusCodeFromGrpc(err)
 
 		if err != nil {
-			auditReqContext.Error = err.Error()
+			auditReqContext.Error = err
 			err2 := a.Index(auditReqContext)
 			if err2 != nil {
 				logger.Error("unable to index", "error", err2)
@@ -129,7 +129,7 @@ func StreamServerInterceptor(a Auditing, logger *slog.Logger, shouldAudit func(f
 		auditReqContext.StatusCode = statusCodeFromGrpc(err)
 
 		if err != nil {
-			auditReqContext.Error = err.Error()
+			auditReqContext.Error = err
 			err2 := a.Index(auditReqContext)
 			if err2 != nil {
 				logger.Error("unable to index", "error", err2)
@@ -244,7 +244,7 @@ func (a auditingConnectInterceptor) WrapStreamingHandler(next connect.StreamingH
 		auditReqContext.StatusCode = statusCodeFromGrpc(err)
 
 		if err != nil {
-			auditReqContext.Error = err.Error()
+			auditReqContext.Error = err
 			err2 := a.auditing.Index(auditReqContext)
 			if err2 != nil {
 				a.logger.Error("unable to index", "error", err2)
@@ -311,7 +311,7 @@ func (i auditingConnectInterceptor) WrapUnary(next connect.UnaryFunc) connect.Un
 		auditReqContext.StatusCode = statusCodeFromGrpc(err)
 
 		if err != nil {
-			auditReqContext.Error = err.Error()
+			auditReqContext.Error = err
 			err2 := i.auditing.Index(auditReqContext)
 			if err2 != nil {
 				i.logger.Error("unable to index", "error", err2)
@@ -432,7 +432,7 @@ func HttpFilter(a Auditing, logger *slog.Logger) (restful.FilterFunction, error)
 		err = json.Unmarshal(body, &auditReqContext.Body)
 		if err != nil {
 			auditReqContext.Body = strBody
-			auditReqContext.Error = err.Error()
+			auditReqContext.Error = err
 		}
 
 		err = a.Index(auditReqContext)

diff --git a/auditing/auditing.go b/auditing/auditing.go
@@ -1,6 +1,7 @@
 package auditing
 
 import (
+	"context"
 	"log/slog"
 	"os"
 	"path/filepath"
@@ -49,39 +50,38 @@ const (
 const EntryFilterDefaultLimit int64 = 100
 
 type Entry struct {
-	Id string `db:"-"` // filled by the auditing driver
-
-	Component string    `db:"component"`
-	RequestId string    `db:"rqid" json:"rqid"`
-	Type      EntryType `db:"type"`
-	Timestamp time.Time `db:"timestamp"`
+	Id        string // filled by the auditing driver
+	Component string
+	RequestId string `json:"rqid"`
+	Type      EntryType
+	Timestamp time.Time
 
-	User   string `db:"userid"`
-	Tenant string `db:"tenant"`
+	User   string
+	Tenant string
 
 	// For `EntryDetailHTTP` the HTTP method get, post, put, delete, ...
 	// For `EntryDetailGRPC` unary, stream
-	Detail EntryDetail `db:"detail"`
+	Detail EntryDetail
 	// e.g. Request, Response, Error, Opened, Close
-	Phase EntryPhase `db:"phase"`
+	Phase EntryPhase
 	// For `EntryDetailHTTP` /api/v1/...
 	// For `EntryDetailGRPC` /api.v1/... (the method name)
-	Path         string `db:"path"`
-	ForwardedFor string `db:"forwardedfor"`
-	RemoteAddr   string `db:"remoteaddr"`
+	Path         string
+	ForwardedFor string
+	RemoteAddr   string
 
-	Body       any `db:"body"`       // JSON, string or numbers
-	StatusCode int `db:"statuscode"` // for `EntryDetailHTTP` the HTTP status code, for EntryDetailGRPC` the grpc status code
+	Body       any // JSON, string or numbers
+	StatusCode int // for `EntryDetailHTTP` the HTTP status code, for EntryDetailGRPC` the grpc status code
 
 	// Internal errors
-	Error string `db:"error"`
+	Error error
 }
 
 func (e *Entry) prepareForNextPhase() {
 	e.Id = ""
 	e.Timestamp = time.Now()
 	e.Body = nil
-	e.Error = ""
+	e.Error = nil
 
 	switch e.Phase {
 	case EntryPhaseRequest:
@@ -133,7 +133,7 @@ type Auditing interface {
 	// Searches for entries matching the given filter.
 	// By default only recent entries will be returned.
 	// The returned entries will be sorted by timestamp in descending order.
-	Search(EntryFilter) ([]Entry, error)
+	Search(context.Context, EntryFilter) ([]Entry, error)
 }
 
 func defaultComponent() (string, error) {

diff --git a/auditing/meilisearch.go b/auditing/meilisearch.go
@@ -129,7 +129,7 @@ func (a *meiliAuditing) Index(entry Entry) error {
 	return nil
 }
 
-func (a *meiliAuditing) Search(filter EntryFilter) ([]Entry, error) {
+func (a *meiliAuditing) Search(_ context.Context, filter EntryFilter) ([]Entry, error) {
 	predicates := make([]string, 0)
 	if filter.Component != "" {
 		predicates = append(predicates, fmt.Sprintf("component = %q", filter.Component))
@@ -274,8 +274,8 @@ func (a *meiliAuditing) encodeEntry(entry Entry) map[string]any {
 	if entry.StatusCode != 0 {
 		doc["status-code"] = entry.StatusCode
 	}
-	if entry.Error != "" {
-		doc["error"] = entry.Error
+	if entry.Error != nil {
+		doc["error"] = entry.Error.Error()
 	}
 	if entry.Body != nil {
 		doc["body"] = entry.Body
@@ -347,7 +347,7 @@ func (a *meiliAuditing) decodeEntry(doc map[string]any) Entry {
 		entry.StatusCode = int(statusCode)
 	}
 	if err, ok := doc["error"].(string); ok {
-		entry.Error = err
+		entry.Error = errors.New(err)
 	}
 	if body, ok := doc["body"]; ok {
 		entry.Body = body

diff --git a/auditing/meilisearch_integration_test.go b/auditing/meilisearch_integration_test.go
@@ -70,6 +70,7 @@ func StartMeilisearch(t testing.TB) (container testcontainers.Container, c *conn
 }
 
 func TestAuditing_Meilisearch(t *testing.T) {
+	ctx := context.Background()
 	container, c, err := StartMeilisearch(t)
 	require.NoError(t, err)
 	defer func() {
@@ -99,7 +100,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 				RemoteAddr:   "10.0.0.0",
 				Body:         "This is the body of 00000000-0000-0000-0000-000000000000",
 				StatusCode:   200,
-				Error:        "",
+				Error:        nil,
 			},
 			{
 				Component:    "auditing.test",
@@ -115,7 +116,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 				RemoteAddr:   "10.0.0.1",
 				Body:         "This is the body of 00000000-0000-0000-0000-000000000001",
 				StatusCode:   201,
-				Error:        "",
+				Error:        nil,
 			},
 			{
 				Component:    "auditing.test",
@@ -131,7 +132,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 				RemoteAddr:   "10.0.0.2",
 				Body:         "This is the body of 00000000-0000-0000-0000-000000000002",
 				StatusCode:   0,
-				Error:        "",
+				Error:        nil,
 			},
 		}
 	}
@@ -143,7 +144,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 		{
 			name: "no entries, no search results",
 			t: func(t *testing.T, a Auditing) {
-				entries, err := a.Search(EntryFilter{})
+				entries, err := a.Search(ctx, EntryFilter{})
 				require.NoError(t, err)
 				assert.Empty(t, entries)
 			},
@@ -158,7 +159,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 				err = a.Flush()
 				require.NoError(t, err)
 
-				entries, err := a.Search(EntryFilter{
+				entries, err := a.Search(ctx, EntryFilter{
 					Body: "test",
 				})
 				require.NoError(t, err)
@@ -177,7 +178,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 				err = a.Flush()
 				require.NoError(t, err)
 
-				entries, err := a.Search(EntryFilter{})
+				entries, err := a.Search(ctx, EntryFilter{})
 				require.NoError(t, err)
 				assert.Len(t, entries, len(es))
 
@@ -187,7 +188,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 					t.Errorf("diff (+got -want):\n %s", diff)
 				}
 
-				entries, err = a.Search(EntryFilter{
+				entries, err = a.Search(ctx, EntryFilter{
 					Body: "This",
 				})
 				require.NoError(t, err)
@@ -206,7 +207,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 				err = a.Flush()
 				require.NoError(t, err)
 
-				entries, err := a.Search(EntryFilter{
+				entries, err := a.Search(ctx, EntryFilter{
 					RequestId: es[0].RequestId,
 				})
 				require.NoError(t, err)
@@ -234,7 +235,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 				err = a.Flush()
 				require.NoError(t, err)
 
-				entries, err := a.Search(EntryFilter{
+				entries, err := a.Search(ctx, EntryFilter{
 					Phase: EntryPhaseResponse,
 				})
 				require.NoError(t, err)
@@ -259,7 +260,7 @@ func TestAuditing_Meilisearch(t *testing.T) {
 				err = a.Flush()
 				require.NoError(t, err)
 
-				entries, err := a.Search(EntryFilter{
+				entries, err := a.Search(ctx, EntryFilter{
 					// we want to run a phrase search as otherwise we return the other entries as well
 					// https://www.meilisearch.com/docs/reference/api/search#phrase-search-2
 					Body: fmt.Sprintf("%q", es[0].Body.(string)),