BatchRequestItem loses query parameters from RequestInformation
Maintainer thường phản hồi trong vòng 1 ngày
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 48/100
Hướng nghiên cứu
Bắt đầu với src/msgraph_core/requests/batch_request_item.py tại các dòng constructor được liên kết trong issue, sau đó so sánh cách RequestInformation.url và query_parameters hoạt động trong tệp kiota-python được tham chiếu. Chạy reproduction được cung cấp để xác nhận rằng batch body bỏ qua các tham số; hoàn tất khi các tham số truy vấn xuất hiện trong batch request body.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
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
- Ngôn ngữ chính
- Python
- Star
- 288
- Fork
- 53
- Merge trung bình
- 40 phút
- Pull request đã merge (30 ngày)
- 1
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của microsoftgraph/msgraph-sdk-python-core
-
Logging to root loggerĐang mởstatus:waiting-for-triage type:bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
microsoftgraph/msgraph-sdk-python-core#1078 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Missing 'deprecated' dependencyCó thể đã có người làm @Daiyuanranfeng đã nhận 3 ngày trước. Đang mởstatus:waiting-for-triage type:bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
microsoftgraph/msgraph-sdk-python-core#1030 · 4 bình luận · 4 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Replace httpx with httpx2Đang mởstatus:waiting-for-triage type:feature
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 52/100
microsoftgraph/msgraph-sdk-python-core#1115 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
status:waiting-for-triage
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 15/100
microsoftgraph/msgraph-sdk-python-core#935 · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
type:bug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 48/100
microsoftgraph/msgraph-sdk-python-core#917 · 3 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của microsoftgraph/msgraph-sdk-python-core
Issue tương tự
-
tests
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
Maintainer thường phản hồi trong vòng 3 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
[Plugin] 群聊记忆 · 人格养成Đang mở
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 74/100
-
bug maintainer-managed
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
awslabs/visual-asset-management-system#1759 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100