Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Server side pagination for user audit logs api #1619

Merged
merged 2 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions deepfence_server/apiDocs/operation.go
Original file line number Diff line number Diff line change
Expand Up @@ -735,9 +735,12 @@ func (d *OpenApiDocs) AddSettingsOperations() {
d.AddOperation("updateSetting", http.MethodPatch, "/deepfence/settings/global-settings/{id}",
"Update setting", "Update setting",
http.StatusNoContent, []string{tagSettings}, bearerToken, new(SettingUpdateRequest), nil)
d.AddOperation("getUserActivityLogs", http.MethodGet, "/deepfence/settings/user-activity-log",
"Get activity logs", "Get activity logs for all users",
http.StatusOK, []string{tagSettings}, bearerToken, nil, new([]postgresqldb.GetAuditLogsRow))
d.AddOperation("getUserAuditLogs", http.MethodPost, "/deepfence/settings/user-audit-log",
"Get user audit logs", "Get audit logs for all users",
http.StatusOK, []string{tagSettings}, bearerToken, new(GetAuditLogsRequest), new([]postgresqldb.GetAuditLogsRow))
d.AddOperation("getUserAuditLogsCount", http.MethodGet, "/deepfence/settings/user-audit-log/count",
"Get user audit logs count", "Get user audit logs count",
http.StatusOK, []string{tagSettings}, bearerToken, nil, new(SearchCountResp))

// Scheduled tasks
d.AddOperation("getScheduledTasks", http.MethodGet, "/deepfence/scheduled-task",
Expand Down
35 changes: 34 additions & 1 deletion deepfence_server/handler/audit_log.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"time"

"github.com/deepfence/ThreatMapper/deepfence_server/model"
reporters_search "github.com/deepfence/ThreatMapper/deepfence_server/reporters/search"
"github.com/deepfence/ThreatMapper/deepfence_utils/directory"
"github.com/deepfence/ThreatMapper/deepfence_utils/log"
postgresql_db "github.com/deepfence/ThreatMapper/deepfence_utils/postgresql/postgresql-db"
Expand Down Expand Up @@ -155,7 +156,36 @@ func (h *Handler) AddAuditLog(namespace string, params postgresql_db.CreateAudit
return nil
}

func (h *Handler) GetAuditLogsCount(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()
pgClient, err := directory.PostgresClient(ctx)
if err != nil {
log.Error().Err(err).Msg("failed to get db connection")
h.respondError(err, w)
return
}

count, err := pgClient.CountAuditLogs(ctx)
if err != nil {
log.Error().Err(err).Msg("failed to run CountAuditLogs query")
h.respondError(err, w)
return
}

httpext.JSON(w, http.StatusOK, reporters_search.SearchCountResp{
Count: int(count),
})
}

func (h *Handler) GetAuditLogs(w http.ResponseWriter, r *http.Request) {
defer r.Body.Close()
var req model.GetAuditLogsRequest
err := httpext.DecodeJSON(r, httpext.NoQueryParams, MaxPostRequestSize, &req)
if err != nil {
h.respondError(&BadDecoding{err}, w)
return
}

ctx := r.Context()
pgClient, err := directory.PostgresClient(ctx)
if err != nil {
Expand All @@ -164,7 +194,10 @@ func (h *Handler) GetAuditLogs(w http.ResponseWriter, r *http.Request) {
return
}

auditLogs, err := pgClient.GetAuditLogs(ctx)
auditLogs, err := pgClient.GetAuditLogs(ctx, postgresql_db.GetAuditLogsParams{
Offset: int32(req.Window.Offset),
Limit: int32(req.Window.Size),
})
if err != nil {
log.Error().Msgf("%v", err)
h.respondError(err, w)
Expand Down
4 changes: 4 additions & 0 deletions deepfence_server/model/setting.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ type SettingsResponse struct {
Description string `json:"description" required:"true"`
}

type GetAuditLogsRequest struct {
Window FetchWindow `json:"window" required:"true"`
}

type SettingUpdateRequest struct {
ID int64 `path:"id" validate:"required" required:"true"`
Key string `json:"key" validate:"required,oneof=console_url inactive_delete_scan_results" required:"true" enum:"console_url,inactive_delete_scan_results"`
Expand Down
5 changes: 4 additions & 1 deletion deepfence_server/router/router.go
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,10 @@ func SetupRoutes(r *chi.Mux, serverPort string, serveOpenapiDocs bool, ingestC c
})

r.Route("/settings", func(r chi.Router) {
r.Get("/user-activity-log", dfHandler.AuthHandler(ResourceSettings, PermissionRead, dfHandler.GetAuditLogs))
r.Route("/user-audit-log", func(r chi.Router) {
r.Post("/", dfHandler.AuthHandler(ResourceSettings, PermissionRead, dfHandler.GetAuditLogs))
r.Get("/count", dfHandler.AuthHandler(ResourceSettings, PermissionRead, dfHandler.GetAuditLogsCount))
})
r.Route("/global-settings", func(r chi.Router) {
r.Get("/", dfHandler.AuthHandler(ResourceSettings, PermissionRead, dfHandler.GetGlobalSettings))
r.Patch("/{id}", dfHandler.AuthHandler(ResourceSettings, PermissionWrite, dfHandler.UpdateGlobalSettings))
Expand Down
2 changes: 1 addition & 1 deletion deepfence_utils/postgresql/postgresql-db/db.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion deepfence_utils/postgresql/postgresql-db/models.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 22 additions & 4 deletions deepfence_utils/postgresql/postgresql-db/queries.sql.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion deepfence_utils/postgresql/queries.sql
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,12 @@ SELECT l.event,
l.user_role as role,
l.created_at
FROM audit_log l
ORDER BY l.created_at DESC;
ORDER BY id DESC
OFFSET $1 LIMIT $2;

-- name: CountAuditLogs :one
SELECT count(*)
FROM audit_log;

-- name: GetAuditLogsLast5Minutes :many
SELECT l.event,
Expand Down