Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Post_collection is not raising BadRequestError when payload relationships data is not array of dictionaries #52

Open
kaitj91 opened this issue Mar 27, 2017 · 0 comments

Comments

@kaitj91
Copy link
Contributor

kaitj91 commented Mar 27, 2017

It is very important that the library is able to return some sort of response that let's the user know they submitted an invalid request by raising a BadRequestError and returning a 400 and some sort of description explaining why.

Through testing post_collection, I found that we are not raising a BadRequestError when we send a payload where the relationships data is not an array of dictionaries.

For example:

def test_add_resource_when_relationships_data_has_invalid_format(self):
        """Create resource when relationships data is not an array of dictionaries returns 400.

        A BadRequestError is raised.
        """
        payload = {
            'data': {
                'attributes': {
                    'first': 'Sally',
                    'last': 'Smith',
                    'username': 'SallySmith1',
                    'password': 'password',
                },
                'type': 'users',
                'relationships': {
                    'posts': {
                        'data': ['foo']
                    }
                }
            }
        }

        with self.assertRaises(errors.BadRequestError) as error:
            models.serializer.post_collection(
                self.session, payload, 'users')

        self.assertEqual(
            error.exception.detail, 'posts data must be an array of objects')
        self.assertEqual(error.exception.status_code, 400)

This test fails because there is no check for this in place in post_collection. Thus when I try to run this test a AttributeError occurs. Specifically the AttributeError is occuring because we are failing to check

if not isinstance(item, dict):
    raise BadRequestError('{} data must be an array of objects'.format(api_key))

at the beginning of the for loop below:

                    for item in data_rel:
                        if not {'type', 'id'} in set(item.keys()):
                            raise BadRequestError(
                                '{} must have type and id keys'.format(key))

Because we do not have this check a AttributeError occurs because the item does not have any keys when trying to execute item.keys().
This is an easy fix that would provide an informative error message to users who send badly formatted payloads.

@kaitj91 kaitj91 changed the title Post_collection call not raising BadRequestError when payload relationships data is not array of dictionaries Post_collection is not raising BadRequestError when payload relationships data is not array of dictionaries Mar 27, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant