OpenAPITools / OpenAPITools/openapi-generator
[BUG] [Dart] API Responses incorrectly use `.body` instead of `.bodyBytes` when checking emptiness, which can crash for non-ut8 data
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator (example)?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
openapi-generator version
7.3.0-snapshot
if (_response.body.isNotEmpty && _response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(
await _decodeBodyBytes(_response),
'OutputFormat',
) as OutputFormat;
}
the .body method implicitly converts to utf-8, which will throw exceptions when the data isn't a utf-8 string. Instead, when checking for emptiness, .bodyBytes should be used instead.
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 with the generated Dart response-handling code shown in the issue and trace where the response body is checked for emptiness before deserialization. Verify the behavior with non-UTF-8 response data and identify the relevant generated-client test coverage. Done means empty-response detection no longer implicitly decodes non-UTF-8 bytes and existing API response behavior remains intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100