feat(org member invite): OrganizationMemberInviteIndex endpoint #87642

mifu67 · 2025-03-21T21:50:59Z

GET: Lists all invites (approved and requests). If org manager/admin, show all invites; otherwise, show only approved invites
POST: Create new invite, preserving member invite member functionality

Created endpoints/organization_member/utils.py to hold values accessible to both OrganizationMember* and OrganizationMemberInvite* endpoints (at least until the end of the API rollout period).

src/sentry/api/endpoints/organization_member_invite/index.py

codecov · 2025-03-21T21:58:51Z

Codecov Report

Attention: Patch coverage is 98.80952% with 5 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
.../api/endpoints/organization_member_invite/index.py	94.62%	5 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           master   #87642       +/-   ##
===========================================
+ Coverage   42.12%   87.80%   +45.67%     
===========================================
  Files        9880     9982      +102     
  Lines      561201   565449     +4248     
  Branches    22137    22137               
===========================================
+ Hits       236421   496471   +260050     
+ Misses     324349    68547   -255802     
  Partials      431      431

src/sentry/api/endpoints/organization_member/index.py

cathteng · 2025-03-25T15:49:54Z

src/sentry/api/endpoints/organization_member_invite/index.py

+        if invite_queryset.filter(invite_status=InviteStatus.APPROVED.value).exists():
+            raise MemberConflictValidationError("The user %s has already been invited" % email)
+
+        if not self.context.get("allow_existing_invite_request"):


is this necessary if we already have a unique constraint on organization+email?

sentry/src/sentry/models/organizationmemberinvite.py

Line 89 in 754c3f6

unique_together = ("organization", "email")

Might be good to surface this to the user instead of a confusing FK error? The unique constraint exists on the organizationmember model as well, so I assume this is the reasoning behind the special error.

src/sentry/api/endpoints/organization_member_invite/index.py

cathteng · 2025-03-25T16:14:46Z

src/sentry/api/endpoints/organization_member_invite/index.py

+        """
+        List all organization member invites.
+        """
+        queryset = OrganizationMemberInvite.objects.filter(organization=organization).order_by(


when this ordering happens, which invite objects are shown first? it would be nice to see the join requests first

I think it goes APPROVED -> REQUESTED_TO_BE_INVITED -> REQUESTED_TO_JOIN according to the enum

src/sentry/api/endpoints/organization_member_invite/index.py

cathteng

overall looking good but i think this is such a monster endpoint that we should try to break down the logic into their own contained functions where possible

src/sentry/api/endpoints/organization_member_invite/index.py

…ializer

cathteng

more thoughts on organization, i think the logic is good though

src/sentry/api/endpoints/organization_member_invite/index.py

tests/sentry/api/endpoints/test_organization_member_invite_index.py

cathteng

👩🏻‍💻

src/sentry/api/endpoints/organization_member_invite/index.py

cathteng · 2025-03-28T23:22:40Z

src/sentry/api/serializers/rest_framework/organizationmemberinvite.py

cathteng · 2025-03-28T23:25:18Z

src/sentry/api/endpoints/organization_member_invite/index.py

+            context={
+                "organization": organization,
+                "allowed_roles": allowed_roles,
+                "allow_retired_roles": not features.has("organizations:team-roles", organization),


nit: could remove allow_retired_roles from context and simply do the feature flag check where this is used inside the validator since we're already passing organization (it's only used in validate_orgRole)

cathteng · 2025-03-28T23:26:57Z

tests/sentry/api/endpoints/test_organization_member_invite_index.py

+        assert response.data[1]["inviteStatus"] == "requested_to_be_invited"
+
+    def test_org_owner(self):
+        user = self.create_user("[email protected]", username="powerful mifu")


cathteng · 2025-03-28T23:34:19Z

src/sentry/api/endpoints/organization_member_invite/index.py

+        if not request.access.has_scope("member:write"):
+            queryset = queryset.filter(invite_status=InviteStatus.APPROVED.value)


forgot to comment
it seems like everyone can see the requests

sentry/static/app/views/settings/organizationMembers/organizationMembersList.tsx

Lines 332 to 356 in 751c930

{inviteRequests.length > 0 && (

<Panel>

<PanelHeader>

<StyledPanelItem>

<div>{t('Pending Members')}</div>

<div>{t('Role')}</div>

<div>{t('Teams')}</div>

</StyledPanelItem>

</PanelHeader>

<PanelBody>

{inviteRequests.map(inviteRequest => (

<InviteRequestRow

key={inviteRequest.id}

organization={organization}

inviteRequest={inviteRequest}

inviteRequestBusy={{}}

allRoles={currentMember?.orgRoleList ?? currentMember?.roles ?? ORG_ROLES}

onApprove={handleInviteRequestApprove}

onDeny={handleInviteRequestDeny}

onUpdate={data => updateInviteRequest(inviteRequest.id, data)}

/>

))}

</PanelBody>

</Panel>

)}

- GET: Lists all invites (approved and requests). If org manager/admin, show all invites; otherwise, show only approved invites - POST: Create new invite, preserving member invite member functionality Created `endpoints/organization_member/utils.py` to hold values accessible to both `OrganizationMember*` and `OrganizationMemberInvite*` endpoints (at least until the end of the API rollout period).

github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Mar 21, 2025

vercel bot deployed to Preview March 21, 2025 21:51 View deployment

mifu67 commented Mar 21, 2025

View reviewed changes

src/sentry/api/endpoints/organization_member_invite/index.py Outdated Show resolved Hide resolved

mifu67 commented Mar 21, 2025

View reviewed changes

src/sentry/api/endpoints/organization_member_invite/index.py Outdated Show resolved Hide resolved

vercel bot deployed to Preview March 24, 2025 17:43 View deployment

mifu67 changed the base branch from master to mifu67/member-invite/org-member-invite-serializer March 25, 2025 15:27

Base automatically changed from mifu67/member-invite/org-member-invite-serializer to master March 25, 2025 15:36

cathteng reviewed Mar 25, 2025

View reviewed changes

mifu67 added 8 commits March 25, 2025 10:49

first pass

900a4cb

remove team role refs from POST

184d38e

updates

6287115

plugging along

db72ea1

move constants to common utils file + request serializer

1b6983b

GET tests

4924ee8

add a couple more tests

a871b0b

PUT tests

f9f4618

mifu67 force-pushed the mifu67/member-invite/org-member-invite-index branch from b64ebec to f9f4618 Compare March 25, 2025 17:52

vercel bot deployed to Preview March 25, 2025 17:57 View deployment

address PR comments

bfd35a9

vercel bot deployed to Preview March 26, 2025 19:17 View deployment

mifu67 marked this pull request as ready for review March 26, 2025 19:37

mifu67 requested review from a team as code owners March 26, 2025 19:37

mifu67 requested a review from cathteng March 26, 2025 19:37

remove unused fields

286fe2f

vercel bot deployed to Preview March 26, 2025 20:27 View deployment

add roles to team dict

7f2a337

vercel bot deployed to Preview March 26, 2025 22:32 View deployment

ref to also post invite requests, preserving existing behavior

29fce96

mifu67 requested a review from a team as a code owner March 27, 2025 00:31

vercel bot deployed to Preview March 27, 2025 00:35 View deployment

cathteng reviewed Mar 27, 2025

View reviewed changes

mifu67 added 2 commits March 27, 2025 13:56

pull out object creation + validate integration token org role in ser…

84c3ba0

…ializer

pass retired roles status to invite request serializer

b8dfacf

vercel bot deployed to Preview March 27, 2025 21:20 View deployment

mifu67 requested review from cathteng and leedongwei March 27, 2025 22:07

cathteng reviewed Mar 28, 2025

View reviewed changes

pull validator into separate file + move team checks to validator

37b8b3e

mifu67 requested a review from cathteng March 28, 2025 21:23

vercel bot deployed to Preview March 28, 2025 21:27 View deployment

cathteng approved these changes Mar 28, 2025

View reviewed changes

cathteng reviewed Mar 28, 2025

View reviewed changes

let everyone view invite requests + nits

508aa47

vercel bot deployed to Preview March 28, 2025 23:54 View deployment

feature flag

0431a8d

vercel bot deployed to Preview March 31, 2025 18:39 View deployment

mifu67 merged commit 9dae48a into master Mar 31, 2025
48 checks passed

mifu67 deleted the mifu67/member-invite/org-member-invite-index branch March 31, 2025 21:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(org member invite): OrganizationMemberInviteIndex endpoint #87642

feat(org member invite): OrganizationMemberInviteIndex endpoint #87642

mifu67 commented Mar 21, 2025 •

edited

Loading

codecov bot commented Mar 21, 2025 •

edited

Loading

cathteng Mar 25, 2025

mifu67 Mar 26, 2025

cathteng Mar 25, 2025

mifu67 Mar 26, 2025

cathteng left a comment

cathteng left a comment

cathteng left a comment

cathteng Mar 28, 2025

cathteng Mar 28, 2025

cathteng Mar 28, 2025

cathteng Mar 28, 2025

		if not request.access.has_scope("member:write"):
		queryset = queryset.filter(invite_status=InviteStatus.APPROVED.value)

	{inviteRequests.length > 0 && (
	<Panel>
	<PanelHeader>
	<StyledPanelItem>
	<div>{t('Pending Members')}</div>
	<div>{t('Role')}</div>
	<div>{t('Teams')}</div>
	</StyledPanelItem>
	</PanelHeader>
	<PanelBody>
	{inviteRequests.map(inviteRequest => (
	<InviteRequestRow
	key={inviteRequest.id}
	organization={organization}
	inviteRequest={inviteRequest}
	inviteRequestBusy={{}}
	allRoles={currentMember?.orgRoleList ?? currentMember?.roles ?? ORG_ROLES}
	onApprove={handleInviteRequestApprove}
	onDeny={handleInviteRequestDeny}
	onUpdate={data => updateInviteRequest(inviteRequest.id, data)}
	/>
	))}
	</PanelBody>
	</Panel>
	)}

feat(org member invite): OrganizationMemberInviteIndex endpoint #87642

feat(org member invite): OrganizationMemberInviteIndex endpoint #87642

Conversation

mifu67 commented Mar 21, 2025 • edited Loading

codecov bot commented Mar 21, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cathteng left a comment

Choose a reason for hiding this comment

cathteng left a comment

Choose a reason for hiding this comment

cathteng left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mifu67 commented Mar 21, 2025 •

edited

Loading

codecov bot commented Mar 21, 2025 •

edited

Loading