Skip to content

BatchRequestItem loses query parameters from RequestInformation #1035

@Nothing4You

Description

@Nothing4You

Describe the bug

I'm trying to peform a batched GET request with additional query parameters to select specific fields on a response.
The resulting BatchRequestItem is not aware of query parameters and will result in the request being sent without them.
After some debugging I figured out that the underlying problem is the way RequestInformation works.
It's unclear whether this is by design, at least it's very easy to use it incorrectly.

RequestInformation has a public property query_parameters. It also has a url property with getter and setter methods, which deal with __uri internally.
After setting the url property, which results in __uri being truthy, query_parameters will not be evaluated anymore in the url getter, which is used e.g. by BatchRequestItem.

It's unclear whether this is an issue with BatchRequestItem copying the parameters from RequestInformation or whether RequestInformation should include them in the url getter, in which case this issue should be moved to the repo for the microsoft-kiota-abstractions package.

Expected behavior

Query parameters included in the batch body.

How to reproduce

import asyncio
from azure.identity import AzureCliCredential
from msgraph import GraphServiceClient
from kiota_abstractions.request_information import RequestInformation
from kiota_abstractions.method import Method
from msgraph_core.requests.batch_request_item import BatchRequestItem
from msgraph_core.requests.batch_request_content import BatchRequestContent


async def main():
    credential = AzureCliCredential()
    client = GraphServiceClient(credentials=credential, scopes=["https://graph.microsoft.com/.default"])

    request_info = RequestInformation()
    request_info.http_method = Method.GET
    request_info.url = "/me"

    request_info.query_parameters = {
        "$select": ",".join([
            "id",
            "userPrincipalName",
            "displayName",
            "accountEnabled",
        ])
    }

    batch_item = BatchRequestItem(request_information=request_info)
    batch_content = BatchRequestContent({batch_item.id: batch_item})
    batch_response = await client.batch.post(
        batch_request_content=batch_content,
    )
    print(repr(batch_response.responses.get(batch_item.id).body))


asyncio.run(main())

SDK Version

1.3.8

Latest version known to work for scenario above?

No response

Known Workarounds

Append query parameters to the URL directly, e.g.

    query_parameters = {
        "$select": ",".join([
            "id",
            "userPrincipalName",
            "displayName",
            "accountEnabled",
        ])
    }
    request_info.url = "/me?" + urllib.parse.urlencode(query_parameters)

Debug output

N/A

Configuration

No response

Other information

The constructor for BatchRequestItem only takes the URL from the provided RequestInformation, but it doesn't take into account that there may be query parameters, so they're just ignored.

https://github.com/microsoftgraph/msgraph-sdk-python-core/blob/v1.3.8/src/msgraph_core/requests/batch_request_item.py#L41-L53

The getter for url on RequestInformation skips any further processing if __url is already truthy: https://github.com/microsoft/kiota-python/blob/microsoft-kiota-abstractions-v1.9.7/packages/abstractions/kiota_abstractions/request_information.py#L97-L102

The setter for url copies the provided URL to __url: https://github.com/microsoft/kiota-python/blob/microsoft-kiota-abstractions-v1.9.7/packages/abstractions/kiota_abstractions/request_information.py#L123-L130

Metadata

Metadata

Assignees

No one assigned

    Labels

    status:waiting-for-triageAn issue that is yet to be reviewed or assignedtype:bugA broken experience

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions