EMT-2370 setThirdPartyAPIsTimeout Implementation #1517

NidhiDixit09 · 2025-08-25T22:00:26Z

Reference

EMT-2370 - https://branch.atlassian.net/browse/EMT-2370

Type Of Change

New feature (non-breaking change which adds functionality)

cc @BranchMetrics/saas-sdk-devs for visibility.

… will be fetched in parallel now for installs and opens.

matter-code-review · 2025-08-25T22:00:52Z

Summary By MatterAI

🔄 What Changed

This Pull Request introduces a new public API setAnonID in the Branch SDK, enabling developers to set a custom anonymous ID for the current user. This method is implemented with robust input validation and thread-safe storage. Concurrently, all code related to BNCAppleReceipt (including its implementation, associated unit tests, and references within BNCRequestFactory and BranchConstants) has been completely removed, streamlining the SDK's codebase. Minor CI/CD updates include correcting an artifact name in the release workflow and upgrading the download-artifact GitHub Action to v5. 🚀

🔍 Impact of the Change

The setAnonID method provides enhanced flexibility for managing anonymous user identification, allowing for more tailored tracking and integration with external systems. The comprehensive removal of BNCAppleReceipt functionality significantly reduces the SDK's footprint and complexity by eliminating unused or deprecated components, leading to a leaner and more maintainable codebase. The CI/CD updates ensure more reliable and up-to-date build and release processes. ✅

📁 Total Files Changed

.github/workflows/release.yml: Updated artifact name and download-artifact action version. (2 additions, 2 deletions)
Branch-TestBed/Branch-SDK-Tests/BNCAppleReceiptTests.m: Removed unit tests for BNCAppleReceipt. (33 deletions)
Branch-TestBed/Branch-SDK-Tests/BranchClassTests.m: Added comprehensive unit tests for the new setAnonID method. (97 additions)
Sources/BranchSDK/BNCAppleReceipt.m: Removed the implementation of BNCAppleReceipt. (66 deletions)
Sources/BranchSDK/BNCRequestFactory.m: Removed BNCAppleReceipt dependency and related data collection methods. (17 deletions)
Sources/BranchSDK/Branch.m: Added the new setAnonID public method with validation and thread safety. (10 additions)
Sources/BranchSDK/BranchConstants.m: Removed constants related to Apple Receipt. (2 deletions)
Sources/BranchSDK/Private/BNCAppleReceipt.h: Removed the header file for BNCAppleReceipt. (27 deletions)
Sources/BranchSDK/Private/BranchConstants.h: Removed constants related to Apple Receipt. (2 deletions)
Sources/BranchSDK/Public/Branch.h: Added the declaration for the setAnonID method. (6 additions)

🧪 Test Added

Extensive unit tests for the new Branch.setAnonID method were added in BranchClassTests.m. These tests cover various scenarios, including setting valid string values, updating existing values, handling nil and empty strings gracefully, rejecting non-string objects, verifying behavior with long strings and special characters, and ensuring thread safety during concurrent calls. 🧪

🔒Security Vulnerabilities

No new security vulnerabilities were introduced. The setAnonID method incorporates robust input validation (checking for non-nil and NSString type) and uses @synchronized for thread-safe access to shared preferences, adhering to good defensive programming practices. 🛡️

Tip

Quality Recommendations

Ensure that the removal of BNCAppleReceipt does not impact any downstream analytics or attribution features that might have implicitly relied on its data, and if so, document the new approach.

Tanka Poem ♫

Code flows, clean and bright,
Old receipts fade from sight.
New ID takes hold,
Threads now safely interwove,
Logic's beauty, clear and bold. ✨

Sequence Diagram

sequenceDiagram
    participant App as Application
    participant BranchSDK as Branch SDK
    participant BNCPreferenceHelper as Preference Helper
    participant BranchLogger as Branch Logger

    App->>BranchSDK: Branch.setAnonID(anonID: String)
    activate BranchSDK
    BranchSDK->>BranchSDK: @synchronized(self) block
    alt Valid anonID (non-nil, NSString)
        BranchSDK->>BNCPreferenceHelper: sharedInstance.anonID = anonID
        BNCPreferenceHelper-->>BranchSDK: anonID stored
    else Invalid anonID (nil or non-NSString)
        BranchSDK->>BranchLogger: logWarning("Invalid anonID provided...")
        BranchLogger-->>BranchSDK: Warning logged
    end
    deactivate BranchSDK

NidhiDixit09 · 2025-08-26T16:49:02Z

/matter review

matter-code-review

Implementation looks solid with proper timeout validation and comprehensive test coverage. Found one potential race condition in concurrent API loading.

Sources/BranchSDK/BNCRequestFactory.m

matter-code-review · 2025-08-26T16:49:26Z

Sources/BranchSDK/BNCRequestFactory.m

+        if (!self.preferenceHelper.appleAttributionTokenChecked) {
+            self.appleAttributionToken = [BNCSystemObserver appleAttributionToken];
+            if (self.appleAttributionToken) {
+                self.preferenceHelper.appleAttributionTokenChecked = YES;
+            }
+        }


🐛 Bug Fix

Issue: Race condition when setting self.appleAttributionToken from concurrent dispatch queue without synchronization
Fix: Add @synchronized block around property assignment to prevent data races
Impact: Prevents potential crashes or data corruption when multiple threads access this property simultaneously

Suggested change

if (!self.preferenceHelper.appleAttributionTokenChecked) {

self.appleAttributionToken = [BNCSystemObserver appleAttributionToken];

if (self.appleAttributionToken) {

self.preferenceHelper.appleAttributionTokenChecked = YES;

}

}

if (!self.preferenceHelper.appleAttributionTokenChecked) {

NSString *token = [BNCSystemObserver appleAttributionToken];

@synchronized(self) {

self.appleAttributionToken = token;

}

if (self.appleAttributionToken) {

self.preferenceHelper.appleAttributionTokenChecked = YES;

}

}

✅ Resolved: Apple attribution token assignment moved to synchronized block in dispatch queue

Sources/BranchSDK/BNCRequestFactory.m

matter-code-review · 2025-08-26T16:49:26Z

Sources/BranchSDK/BNCRequestFactory.m

    if ([[self.preferenceHelper attributionLevel] isEqualToString:BranchAttributionLevelFull]) {
-        NSString *odmInfo = [BNCODMInfoCollector instance].odmInfo ;
-        if (odmInfo) {
-            [self safeSetValue:odmInfo forKey:BRANCH_REQUEST_KEY_ODM_INFO onDict:json];
+        if (self.odmInfo) {
+            [self safeSetValue:self.odmInfo forKey:BRANCH_REQUEST_KEY_ODM_INFO onDict:json];
            NSNumber* odmInitDateInNumberFormat = BNCWireFormatFromDate(self.preferenceHelper.odmInfoInitDate);
            [self safeSetValue:odmInitDateInNumberFormat forKey:BRANCH_REQUEST_KEY_ODM_FIRST_OPEN_TIMESTAMP onDict:json];
        }


🐛 Bug Fix

Issue: Accessing self.odmInfo without synchronization after concurrent assignment
Fix: Add @synchronized block around property access to ensure thread safety
Impact: Prevents reading potentially corrupted or partially written data

Suggested change

if ([[self.preferenceHelper attributionLevel] isEqualToString:BranchAttributionLevelFull]) {

NSString *odmInfo = [BNCODMInfoCollector instance].odmInfo ;

if (odmInfo) {

[self safeSetValue:odmInfo forKey:BRANCH_REQUEST_KEY_ODM_INFO onDict:json];

if (self.odmInfo) {

[self safeSetValue:self.odmInfo forKey:BRANCH_REQUEST_KEY_ODM_INFO onDict:json];

NSNumber* odmInitDateInNumberFormat = BNCWireFormatFromDate(self.preferenceHelper.odmInfoInitDate);

[self safeSetValue:odmInitDateInNumberFormat forKey:BRANCH_REQUEST_KEY_ODM_FIRST_OPEN_TIMESTAMP onDict:json];

}

if ([[self.preferenceHelper attributionLevel] isEqualToString:BranchAttributionLevelFull]) {

NSString *odmInfo;

@synchronized(self) {

odmInfo = self.odmInfo;

}

if (odmInfo) {

[self safeSetValue:odmInfo forKey:BRANCH_REQUEST_KEY_ODM_INFO onDict:json];

NSNumber* odmInitDateInNumberFormat = BNCWireFormatFromDate(self.preferenceHelper.odmInfoInitDate);

[self safeSetValue:odmInitDateInNumberFormat forKey:BRANCH_REQUEST_KEY_ODM_FIRST_OPEN_TIMESTAMP onDict:json];

}

}

✅ Resolved: ODM info access is now properly synchronized in addODMInfoToJSON method

NidhiDixit09 · 2025-08-27T05:29:35Z

/matter review-full

matter-code-review

Implementation looks solid with proper timeout validation and thread safety. Found one potential race condition in concurrent dispatch queue usage.

Sources/BranchSDK/BNCRequestFactory.m

gdeluna-branch · 2025-08-27T23:14:03Z

/matter summary

matter-code-review · 2025-08-27T23:14:35Z

Summary By MatterAI

🔄 What Changed

This PR introduces a new setThirdPartyAPIsTimeout method, allowing configuration of timeouts for external API calls like On-Device Conversion (ODM) info and Apple Attribution Token. It refactors the BNCODMInfoCollector to be fully asynchronous, removing blocking calls and centralizing timeout management within BNCRequestFactory. The AppAdsOnDeviceConversion.xcframework dependency has been removed, and CI/CD workflows are updated to use a consistent Xcode version (16.4). Test URLs for BNCAPIServerTest were also updated.

🔍 Impact of the Change

🚀 This change significantly enhances the SDK's performance and responsiveness by making third-party API data collection non-blocking and concurrent. It improves reliability by providing a configurable timeout for external dependencies, preventing potential hangs. The SDK's footprint is reduced by removing an external framework, and CI/CD stability is ensured through consistent Xcode versions. The refactoring streamlines SDK initialization by deferring ODM loading to request creation.

📁 Total Files Changed

.github/workflows/pre-release-qa.yml: Updated Xcode version for pre-release QA jobs.
.github/workflows/verify.yml: Updated Xcode version for verification jobs.
Branch-TestBed/Branch-SDK-Tests/BNCAPIServerTest.m: Updated expected URL for validation service.
Branch-TestBed/Branch-SDK-Tests/BNCODMTests.m: Refactored ODM timeout and loading tests to use new async API.
Branch-TestBed/Branch-SDK-Tests/BNCPreferenceHelperTests.m: Added tests for thirdPartyAPIsTimeout default and setter/getter.
Branch-TestBed/Branch-SDK-Tests/BranchClassTests.m: Added comprehensive tests for Branch.setThirdPartyAPIsTimeout including valid, invalid, and boundary values.
Branch-TestBed/Branch-TestBed-CI.xctestplan: Disabled Reflection_ODM_Tests target.
Branch-TestBed/Branch-TestBed.xcodeproj/Branch-TestBed.xctestplan: Skipped specific Reflection_ODM_Tests.
Branch-TestBed/Reflection_ODM_Tests.xctestplan: Skipped specific Reflection_ODM_Tests.
Branch-TestBed/Reflection_ODM_Tests/Framework/.../AppAdsOnDeviceConversion.framework/... (multiple files): Removed AppAdsOnDeviceConversion.xcframework and its related headers/modulemap.
Branch-TestBed/Reflection_ODM_Tests/Reflection_ODM_Tests.m: Updated ODM reflection tests to use the new loadODMInfoWithCompletionHandler.
Sources/BranchSDK/BNCODMInfoCollector.m: Major refactoring to remove odmInfo property and blocking calls, introducing loadODMInfoWithCompletionHandler.
Sources/BranchSDK/Private/BNCODMInfoCollector.h: Updated interface for BNCODMInfoCollector to reflect asynchronous changes.
Sources/BranchSDK/BNCPreferenceHelper.m: Added thirdPartyAPIsTimeout property with default value and persistence.
Sources/BranchSDK/Public/BNCPreferenceHelper.h: Added thirdPartyAPIsTimeout property declaration.
Sources/BranchSDK/BNCRequestFactory.m: Implemented loadDataFromThirdPartyAPIs for concurrent, timeout-controlled fetching of ODM info and Apple Attribution Token.
Sources/BranchSDK/BNCSystemObserver.m: Simplified appleAttributionToken method by removing internal timeout logic.
Sources/BranchSDK/Branch.m: Removed proactive ODM loading, added setThirdPartyAPIsTimeout static method with validation.
Sources/BranchSDK/Public/Branch.h: Added setThirdPartyAPIsTimeout public API declaration.

🧪 Test Added

Extensive tests were added for the new setThirdPartyAPIsTimeout functionality:

testThirdPartyAPIsTimeoutDefaultValue: Verifies the default timeout is 0.5 seconds.
testThirdPartyAPIsTimeoutSetterGetter: Confirms the timeout can be set and retrieved correctly with various valid values.
testBranchSetThirdPartyAPIsTimeout: Checks that the Branch class method correctly updates the preference helper.
testBranchSetThirdPartyAPIsTimeoutMultipleValues: Ensures the Branch method handles multiple valid timeout values.
testTimeoutIntegrationWithPreferenceHelper: Validates consistency when setting timeouts via Branch and directly on BNCPreferenceHelper.
testTimeoutValueConsistency: Confirms the set timeout value remains consistent across multiple reads.
testBranchSetThirdPartyAPIsTimeoutInvalidLowValues: Verifies that invalid low timeout values (<= 0) are rejected.
testBranchSetThirdPartyAPIsTimeoutInvalidHighValues: Verifies that invalid high timeout values (> 10 seconds) are rejected.
testBranchSetThirdPartyAPIsTimeoutBoundaryValues: Tests the behavior at the valid boundaries (0.0001s and 10.0s) and just outside (10.0001s).

🔒Security Vulnerabilities

No new security vulnerabilities were introduced. The changes improve the reliability of external API calls, which can indirectly contribute to a more robust and secure system by preventing hangs or unexpected behavior from third-party services.

gdeluna-branch · 2025-08-27T23:17:24Z

/matter review

matter-code-review · 2025-08-27T23:17:35Z

Simple string formatting change with proper semicolon termination. Code change is minimal and safe.

…InstallWithURLString and dataForOpenWithURLString.

NidhiDixit09 · 2025-08-29T18:22:07Z

/matter review-full

matter-code-review

Comprehensive third-party API timeout implementation with proper validation and thread safety. Found several critical bugs in test code and potential race conditions.

Skipped files

Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj: Skipped file pattern
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/Info.plist: Skipped file pattern
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/ios-arm64/AppAdsOnDeviceConversion.framework/AppAdsOnDeviceConversion: File hunk diff too large
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/ios-arm64/AppAdsOnDeviceConversion.framework/Info.plist: Skipped file pattern
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/ios-arm64_x86_64-simulator/AppAdsOnDeviceConversion.framework/AppAdsOnDeviceConversion: File hunk diff too large
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/ios-arm64_x86_64-simulator/AppAdsOnDeviceConversion.framework/Info.plist: Skipped file pattern

Branch-TestBed/Branch-SDK-Tests/BNCODMTests.m

Sources/BranchSDK/BNCODMInfoCollector.m

Sources/BranchSDK/BNCRequestFactory.m

Sources/BranchSDK/Branch.m

Branch-TestBed/Branch-SDK-Tests/BranchClassTests.m

NidhiDixit09 · 2025-08-29T18:59:03Z

/matter review

matter-code-review

Implementation looks solid with proper timeout validation and concurrent API loading. Found one test assertion issue and a potential race condition in property access.

Skipped files

Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj: Skipped file pattern
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/Info.plist: Skipped file pattern
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/ios-arm64/AppAdsOnDeviceConversion.framework/AppAdsOnDeviceConversion: File hunk diff too large
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/ios-arm64/AppAdsOnDeviceConversion.framework/Info.plist: Skipped file pattern
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/ios-arm64_x86_64-simulator/AppAdsOnDeviceConversion.framework/AppAdsOnDeviceConversion: File hunk diff too large
Branch-TestBed/Reflection_ODM_Tests/Framework/AppAdsOnDeviceConversion.xcframework/ios-arm64_x86_64-simulator/AppAdsOnDeviceConversion.framework/Info.plist: Skipped file pattern

Branch-TestBed/Branch-SDK-Tests/BranchClassTests.m

/matter summary: Generate AI Summary for the PR
/matter review: Generate AI Reviews for the latest commit in the PR
/matter review-full: Generate AI Reviews for the complete PR
/matter release-notes: Generate AI release-notes for the PR
/matter : Chat with your PR with Matter AI Agent
/matter remember : Generate AI memories for the PR
/matter explain: Get an explanation of the PR
/matter help: Show the list of available commands and documentation
Need help? Join our Discord server: https://discord.gg/fJU5DvanU3

NidhiDixit09 added 10 commits August 22, 2025 12:21

Added API - setThirdPartyAPIsTimeout, ODM and Apple attribution token…

0df8b86

… will be fetched in parallel now for installs and opens.

Added Unit tests

f4fc6fd

Added unit tests, code cleanup.

6b77087

Updated platform version

6d05846

Update verify.yml

2e7c233

Update verify.yml

5679df4

Update Scanfile

dd71d49

Update verify.yml

a0abe59

Unit test fixes.

bcedd58

Reverted Deployment target.

ed494df

NidhiDixit09 added 4 commits August 25, 2025 23:38

Reverted refactoring of class BNCODMInfoCollector class

533e0c1

Removed extra spaces.

dcc5db1

Reverted GHA changes

5026d2d

Reverted previous changes and refactored BNCODMInfoCollector class

67217f4

NidhiDixit09 requested a review from gdeluna-branch August 26, 2025 07:48

NidhiDixit09 added 2 commits August 26, 2025 08:07

Removed extra param from the comments.

d07026a

Removed extra header file.

7de6ddd

matter-code-review bot reviewed Aug 26, 2025

View reviewed changes

Code cleanup and refactoring of appleAttributionToken function.

e7b7733

matter-code-review bot reviewed Aug 27, 2025

View reviewed changes

Sources/BranchSDK/BNCRequestFactory.m Show resolved Hide resolved

NidhiDixit09 added 7 commits August 27, 2025 09:39

Temp changes for Github Runner Bug.

2cd4f5c

Temp change for ODM timeout test

0655535

Fixed Unit tests.

f27b347

Replaced ODM framework binary with SPM

6220b10

testing - temp change.

0859ddf

Update project.pbxproj

17ab689

Integration Tests temp.

1397945

BranchMetrics deleted a comment from matter-code-review bot Aug 27, 2025

gdeluna-branch approved these changes Aug 27, 2025

View reviewed changes

NidhiDixit09 added 3 commits August 28, 2025 12:48

Updated API name and moved loadDataFromThirdPartyAPIs call to dataFor…

6d02ced

…InstallWithURLString and dataForOpenWithURLString.

Updated new API name in unit tests.

35482fc

synchronized fetchODMInfoFromDeviceWithInitDate function.

4b413b2

BranchMetrics deleted a comment from matter-code-review bot Aug 29, 2025

matter-code-review bot reviewed Aug 29, 2025

View reviewed changes

Branch-TestBed/Branch-SDK-Tests/BranchClassTests.m Outdated Show resolved Hide resolved

Sources/BranchSDK/BNCRequestFactory.m Show resolved Hide resolved

Sources/BranchSDK/BNCRequestFactory.m Show resolved Hide resolved

Updated Variable Name.

0a705cc

NidhiDixit09 added 4 commits August 29, 2025 12:22

Commit message 1

bd8cc80

Commit message 2

6cabb14

Commit message 3

a842bd5

Commit message 333

d254527

Reverted GHA updates.

fb5ee35

gdeluna-branch approved these changes Aug 29, 2025

View reviewed changes

Merge branch 'master' into EMT-2370-setThirdPartyAPIsTimeout

f0a1276

NidhiDixit09 merged commit c98a544 into master Aug 29, 2025
6 of 15 checks passed

EMT-2370 setThirdPartyAPIsTimeout Implementation #1517

EMT-2370 setThirdPartyAPIsTimeout Implementation #1517

Uh oh!

Conversation

NidhiDixit09 commented Aug 25, 2025

Reference

Type Of Change

Uh oh!

matter-code-review bot commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary By MatterAI

🔄 What Changed

🔍 Impact of the Change

📁 Total Files Changed

🧪 Test Added

🔒Security Vulnerabilities

Quality Recommendations

Tanka Poem ♫

Sequence Diagram

Uh oh!

NidhiDixit09 commented Aug 26, 2025

Uh oh!

matter-code-review bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

matter-code-review bot Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

matter-code-review bot Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

matter-code-review bot Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

matter-code-review bot Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

NidhiDixit09 commented Aug 27, 2025

Uh oh!

matter-code-review bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gdeluna-branch commented Aug 27, 2025

Uh oh!

matter-code-review bot commented Aug 27, 2025

Summary By MatterAI

🔄 What Changed

🔍 Impact of the Change

📁 Total Files Changed

🧪 Test Added

🔒Security Vulnerabilities

Uh oh!

gdeluna-branch commented Aug 27, 2025

Uh oh!

matter-code-review bot commented Aug 27, 2025

Uh oh!

NidhiDixit09 commented Aug 29, 2025

Uh oh!

matter-code-review bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

NidhiDixit09 commented Aug 29, 2025

Uh oh!

matter-code-review bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matter-code-review bot commented Aug 29, 2025

PR Review Skipped

Command List

matter-code-review bot commented Aug 25, 2025 •

edited

Loading