Fixed bug with Advanced Compliance and Integration Validator #1495
Conversation
…or whether or not it should use the custom endpoint. Updated getBaseURLForLinkingEndpoints() to take in a bool parameter for whether or not it should use the custom endpoint.
|
Summary By MatterAI
🔄 What ChangedThis Pull Request addresses a critical bug related to Branch's Advanced Compliance feature and the Integration Validator. The core change is in the
🔍 Impact of the ChangeThis fix resolves a bug (INTENG-22685) where the Branch Integration Validator would fail to function correctly if a customer had enabled Advanced Compliance and set a protected API URL (e.g., 📁 Total Files Changed
🧪 Test AddedWhile no automated tests were added, the PR provides clear manual testing instructions to verify the fix:
🔒 Security VulnerabilitiesNo new security vulnerabilities were introduced or detected by these changes. The modification primarily concerns API endpoint routing logic and does not involve changes to authentication, authorization, or sensitive data handling that would pose a security risk. Tip Quality Recommendations
Sequence DiagramsequenceDiagram
participant App as Application
participant BranchSDK as Branch SDK
participant BNCServerAPI as BNCServerAPI.m
participant BranchAPI as Branch API (Standard)
participant ProtectedAPI as Branch API (Protected/Custom)
App->>BranchSDK: Branch setAPIUrl("https://protected-api.branch.io")
App->>BranchSDK: branch validateSDKIntegration()
BranchSDK->>BNCServerAPI: validationServiceURL()
BNCServerAPI->>BNCServerAPI: getBaseURLForLinkingEndpoints(useCustomURL: NO)
BNCServerAPI-->>BranchAPI: Returns Standard URL for /v1/app-link-settings
BranchSDK->>BranchAPI: Make validation request
BranchAPI-->>BranchSDK: Validation Response
BranchSDK-->>App: Integration Validator Result
Note over BranchSDK,ProtectedAPI: For other services (e.g., linkServiceURL, qrcodeServiceURL, latdServiceURL)
BranchSDK->>BNCServerAPI: otherServiceURL()
BNCServerAPI->>BNCServerAPI: getBaseURLForLinkingEndpoints(useCustomURL: YES)
alt useCustomURL is YES AND customAPIURL is set
BNCServerAPI-->>ProtectedAPI: Returns Protected URL
else useCustomURL is YES AND customAPIURL is NOT set OR useCustomURL is NO
BNCServerAPI-->>BranchAPI: Returns Standard URL
end
BranchSDK->>BranchAPI: Make service request
BranchAPI-->>BranchSDK: Service Response
|
![matter-code-review[bot]](https://avatars.githubusercontent.com/in/474549?s=60&v=4){kind=small}
Sources/BranchSDK/BNCServerAPI.m
Outdated
| - (NSString *)getBaseURLForLinkingEndpoints: (BOOL)useCustom { | ||
| if (useCustom && self.customAPIURL) { | ||
| return self.customAPIURL; | ||
| } |
There was a problem hiding this comment.
💡 Optional Recommendation
Issue: The code doesn't have any logging when switching between custom and standard URLs.
Fix: Consider adding debug logging to help with troubleshooting.
Impact: Would make it easier to debug URL-related issues in production environments.
| - (NSString *)getBaseURLForLinkingEndpoints: (BOOL)useCustom { | |
| if (useCustom && self.customAPIURL) { | |
| return self.customAPIURL; | |
| } | |
| - (NSString *)getBaseURLForLinkingEndpoints: (BOOL)useCustom { | |
| if (useCustom && self.customAPIURL) { | |
| BNCLogDebug(@"Using custom API URL: %@", self.customAPIURL); | |
| return self.customAPIURL; | |
| } | |
| BNCLogDebug(@"Using standard API URL"); |
Co-authored-by: matter-code-review[bot] <150888575+matter-code-review[bot]@users.noreply.github.com>
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
rob-gioia-branch
deleted the
Integration-Validator-Protected-Endpoint-Bugfix
branch
2 participants
Updated getBaseURLForLinkingEndpoints() to take in a bool parameter for whether or not it should use the custom endpoint.
Reference
INTENG-22685
Summary
If a customer is using Advanced Compliance and then runs the Integration Validator code, the Integration Validator will not work. This is because the protected-api endpoint gets used for the requests, and there is no app-settings protected equivalent for that endpoint. Since the Integration Validator code is never released into the wild, but only used for testing, we can safely keep that endpoint going to the regular Branch endpoint, with all other calls like opens, installs, etc... still going through the protected endpoint for Advanced Compliance customers. To address this, I've added a boolean parameter to the getBaseURLForLinkingEndpoints() function, which can take in false in the case of any test code, like the integration validator, so that the regular endpoint (instead of protected-api) is used.
Motivation
To fix the bug caused when the protected API URL is set before the integration validator is run:
[Branch setAPIUrl:@"https://protected-api.branch.io"];
[branch validateSDKIntegration];
Type Of Change
Testing Instructions
[Branch setAPIUrl:@"https://protected-api.branch.io"];
[branch validateSDKIntegration];
cc @BranchMetrics/saas-sdk-devs for visibility.