Skip to content

fix: use magic link type for OTP sign in #104

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

Conversation

khorshuheng
Copy link
Collaborator

@khorshuheng khorshuheng commented Apr 25, 2025

Description

In the current version of appflowy gotrue, both magiclink and recovery type follows the same workflow, and it is alright to use them interchangeably.

However, we are planning to modify appflowy gotrue to include additional business logic for the recovery workflow, so it now becomes necessary to use magic link for the verify token endpoint as opposed to recovery.


Checklist

General

  • I've included relevant documentation or comments for the changes introduced.
  • I've tested the changes in multiple environments (e.g., different browsers, operating systems).

Testing

  • I've added or updated tests to validate the changes introduced for AppFlowy Web.

Feature-Specific

  • For feature additions, I've added a preview (video, screenshot, or demo) in the "Feature Preview" section.
  • I've verified that this feature integrates seamlessly with existing functionality.

Summary by Sourcery

Bug Fixes:

  • Modify the token verification type to align with upcoming changes in the authentication workflow

Copy link

sourcery-ai bot commented Apr 25, 2025

Reviewer's Guide by Sourcery

This pull request modifies the OTP sign-in process to use the 'magiclink' type instead of 'recovery' when calling the /verify endpoint. This change is necessary because the appflowy gotrue service is being updated to include additional business logic for the recovery workflow, making it necessary to differentiate between magic link and recovery workflows.

Sequence diagram for OTP Sign-in Process

sequenceDiagram
    participant User
    participant AppFlowy Web
    participant GoTrue Service

    User->>AppFlowy Web: Initiates OTP sign-in with email and code
    AppFlowy Web->>GoTrue Service: Sends /verify request with email, code, and type='magiclink'
    activate GoTrue Service
    GoTrue Service-->>AppFlowy Web: Returns response (success or failure)
    deactivate GoTrue Service
    AppFlowy Web-->>User: Notifies user of sign-in status
Loading

File-Level Changes

Change Details Files
Updated the OTP sign-in process to use the 'magiclink' type instead of 'recovery' when calling the /verify endpoint.
  • Changed the type parameter from recovery to magiclink in the signInOTP function's /verify endpoint call.
src/application/services/js-services/http/gotrue.ts

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!

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

@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 @khorshuheng - I've reviewed your changes - here's some feedback:

Overall Comments:

  • It would be helpful to include a test case to ensure the correct type is being sent in the request.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

@qinluhe qinluhe merged commit f66b0d0 into AppFlowy-IO:main Apr 28, 2025
3 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