Skip to content

feat: AppsFlyer unified deep linking to registration screen - #501

Closed
dariakharlan wants to merge 1 commit into
openedx:mainfrom
dariakharlan:feat/appsflyer-deeplink-registration
Closed

feat: AppsFlyer unified deep linking to registration screen#501
dariakharlan wants to merge 1 commit into
openedx:mainfrom
dariakharlan:feat/appsflyer-deeplink-registration

Conversation

@dariakharlan

Copy link
Copy Markdown

Summary

  • Integrates the AppsFlyer Android SDK for Unified Deep Linking (UDL), mirroring the existing Branch integration pattern in this codebase.
  • Deep links from go.proanalytics.academy, proanalytics.onelink.me, and the academyapp:// custom scheme resolve through a new AppsFlyerDeepLinkHandler and route to the registration (sign-up) screen by default. A OneLink template can override the destination by setting a screen_name deep link parameter, reusing the existing DeepLink/DeepLinkRouter infrastructure.
  • New APPSFLYER.ENABLED / APPSFLYER.DEV_KEY config keys (default config.yaml for dev/stage/prod), following the same pattern as BRANCH.
  • Manifest intent-filters added for the custom scheme and the two App Links domains (autoVerify="true").
  • Added tools:replace for allowBackup/dataExtractionRules/fullBackupContent on <application>, required because the AppsFlyer SDK ships its own manifest entries for these that otherwise fail the manifest merge.

Why

Support AppsFlyer-driven install/re-engagement attribution and route new users straight to registration when they arrive via a tracked link, without disrupting the existing Branch-based deep link flows (course/discussion links, etc.).

Notes for reviewers

  • APPSFLYER.ENABLED defaults to false and DEV_KEY is empty in all three environments — the SDK will not initialize until a real dev key is configured.
  • For the App Links domains to auto-verify, Digital Asset Links JSON needs to be published on go.proanalytics.academy and proanalytics.onelink.me (handled via AppsFlyer's OneLink setup).
  • Full :app compile could not be verified in the dev environment used for this change due to a pre-existing, unrelated MSAL dependency issue in the auth module (reproducible on main without this change). The core module (housing the new config classes) compiles cleanly, and the app-module changes closely follow the already-working Branch pattern.

Test plan

  • Set APPSFLYER.ENABLED: true and a real DEV_KEY in the target environment's config.yaml
  • Build and install the app
  • Trigger a OneLink click (or adb shell am start -a android.intent.action.VIEW -d "academyapp://test") and confirm the app opens to the registration screen
  • Verify existing Branch deep links (course/discussion) still work unaffected

Adds AppsFlyer Android SDK integration for Unified Deep Linking (UDL),
following the existing Branch integration pattern. Deep links from
go.proanalytics.academy, proanalytics.onelink.me, and the academyapp://
scheme resolve via AppsFlyerDeepLinkHandler and route to the registration
(sign-up) screen by default, unless the OneLink template overrides the
destination via a screen_name parameter.

- New AppsFlyerConfig / Config.getAppsFlyerConfig(), gated by an
  APPSFLYER.ENABLED flag in config.yaml (mirrors BRANCH config)
- Manifest intent-filters for the custom scheme and App Links domains
- New DeepLinkType.REGISTER wired into DeepLinkRouter, respecting
  REGISTRATION_ENABLED and current login state
- AppsFlyerDeepLinkHandler subscribes to the SDK's DeepLinkListener and
  exposes a replay-1 SharedFlow consumed by AppActivity, avoiding races
  between SDK resolution and Activity startup

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 27, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @dariakharlan!

This repository is currently maintained by @openedx/openedx-mobile-maintainers.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation.
Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign.
See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed.
After this time, you can re-run the CLA check by adding a comment below that you have signed it.
If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Aug 27, 2026
@dariakharlan dariakharlan closed this by deleting the head repository Aug 27, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Done in Contributions Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants