Skip to content

docs(code-review): update stale GitLab contributor-seeding docstring#117710

Closed
billyvg wants to merge 1 commit into
masterfrom
ref/update-stale-gitlab-contributor-docstring
Closed

docs(code-review): update stale GitLab contributor-seeding docstring#117710
billyvg wants to merge 1 commit into
masterfrom
ref/update-stale-gitlab-contributor-docstring

Conversation

@billyvg

@billyvg billyvg commented Jun 15, 2026

Copy link
Copy Markdown
Member

What

The Known limitations section in merge_request.py claimed that GitLab contributors are never seeded and every GitLab MR is filtered with ORG_CONTRIBUTOR_NOT_FOUND. That description was accurate before #116317, but is now stale.

Why

track_gitlab_contributor_seat_processor was added in #116317 and is registered as the first entry in MergeEventWebhook.WEBHOOK_EVENT_PROCESSORS, so the OrganizationContributors row is seeded before handle_merge_request_event runs 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

  • Replace the stale Known limitations block with a Contributor seeding section that describes how seeding actually works today.
  • Add a Residual gaps section documenting what still isn't covered:
    1. NoteEventWebhook (@sentry review) has no fallback seeding — depends on the prior MR-open event having seeded the row.
    2. MergeEventWebhook.__call__ can short-circuit before processors run (missing last_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

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).
@github-actions github-actions Bot added the Scope: Backend Automatically applied to PRs that change backend components label Jun 15, 2026
@billyvg billyvg closed this Jun 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Scope: Backend Automatically applied to PRs that change backend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant