Skip to content

[swift6][client] Remove unnecessary Combine checks#22810

Merged
4brunu merged 1 commit intoOpenAPITools:masterfrom
4brunu:feature/swift-remove-unnecessary-check
Jan 26, 2026
Merged

[swift6][client] Remove unnecessary Combine checks#22810
4brunu merged 1 commit intoOpenAPITools:masterfrom
4brunu:feature/swift-remove-unnecessary-check

Conversation

@4brunu
Copy link
Contributor

@4brunu 4brunu commented Jan 26, 2026

[swift6][client] Remove unnecessary Combine checks

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 WSL)
    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 solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz-ah (2017/09) @4brunu (2019/11) @dydus0x14 (2023/06)


Summary by cubic

Removed redundant #if canImport(Combine) checks in the Swift 6 client generator and samples, always importing Combine when useCombine is enabled. This simplifies the code and ensures Combine publisher APIs are consistently available.

  • Refactors
    • Unconditionally import Combine in api.mustache when useCombine is true.
    • Removed #if/#endif guards around Combine publisher methods.
    • Regenerated Swift 6 samples to match the updated template.

Written for commit 7b9979c. Summary will update on new commits.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 19 files

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="modules/openapi-generator/src/main/resources/swift6/api.mustache">

<violation number="1" location="modules/openapi-generator/src/main/resources/swift6/api.mustache:11">
P2: Unconditional `import Combine` will fail to compile on non‑Apple platforms where the Combine module isn’t available. Keep the `#if canImport(Combine)` guard (and guard Combine-specific methods) to avoid breaking Swift builds outside Apple platforms.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

#if canImport(Combine)
import Combine
#endif{{/useCombine}}{{#useVapor}}
import Combine{{/useCombine}}{{#useVapor}}
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: Unconditional import Combine will fail to compile on non‑Apple platforms where the Combine module isn’t available. Keep the #if canImport(Combine) guard (and guard Combine-specific methods) to avoid breaking Swift builds outside Apple platforms.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/resources/swift6/api.mustache, line 11:

<comment>Unconditional `import Combine` will fail to compile on non‑Apple platforms where the Combine module isn’t available. Keep the `#if canImport(Combine)` guard (and guard Combine-specific methods) to avoid breaking Swift builds outside Apple platforms.</comment>

<file context>
@@ -8,9 +8,7 @@
-#if canImport(Combine)
-import Combine
-#endif{{/useCombine}}{{#useVapor}}
+import Combine{{/useCombine}}{{#useVapor}}
 import Vapor{{/useVapor}}{{#swiftUseApiNamespace}}
 
</file context>
Fix with Cubic

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine, since combine is optional, can be added or removed with configurations, and we don't support Linux right now, at least not intentionally.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback! I've saved this as a new learning to improve future reviews.

@4brunu
Copy link
Contributor Author

4brunu commented Jan 26, 2026

CI failure is not related to this PR.

@4brunu 4brunu merged commit 43b15fb into OpenAPITools:master Jan 26, 2026
14 of 17 checks passed
@4brunu 4brunu deleted the feature/swift-remove-unnecessary-check branch January 26, 2026 12:23
kingofdisasterr pushed a commit to kingofdisasterr/openapi-generator that referenced this pull request Jan 27, 2026
@wing328 wing328 added this to the 7.20.0 milestone Feb 15, 2026
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.

2 participants