What is the "request" object?

[straeter]

Describe the bug

from paddle_billing.Notifications import Secret, Verifier

integrity_check = Verifier().verify(request, Secret('WEBHOOK_SECRET_KEY'))

---> what is this mysterious "request" object? Is it from fastapi or any other library or is it defined in the library itself? At least flask "request" object did not work.

(it is not a bug but the issue categories were very limited)

Steps to reproduce

from flask import request
...
@app.route('/test', methods=['POST']:
def test():
integrity_check = Verifier().verify(request, Secret('WEBHOOK_SECRET_KEY'))

Expected behavior

verify the request

Code snippets

No response

Python version

Python 3.12

SDK version

paddle-python-sdk 1.01

API version

Paddle Version 1

Additional context

No response

[davidgrayston-paddle]

Hello @straeter 👋

Thank you for raising this issue.

The Verifier().verify() method currently supports any request object matching the paddle_billing.Notifications.Requests.Request protocol, which covers major libraries such as Flask and Django.

class Request(Protocol):
    body: Optional[bytes]
    content: Optional[bytes]
    data: Optional[bytes]
    headers: Headers

I've checked that Flask v3.1.0 requests can be verified, so the issue could be related to the time drift check. By default the max variance is 5 seconds, so you could try increasing this to rule it out as the cause, e.g. Verifier(seconds).verify(request, Secret('WEBHOOK_SECRET_KEY'))

In future we may introduce dedicated convenience methods to make this easier to use, but in the meantime, if you continue to experience this issue, please let us know.

[straeter]

@davidgrayston-paddle thank you, this fixed it!

(I think it would still help to add a bit documentation about the request object)

[i7p9h9]

It looks like this works only with Flask/Django. In FastAPI, however, Request.body is an async function, not a property.

So the existing code:

        raw_body = None
        if hasattr(request, "body"):
            raw_body = request.body.decode("utf-8")
        elif hasattr(request, "content"):
            raw_body = request.content.decode("utf-8")
        elif hasattr(request, "data"):
            raw_body = request.data.decode("utf-8")

will fail in FastAPI. The correct usage in FastAPI would be:

        raw_body = request.body().decode("utf-8")

[davidgrayston-paddle]

Hi @i7p9h9 👋

Unfortunately FastAPI requests are not currently supported as they don't conform to the currently supported protocol. We will look into adding this support, but in the meantime you would need to adapt the FastAPI request to the compatible protocol, which might look like this:

class PaddleRequest:
    def __init__(self, body, headers):
        self._body = body
        self._headers = headers

    @property
    def body(self):
        return self._body

    @property
    def headers(self):
        return self._headers

Then create as follows:

body = await fastapi_request.body()

request = PaddleRequest(
    body=body,
    headers=fastapi_request.headers
)