Skip to content

refactor: deeplink handler #7802

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

Merged
merged 9 commits into from
Apr 24, 2025
Merged

Conversation

LucasXu0
Copy link
Collaborator

@LucasXu0 LucasXu0 commented Apr 22, 2025

Feature Preview

  • refactor deeplink handler to support different DeepLinkSchema
  • support workspace invitation deeplink schema

PR Checklist

  • My code adheres to AppFlowy's Conventions
  • I've listed at least one issue that this PR fixes in the description above.
  • I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
  • All existing tests are passing.

Summary by Sourcery

Refactor the deeplink handling system to support multiple deeplink schemas with a more modular and extensible approach

New Features:

  • Add support for modular deep link handling with easy extensibility for future deep link schemas

Enhancements:

  • Introduce a flexible DeepLinkHandlerRegistry that allows registering and processing different types of deep links
  • Create an abstract DeepLinkHandler interface to standardize deep link processing
  • Separate concerns by creating specific handlers for login and payment deep links

Copy link
Contributor

sourcery-ai bot commented Apr 22, 2025

Reviewer's Guide by Sourcery

This pull request refactors the deep link handling mechanism to support different deep link schemas. It introduces a DeepLinkHandlerRegistry to manage and process deep links using dedicated handlers. The changes include creating a DeepLinkHandler abstract class, implementing specific handlers for login and payment success deep links, and updating the AppFlowyCloudDeepLink class to use the new registry.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Introduced a DeepLinkHandlerRegistry to manage and process different deep link types.
  • Created a DeepLinkHandlerRegistry class to manage deep link handlers.
  • Implemented a DeepLinkHandler abstract class for handling specific deep link types.
  • Added LoginDeepLinkHandler to handle login-related deep links.
  • Added PaymentDeepLinkHandler to handle payment success deep links.
  • Registered LoginDeepLinkHandler and PaymentDeepLinkHandler in the DeepLinkHandlerRegistry.
  • Modified the deep link processing logic to use the DeepLinkHandlerRegistry to find and execute the appropriate handler.
frontend/appflowy_flutter/lib/startup/tasks/appflowy_cloud_task.dart
frontend/appflowy_flutter/lib/startup/tasks/deeplink/deeplink_handler.dart
frontend/appflowy_flutter/lib/startup/tasks/deeplink/login_deeplink_handler.dart
frontend/appflowy_flutter/lib/startup/tasks/deeplink/payment_deeplink_handler.dart
Refactored deep link processing to use dedicated handlers for different deep link schemas.
  • Removed the direct handling of authentication callback and payment success deep links from AppFlowyCloudDeepLink.
  • Introduced DeepLinkState enum to represent the state of deep link processing.
  • Added callbacks for state changes, results, and errors during deep link processing.
  • Implemented the canHandle method in each handler to determine if it can process a given URI.
  • Implemented the handle method in each handler to process the URI and return a result.
  • Updated the AppFlowyCloudDeepLink class to use the registry to process deep links.
frontend/appflowy_flutter/lib/startup/tasks/appflowy_cloud_task.dart
frontend/appflowy_flutter/lib/startup/tasks/deeplink/deeplink_handler.dart
frontend/appflowy_flutter/lib/startup/tasks/deeplink/login_deeplink_handler.dart
frontend/appflowy_flutter/lib/startup/tasks/deeplink/payment_deeplink_handler.dart

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @LucasXu0 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider making the DeepLinkHandlerRegistry a singleton to ensure consistent handling of deep links across the application.
  • The canHandle methods in DeepLinkHandler implementations could benefit from additional validation of the URI parameters.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@LucasXu0 LucasXu0 force-pushed the workspace_deeplink branch from f540467 to 4c55a55 Compare April 23, 2025 15:17
@LucasXu0 LucasXu0 force-pushed the workspace_deeplink branch from d90149a to c8e2811 Compare April 24, 2025 02:42
@LucasXu0 LucasXu0 merged commit 48d6a71 into AppFlowy-IO:main Apr 24, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant