feat(consent): record consent in the same transaction as the user - #1914
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (13)
💤 Files with no reviewable changes (2)
🚧 Files skipped from review as they are similar to previous changes (11)
Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review. 📝 SummarySummary by CodeRabbit
WalkthroughThe change adds consent records to signup. It defines consent contracts and audit events, persists users and consent atomically, integrates consent into authentication flows, and adds unit and PostgreSQL integration coverage. ChangesSignup consent flow
Estimated code review effort: 4 (Complex) | ~60 minutes Merge Risk: 🔵 Low · up to Signup now creates users and consent atomically, but a duplicate-signup conflict can leave a database connection checked out. This is a bounded availability risk that should be addressed before sustained conflict traffic. Suggested reviewers: 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Coverage Report for CI Build 34094313603Coverage increased (+0.3%) to 50.011%Details
Uncovered Changes
Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
481c8eb to
c396eaa
Compare
c396eaa to
6989f83
Compare
The invariant this establishes: a user row without a consent record is impossible. ResolveAll runs before the transaction opens, so an incomplete payload never starts one; inside it, the user insert and the consent insert both land or neither does. user.Repository and the new user_consents repository each gain a Create that takes a *sqlx.Tx. pkg/db has WithTxn but carries no transaction on the context, so the transaction is threaded through explicitly rather than found on one. Both are additive, and the user repository change is the one place this feature reaches outside its own domain. The consent repository has Create and nothing else, because the table is immutable. consent.Grant writes one record for the documents it is given and has no completeness rule of its own. ResolveAll is what decides a signup covers every configured document, and keeping that out of Grant leaves room for a later re-consent covering a subset without a second write path. getOrCreateUser now has three outcomes for a new user. A complete payload writes both rows in one transaction. An incomplete one returns ErrConsentRequired and writes nothing. An existing user gets no record at all, which is absolute: a record written outside a user creation would carry that moment's timestamp and IP for an agreement made elsewhere, which is worse than no record because it reads like evidence. A nil flow means one of the paths that create a user without one, and those stay exempt because no account holder is present to consent. The completeness check runs at user creation under every intent, not for the error but as the invariant guarding the write. An unset intent is permissive for the login gate but never for consent. With app.consent disabled ResolveAll resolves nothing, and an empty document set means write no record, so nothing changes for a deployment that does not ask for consent. Each signup also writes one audit record, with UserConsentGrantedEvent and ConsentType added to pkg/auditrecord following the entity.verb naming already there. It goes through the repository with the actor filled in, as userpat does for its PAT events: the repository enriches an empty actor from the context, and these endpoints are on the authentication skip list with no actor in it, so the record would otherwise land as the system actor for an act a person performed. It is written after the commit, since the audit repository has no transactional create, so it cannot be atomic with the record it describes. That is why the consent record is the source of truth and this one is a breadcrumb: a failure is logged and the signup stands. Its target metadata carries the whole document snapshot rather than the id and the version alone, so a reader working from the audit trail can say what was accepted without reading back a record they may not have access to. The rollback is tested against a real Postgres rather than a mocked transaction, since a mock can only pretend to roll back. See docs/rfcs/0002-explicit-consent-at-signup.md, Enforcement and Storage.
6989f83 to
fa677e9
Compare
| type Repository interface { | ||
| Create(ctx context.Context, tx *sqlx.Tx, cnst Consent) (Consent, error) | ||
| } |
There was a problem hiding this comment.
We will need to establish a pattern across the codebase on how to move transactions across services — this doesn't exist as of now, and will be done later. The approach may vary as well. So instead of doing it as a one-off case and making db trnx as dependency in service, can we instead look at alternatives, e.g. a postgres-layer method (say CreateWithConsent with the interface declared on authenticate's side since it already imports both domains) which opens WithTxn internally and inserts all the rows required?
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
internal/store/postgres/user_repository.go (1)
225-226: 🩺 Stability & Availability | 🟡 Minor | ⚡ Quick winRoll back
Createon duplicate-key errors
Createstarts a transaction withBeginTxx, but theErrDuplicateKeybranch returns without commit or rollback.WithTimeoutonly cancels the query context. The transaction keeps its connection until rollback, commit, or cancellation of the context passed toBeginTxx; repeated conflicts with an active context can reduce pool capacity or exhaust it. The newWithTxnpath does not surroundCreate, and this PR leavesCreateunchanged.♻️ Proposed fix
err = checkPostgresError(err) switch { case errors.Is(err, ErrDuplicateKey): + if rbErr := tx.Rollback(); rbErr != nil { + return user.User{}, rbErr + } return user.User{}, user.ErrConflict default:
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Team
Run ID: 7b8c77c9-8812-4e98-89b7-4898d2d17d9f
📒 Files selected for processing (20)
cmd/serve.gocore/authenticate/mocks/consent_service.gocore/authenticate/mocks/user_service.gocore/authenticate/service.gocore/authenticate/service_test.gocore/consent/consent.gocore/consent/errors.gocore/consent/service.gocore/consent/service_test.gocore/user/mocks/repository.gocore/user/service.gocore/user/service_test.gocore/user/user.godocs/rfcs/0002-explicit-consent-at-signup.mdinternal/store/postgres/postgres.gointernal/store/postgres/user_consent.gointernal/store/postgres/user_consent_repository.gointernal/store/postgres/user_consent_repository_test.gointernal/store/postgres/user_repository.gopkg/auditrecord/consts.go
Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.
The consent record still lands with the user row or not at all, but no service signature names a database transaction any more. core/user, core/consent and core/authenticate no longer import sqlx. user.Repository gains CreateWithConsent in place of CreateWithTx, and the Postgres implementation opens the transaction itself, writing the user row and then the consent record through the repository that already owns that table. Both user create paths still share buildUserInsertQuery, so they cannot drift. consent.Service keeps its config, its documents, its resolve rules and its audit record. What changed is that Grant, which wrote, becomes PrepareGrant, which builds and validates the record and performs no I/O. Its Repository interface had no other caller and is gone, and with it the last *sqlx.Tx in core. The identity is no longer required by validateGrant: the user id is generated by the insert, and the writer stamps it from the row it just wrote, with NOT NULL and a foreign key behind it. This is deliberately scoped to signup rather than general: the codebase has no pattern for a transaction spanning two domains, the read-only aggregates are not one, and organization.AdminCreate shows the current answer is to sequence the writes and accept partial failure. A general pattern needs its own research and RFC. Until then the composite write lives with the user domain, which is where user creation has always lived, and the comments say so at each site. The rollback is still proved against a real database, now through CreateWithConsent rather than a hand-assembled transaction. See docs/rfcs/0002-explicit-consent-at-signup.md, Enforcement and Storage. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
aebd4f8 to
57fc138
Compare
57fc138 to
55a7236
Compare
The comments added with the consent write explained more than a reader
needs. Keep the reasons that are not in the code, and drop the ones
repeated across layers: that the consent identity is stamped from the
inserted row was stated in five places, the audit actor rationale in three.
Two were wrong rather than only verbose:
- three claimed a foreign key on user_consents.user_id, which the
migration rules out on purpose: "no FK to users(id): Delete is a hard
DELETE, so CASCADE would drop these records"
- the fakeRepository doc comment was left standing over the wrong type
once the fake it described was removed
No behaviour change. gofmt realigns the struct literals whose interstitial
comments went away.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
55a7236 to
0447c33
Compare
Summary
ResolveAllruns before the transaction opens, so an incomplete payload never starts one; inside it, the user insert and the consent insert both land or neither does. Per RFC 0002, Enforcement and Storage.user.RepositorygainsCreateWithTx, which is the one place this feature reaches outside its own domain.pkg/dbhasWithTxnbut carries no transaction on the context, so it is threaded through explicitly. Both create paths share one query builder, so they cannot drift.user.consent_grantedaudit record is written after the commit, through the repository rather than the service, withActorfilled in explicitly — these endpoints are skip-listed, so an empty actor would be enriched to the nil UUID and thesystemactor for an act a person performed. It cannot be atomic with the consent row, which is why that row is the source of truth and a failed audit write is logged and carried past.