docs(code-review): update stale GitLab contributor-seeding docstring#117710
Closed
billyvg wants to merge 1 commit into
Closed
docs(code-review): update stale GitLab contributor-seeding docstring#117710billyvg wants to merge 1 commit into
billyvg wants to merge 1 commit into
Conversation
The 'Known limitations' section claimed GitLab contributors are never seeded and every MR is filtered with ORG_CONTRIBUTOR_NOT_FOUND. track_gitlab_contributor_seat_processor was added in #116317 and is now the first entry in MergeEventWebhook.WEBHOOK_EVENT_PROCESSORS, so the contributor row exists before preflight runs. Replace the stale block with an accurate description of how seeding works today and document the two residual gaps: 1. NoteEventWebhook (@sentry review) has no fallback seeding — relies on the prior MR-open event having seeded the row. 2. MergeEventWebhook.__call__ short-circuits before processors when last_commit is missing or author email is absent (tracked: SCM-99).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The
Known limitationssection inmerge_request.pyclaimed that GitLab contributors are never seeded and every GitLab MR is filtered withORG_CONTRIBUTOR_NOT_FOUND. That description was accurate before #116317, but is now stale.Why
track_gitlab_contributor_seat_processorwas added in #116317 and is registered as the first entry inMergeEventWebhook.WEBHOOK_EVENT_PROCESSORS, so theOrganizationContributorsrow is seeded beforehandle_merge_request_eventruns preflight. The old docstring (including the note that tests pass only because they seed the row manually) no longer describes production behaviour and actively misleads readers.Changes
Known limitationsblock with aContributor seedingsection that describes how seeding actually works today.Residual gapssection documenting what still isn't covered:NoteEventWebhook(@sentry review) has no fallback seeding — depends on the prior MR-open event having seeded the row.MergeEventWebhook.__call__can short-circuit before processors run (missinglast_commit/ author email), so the author is never seeded. Tracked on SCM-99.Verification
Docs-only change. No behaviour is modified.
View Session in Sentry