Implement audit backend for TimescaleDB.

auditing/auditing.go

@@ -1,18 +1,16 @@
 package auditing
 
 import (
+	"context"
 	"log/slog"
+	"os"
+	"path/filepath"
 	"time"
 )
 
 type Config struct {
-	Component        string
-	URL              string
-	APIKey           string
-	IndexPrefix      string
-	RotationInterval Interval
-	Keep             int64
-	Log              *slog.Logger
+	Component string
+	Log       *slog.Logger
 }
 
 type Interval string
@@ -135,5 +133,14 @@ 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) {
+	ex, err := os.Executable()
+	if err != nil {
+		return "", err
+	}
+
+	return filepath.Base(ex), nil
 }

auditing/meilisearch.go

@@ -5,8 +5,6 @@ import (
 	"errors"
 	"fmt"
 	"log/slog"
-	"os"
-	"path/filepath"
 	"regexp"
 	"slices"
 	"strings"
@@ -17,6 +15,15 @@ import (
 	"github.com/meilisearch/meilisearch-go"
 )
 
+type MeilisearchConfig struct {
+	URL    string
+	APIKey string
+
+	IndexPrefix      string
+	RotationInterval Interval
+	Keep             int64
+}
+
 type meiliAuditing struct {
 	component        string
 	client           *meilisearch.Client
@@ -39,32 +46,33 @@ const (
 	meiliIndexCreationWaitInterval = 100 * time.Millisecond
 )
 
-func New(c Config) (Auditing, error) {
+func NewMeilisearch(c Config, mc MeilisearchConfig) (Auditing, error) {
 	if c.Component == "" {
-		ex, err := os.Executable()
+		component, err := defaultComponent()
 		if err != nil {
 			return nil, err
 		}
-		c.Component = filepath.Base(ex)
+
+		c.Component = component
 	}
 
 	client := meilisearch.NewClient(meilisearch.ClientConfig{
-		Host:   c.URL,
-		APIKey: c.APIKey,
+		Host:   mc.URL,
+		APIKey: mc.APIKey,
 	})
 	v, err := client.GetVersion()
 	if err != nil {
-		return nil, fmt.Errorf("unable to connect to meilisearch at:%s %w", c.URL, err)
+		return nil, fmt.Errorf("unable to connect to meilisearch at:%s %w", mc.URL, err)
 	}
-	c.Log.Info("meilisearch", "connected to", v, "index rotated", c.RotationInterval, "index keep", c.Keep)
+	c.Log.Info("meilisearch", "connected to", v, "index rotated", mc.RotationInterval, "index keep", mc.Keep)
 
 	a := &meiliAuditing{
 		component:        c.Component,
 		client:           client,
 		log:              c.Log.WithGroup("auditing"),
-		indexPrefix:      c.IndexPrefix,
-		rotationInterval: c.RotationInterval,
-		keep:             c.Keep,
+		indexPrefix:      mc.IndexPrefix,
+		rotationInterval: mc.RotationInterval,
+		keep:             mc.Keep,
 	}
 	return a, nil
 }
@@ -121,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))

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() {
@@ -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)),
@@ -277,10 +278,11 @@ func TestAuditing_Meilisearch(t *testing.T) {
 		tt := tt
 
 		t.Run(fmt.Sprintf("%d %s", i, tt.name), func(t *testing.T) {
-			a, err := New(Config{
+			a, err := NewMeilisearch(Config{
+				Log: slog.Default(),
+			}, MeilisearchConfig{
 				URL:         c.Endpoint,
 				APIKey:      c.Password,
-				Log:         slog.Default(),
 				IndexPrefix: fmt.Sprintf("test-%d", i),
 			})
 			require.NoError(t, err)