Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

iOS Integration Validator 2.0 #1439

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

sharath-branch
Copy link
Contributor

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:

  1. When tests fail, we now have steps to help them fix the issues with corresponding references
  2. The developer can export logs right from the validator to share data with the PS or Support team.
  3. 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.

  1. 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.
  2. The Branch SDK version is now shown on the validator.
  3. The alert shows whether the Branch live or test key is being used.
  4. Default Link Domain is validated with info.plist
  5. Alternate Link Domain is validated with info.plist
  6. IDFA accessibility is determined
  7. 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.
  8. Logs can now be exported as a text file and shared using the native share sheet

IMG_0008 2
IMG_0009 2
Screenshot 2024-10-15 at 4 55 05 PM
https://github.com/user-attachments/assets/a14334cd-7764-42a8-bbf0-b4e7b12773ca

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

@ahmednawar
Copy link
Contributor

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

@nsingh-branch
Copy link
Contributor

@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
Copy link
Contributor

@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 ! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants