tenseleyflow/shithub / ad6dfd8

Browse files

M: audit-log uniformity + renderBodyHTML helper for issues/PRs/reviews

Authored by mfwolffe <wolffemf@dukes.jmu.edu>
SHA
ad6dfd840e0c28f3553a8e8d8b0a45e004cb296b
Parents
edda2d6
Tree
8197f23

7 changed files

StatusFile+-
M internal/auth/audit/audit.go 9 2
M internal/issues/issues.go 39 2
M internal/pulls/pulls.go 24 18
M internal/pulls/review/comment.go 2 3
M internal/pulls/review/review.go 16 0
M internal/pulls/review/submit.go 1 2
M internal/pulls/state.go 10 1
internal/auth/audit/audit.gomodified
@@ -60,6 +60,11 @@ const (
6060
 	ActionRepoTransferDeclined   Action = "repo_transfer_declined"
6161
 	ActionRepoTransferCanceled   Action = "repo_transfer_canceled"
6262
 	ActionRepoTransferExpired    Action = "repo_transfer_expired"
63
+	ActionIssueStateChanged      Action = "issue_state_changed"
64
+	ActionIssueLockChanged       Action = "issue_lock_changed"
65
+	ActionIssueCommentCreated    Action = "issue_comment_created"
66
+	ActionPullStateChanged       Action = "pull_state_changed"
67
+	ActionPullMerged             Action = "pull_merged"
6368
 )
6469
6570
 // Target is a typed target-type constant.
@@ -68,6 +73,8 @@ type Target string
6873
 const (
6974
 	TargetUser  Target = "user"
7075
 	TargetRepo  Target = "repo"
76
+	TargetIssue Target = "issue"
77
+	TargetPull  Target = "pull"
7178
 )
7279
7380
 // Recorder writes audit rows. Bound to the sqlc queries handle.
internal/issues/issues.gomodified
@@ -21,6 +21,7 @@ import (
2121
 	"github.com/jackc/pgx/v5/pgtype"
2222
 	"github.com/jackc/pgx/v5/pgxpool"
2323
24
+	"github.com/tenseleyFlow/shithub/internal/auth/audit"
2425
 	"github.com/tenseleyFlow/shithub/internal/auth/throttle"
2526
 	issuesdb "github.com/tenseleyFlow/shithub/internal/issues/sqlc"
2627
 	mdrender "github.com/tenseleyFlow/shithub/internal/markdown"
@@ -33,6 +34,12 @@ type Deps struct {
3334
 	Pool    *pgxpool.Pool
3435
 	Limiter *throttle.Limiter
3536
 	Logger  *slog.Logger
37
+	// Audit is optional; when non-nil, state-changing orchestrator
38
+	// calls (SetState, SetLock, AddComment) record an audit row. The
39
+	// repo lifecycle package writes audit rows directly via deps.Audit;
40
+	// this field ensures issues/PR mutations are equally traceable
41
+	// (S00-S25 audit, M).
42
+	Audit *audit.Recorder
3643
 }
3744
3845
 // Errors returned by the orchestrator. Handlers map these to status
@@ -117,7 +124,7 @@ func Create(ctx context.Context, deps Deps, p CreateParams) (issuesdb.Issue, err
117124
 	}
118125
119126
 	// Render markdown for the cached body html.
120
-	html, _ := mdrender.RenderHTML([]byte(p.Body))
127
+	html := renderBodyHTML(ctx, deps, p.Body)
121128
 	row.BodyHtmlCached = pgtype.Text{String: html, Valid: html != ""}
122129
123130
 	if err := q.UpdateIssueTitleBody(ctx, tx, issuesdb.UpdateIssueTitleBodyParams{
@@ -178,7 +185,7 @@ func AddComment(ctx context.Context, deps Deps, p CommentCreateParams) (issuesdb
178185
 		return issuesdb.IssueComment{}, ErrIssueLocked
179186
 	}
180187
181
-	html, _ := mdrender.RenderHTML([]byte(body))
188
+	html := renderBodyHTML(ctx, deps, body)
182189
183190
 	tx, err := deps.Pool.Begin(ctx)
184191
 	if err != nil {
@@ -209,6 +216,11 @@ func AddComment(ctx context.Context, deps Deps, p CommentCreateParams) (issuesdb
209216
 		return issuesdb.IssueComment{}, err
210217
 	}
211218
 	committed = true
219
+	if deps.Audit != nil {
220
+		_ = deps.Audit.Record(ctx, deps.Pool, p.AuthorUserID,
221
+			audit.ActionIssueCommentCreated, audit.TargetIssue, p.IssueID,
222
+			map[string]any{"comment_id": c.ID})
223
+	}
212224
 	return c, nil
213225
 }
214226
@@ -262,6 +274,11 @@ func SetState(ctx context.Context, deps Deps, actorUserID, issueID int64, newSta
262274
 		return err
263275
 	}
264276
 	committed = true
277
+	if deps.Audit != nil {
278
+		_ = deps.Audit.Record(ctx, deps.Pool, actorUserID,
279
+			audit.ActionIssueStateChanged, audit.TargetIssue, issueID,
280
+			map[string]any{"state": newState, "reason": reason})
281
+	}
265282
 	return nil
266283
 }
267284
@@ -308,5 +325,25 @@ func SetLock(ctx context.Context, deps Deps, actorUserID, issueID int64, locked
308325
 		return err
309326
 	}
310327
 	committed = true
328
+	if deps.Audit != nil {
329
+		_ = deps.Audit.Record(ctx, deps.Pool, actorUserID,
330
+			audit.ActionIssueLockChanged, audit.TargetIssue, issueID,
331
+			map[string]any{"locked": locked, "reason": reason})
332
+	}
311333
 	return nil
312334
 }
335
+
336
+// renderBodyHTML wraps markdown.RenderHTML with a logger-aware error
337
+// path. Body length is bounded upstream (orchestrator validation +
338
+// DB CHECK at 65535), so ErrInputTooLarge is structurally impossible
339
+// here — but if it ever fires, log loudly: it means a precondition
340
+// somewhere upstream regressed. The audit (S00-S25, M) flagged the
341
+// `_`-discard pattern as the kind of slop where a real bug could hide.
342
+func renderBodyHTML(ctx context.Context, deps Deps, body string) string {
343
+	html, err := mdrender.RenderHTML([]byte(body))
344
+	if err != nil && deps.Logger != nil {
345
+		deps.Logger.WarnContext(ctx, "issues: markdown render failed",
346
+			"error", err, "body_bytes", len(body))
347
+	}
348
+	return html
349
+}
internal/pulls/pulls.gomodified
@@ -21,20 +21,21 @@ import (
2121
 	"errors"
2222
 	"fmt"
2323
 	"log/slog"
24
-	"path/filepath"
2524
 	"strings"
2625
2726
 	"github.com/jackc/pgx/v5"
2827
 	"github.com/jackc/pgx/v5/pgtype"
2928
 	"github.com/jackc/pgx/v5/pgxpool"
3029
30
+	"github.com/tenseleyFlow/shithub/internal/auth/audit"
3131
 	"github.com/tenseleyFlow/shithub/internal/checks"
3232
 	"github.com/tenseleyFlow/shithub/internal/issues"
3333
 	issuesdb "github.com/tenseleyFlow/shithub/internal/issues/sqlc"
34
+	mdrender "github.com/tenseleyFlow/shithub/internal/markdown"
3435
 	"github.com/tenseleyFlow/shithub/internal/pulls/review"
3536
 	pullsdb "github.com/tenseleyFlow/shithub/internal/pulls/sqlc"
3637
 	repogit "github.com/tenseleyFlow/shithub/internal/repos/git"
37
-	mdrender "github.com/tenseleyFlow/shithub/internal/markdown"
38
+	"github.com/tenseleyFlow/shithub/internal/repos/protection"
3839
 	reposdb "github.com/tenseleyFlow/shithub/internal/repos/sqlc"
3940
 )
4041
@@ -42,6 +43,10 @@ import (
4243
 type Deps struct {
4344
 	Pool   *pgxpool.Pool
4445
 	Logger *slog.Logger
46
+	// Audit is optional; when non-nil, Merge and SetState write audit
47
+	// rows. Mirrors the issues orchestrator's contract so PR-side
48
+	// state changes are equally traceable (S00-S25 audit, M).
49
+	Audit *audit.Recorder
4550
 }
4651
4752
 // Errors surfaced to handlers.
@@ -372,23 +377,11 @@ func loadRequiredCheckNames(ctx context.Context, pool *pgxpool.Pool, repoID int6
372377
 	if err != nil {
373378
 		return nil, err
374379
 	}
375
-	var best reposdb.BranchProtectionRule
376
-	bestLen := -1
377
-	for _, r := range rules {
378
-		ok, _ := filepath.Match(r.Pattern, baseRef)
380
+	rule, ok := protection.MatchLongestRule(rules, baseRef)
379381
 	if !ok {
380
-			continue
381
-		}
382
-		if len(r.Pattern) > bestLen ||
383
-			(len(r.Pattern) == bestLen && r.Pattern < best.Pattern) {
384
-			best = r
385
-			bestLen = len(r.Pattern)
386
-		}
387
-	}
388
-	if bestLen < 0 {
389382
 		return []string{}, nil
390383
 	}
391
-	return best.StatusChecksRequired, nil
384
+	return rule.StatusChecksRequired, nil
392385
 }
393386
394387
 // int64FromPg unwraps a pgtype.Int8; returns 0 when invalid.
@@ -412,7 +405,7 @@ func EditPR(ctx context.Context, deps Deps, prID int64, title, body string) erro
412405
 	if len(body) > 65535 {
413406
 		return issues.ErrBodyTooLong
414407
 	}
415
-	html, _ := mdrender.RenderHTML([]byte(body))
408
+	html := renderBodyHTML(ctx, deps, body)
416409
 	q := issuesdb.New()
417410
 	return q.UpdateIssueTitleBody(ctx, deps.Pool, issuesdb.UpdateIssueTitleBodyParams{
418411
 		ID:             prID,
@@ -468,3 +461,16 @@ func AllowedMethod(repo reposdb.Repo, method string) bool {
468461
 	}
469462
 	return false
470463
 }
464
+
465
+// renderBodyHTML wraps markdown.RenderHTML with a logger-aware error
466
+// path. PR body length is bounded upstream at 65535 chars by the
467
+// orchestrator; markdown caps at 1 MiB. ErrInputTooLarge here means
468
+// a precondition regressed — log loudly. (S00-S25 audit, M.)
469
+func renderBodyHTML(ctx context.Context, deps Deps, body string) string {
470
+	html, err := mdrender.RenderHTML([]byte(body))
471
+	if err != nil && deps.Logger != nil {
472
+		deps.Logger.WarnContext(ctx, "pulls: markdown render failed",
473
+			"error", err, "body_bytes", len(body))
474
+	}
475
+	return html
476
+}
internal/pulls/review/comment.gomodified
@@ -12,7 +12,6 @@ import (
1212
 	"github.com/jackc/pgx/v5/pgtype"
1313
1414
 	pullsdb "github.com/tenseleyFlow/shithub/internal/pulls/sqlc"
15
-	mdrender "github.com/tenseleyFlow/shithub/internal/markdown"
1615
 )
1716
1817
 // CommentParams describes a single inline comment on a PR. When
@@ -76,7 +75,7 @@ func AddComment(ctx context.Context, deps Deps, p CommentParams) (pullsdb.PrRevi
7675
 		}
7776
 	}
7877
79
-	html, _ := mdrender.RenderHTML([]byte(body))
78
+	html := renderBodyHTML(ctx, deps, body)
8079
8180
 	cur := pgtype.Int4{}
8281
 	if p.CurrentPosition >= 0 {
@@ -115,7 +114,7 @@ func EditComment(ctx context.Context, deps Deps, commentID int64, body string) e
115114
 	if len(body) > 65535 {
116115
 		return ErrBodyTooLong
117116
 	}
118
-	html, _ := mdrender.RenderHTML([]byte(body))
117
+	html := renderBodyHTML(ctx, deps, body)
119118
 	return pullsdb.New().UpdatePRReviewCommentBody(ctx, deps.Pool, pullsdb.UpdatePRReviewCommentBodyParams{
120119
 		ID: commentID, Body: body, BodyHtmlCached: pgtype.Text{String: html, Valid: html != ""},
121120
 	})
internal/pulls/review/review.gomodified
@@ -15,10 +15,13 @@
1515
 package review
1616
1717
 import (
18
+	"context"
1819
 	"errors"
1920
 	"log/slog"
2021
2122
 	"github.com/jackc/pgx/v5/pgxpool"
23
+
24
+	mdrender "github.com/tenseleyFlow/shithub/internal/markdown"
2225
 )
2326
2427
 // Deps wires this package into the runtime.
@@ -44,3 +47,16 @@ var (
4447
 // MaxReviewersPerPR caps active review requests per PR. Matches the
4548
 // spec pitfall section.
4649
 const MaxReviewersPerPR = 20
50
+
51
+// renderBodyHTML wraps markdown.RenderHTML with a logger-aware error
52
+// path. Review/comment body length is bounded upstream at 65535 chars
53
+// by the orchestrator. ErrInputTooLarge here means a precondition
54
+// regressed — log loudly. (S00-S25 audit, M.)
55
+func renderBodyHTML(ctx context.Context, deps Deps, body string) string {
56
+	html, err := mdrender.RenderHTML([]byte(body))
57
+	if err != nil && deps.Logger != nil {
58
+		deps.Logger.WarnContext(ctx, "review: markdown render failed",
59
+			"error", err, "body_bytes", len(body))
60
+	}
61
+	return html
62
+}
internal/pulls/review/submit.gomodified
@@ -13,7 +13,6 @@ import (
1313
1414
 	issuesdb "github.com/tenseleyFlow/shithub/internal/issues/sqlc"
1515
 	pullsdb "github.com/tenseleyFlow/shithub/internal/pulls/sqlc"
16
-	mdrender "github.com/tenseleyFlow/shithub/internal/markdown"
1716
 )
1817
1918
 // SubmitParams describes the submit-a-review action.
@@ -44,7 +43,7 @@ func Submit(ctx context.Context, deps Deps, p SubmitParams) (pullsdb.PrReview, e
4443
 	if len(body) > 65535 {
4544
 		return pullsdb.PrReview{}, ErrBodyTooLong
4645
 	}
47
-	html, _ := mdrender.RenderHTML([]byte(body))
46
+	html := renderBodyHTML(ctx, deps, body)
4847
4948
 	tx, err := deps.Pool.Begin(ctx)
5049
 	if err != nil {
internal/pulls/state.gomodified
@@ -6,6 +6,7 @@ import (
66
 	"context"
77
 	"errors"
88
9
+	"github.com/tenseleyFlow/shithub/internal/auth/audit"
910
 	"github.com/tenseleyFlow/shithub/internal/issues"
1011
 	pullsdb "github.com/tenseleyFlow/shithub/internal/pulls/sqlc"
1112
 	repogit "github.com/tenseleyFlow/shithub/internal/repos/git"
@@ -43,5 +44,13 @@ func SetState(ctx context.Context, deps Deps, gitDir string, actorUserID, prID i
4344
 			return err
4445
 		}
4546
 	}
46
-	return issues.SetState(ctx, issues.Deps{Pool: deps.Pool, Logger: deps.Logger}, actorUserID, prID, newState, "")
47
+	if err := issues.SetState(ctx, issues.Deps{Pool: deps.Pool, Logger: deps.Logger}, actorUserID, prID, newState, ""); err != nil {
48
+		return err
49
+	}
50
+	if deps.Audit != nil {
51
+		_ = deps.Audit.Record(ctx, deps.Pool, actorUserID,
52
+			audit.ActionPullStateChanged, audit.TargetPull, prID,
53
+			map[string]any{"state": newState})
54
+	}
55
+	return nil
4756
 }