microsoftgraph / microsoftgraph/msgraph-sdk-python-core

BatchRequestBuilder doesn't copy headers from BatchRequestContent on post

オープン
#831 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

P1 type:bug
主要言語
Python
スター
288
フォーク
52
平均マージ
8時間 10分
マージ済み PR(30日)
1

説明

Describe the bug

I'm trying to send a batch request from UsersRequestBuilder and GroupsRequestBuilder objects that use the ConsistencyLevel: eventual header. The RequestInformation objects loaded in the BatchRequestContent include the header, but then when calling to the post method of the BatchRequestBuilder it doesn't copy the headers, just creates the Content-Type header, resulting on a 400 error from the server.

The bug itself is in the following lines:

https://github.com/microsoftgraph/msgraph-sdk-python-core/blob/df7bdbfb7e4268df10606f2b35623ecff559fe00/src/msgraph_core/requests/batch_request_builder.py#L126-L135

Expected behavior

The to_post_request_information method from BatchRequestBuilder should copy the headers from the provided BatchRequestContent object

How to reproduce

You can reproduce it using the following snippet

import base64

from typing import Optional

from azure.keyvault.secrets import SecretClient
from azure.identity import CertificateCredential, ManagedIdentityCredential
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph.generated.users.users_request_builder import UsersRequestBuilder
from msgraph.graph_service_client import GraphServiceClient
from msgraph_core.requests.batch_request_builder import BatchRequestBuilder
from msgraph_core.requests.batch_request_content import BatchRequestContent
from msgraph_core.requests.batch_request_item import BatchRequestItem


def get_tenant_credential(tenant_id, client_id, cert_name):
    url = "https://<YOUR VAULT URL>.vault.azure.net/"
    credential = ManagedIdentityCredential(
        client_id="<YOUR CLIENT ID>"
    )
    key_vault_client = SecretClient(vault_url=url, credential=credential)
    secret = key_vault_client.get_secret(cert_name).value
    cert_bytes = base64.b64decode(secret)
    return CertificateCredential(
        tenant_id=tenant_id,
        client_id=client_id,
        certificate_data=cert_bytes,
        send_certificate_chain=True
    )


def get_graph_client():
    tenant = "<YOUR TENANT>"
    client_id = "<YOUR GRAPH CLIENT ID>"
    cert_name = "<YOUR GRAPH CERT NAME>"
    credential = get_tenant_credential(tenant, client_id, cert_name)
    scopes = ["https://graph.microsoft.com/.default"]
    return GraphServiceClient(credential, scopes)


def build_query_filters(
    domains: list[str],
    fields: Optional[list[str]] = None,
    search_term: Optional[str] = None,
    excluded_ids: Optional[set[str]] = None,
) -> str:
    filter_list = [f"endswith(mail, '@{d}')" for d in domains]
    filters = f"({' or '.join(filter_list)})"

    if search_term:
        if fields is None:
            fields = ['displayName', 'mail']

        search_filter_list = [f"startswith({f}, '{search_term}')"
                              for f in fields]
        search_filters = f"({' or '.join(search_filter_list)})"
        filters = f"{filters} and {search_filters}"

    if excluded_ids:
        exclusion_list = [f"id ne '{i}'" for i in excluded_ids]
        excluded_filter = f"{' and '.join(exclusion_list)}"
        filters = f"{filters} and {excluded_filter}"
    return filters


def build_users_request_config(
    search_term: Optional[str] = None,
    n_items: Optional[int] = None,
    excluded_ids: Optional[set[str]] = None,
) -> RequestConfiguration:
    domains = ["microsoft.com", "linkedin.biz", "*.microsoft.com"]
    filters = build_query_filters(
        domains,
        search_term=search_term,
        excluded_ids=excluded_ids,
    )
    query_params = UsersRequestBuilder.UsersRequestBuilderGetQueryParameters(
        select=['id', 'displayName', 'mail'],
        filter=filters,
        top=n_items,
        count=True,
    )
    request_config = RequestConfiguration(query_parameters=query_params)
    request_config.headers.add("ConsistencyLevel", "eventual")
    return request_config


async def search(search_term: str, n_items: int = 5):
    client = get_graph_client()
    request_adapter = client.request_adapter

    # Build user request batch item
    user_request_config = build_users_request_config(search_term, n_items)
    user_request_builder = UsersRequestBuilder(request_adapter, {})
    user_request_info = user_request_builder.to_get_request_information(
        user_request_config
    )
    user_request_item = BatchRequestItem(user_request_info)

    # Build group request batch item
    # group_request_config = build_groups_request_config(
    #     search_term, n_items
    # )
    # group_request_builder = GroupsRequestBuilder(request_adapter, {})
    # group_request_info = group_request_builder.to_get_request_information(
    #     group_request_config
    # )
    # group_request_item = BatchRequestItem(group_request_info)

    # Create batch request content
    batch_request_content = BatchRequestContent({
        user_request_item.id: user_request_item,
        # group_request_item.id: group_request_item
    })

    batch_request_builder = BatchRequestBuilder(request_adapter)
    batch_result = await batch_request_builder.post(batch_request_content)
    return batch_result


if __name__ == "__main__":
    import asyncio

    search_term = "test"
    n_items = 5
    loop = asyncio.get_event_loop()
    results = loop.run_until_complete(search(search_term, n_items))
    print(results)
SDK Version

1.15.0

Latest version known to work for scenario above?

No response

Known Workarounds

There's no workaround possible, given the request information is created in the same method that send the post

Debug output

ERROR:root:API Error:
APIError
Code: 400
message: The server returned an unexpected status code and no error class is registered for this code 400

Configuration

No response

Other information

No response

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

src/msgraph_core/requests/batch_request_builder.py、特に126-135行付近のto_post_request_informationメソッドを読み、BatchRequestContentがどのようにpostへ渡されるかを追跡してください。ConsistencyLevelヘッダーを付けて、提供されたバッチ再現を実行してください。生成されたPOSTリクエストでそのヘッダーが保持され、報告されている400エラーが返されなくなれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api, backend
issue の種類
バグ
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。