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

Integration Validator 2.0 #1223

Merged
merged 20 commits into from
Dec 10, 2024
Merged

Integration Validator 2.0 #1223

merged 20 commits into from
Dec 10, 2024

Conversation

rob-gioia-branch
Copy link
Contributor

Added a popup dialog displaying the Integration Validator results with options to view more details and export the logs

Reference

No ticket

Description

Clients that I've worked with were running into pain points when using the integration validator. On Android, the validator also did not have the popup functionality that iOS currently has. With the Integration Validator 2.0, clients can:

  • Check their Branch SDK version
  • View each of the checks and whether they passed or failed
  • Get more details about why a test failed and how to fix it
  • Link out to the relevant spot in the docs in their mWeb browser
  • Export the Branch logs at the click of a button

Screenshot 2024-09-27 at 3 51 13 PM

Screenshot 2024-09-27 at 3 52 46 PM

Screenshot 2024-09-27 at 3 52 58 PM

Screenshot 2024-09-27 at 3 53 45 PM

Testing Instructions

  • Run the integration validator using the usual method: IntegrationValidator.validate(this);

Risk Assessment [HIGH || MEDIUM || LOW]

LOW

  • [ X ] I, the PR creator, have tested — integration, unit, or otherwise — this code.

Reviewer Checklist (To be checked off by the reviewer only)

  • JIRA Ticket is referenced in PR title.
  • Correctness & Style
    • Conforms to AOSP Style Guides
    • Mission critical pieces are documented in code and out of code as needed.
  • Unit Tests reviewed and test issue sufficiently.
  • Functionality was reviewed in QA independently by another engineer on the team.

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

…h options to view more details and export the logs

Added a popup dialog displaying the Integration Validator results with options to view more details and export the logs
@gdeluna-branch gdeluna-branch self-requested a review October 4, 2024 11:50
Got deep link validator dialog showing
…outing

Added spinner with the different choices of deep link keys used for routing
…choice

Next button loads the correct content for step 2 based on the user's choice
Removed unneeded permissions
Used IBranchLoggingCallbacks to retrieve the Branch logs
Added code to generate the various types of Branch links for testing
Laid out the UI for step 3 of the modal (link & use case testing)
…psulate each row

Added constants and built out a deep link validator row class to encapsulate each row
Got the info buttons showing the relevant tooltips
Added share button functionality
…ink issue

Added debug button functionality to show popup with how to fix deep link issue
…oded specifics

Logic refactors so that each row uses uniform, modular code vs. hardcoded specifics
Added foreground click use case
Added warm start test case logic + some bugfixes
Params bugfixes
…ator-2.0

# Conflicts:
#	Branch-SDK/src/main/res/drawable/branch_icon.png
Merged the Deep Linking Validator and the Integration Validator.
@rob-gioia-branch
Copy link
Contributor Author

@nsingh-branch - I've merged the Deep Linking Validator into here. Now there is a button at the bottom of the Integration Validator dialog so that the deep linking validator can be utilized without the client having to run that code separately.

386659004-58a80786-45fc-412a-b972-87d2406c81f9

Please LMK if any changes are needed. The only outstanding items based on our prior discussion are:

  • Getting a designer to do an aesthetic pass on it
  • Checking with legal regarding the use of the Branch logo / or needing the full name

Happy to make any changes that you, @NidhiDixit09 , or @gdeluna-branch request. Thanks!

cc: @ahmednawar

Refactors based on Gabe's PR feedback (1 of 2)
Refactors based on Gabe's PR feedback (2/2)
@rob-gioia-branch
Copy link
Contributor Author

Hey @gdeluna-branch thank you for reviewing this PR! I made all of the changes you requested except for one, noted above, where each check is its own object so it wouldn't be possible to refactor the constructor to just take in one object. But please LMK if I am mistaken and I'm happy to take another look.

Regarding next steps:

  • Who can we reach out to to check about using the Branch name / logo per your comment in slack? Do I just ask [email protected]?
  • What is the process for looping in a designer to improve the aesthetics?

cc: @ahmednawar

Copy link
Contributor

@gdeluna-branch gdeluna-branch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking some feedback offline

@rob-gioia-branch
Copy link
Contributor Author

Thanks Gabe! Now that the offline feedback has been resolved and legal gave us their approval, sending this back your way

Copy link
Contributor

@gdeluna-branch gdeluna-branch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work

@rob-gioia-branch rob-gioia-branch merged commit 0ab54c5 into master Dec 10, 2024
6 of 9 checks passed
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.

2 participants