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

fix: Fix verify email flow bug for duplicate access token calls #3440

Merged
merged 3 commits into from
Jan 24, 2025

Conversation

arjunaj5
Copy link
Contributor

@arjunaj5 arjunaj5 commented Jan 24, 2025

Clickup

https://app.clickup.com/t/86cxta2mz

Code Coverage

Please add code coverage here

UI Preview

Slack Thread

Summary by CodeRabbit

Summary by CodeRabbit

  • Bug Fixes
    • Updated email verification process to improve authentication token refresh mechanism.
  • Tests
    • Streamlined test setup by removing unused imports and updating mocked methods to reflect current functionality in the authentication service.

Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

In a stylish code transformation, the VerifyPage class has undergone a subtle yet significant method swap. The authentication refresh mechanism now calls refreshEou() instead of the previous newRefreshToken() method. This change maintains the existing observable pipeline's structure while introducing a new approach to handling email verification responses. The error handling remains consistent, preserving the original error navigation logic.

Changes

File Change Summary
src/app/auth/verify/verify.page.ts Replaced this.authService.newRefreshToken(resp.refresh_token) with this.authService.refreshEou() in ngOnInit method. Error handling logic remains unchanged.
src/app/auth/verify/verify.page.spec.ts Removed unused imports and updated authServiceSpy to mock refreshEou() instead of newRefreshToken(). Adjusted test cases to align with the new method.

Possibly related PRs

Suggested Labels

size/M

Suggested Reviewers

  • Chethan-Fyle
  • bistaastha

Poem

Whisper of code, a subtle dance 🕺
Refresh token's stylish new stance
One method bows, another takes flight
In Rajini's code, everything's just right! 💥
Authentication's cosmic ballet spins on


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between af8a361 and e76ec6a.

📒 Files selected for processing (2)
  • src/app/auth/verify/verify.page.spec.ts (3 hunks)
  • src/app/auth/verify/verify.page.ts (1 hunks)
🔇 Additional comments (4)
src/app/auth/verify/verify.page.ts (1)

29-29: Super move with the refreshEou() call, boss!

This direct call to refreshEou() cleans up the flow, aligning the code with the email verify steps. No more unused resp variable is needed, da. Looks good to me, thalaiva!

src/app/auth/verify/verify.page.spec.ts (3)

10-10: Neat usage of of from RxJS, Machi!

Bringing in of sets up the perfect test scenario for mocking observables. Good job, boss!


26-26: Ayyo, we’ve switched to refreshEou in the spy, great stuff!

This makes our tests consistent with the new method, da. The approach is correct and keeps the code clean. Keep rocking!


82-82: Refreshing the EOU data, Superstar!

Calling authService.refreshEou here ensures we test the updated logic. The test scenario matches the new flow, so all is well, thambi!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the size/XS Extra Small PR label Jan 24, 2025
Copy link

PR description must contain a link to a ClickUp (case-insensitive)

1 similar comment
Copy link

PR description must contain a link to a ClickUp (case-insensitive)

Copy link

PR description must contain a link to a ClickUp (case-insensitive)

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c661325 and af8a361.

📒 Files selected for processing (1)
  • src/app/auth/verify/verify.page.ts (1 hunks)
🧰 Additional context used
🪛 eslint
src/app/auth/verify/verify.page.ts

[error] 29-29: 'resp' is defined but never used.

(@typescript-eslint/no-unused-vars)

🪛 GitHub Check: Run linters
src/app/auth/verify/verify.page.ts

[failure] 29-29:
'resp' is defined but never used

🪛 GitHub Actions: Lint
src/app/auth/verify/verify.page.ts

[error] 29-29: Variable 'resp' is defined but never used

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (12.x)

@@ -26,7 +26,7 @@
this.routerAuthService
.emailVerify(verificationCode)
.pipe(
switchMap((resp) => this.authService.newRefreshToken(resp.refresh_token)),
switchMap((resp) => this.authService.refreshEou()),
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Ayyo! Unused variable alert, thalaiva!

"resp" isn't required anymore, boss. The linter is screaming at us because we define "resp" but never use it. Remove it from the function signature to keep your code clean and ensure the pipeline passes.

Here's the fix, macha:

-        switchMap((resp) => this.authService.refreshEou()),
+        switchMap(() => this.authService.refreshEou()),
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
switchMap((resp) => this.authService.refreshEou()),
switchMap(() => this.authService.refreshEou()),
🧰 Tools
🪛 eslint

[error] 29-29: 'resp' is defined but never used.

(@typescript-eslint/no-unused-vars)

🪛 GitHub Check: Run linters

[failure] 29-29:
'resp' is defined but never used

🪛 GitHub Actions: Lint

[error] 29-29: Variable 'resp' is defined but never used

@@ -26,7 +26,7 @@ export class VerifyPage implements OnInit {
this.routerAuthService
.emailVerify(verificationCode)
.pipe(
switchMap((resp) => this.authService.newRefreshToken(resp.refresh_token)),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

everything being done in this.authService.newRefreshToken() call is already done in the emailVerify method in line 27 except refreshEou().

This takes care of 401 issues during email verify flow: https://fylein.slack.com/archives/C017C400V37/p1736916713193809

Copy link

Unit Test Coverage % values
Statements 96.17% ( 19352 / 20122 )
Branches 91.24% ( 10676 / 11700 )
Functions 94.5% ( 5762 / 6097 )
Lines 96.23% ( 18477 / 19200 )

@arjunaj5 arjunaj5 merged commit 68ded35 into master Jan 24, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XS Extra Small PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants