microsoftgraph / microsoftgraph/msgraph-sdk-python-core
Adding request info does not use specified request_id for BatchRequestContent
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 288
- フォーク
- 52
- 平均マージ
- 8時間 10分
- マージ済み PR(30日)
- 1
説明
Describe the bug
Trying to add batch request steps with custom request IDs so that I can track the responses, however the custom request ID is always overridden to a random uuid
Expected behavior
Should be able to specify a custom request ID as specified in the function doc strings and in samples.
How to reproduce
You can track this through:
msgraph_core/requests/batch_request_content.py
def add_request_information(
self, request_information: RequestInformation, request_id: Optional[str] = None
) -> None:
"""
Adds a request to the batch request content.
Args:
request_information (RequestInformation): The request information to add.
request_id: Optional[str]: The request id to add.
"""
request_id = request_id if request_id else str(uuid.uuid4())
self.add_request(request_id, BatchRequestItem(request_information))
When creating the BatchRequestItem (msgraph_core/requests/batch_request_item.py), we've not passed the request ID into the init, so a random one is assigned to the Item:
def __init__(
self,
request_information: Optional[RequestInformation] = None,
id: str = "",
depends_on: Optional[list[Union[str, 'BatchRequestItem']]] = []
):
"""
Initializes a new instance of the BatchRequestItem class.
Args:
request_information (RequestInformation): The request information.
id (str, optional): The ID of the request item. Defaults to "".
depends_on (Optional[list[Union[str, BatchRequestItem]], optional):
The IDs of the requests that this request depends on. Defaults to None.
"""
if request_information is None or not request_information.http_method:
raise ValueError("HTTP method cannot be Null/Empty")
self._id = id or str(uuid4())
The custom one is then only used if there isn't one already on the request, which is impossible here because of the initialisation of the item object:
def add_request(self, request_id: Optional[str], request: BatchRequestItem) -> None:
"""
Adds a request to the batch request content.
Args:
request_id (Optional[str]): The request id to add.
request (BatchRequestItem): The request to add.
"""
if len(self.requests) >= BatchRequestContent.MAX_REQUESTS:
raise RuntimeError(f"Maximum number of requests is {BatchRequestContent.MAX_REQUESTS}")
if not request.id:
request.id = request_id if request_id else str(uuid.uuid4())
So it's impossible for you to set a custom request ID through the add_request_information function. Either we should pass the custom one into the initialisation of the Item, or the "add_request" function should be checking for whether we have a request_id not a request.id. Suspect it should be the latter otherwise the function signature makes no sense.
SDK Version
1.17.0 of the SDK, 1.20.0 of msgraph-core
Latest version known to work for scenario above?
No response
Known Workarounds
No response
Debug output
Click to expand log
```</details>
### Configuration
_No response_
### Other information
_No response_
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
msgraph_core/requests/batch_request_content.py の add_request_information から開始し、msgraph_core/requests/batch_request_item.py で BatchRequestItem がどのように作成されるかを追跡します。指定された request_id がアイテムの ID のままであること、およびカスタム ID が指定されていない場合でも生成された ID が引き続き機能することを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- api
- issue の種類
- バグ
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 45/100