Audit Event CheckList #181

Merged

Quaternions merged 17 commits from audit-checkreport into staging 2025-06-14 02:33:20 +00:00

Conversation 3 Commits 17 Files Changed 25 +1725 -101

Quaternions commented 2025-06-08 06:53:03 +00:00

Owner

Copy Link

Depends on #160, #196, #197.

Closes #147.

This introduces a new type of audit event: the CheckList. This is a list of map checks that the validator performed. The intention is to update the web interface to display ✅ check marks for every check passed and ❌ for every check failed, and also include the summary of why the check failed. The Details field would be the complete internal structure of the check in json, but I'm thinking it's unnecessary and should just be omitted. The Details field has been removed.

type Check struct {
	Name    string `json:"name"`
	Summary string `json:"summary"`
	Passed  bool   `json:"passed"`
}

type AuditEventDataCheckList struct {
	CheckList []Check `json:"check_list"`
}

This is created instead of the Error audit event when the validator requests changes, but the Error audit event can still be created for other purposes.

• Make a proper error instead of hijacking a CheckList

Depends on #160, #196, #197. Closes #147. This introduces a new type of audit event: the CheckList. This is a list of map checks that the validator performed. The intention is to update the web interface to display ✅ check marks for every check passed and ❌ for every check failed, and also include the summary of why the check failed. ~~The `Details` field would be the complete internal structure of the check in json, but I'm thinking it's unnecessary and should just be omitted.~~ The `Details` field has been removed. ```go type Check struct { Name string `json:"name"` Summary string `json:"summary"` Passed bool `json:"passed"` } type AuditEventDataCheckList struct { CheckList []Check `json:"check_list"` } ``` This is created instead of the Error audit event when the validator requests changes, but the Error audit event can still be created for other purposes. - [x] Make a proper error instead of hijacking a CheckList

Quaternions added 8 commits 2025-06-08 06:53:03 +00:00

format 3fcaf86b69

submissions: AuditEvent CheckReport b44d046972

openapi: send detailed CheckList on internal changes requested 60b398b7e9

openapi: generate 16b428ef31

submissions-api: update changes requested internal endpoint 28b9de7a3c

validation: plumb out CheckList 7c8b1c40cf

validation: hijack check system to report internal error ... 17a1cc123b

This should really use the dedicated error audit event somehow

submissions: accept CheckList in internal changes requested 58433afa91

Quaternions force-pushed audit-checkreport from 58433afa91 to fb76be406e 2025-06-08 06:53:31 +00:00 Compare

Quaternions added 2 commits 2025-06-09 01:14:18 +00:00

remove details 1e566c1738

openapi: generate def8324414

Quaternions force-pushed audit-checkreport from def8324414 to 820a9765bd 2025-06-11 05:19:27 +00:00 Compare

Quaternions force-pushed audit-checkreport from 820a9765bd to 9efd87a6c9 2025-06-12 01:22:08 +00:00 Compare

Quaternions changed title from Audit Event CheckReport to Audit Event CheckList 2025-06-12 01:22:37 +00:00

Quaternions added 1 commit 2025-06-12 01:23:49 +00:00

submissions: snake_case CheckList audit event 6bba14832c

Quaternions commented 2025-06-12 01:29:32 +00:00

Author

Owner

Copy Link

2 months ago: old
1 minute ago: new

2 months ago: old 1 minute ago: new 

image.png

138 KiB

Quaternions added the backendvalidator labels 2025-06-12 01:32:49 +00:00

Quaternions added 1 commit 2025-06-12 01:39:32 +00:00

validation: remove unnecessary derives ef0044ce99

Quaternions requested review from itzaname 2025-06-12 01:40:13 +00:00

Quaternions commented 2025-06-12 01:40:48 +00:00

Author

Owner

Copy Link

@itzaname Please confirm that this data is sufficient for the frontend, especially as it pertains to the future web implementation. You can see the initial web implementation in web/src/app/ts/AuditEvent.ts.

@itzaname Please confirm that this data is sufficient for the frontend, especially as it pertains to the future web implementation. You can see the initial web implementation in `web/src/app/ts/AuditEvent.ts`.

Quaternions added 1 commit 2025-06-12 03:26:17 +00:00

validation: tweak check name c38cc2d56e

itzaname approved these changes 2025-06-13 23:43:12 +00:00

itzaname left a comment

Owner

Copy Link

LGTM

LGTM

Quaternions merged commit ed7109270f into staging 2025-06-14 02:33:20 +00:00

Quaternions deleted branch audit-checkreport 2025-06-14 02:33:20 +00:00

Quaternions referenced this issue from a commit 2025-06-14 02:33:22 +00:00

Audit Event CheckList (#181)

Sign in to join this conversation.

Reviewers

No Reviewers

itzaname

Labels

Clear labels

backend

Submissions api related

bug

Something is not working

duplicate

This issue or pull request already exists

enhancement

New feature

frontend

Website related

help wanted

Need some help

invalid

Something is wrong

question

More information is needed

validator

Map validation related

wontfix

This won't be fixed

No Label backend validator

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

aidan9382 CI dowoge ic3w0lf22 interpreterK itzaname Quaternions

No Assignees

2 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: StrafesNET/maps-service#181