[swift] refactor global fields to local fields in API classes #20082
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Generated Swift code used global static variables for important state like
customHeaders
andrequestBuilderFactory
(see APIs.mustache).This likely introduces race conditions if one needs to set a custom requestBuilderFactory or header for a single request, as it is not guaranteed that no other Thread/Task re-sets this global var concurrently.
This PR adds local fields in generated Api classes that are initialized with the existing static fields by default.
Api calls are no longer class funcs.
You can now create two instances of an API using different RequestBuilders, headers, and so on. In other platforms such as kotlin or java, this was always possible using different ApiClients.
For backwards compatibility, you may just use the constructor with it's default values, which pulls in the static values just as before.
fixes #17377
TODO: This currently only adresses swift5, swift6 in progress.
PR checklist
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*
.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master
(upcoming7.x.0
minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)