Fix #2565: Retry ref code lookup on subsequent launches.

[jhreis]

Summary of Changes

This is fully dependent on #2535, do not merge this before that completes.

This pull request fixes #2565

Submitter Checklist:

• Unit Tests are updated to cover new or changed functionality
• User-facing strings use NSLocalizableString()

Test Plan:

This impacts user referral promo logic, so should test all initial download ids and referral code retrieval paths. Download Id redemption has not touched, as this only impacts app opening logic, but it may be good to run a quick test or two on that as well.

User launches with clipboard referral and internet

1. Visit a Super Referrer landing page
2. Hit the download button
3. This will redirect you to the App Store, close the App Store
4. Go to notes app (or some other place with a text field)
5. Paste the clipboard
6. Should output F83AB73F-9852-4F01-ABA8-7830B8825993 and then the specific ref code (e.g. ABC123) from the referral
7. So full out put would be F83AB73F-9852-4F01-ABA8-7830B8825993:ABC123 for example
8. Download Brave through TF
9. Open Brave
10. Verify that correct ref code shows up in settings / on server
11. Verify assets are shown on the home page
12. Verify favorites show the referral’s custom favs

User launches with clipboard referral and no internet

1. Visit a Super Referrer landing page
2. Hit the download button
3. This will redirect you to the App Store, close the App Store
4. Go to notes app (or some other place with a text field)
5. Paste the clipboard
6. Should output F83AB73F-9852-4F01-ABA8-7830B8825993 and then the specific ref code (e.g. ABC123) from the referral
7. So full output would be F83AB73F-9852-4F01-ABA8-7830B8825993:ABC123 for example
8. Download Brave through TF
9. Disable internet (this makes sure the fallback is not activated if clipboard fails for some reason)
10. Open Brave
11. Since no internet connection, no custom assets / download id, but ref code should still be shown inside the settings page
12. Close app entirely (swipe up on it)
13. Re-enable internet connection
14. Launch Brave again
15. Check settings page, download id should now be showing
16. Custom assets should eventually show up (may take a bit)

User launches with no clipboard referral and internet

1. Referral should still work, even if clipboard approach fails, this tests that condition:
2. Visit a Super Referrer landing page
3. Hit the download button
4. This will redirect you to the App Store, close the App Store
5. Go to notes app (or some other place with a text field)
6. Paste the clipboard
7. Should output F83AB73F-9852-4F01-ABA8-7830B8825993: and then the specific ref code (e.g. ABC123) from the referral
8. So full output would be F83AB73F-9852-4F01-ABA8-7830B8825993:ABC123 for example
9. Copy a random string (e.g. “chocolate and coffee”)
10. Re-paste the clipboard to verify the new string is not the referral string
11. Download Brave through TF
12. Open Brave
13. Verify that correct ref code shows up in settings / on server
14. Verify assets are shown on the home page
15. Verify favorites show the referral’s custom favs

User launches with no clipboard referral and no internet

1. Referral should still work, even if clipboard approach fails, this tests that condition:
2. Visit a Super Referrer landing page
3. Hit the download button
4. This will redirect you to the App Store, close the App Store
5. Go to notes app (or some other place with a text field)
6. Paste the clipboard
7. Should output F83AB73F-9852-4F01-ABA8-7830B8825993: and then the specific ref code (e.g. ABC123) from the referral
8. So full output would be F83AB73F-9852-4F01-ABA8-7830B8825993:ABC123 for example
9. Copy a random string (e.g. “chocolate and coffee”)
10. Re-paste the clipboard to verify the new string is not the referral string
11. Download Brave through TF
12. Disable internet (this makes sure the fallback is not activated if clipboard fails for some reason)
13. Open Brave
14. Since no internet connection, no custom assets / download id, no ref-code should be shown this time
15. Close app entirely (swipe up on it)
16. Re-enable internet connection
17. Launch Brave again
18. Check settings page, download id / ref code should now be showing
19. Custom assets should eventually show up (may take a bit)

Screenshots:

Reviewer Checklist:

• Issues include necessary QA labels:
  • QA/(Yes|No)
  • release-notes/(include|exclude)
  • bug / enhancement
• Necessary security reviews have taken place.
• Adequate unit test coverage exists to prevent regressions.
• Adequate test plan exists for QA to validate (if applicable).
• Issue is assigned to a milestone (should happen at merge time).

[iccub]

Doesn't make sense to me, shouldn't this flag be toggled after the ref lookup network call?

[jhreis]

Yup 😄 I think I moved this last minute when cleaning things up, but this looks v wrong. Fixing.

[jhreis]

Probably more clear to just wrap these all in a struct, since all related to the same thing.

struct ReferralLookupRetry {
    private var retryTimer: Timer?
    private var currentCount = 0
    ...
}

[jumde]

If the refcode is cleared here, app won't find the refcode on the next launch if the the 10 network requests are not successful. May be store it in URP preferences?

[jhreis]

Ref code is passed into the look up function, and it is stored internally there:
https://github.com/brave/brave-ios/pull/2574/files#diff-bfe2070e3d8f02013654953e18b60730R280

Here is where it is stored:
https://github.com/brave/brave-ios/pull/2574/files#diff-60f6d7911cf19ceb7bcfcde55f9bc740R126

Then two lines below the network request (and potential retry logic) is executed.

[jumde]

My concern is that we are still accessing the clipboard on subsequent launches, I think we should just store it in a preference and use it from there: https://github.com/brave/brave-ios/pull/2574/files#diff-bfe2070e3d8f02013654953e18b60730R273 - Let me know if I'm missing something.

[jhreis]

That make sense, we will add a ref code check to prevent reading the clipboard again. Will be in a follow PR though, as it doesn't pertain to what this PR is.

[jhreis]

New commits from @iccub lgtm, ++
(can't formally review, since originally my PR)

[jhreis]

Per @jumde's comments, created follow up ticket, which will be required for this feature:
#2584

[jumde]

Issue to access clipboard on subsequent launches is being addressed here: https://github.com/brave/brave-ios/pull/2585/files - rest looks good to me