Open platform to collect and prioritize feedback
feature: Add Support for Persisting Audit Events (#551)
Cooper Filbyc7efc927f505
diff --git a/app/models/infra.go b/app/models/infra.goindex 2b1335569..e47a4f100 100644--- a/app/models/infra.go+++ b/app/models/infra.go@@ -97,3 +97,11 @@ var (type APIAuthorize struct {APIKey string `json:"apiKey"`}++// Event is used for tracking client audit events and actions+type Event struct {+ ID int `json:"id"`+ ClientIP string `json:"clientIP"`+ Name string `json:"name"`+ CreatedAt time.Time `json:"createdAt"`+}diff --git a/app/pkg/web/request.go b/app/pkg/web/request.goindex bd7b3b2a3..73121f42c 100644--- a/app/pkg/web/request.go+++ b/app/pkg/web/request.go@@ -49,9 +49,6 @@ func WrapRequest(request *http.Request) Request {clientIP := request.Header.Get("X-Forwarded-For")if clientIP == "" {clientIP = strings.Split(request.RemoteAddr, ":")[0]- if clientIP == "" {- clientIP = "N/A"- }} else {clientIP = strings.Split(clientIP, ",")[0]}diff --git a/app/pkg/web/request_test.go b/app/pkg/web/request_test.goindex 859771425..468134aa4 100644--- a/app/pkg/web/request_test.go+++ b/app/pkg/web/request_test.go@@ -51,7 +51,7 @@ func TestRequest_WithPort(t *testing.T) {Expect(req.Method).Equals("GET")Expect(req.GetHeader("Content-Type")).Equals("application/json")- Expect(req.ClientIP).Equals("N/A")+ Expect(req.ClientIP).Equals("")Expect(req.URL.Hostname()).Equals("helloworld.com")Expect(req.URL.Scheme).Equals("http")Expect(req.URL.Port()).Equals("3000")diff --git a/app/storage/inmemory/event.go b/app/storage/inmemory/event.gonew file mode 100644index 000000000..761d3e2b3--- /dev/null+++ b/app/storage/inmemory/event.go@@ -0,0 +1,50 @@+package inmemory++import (+ "time"++ "github.com/getfider/fider/app/models"+)++// EventStorage contains read and write operations for Audit Events+type EventStorage struct {+ lastID int+ user *models.User+ tenant *models.Tenant+ events map[int]*models.Event+}++// NewEventStorage creates a new inmemory EventStorage+func NewEventStorage() *EventStorage {+ return &EventStorage{}+}++// SetCurrentTenant to current context+func (e *EventStorage) SetCurrentTenant(tenant *models.Tenant) {+ e.tenant = tenant+}++// SetCurrentUser to current context+func (e *EventStorage) SetCurrentUser(user *models.User) {+ e.user = user+}++// Add stores a new event+func (e *EventStorage) Add(clientIP, name string) (*models.Event, error) {+ e.lastID+++ event := &models.Event{+ ID: e.lastID,+ ClientIP: clientIP,+ Name: name,+ CreatedAt: time.Now(),+ }+ e.events[event.ID] = event++ return event, nil+}++// GetByID returns the event with the specified id+func (e *EventStorage) GetByID(id int) (*models.Event, error) {+ event := e.events[id]+ return event, nil+}diff --git a/app/storage/postgres/event.go b/app/storage/postgres/event.gonew file mode 100644index 000000000..ddc1af6e0--- /dev/null+++ b/app/storage/postgres/event.go@@ -0,0 +1,92 @@+package postgres++import (+ "database/sql"+ "time"++ "github.com/getfider/fider/app/models"+ "github.com/getfider/fider/app/pkg/dbx"+ "github.com/getfider/fider/app/pkg/errors"+)++type dbEvent struct {+ ID int `db:"id"`+ TenantID int `db:"tenant_id"`+ ClientIP sql.NullString `db:"client_ip"`+ Name string `db:"name"`+ CreatedAt time.Time `db:"created_at"`+}++func (d *dbEvent) toModel() *models.Event {+ return &models.Event{+ ID: d.ID,+ ClientIP: d.ClientIP.String,+ Name: d.Name,+ CreatedAt: d.CreatedAt,+ }+}++// EventStorage contains read and write operations for Audit Events+type EventStorage struct {+ trx *dbx.Trx+ user *models.User+ tenant *models.Tenant+}++// NewEventStorage creates a new inmemory EventStorage+func NewEventStorage(trx *dbx.Trx) *EventStorage {+ return &EventStorage{+ trx: trx,+ }+}++// SetCurrentTenant to current context+func (e *EventStorage) SetCurrentTenant(tenant *models.Tenant) {+ e.tenant = tenant+}++// SetCurrentUser to current context+func (e *EventStorage) SetCurrentUser(user *models.User) {+ e.user = user+}++// Add stores a new event+func (e *EventStorage) Add(clientIP, name string) (*models.Event, error) {+ event := &models.Event{+ ClientIP: clientIP,+ Name: name,+ CreatedAt: time.Now(),+ }+ dbClientIP := sql.NullString{+ String: clientIP,+ Valid: len(clientIP) > 0,+ }++ err := e.trx.Get(&event.ID, `+ INSERT INTO events (tenant_id, client_ip, name, created_at)+ VALUES ($1, $2, $3, $4)+ RETURNING id+ `, e.tenant.ID, dbClientIP, event.Name, event.CreatedAt)++ if err != nil {+ return nil, errors.Wrap(err, "failed to insert event")+ }++ return event, nil+}++// GetByID returns the event with the specified id+func (e *EventStorage) GetByID(id int) (*models.Event, error) {+ event := &dbEvent{}+ err := e.trx.Get(event, `+ SELECT id, tenant_id, client_ip, name, created_at+ FROM events+ WHERE id = $1 AND tenant_id = $2+ `, id, e.tenant.ID)++ if err != nil {+ return nil, errors.Wrap(err, "failed to find event with id %d", id)+ }++ return event.toModel(), nil+}diff --git a/app/storage/postgres/event_test.go b/app/storage/postgres/event_test.gonew file mode 100644index 000000000..945543cfe--- /dev/null+++ b/app/storage/postgres/event_test.go@@ -0,0 +1,41 @@+package postgres_test++import (+ "testing"++ . "github.com/getfider/fider/app/pkg/assert"+)++func TestEventStorage_AddAndGet(t *testing.T) {+ SetupDatabaseTest(t)+ defer TeardownDatabaseTest()++ events.SetCurrentTenant(demoTenant)++ clientIP := "127.0.0.1"+ name := "posts.create"+ event, err := events.Add(clientIP, name)+ Expect(err).IsNil()++ event, err = events.GetByID(event.ID)+ Expect(err).IsNil()+ Expect(event.ClientIP).Equals(clientIP)+ Expect(event.Name).Equals(name)+}++func TestEventStorage_AddAndGetWithNullClientIP(t *testing.T) {+ SetupDatabaseTest(t)+ defer TeardownDatabaseTest()++ events.SetCurrentTenant(demoTenant)++ clientIP := ""+ name := "tenant.register"+ event, err := events.Add(clientIP, name)+ Expect(err).IsNil()++ event, err = events.GetByID(event.ID)+ Expect(err).IsNil()+ Expect(event.ClientIP).Equals(clientIP)+ Expect(event.Name).Equals(name)+}diff --git a/app/storage/postgres/setup_test.go b/app/storage/postgres/setup_test.goindex e5bb00d5a..d072d6041 100644--- a/app/storage/postgres/setup_test.go+++ b/app/storage/postgres/setup_test.go@@ -18,6 +18,7 @@ var users *postgres.UserStoragevar posts *postgres.PostStoragevar tags *postgres.TagStoragevar notifications *postgres.NotificationStorage+var events *postgres.EventStoragevar demoTenant *models.Tenantvar avengersTenant *models.Tenant@@ -36,6 +37,7 @@ func SetupDatabaseTest(t *testing.T) {posts = postgres.NewPostStorage(trx)tags = postgres.NewTagStorage(trx)notifications = postgres.NewNotificationStorage(trx)+ events = postgres.NewEventStorage(trx)demoTenant, _ = tenants.GetByDomain("demo")avengersTenant, _ = tenants.GetByDomain("avengers")diff --git a/app/storage/storage.go b/app/storage/storage.goindex 522380adf..149d67dd1 100644--- a/app/storage/storage.go+++ b/app/storage/storage.go@@ -102,3 +102,10 @@ type Notification interface {GetActiveNotifications() ([]*models.Notification, error)GetNotification(id int) (*models.Notification, error)}++// Event contains read and write operations for Audit Events+type Event interface {+ Base+ Add(clientIP, name string) (*models.Event, error)+ GetByID(id int) (*models.Event, error)+}diff --git a/migrations/201810022329_add_events.sql b/migrations/201810022329_add_events.sqlnew file mode 100644index 000000000..70acdb56c--- /dev/null+++ b/migrations/201810022329_add_events.sql@@ -0,0 +1,9 @@+CREATE TABLE IF NOT EXISTS events (+ id SERIAL NOT NULL,+ tenant_id INT NOT NULL,+ client_ip INET,+ name VARCHAR(64) NOT NULL,+ created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),+ PRIMARY KEY (id),+ FOREIGN KEY (tenant_id) REFERENCES tenants(id)+);\ No newline at end of file