Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[swift] refactor global fields to local fields in API classes #20082

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kalinjul
Copy link
Contributor

@kalinjul kalinjul commented Nov 12, 2024

Generated Swift code used global static variables for important state like customHeaders and requestBuilderFactory (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

  • 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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@kalinjul kalinjul marked this pull request as draft November 12, 2024 09:12
@4brunu
Copy link
Contributor

4brunu commented Nov 13, 2024

Hi @kalinjul.
I would like to suggest to you checking the swift 6 generator and consider contributing to it.
Swift 6 already supports different headers, base url, etc, per request, although it still uses the global variables, because the variables were moved into a singleton.
But the swift 6 generator is aligned with what you are trying to archive here.
Please check if it fills yours needs or if still needs some tweaking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Swift – global mutable state causes memory corruption crashes
2 participants