fix(api): Validate request body type for plugin config PUT#115974
Draft
sentry[bot] wants to merge 1 commit into
Draft
fix(api): Validate request body type for plugin config PUT#115974sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
github-actions
Bot
added
the
Scope: Backend
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
1 participant
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.
This PR addresses an
AttributeError: 'list' object has no attribute 'get'occurring in thePUT /api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/plugins/{plugin_id}/endpoint.The root cause was that the endpoint's
putmethod inproject_plugin_details.pyexpectedrequest.datato be a dictionary when callingrequest.data.get(key). However, some clients were sending the request body as a JSON array (e.g.,[{"name": "urls", "value": "..."}]), which Django REST Framework deserializes into a Python list.To fix this, a type check has been added at the beginning of the
putmethod. Ifrequest.datais not a dictionary, the endpoint now returns a400 Bad Requestresponse with a clear error message, preventing theAttributeErrorand providing better feedback to the client.A corresponding test case has also been added to
test_project_plugin_details.pyto ensure this validation works as expected.Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
Fixes SENTRY-5M56