ci(swift-sdk): prune orphaned FFI header subdirs in build_ios.sh

[llbartekll]

Issue being fixed or feature implemented

The Swift SDK CI job (.github/workflows/swift-sdk-build.yml, job Swift SDK and Example build (warnings as errors)) has been failing on PRs that merge v3.1-dev with:

DashSDKFFI.h:10:1: error: umbrella header for module 'DashSDKFFI'
does not include header '/dash-spv-ffi/dash-spv-ffi.h'

The self-hosted macOS ARM64 runner preserves target/ across CI runs (introduced by #3632, git clean -ffdx -e target/ -e target/**). Recently #3644 removed the dash-spv-ffi crate from the unified FFI build and dropped its #include from the umbrella header. cargo never reclaims target/<triple>/<profile>/include/<crate>/ when a crate leaves the dependency tree, so the orphan dash-spv-ffi/dash-spv-ffi.h sits in the cached include directory, xcodebuild -create-xcframework -headers bundles it into the framework, and Clang's umbrella header check fails.

What was done?

Made packages/swift-sdk/build_ios.sh self-correcting against this class of stale-state failure.

• Introduced a single ordered INCLUDED_CRATES list at the top of the script — the canonical set of FFI crates whose cbindgen output ships in DashSDKFFI.xcframework. Ordering matters because earlier headers define types referenced by later ones.
• inject_modulemap now:
  1. Prunes any immediate subdirectory of the include dir whose name is not in INCLUDED_CRATES (catches orphans from removed/renamed crates), with safe quoting and a [[ -d "$dir" ]] || continue guard.
  2. Asserts that every crate in INCLUDED_CRATES has its expected header on disk — converts the silent drift case ("array references a crate Cargo.toml doesn't pull in") into a clear script-level error before Clang sees it.
  3. Generates the umbrella DashSDKFFI.h from the same list via a printf loop, replacing the previous hardcoded heredoc.
• module.modulemap heredoc and the opaque-struct rewrite loop are untouched.

The list is the one source of truth: a future crate removal becomes a one-line edit, and the script self-heals the runner's cache on the next run.

How Has This Been Tested?

Validated locally before pushing.

• bash -n packages/swift-sdk/build_ios.sh clean.
• Sourced inject_modulemap against the real stale target/aarch64-apple-ios-sim/release/include/ on this workstation (which contained the same dash-spv-ffi/ orphan the runner has): the orphan was pruned, generated DashSDKFFI.h came out byte-identical to the post-#3644 heredoc shape, module.modulemap unchanged.
• Hid one of the surviving include dirs (dash-network/) to simulate a Cargo.toml/array drift: existence assertion fired with Missing header: … and exit 1. No silent failure path into Clang.

On CI (this PR): the first run will exercise the bug — the runner's cached target/ still contains the dash-spv-ffi/ subdir from prior builds, the prune step will remove it (look for → pruned orphan header dir: dash-spv-ffi in the logs), the umbrella check passes, and the runner's cache is permanently repaired for every subsequent PR. Re-runs on the same SHA will be a no-op for the prune step.

Out-of-scope: not switching the modulemap from umbrella header "X.h" to umbrella . — that would mask the orphan rather than fix it, and would lose the explicit #include order the framework relies on for transitive type visibility.

Breaking Changes

None. The generated umbrella header is byte-identical to the previous hardcoded heredoc on the no-orphan path, and the script is invoked the same way.

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated relevant unit/integration/functional/e2e tests
• I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
• I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

• I have assigned this pull request to a milestone

🤖 Generated with Claude Code

Summary by CodeRabbit

• Chores
  • Improved iOS SDK build system with enhanced header organization, validation, and error handling to ensure more reliable builds.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b21a63e8-3f26-480c-9063-131e165c51d9

📥 Commits

Reviewing files that changed from the base of the PR and between 798cd25 and 21ff9e3.

📒 Files selected for processing (1)

• packages/swift-sdk/build_ios.sh

---

📝 Walkthrough

Walkthrough

The iOS build script now uses a configurable INCLUDED_CRATES list to dynamically generate the DashSDKFFI.h umbrella header, replacing hardcoded includes. The inject_modulemap function was updated to prune orphan header directories, validate required headers exist for each included crate, and emit include statements in dependency order.

Changes

iOS Build Script – Dynamic Crate Header Inclusion

Layer / File(s)	Summary
Define included crates configuration packages/swift-sdk/build_ios.sh	INCLUDED_CRATES ordered array is introduced to specify which crate headers must be shipped in the unified iOS framework.
Implement dynamic header generation and validation packages/swift-sdk/build_ios.sh	inject_modulemap now prunes header subdirectories not listed in INCLUDED_CRATES, validates that each included crate has its expected $HEADERS_DIR/<crate>/<crate>.h header (failing the build if missing), and generates DashSDKFFI.h by programmatically emitting ordered include statements instead of using a hardcoded heredoc.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• dashpay/platform#3644: Also modifies packages/swift-sdk/build_ios.sh's inject_modulemap umbrella header generation to adjust FFI crate header inclusion.

Suggested reviewers

• shumkov
• QuantumExplorer

Poem

🐰 The crates now dance in ordered list,
No hardcoded headers will be missed.
Validation checks and cleanup flow,
Dynamic builds now steal the show!
*~ A grateful rabbit* 🚀

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately summarizes the main change: pruning orphaned FFI header subdirectories in the iOS build script, which is the core issue being fixed.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/ci-xcframework-header-mismatch

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[thepastaclaw]

✅ Review complete (commit 21ff9e3)

[github-actions]

✅ DashSDKFFI.xcframework built for this PR.

• Workflow run: https://github.com/dashpay/platform/actions/runs/26088409068
• Artifacts: DashSDKFFI.xcframework (folder), DashSDKFFI.xcframework.zip, xc_checksum.txt

SwiftPM (host the zip at a stable URL, then use):

.binaryTarget(
  name: "DashSDKFFI",
  url: "https://your.cdn.example/DashSDKFFI.xcframework.zip",
  checksum: "75d627d7a59a810436018b19554d1a05491cd085c00540f9c300f6605fc9059b"
)

Xcode manual integration:

• Download 'DashSDKFFI.xcframework' artifact from the run link above.
• Drag it into your app target (Frameworks, Libraries & Embedded Content) and set Embed & Sign.
• If using the Swift wrapper package, point its binaryTarget to the xcframework location or add the package and place the xcframework at the expected path.

[thepastaclaw]

Code Review

PR is a small, well-scoped CI fix to packages/swift-sdk/build_ios.sh that prunes orphan cbindgen header subdirs before xcframework creation. No FFI surface, ownership, or ABI changes. One nitpick about silent drift in the opposite direction worth surfacing.

Reviewed commit: 21ff9e3

💬 1 nitpick(s)