EMT-2309: Add Class BNCServerRequestOperation. #1533
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… with v1/install request.
This reverts commit 0ad4564.
This reverts commit 53d322c.
This reverts commit ef025f1.
-> Removed DeepLinkDemo, TestDeepLinking and TestHost Apps for the repo. -> Removed Unit tests from Branch Test Bed App -> Added Test Host App and Unit tests to BranchSDK Workspace.
This reverts commit 83cd178.
This reverts commit af22cad.
…de-Restructure-Cleanup
This commit introduces modern Swift Concurrency patterns to the iOS Branch SDK, mirroring the Android Kotlin Coroutines implementation. The changes enable async/await request processing, actor-based thread safety, and structured concurrency throughout the SDK. ## Swift Concurrency Implementation Added three core Swift files using modern concurrency patterns: - `BranchRequestOperation.swift`: Actor-isolated async operation for processing Branch server requests with structured concurrency, automatic main thread dispatching for callbacks, and session validation matching Android's implementation - `BranchRequestQueue.swift`: Actor-based request queue with serial execution, async/await API, and thread-safe queue management replacing manual NSOperationQueue patterns - `ConfigurationController.swift`: Swift configuration management with async initialization and proper error handling Architecture parallels to Android: - Android: CoroutineScope + Channel → iOS: Actor + AsyncStream - Android: Dispatchers.IO → iOS: Task.detached - Android: Dispatchers.Main → iOS: MainActor ## Swift Package Manager (SPM) Integration Updated Package.swift to define dual-target architecture: - `BranchObjCSDK`: Core Objective-C framework with all existing functionality - `BranchSDK`: Swift wrapper exposing async/await APIs and importing BranchObjCSDK This enables seamless Swift integration while maintaining full Objective-C compatibility. ## Objective-C Bridge Enhancements Modified `BNCServerRequestOperation.m` to support Swift interop: - Added Swift availability checks (@available decorators) - Integrated async callback completion handling - Maintained backward compatibility with existing Objective-C code Updated `BNCServerRequestQueue.m` and `BNCRequestFactory.m` for improved Swift interaction. ## Public API Visibility Changes Moved `BNCConfig.h` from Private to Public headers to enable SPM package visibility. Added `BranchConstants.h` and `BranchConstants.m` to public BranchSDK directory for proper module exposure. ## Test Infrastructure Updates Updated 16 test files to use modular imports: - Changed from `#import "Branch.h"` to `@import BranchSDK` - Updated bridging headers for Swift/Objective-C interop - Modified test schemes to support SPM package dependencies Test files updated: - BNCAPIServerTest.m, BNCODMTests.m, BNCPasteboardTests.m - BNCPreferenceHelperTests.m, BranchActivityItemTests.m - BranchClassTests.m, BranchLoggerTests.m, BranchQRCodeTests.m - BranchShareLinkTests.m, DispatchToIsolationQueueTests.m - Branch_setBranchKeyTests.m - UITestCaseMisc.m, UITestCaseTracking.m, UITestSendV2Event.m - UITestSetIdentity.m, Branch-SDK-Tests-Bridging-Header.h ## Branch-TestBed Configuration Updated Branch-TestBed Xcode project: - Configured SPM package dependency reference - Updated project.pbxproj with proper target dependencies - Removed Package.resolved to allow flexible dependency resolution - Updated all test schemes for SPM compatibility - Modified AppDelegate.m and ViewControllers for async initialization ## Project Structure Cleanup Organized source files into proper directory structure: - Created `Sources/BranchSwiftSDK/` for Swift implementation - Moved configuration files to appropriate locations - Removed duplicate/temporary Swift files from previous iterations - Updated both BranchSDK.xcodeproj and Package.swift configurations ## Key Features - Structured concurrency with proper cancellation support - Actor-based thread safety eliminating race conditions - Automatic main thread dispatching for UI callbacks - Session validation matching Android implementation - Performance optimized with cooperative thread pool - Serial request processing ensuring proper ordering - Modern async/await API for Swift developers - Full backward compatibility with existing Objective-C code
Contributor
Summary By MatterAI
🔄 What ChangedThis Pull Request finalizes the integration of Swift Concurrency into the iOS Branch SDK, building upon the foundational setup from previous changes. It introduces the core 🔍 Impact of the ChangeThis PR represents a significant architectural modernization, bringing structured concurrency, enhanced thread safety, and improved maintainability to the iOS SDK. It achieves architectural parity with the Android SDK, leveraging Swift's 📁 Total Files Changed
🧪 Test Added/RecommendedAddedThis PR leverages the existing extensive test suite, with key verification steps integrated into the
Recommended
🔒Security VulnerabilitiesNo new security vulnerabilities were detected. The architectural shift to Swift Concurrency, with its actor-based thread safety and structured error handling, inherently improves the reliability and robustness of the SDK, indirectly contributing to a more secure codebase by reducing common concurrency-related bugs that could lead to unpredictable behavior or crashes. |
Contributor
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use MatterAICommand List
|
wpinho-branch
changed the title
wpinho-branch
added a commit
that referenced
this pull request
Nov 20, 2025
Work in progress on removing legacy Objective-C bridging code and adding modern Swift implementations to the 4.0.0-alpha.0 branch. Changes: - Added Swift implementations from PR #1533: - BranchRequestQueue.swift (Actor-based queue with Swift Concurrency) - BranchRequestOperation.swift (Modern operation implementation) - ConfigurationController.swift (Configuration management) - Updated Package.swift: - Upgraded swift-tools-version to 5.9 - Added BranchSwiftSDK target - Updated paths and dependencies - Removed bridging files: - Deleted BNCServerRequestQueue.m and BNCServerRequestQueue.h - Removed 16 references from Xcode project - Updated Branch.m: - Removed import of BNCServerRequestQueue.h - Commented out legacy error handling code that used remove: and peekAt: methods (These methods are incompatible with NSOperationQueue implementation) - Updated Branch.h: - Removed import of BNCServerRequestQueue.h - Added forward declarations for BNCServerRequestQueue and BNCServerRequest STATUS: Build currently failing with compilation errors. Additional work needed to: 1. Fix remaining compilation errors in dependent files 2. Implement proper error handling for NSOperationQueue-based request queue 3. Test framework and app builds 4. Complete migration to Swift implementations This is part of the broader effort to modernize the iOS Branch SDK with Swift Concurrency patterns (async/await, actors) while maintaining backward compatibility.
wpinho-branch
added a commit
that referenced
this pull request
Nov 20, 2025
Major changes from PR #1533: 1. Updated BNCServerRequestQueue implementation: - Replaced NSMutableArray with NSOperationQueue for serial processing - Added configureWithServerInterface:branchKey:preferenceHelper: method - Added enqueue:withPriority: for request prioritization - Automatic request processing (no manual peek/remove needed) 2. Added BNCServerRequestOperation: - New NSOperation subclass for async request execution - Handles session validation and error processing - Integrates with BNCCallbackMap for event callbacks 3. Updated Branch.m: - Removed manual queue processing (processNextQueueItem calls) - Removed insertRequestAtFront: method (priority via NSOperationQueue) - Added queue configuration in init - Simplified request enqueueing (automatic processing) 4. Updated Xcode project: - Added BNCServerRequestOperation.m to compile sources - Added BNCServerRequestOperation.h to Private headers Architecture improvements: - Serial queue execution via maxConcurrentOperationCount = 1 - Automatic operation lifecycle management - Better separation of concerns (queue vs operations) - Foundation for future Swift migration Build status: ✅ SUCCESS
…rocessing' of https://github.com/BranchMetrics/ios-branch-deep-linking-attribution into BNC-Server-Request-Queue-Refactoring-And-Auto-Request-Processing
Contributor
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use MatterAICommand List
|
Collaborator
|
@wpinho-branch There are two BranchConstants.m files. One at the original location and one inside BranchSDK_ObjC directory. We should keep only one. |
Collaborator
|
@wpinho-branch Integration tests for this PR are failing https://github.com/BranchMetrics/ios-branch-deep-linking-attribution/actions/runs/20073076865/job/57580213779?pr=1533 . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Reference
EMT-2309 -- Add Class BNCServerRequestOperation.
Summary
This PR implements Swift Concurrency (async/await) patterns for the iOS Branch SDK, mirroring the Android Kotlin Coroutines implementation. The changes introduce modern asynchronous request processing using Swift Actors and structured concurrency while maintaining full backward compatibility with existing Objective-C code.
Key Components:
BranchRequestOperation: Modern async/await operation for request processingBranchRequestQueue: Actor-based thread-safe queue managementConfigurationController: SDK configuration telemetry in SwiftMotivation
The iOS SDK currently uses legacy GCD-based asynchronous patterns, while the Android SDK has migrated to modern Kotlin Coroutines. This creates architectural inconsistency between platforms and makes the codebase harder to maintain.
Benefits of Swift Concurrency:
Technical Alignment:
CoroutineScope + Channel→ iOS:Actor + AsyncStreamDispatchers.IO→ iOS:Task.detachedDispatchers.Main→ iOS:@MainActorType Of Change
Testing Instructions
1. Build Verification
2. Runtime Verification
Run the Branch-TestBed app and verify console output shows:
3. Functional Testing
4. Backward Compatibility
5. Code Quality Checks
Checklist
Implementation Details
Architecture
Runtime Detection Flow
BNCServerRequestOperationchecks iOS version (≥13.0)NSClassFromString()to detect Swift classesNSInvocationcc @BranchMetrics/saas-sdk-devs for visibility.
https://branch.atlassian.net/browse/EMT-2309