microsoftgraph / microsoftgraph/msgraph-sdk-python-core
Can't deserialize response body from batch request as the json properties are single quoted
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 288
- Forks
- 52
- Avg merge
- 8h 10m
- Merged PRs (30d)
- 1
Description
Describe the bug
I'm trying to list applications filtered by particular IDs - there's loads of them so I'm using a batch request with 15 filters at a time (limit). This will allow me to get all the object IDs to query owners etc.
When I attempt to deserialize the BatchResponseContent object with get_response_by_id(response_id, ApplicationCollectionResponse), I get a stack telling me that it can't decode as the properties are single quoted rather than double quoted.
Traceback (most recent call last):
File "/<project>/.venv/lib/python3.9/site-packages/msgraph_core/requests/batch_response_content.py", line 126, in response_body
parse_node = ParseNodeFactoryRegistry().get_root_parse_node(
File "/<project>/.venv/lib/python3.9/site-packages/kiota_abstractions/serialization/parse_node_factory_registry.py", line 41, in get_root_parse_node
return factory.get_root_parse_node(vendor_specific_content_type, content)
File "/<project>/.venv/lib/python3.9/site-packages/kiota_abstractions/serialization/parse_node_proxy_factory.py", line 56, in get_root_parse_node
node = self._concrete.get_root_parse_node(content_type, content)
File "/<project>/.venv/lib/python3.9/site-packages/kiota_serialization_json/json_parse_node_factory.py", line 37, in get_root_parse_node
content_dict = json.loads(content_as_str)
File "/usr/lib/python3.9/json/__init__.py", line 346, in loads
return _default_decoder.decode(s)
File "/usr/lib/python3.9/json/decoder.py", line 337, in decode
obj, end = self.raw_decode(s, idx=_w(s, 0).end())
File "/usr/lib/python3.9/json/decoder.py", line 353, in raw_decode
obj, end = self.scan_once(s, idx)
json.decoder.JSONDecodeError: Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
This is backed up by if I just try to do a json_loads(response.body.decode('utf-8')), which then succeeds if I do a .replace("'", '"').
Expected behavior
I should be able to provide the ApplicationCollectionResponse object to BatchResponseContent.get_response_by_id and deserialize the batch response so that I can get the ID out of the response.
How to reproduce
for app_filter in app_filters:
app_query_params = (
ApplicationsRequestBuilder.ApplicationsRequestBuilderGetQueryParameters(
select=["appId", "id", "serviceManagementReference"],
filter=f"appId in {app_filter}",
)
)
app_request_config = RequestConfiguration(query_parameters=app_query_params)
batch_request_content.add_request_information(
client.applications.to_get_request_information(
request_configuration=app_request_config
),
app_filter,
)
batch_response = await client.batch.post(batch_request_content)
if not batch_response or not batch_response.responses:
log.error("Batch request for application object IDs failed")
return None
for response_id in batch_response.responses.keys():
batch_response.get_response_by_id(response_id, ApplicationCollectionResponse)
SDK Version
1.17.0 of msgraph-sdk (so 1.2.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_
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in msgraph_core/requests/batch_response_content.py, especially response_body and get_response_by_id, and reproduce the issue with the batch request shown. Inspect the response body passed to the serialization registry and compare it with the JSON parser's expectations. Done means ApplicationCollectionResponse can be deserialized from the batch response and the application ID can be retrieved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100