iOS Integration Validator 2.0 #1439

sharath-branch · 2024-10-15T11:30:50Z

Reference

No related JIRA ticket, part of the initiative to improve the Branch SDK implementation QA process.

Summary

Enhanced the iOS Integration Validator with multiple quality of life changes to improve developer experience, aid our support team to debug faster and improve the overall integration testing process.

Motivation

The current iOS integration validator is a good first step for any developer to test their Branch iOS SDK integration. However, it is missing a few key details that can make it easy for the developer to validate their integration. Additionally, there are three key pain points that are solved as quality of life enhancements:

When tests fail, we now have steps to help them fix the issues with corresponding references
The developer can export logs right from the validator to share data with the PS or Support team.
The Integration Validator can now be accessed on-the-fly using a query parameter on any Branch link, eliminating the need for a separate build that initiates just the validator. This eases the testing process for QA teams, PS and even our Support team as they can now run a preliminary check by simply accessing the App Store app!

Type Of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Testing Instructions

There are a total of 8 new changes that can be observed through this PR.

There's an exciting new way to trigger the validator. Add validate_integration=true as a query parameter to any Branch link and click on it to trigger the Integration Validator. This complements the old method beautifully to give developers two great ways to trigger the validator.
The Branch SDK version is now shown on the validator.
The alert shows whether the Branch live or test key is being used.
Default Link Domain is validated with info.plist
Alternate Link Domain is validated with info.plist
IDFA accessibility is determined
When tests fail, the alert now gives an option for the developer to understand what changes need to be made along with references to the documentation website.
Logs can now be exported as a text file and shared using the native share sheet

https://github.com/user-attachments/assets/a14334cd-7764-42a8-bbf0-b4e7b12773ca

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

ahmednawar · 2024-11-14T17:07:23Z

@NidhiDixit09 @nsingh-branch can you please review? this has been sitting idle for a while

nsingh-branch · 2024-11-14T18:02:59Z

@NidhiDixit09 @nsingh-branch can you please review? this has been sitting idle for a while

We had a meeting with Rob yesterday and I believe he's going to be combining the new deep linking validator into this PR as well.

@rob-gioia-branch Is that correct?

rob-gioia-branch · 2024-11-14T18:24:57Z

@NidhiDixit09 @nsingh-branch can you please review? this has been sitting idle for a while

We had a meeting with Rob yesterday and I believe he's going to be combining the new deep linking validator into this PR as well.

@rob-gioia-branch Is that correct?

@nsingh-branch yes that is correct, going to merge the two branches together so that the code is in one PR, and the tests in one validator popup. Will do that soon so that folks can review!

Thank you for the bump @ahmednawar ! :)

NidhiDixit09 · 2024-11-20T08:03:46Z

Sources/BranchSDK/BNCSystemObserver.m

+    NSArray *linkDomains = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"branch_universal_link_domains"];
+
+    for (NSString *domain in linkDomains) {
+        if ([domain isEqualToString:serverLinkDomain]) {


@sharath-branch linkdomains strings can have prefix applinks: also. ( Suggested format is our docs is - applinks:subdomain.app.link https://help.branch.io/developers-hub/docs/ios-basic-integration#3-configure-associated-domains ) . So this check will fail if user adds applinks: to domain in info.plist

This is checking only the info.plist actually and not the associated domains. We recommend adding the prefix applinks: only to associated domains. The recommendation is to add the domains directly to the info.plist without any prefix (https://help.branch.io/developers-hub/docs/ios-basic-integration#4-configure-infoplist).

NidhiDixit09 · 2024-11-20T08:07:56Z

Sources/BranchSDK/BNCSystemObserver.m

@@ -165,6 +165,17 @@ + (BOOL)compareUriSchemes : (NSString *) serverUriScheme {
    return false;


@sharath-branch At line no. 162, if code returns from here, it will not check second and more urlType in array urlTypes

Fixed, thanks!

NidhiDixit09 · 2024-11-20T08:09:55Z

Sources/BranchSDK/Branch+Validator.m

+        case BranchLinkDomainError:
+            return @"Check the link domain and alternate domain values in your info.plist file under the key 'branch_universal_link_domains'. The values should match with the ones on the Branch dashboard.\n\n";
+        case BranchURISchemeError:
+            return @"The URI scheme in your info.plist file shoudl match with the URI scheme value for iOS on the Branch dashboard.\n\n";


Typo - shoudl should be should :)

NidhiDixit09 · 2024-11-20T08:13:33Z

Sources/BranchSDK/Branch+Validator.m

    NSString *uriScheme = [BNCSystemObserver compareUriSchemes:serverUriScheme] ? passString : errorString;
+    bool doUriSchemesMatch = [BNCSystemObserver compareUriSchemes:serverUriScheme];


Minor optimization -

bool doUriSchemesMatch = [BNCSystemObserver compareUriSchemes:serverUriScheme]; NSString *uriScheme = doUriSchemesMatch ? passString : errorString;

NidhiDixit09 · 2024-11-20T08:16:22Z

Sources/BranchSDK/BranchFileLogger.m

+
+@interface BranchFileLogger ()
+
+@property (nonatomic, strong) NSString *logFilePath;


This property is not used anywhere. If its not required, it can be removed.

It's actually a private property that's used in the functions within the class. Have fixed some functions to reference this property which was previously missing.

NidhiDixit09 · 2024-11-20T08:18:20Z

Sources/BranchSDK/Branch.m

@@ -2107,6 +2107,8 @@ - (void)handleInitSuccessAndCallCallback:(BOOL)callCallback sceneIdentifier:(NSS
        id<NSObject> sharedApplication = [applicationClass performSelector:@selector(sharedApplication)];
        if ([sharedApplication respondsToSelector:@selector(openURL:)])
            [sharedApplication performSelector:@selector(openURL:) withObject:comp.URL];
+    } else if ([latestReferringParams[@"validate_integration"] isEqualToString:@"true"]) {
+        [self validateSDKIntegration];


What will happen if deep linking fails ?

If deep linking fails completely, this will never trigger which is an outcome we are fine with. But there are multiple entry points to this function - let's say universal link launch fails, it will launch via URI scheme. If both of these fail, developer can try with the alternate link domain. The idea is that if this fails to load completely, we still have some understanding that the core issue is with the universal links setup itself.

As of today, debugging an issue is a blind spot for CX teams because the error could be anywhere. This function helps in breaking down the issue into (a). either the issue is fundamentally with the links setup (if the validator doesn't launch at all) or (b). the issue is one of the issues highlighted by the validator.

NidhiDixit09 · 2024-11-20T08:23:12Z

Sources/BranchSDK/Public/BranchFileLogger.h

+//
+//  Created by Sharath Sriram on 15/10/24.
+//
+


Is this file supposed to be public ? Its mainly used by "Branch+Validator.h" which is inside private folder.

sharath-branch added 5 commits October 15, 2024 16:31

integration-validator-2.0

0c97306

Removed file logger from tvOS

5239c1b

Added tvOS conditional headers

4b0e2cd

Change header to public to fix test failure

77229f6

Fixed testbed

6bbd3ba

sharath-branch marked this pull request as ready for review October 22, 2024 10:53

sharath-branch requested review from nsingh-branch, NidhiDixit09 and gdeluna-branch October 22, 2024 10:53

NidhiDixit09 reviewed Nov 20, 2024

View reviewed changes

sharath-branch added 2 commits November 25, 2024 13:36

fix: PR changes

f9af58b

fix: testbed file visibility

13d38e4

NidhiDixit09 approved these changes Dec 3, 2024

View reviewed changes

gdeluna-branch approved these changes Dec 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

iOS Integration Validator 2.0 #1439

iOS Integration Validator 2.0 #1439

sharath-branch commented Oct 15, 2024

ahmednawar commented Nov 14, 2024

nsingh-branch commented Nov 14, 2024

rob-gioia-branch commented Nov 14, 2024

NidhiDixit09 Nov 20, 2024

sharath-branch Nov 25, 2024

NidhiDixit09 Nov 20, 2024

sharath-branch Nov 25, 2024

NidhiDixit09 Nov 20, 2024

sharath-branch Nov 25, 2024

NidhiDixit09 Nov 20, 2024

sharath-branch Nov 25, 2024

NidhiDixit09 Nov 20, 2024

sharath-branch Nov 25, 2024

NidhiDixit09 Nov 20, 2024

sharath-branch Nov 25, 2024

NidhiDixit09 Nov 20, 2024

sharath-branch Nov 25, 2024

		@@ -165,6 +165,17 @@ + (BOOL)compareUriSchemes : (NSString *) serverUriScheme {
		return false;

		NSString *uriScheme = [BNCSystemObserver compareUriSchemes:serverUriScheme] ? passString : errorString;
		bool doUriSchemesMatch = [BNCSystemObserver compareUriSchemes:serverUriScheme];


		@interface BranchFileLogger ()

		@property (nonatomic, strong) NSString *logFilePath;

iOS Integration Validator 2.0 #1439

Are you sure you want to change the base?

iOS Integration Validator 2.0 #1439

Conversation

sharath-branch commented Oct 15, 2024

Reference

Summary

Motivation

Type Of Change

Testing Instructions

ahmednawar commented Nov 14, 2024

nsingh-branch commented Nov 14, 2024

rob-gioia-branch commented Nov 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment