microsoftgraph / microsoftgraph/msgraph-sdk-python-core

BatchRequestItem loses query parameters from RequestInformation

Offen
#1,035 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

status:waiting-for-triage type:bug
Vorherrschende Sprache
Python
Sterne
288
Forks
52
Ø Merge
8 Std. 10 Min.
Gemergte PRs (30 T.)
1

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit src/msgraph_core/requests/batch_request_item.py bei den im Issue verlinkten Konstruktorzeilen und vergleiche anschließend, wie sich RequestInformation.url und query_parameters in der referenzierten kiota-python-Datei verhalten. Führe die bereitgestellte Reproduktion aus, um zu bestätigen, dass der Batch-Body die Parameter nicht enthält; abgeschlossen ist die Aufgabe, wenn die Query-Parameter im Batch-Request-Body erscheinen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.