Skip to content
GitLab

[Kotlin][Multiplatform] Fix and improve HTTP client configuration

Merged Administrator requested to merge github/fork/Airthings/fix-http-client-configuration into master

Created by: tkirshboim

PR Description

This PR updates the Kotlin Multiplatform library templates with the following:

  • Fix an object freezing related issue that occurs on iOS when configuring the HTTP client. In the current version of the template, the entire ApiClient instance is captured when configuring the HTTP client. This does not work on iOS and throws an exception. The fix is implemented by capturing only the serializer instance.

  • Always use the HTTP client config that is defined in the API client class and extend it with the optional constructor provided configuration. Without this change, the client of the generated ApiClient class must also configure JSON serialization in order for the generated code to work.

Example usage

These changes were tested and validated in a demo project: https://github.com/Airthings/openapi-multiplatform-multi-module/tree/serializer-config-in-generated-code

CCs

Kotlin technical committee: @jimschubert @dr4ke616 @karismann @Zomzog @andrewemery @4brunu @yutaka0m

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.