hanko/backend/persistence/audit_log_persister.go

package persistence

import (
	"database/sql"
	"errors"
	"fmt"
	"github.com/gobuffalo/pop/v6"
	"github.com/gofrs/uuid"
	"github.com/teamhanko/hanko/backend/persistence/models"
	"strings"
	"time"
)

type AuditLogPersister interface {
	Create(auditLog models.AuditLog) error
	Get(id uuid.UUID) (*models.AuditLog, error)
	List(page int, perPage int, startTime *time.Time, endTime *time.Time, types []string, userId string, email string, ip string, searchString string) ([]models.AuditLog, error)
	Count(startTime *time.Time, endTime *time.Time, types []string, userId string, email string, ip string, searchString string) (int, error)
	Cleanup[models.AuditLog]
}

type auditLogPersister struct {
	db *pop.Connection
}

func NewAuditLogPersister(db *pop.Connection) AuditLogPersister {
	return &auditLogPersister{db: db}
}

func (p *auditLogPersister) Create(auditLog models.AuditLog) error {
	vErr, err := p.db.ValidateAndCreate(&auditLog)
	if err != nil {
		return fmt.Errorf("failed to store auditlog: %w", err)
	}
	if vErr != nil && vErr.HasAny() {
		return fmt.Errorf("auditlog object validation failed: %w", vErr)
	}

	return nil
}

func (p *auditLogPersister) Get(id uuid.UUID) (*models.AuditLog, error) {
	auditLog := models.AuditLog{}
	err := p.db.Eager().Find(&auditLog, id)
	if err != nil && errors.Is(err, sql.ErrNoRows) {
		return nil, nil
	}
	if err != nil {
		return nil, fmt.Errorf("failed to get auditlog: %w", err)
	}

	return &auditLog, nil
}

func (p *auditLogPersister) List(page int, perPage int, startTime *time.Time, endTime *time.Time, types []string, userId string, email string, ip string, searchString string) ([]models.AuditLog, error) {
	auditLogs := []models.AuditLog{}

	query := p.db.Q()
	query = p.addQueryParamsToSqlQuery(query, startTime, endTime, types, userId, email, ip, searchString)
	err := query.Paginate(page, perPage).Order("created_at desc").All(&auditLogs)

	if err != nil && errors.Is(err, sql.ErrNoRows) {
		return auditLogs, nil
	}
	if err != nil {
		return nil, fmt.Errorf("failed to fetch auditLogs: %w", err)
	}

	return auditLogs, nil
}

func (p *auditLogPersister) Count(startTime *time.Time, endTime *time.Time, types []string, userId string, email string, ip string, searchString string) (int, error) {
	query := p.db.Q()
	query = p.addQueryParamsToSqlQuery(query, startTime, endTime, types, userId, email, ip, searchString)
	count, err := query.Count(&models.AuditLog{})
	if err != nil {
		return 0, fmt.Errorf("failed to get auditLog count: %w", err)
	}

	return count, nil
}

func (p *auditLogPersister) addQueryParamsToSqlQuery(query *pop.Query, startTime *time.Time, endTime *time.Time, types []string, userId string, email string, ip string, searchString string) *pop.Query {
	if startTime != nil {
		query = query.Where("created_at > ?", startTime)
	}
	if endTime != nil {
		query = query.Where("created_at < ?", endTime)
	}

	if len(types) > 0 {
		joined := "'" + strings.Join(types, "','") + "'"
		query = query.Where(fmt.Sprintf("type IN (%s)", joined))
	}

	if len(userId) > 0 {
		switch p.db.Dialect.Name() {
		case "postgres", "cockroach":
			query = query.Where("actor_user_id::text LIKE ?", "%"+userId+"%")
		case "mysql", "mariadb":
			query = query.Where("actor_user_id LIKE ?", "%"+userId+"%")
		}
	}

	if len(email) > 0 {
		query = query.Where("actor_email LIKE ?", "%"+email+"%")
	}

	if len(ip) > 0 {
		query = query.Where("meta_source_ip LIKE ?", "%"+ip+"%")
	}

	if len(searchString) > 0 {
		switch p.db.Dialect.Name() {
		case "postgres", "cockroach":
			arg := "%" + searchString + "%"
			query = query.Where("(actor_email LIKE ? OR meta_source_ip LIKE ? OR actor_user_id::text LIKE ?)", arg, arg, arg)
		case "mysql", "mariadb":
			arg := "%" + searchString + "%"
			query = query.Where("(actor_email LIKE ? OR meta_source_ip LIKE ? OR actor_user_id LIKE ?)", arg, arg, arg)
		}
	}

	return query
}

func (p *auditLogPersister) FindExpired(cutoffTime time.Time, page, perPage int) ([]models.AuditLog, error) {
	var items []models.AuditLog

	query := p.db.
		Where("created_at < ?", cutoffTime).
		Select("id").
		Paginate(page, perPage)
	err := query.All(&items)

	return items, err
}

func (p *auditLogPersister) Delete(auditLog models.AuditLog) error {
	err := p.db.Eager().Destroy(&auditLog)
	if err != nil {
		return fmt.Errorf("failed to delete auditlog: %w", err)
	}

	return nil
}