openapi-core icon indicating copy to clipboard operation
openapi-core copied to clipboard

[Bug]: Chunked request from request libraly

Open jitka opened this issue 1 year ago • 3 comments

Actual Behavior

When it shout check response where request data was chunked it fails.

    @property
    def body(self) -> Optional[str]:
        if self.request.body is None:
            return None
        if isinstance(self.request.body, bytes):
            return self.request.body.decode("utf-8")
>       assert isinstance(self.request.body, str)
E       AssertionError

Expected Behavior

Check everithing which can, ideally chunked body itself.

Steps to Reproduce

    @staticmethod
    def chunk_generator(data):
        for block in raw:
            yield block
request = Request(method, url, headers=headers, data=chunk_generator(data), **kwargs)
response = session.send(session.prepare_request(request))  
openapi_request = RequestsOpenAPIRequest(request)
openapi_response = RequestsOpenAPIResponse(response)
unmarshal_response(openapi_request, openapi_response, self.spec)

OpenAPI Core Version

0.17.1

OpenAPI Core Integration

requests

Affected Area(s)

unmarshaling

References

No response

Anything else we need to know?

No response

Would you like to implement a fix?

None

jitka avatar Apr 11 '23 12:04 jitka

possible fix

import types
class RequestsOpenAPIRequestFix(RequestsOpenAPIRequest):
    ...

    @property
    def body(self) -> Optional[str]:
        if self.request.body is None or isinstance(self.request.body, types.GeneratorType):
            return None
        if isinstance(self.request.body, bytes):
            return self.request.body.decode("utf-8")
        assert isinstance(self.request.body, str)
        # TODO: figure out if request._body_position is relevant
        return self.request.body

jitka avatar Apr 11 '23 12:04 jitka

Generator should be resolved to string and passed further to the request if we want to validate the body.

p1c2u avatar Apr 13 '23 11:04 p1c2u

It can be done with Request object but if user has Request object and pass only PreparedRequest to request factory we will not be able to recreate generator and the original generator will be expired in the Request object.

p1c2u avatar Apr 13 '23 15:04 p1c2u