feat(relay): Add endpoint for registering trusted relay #82808
Conversation
github-actions
bot
added
the
Scope: Backend
Codecov ReportAll modified and coverable lines are covered by tests ✅ ✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #82808 +/- ##
==========================================
+ Coverage 87.56% 87.57% +0.01%
==========================================
Files 9469 9471 +2
Lines 536963 537109 +146
Branches 21119 21119
==========================================
+ Hits 470182 470384 +202
+ Misses 66422 66366 -56
Partials 359 359 |
|
|
||
| serializer = TrustedRelaySerializer(data=request.data) | ||
| if not serializer.is_valid(): | ||
| return Response({"detail": "Invalid request body"}, status=status.HTTP_400_BAD_REQUEST) |
There was a problem hiding this comment.
Are there any validation errors we could give to the user? Right now it would be hard to figure what field you made a mistake on.
| try: | ||
| existing_option = OrganizationOption.objects.get( | ||
| organization=organization, key=option_key | ||
| ) | ||
| existing_relays = existing_option.value | ||
| except OrganizationOption.DoesNotExist: | ||
| existing_option = None | ||
| existing_relays = [] |
There was a problem hiding this comment.
You could also use OrganizationOption.objects.get_value(organization=organization, key=option_key, default=[]) to read the value without needing a try/except. You wouldn't be able to know if the option was new/existing though.
| if existing_option is not None: | ||
| existing_option.value = existing_relays | ||
| existing_option.save() | ||
| else: | ||
| OrganizationOption.objects.set_value( | ||
| organization=organization, key=option_key, value=existing_relays | ||
| ) |
There was a problem hiding this comment.
OrganizationOption.objects.set_value() should take care of the insert/update paths for you.
|
|
||
|
|
||
| @region_silo_endpoint | ||
| class InternalRegisterTrustedRelayEndpoint(OrganizationEndpoint): |
There was a problem hiding this comment.
The default permissions from OrganizationEndpoint will allow manager role users to make changes, is that ok for this endpoint?
This PR exposes a new endpoint for registering an external Relay to Sentry.
This endpoint can be authenticated exclusively with the organization auth token, since it's meant to be used in a cli environment.
Closes: https://github.com/getsentry/team-ingest/issues/275