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

Feat/add cooldown varify email #4931

Merged
merged 3 commits into from
Jan 13, 2025
Merged

Conversation

kkatusic
Copy link
Collaborator

@kkatusic kkatusic commented Jan 10, 2025

Adding cool-down counter to the verification process.

@maryjaf or @LatifatAbdullahi when you start testing this, please ping me I will walk you through how to setup network throttling to use slow network setup inside developers tools.

Summary by CodeRabbit

Release Notes

  • New Features

    • Added email verification cooldown mechanism to prevent excessive verification requests
    • Implemented user-friendly email verification retry instructions
  • Localization

    • Added email verification cooldown messages in Catalan, English, and Spanish languages
  • Development

    • Simplified development script by removing sitemap generation during dev mode

@kkatusic kkatusic self-assigned this Jan 10, 2025
Copy link

vercel bot commented Jan 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
giveth-dapps-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 10, 2025 1:43pm

Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request introduces a new email verification cooldown feature across multiple language files and the InputUserEmailVerify component. The changes add a mechanism to prevent users from repeatedly requesting verification emails by implementing a 3-minute cooldown period. This includes adding localized messages in Catalan, English, and Spanish that guide users to check their spam folder or resend the verification code with a countdown timer. Additionally, the project's development script in package.json was simplified by removing the sitemap generation step.

Changes

File Change Summary
lang/ca.json Added Catalan translation for email verification cooldown message
lang/en.json Added English translation for email verification cooldown message
lang/es.json Added Spanish translation for email verification cooldown message
package.json Removed node src/sitemap.ts from dev script
src/components/InputUserEmailVerify.tsx Added cooldown state management for email verification requests

Sequence Diagram

sequenceDiagram
    participant User
    participant Component
    participant EmailService
    
    User->>Component: Request Verification
    alt No Cooldown Active
        Component->>EmailService: Send Verification Email
        Component-->User: Start 3-minute Cooldown
        Component->Component: Update UI with Cooldown Timer
    else Cooldown Active
        Component-->User: Display Cooldown Message
        Note over Component: Prevent Further Requests
    end
Loading

Poem

🐰 A Rabbit's Verification Verse 🔔

In cooldown's embrace, emails take flight,
Three minutes of patience, a digital delight!
Check spam with care, resend with glee,
A verification dance of tech and me!

Hop hop hooray! 🚀


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.

Copy link
Contributor

@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

🧹 Nitpick comments (1)
src/components/InputUserEmailVerify.tsx (1)

239-246: Improve error handling in verification handler

The error handling could be more specific and production-ready.

Consider these improvements:

  const verificationEmailHandler = async () => {
    if (isCooldown) {
      return;
    }

    setIsCooldown(true);
    setCooldownTime(180);

    try {
      const { data } = await client.mutate({
        mutation: SEND_USER_EMAIL_CONFIRMATION_CODE_FLOW,
        variables: {
          email: email,
        },
      });

      // ... rest of the code

    } catch (error) {
-     if (error instanceof Error) {
+     if (error instanceof ApolloError) {
        resetCoolDown();
-       showToastError(error.message);
+       showToastError(error.message || 'Failed to send verification email');
      }
-     console.log(error);
+     // Use proper error logging service in production
+     if (process.env.NODE_ENV === 'development') {
+       console.error('Verification email error:', error);
+     }
    }
  };

Also applies to: 289-298

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8588535 and a82d06b.

📒 Files selected for processing (5)
  • lang/ca.json (1 hunks)
  • lang/en.json (1 hunks)
  • lang/es.json (1 hunks)
  • package.json (1 hunks)
  • src/components/InputUserEmailVerify.tsx (5 hunks)
✅ Files skipped from review due to trivial changes (1)
  • lang/ca.json
🔇 Additional comments (5)
src/components/InputUserEmailVerify.tsx (2)

125-126: LGTM! State management for cooldown

The state management implementation for the cooldown feature is clean and follows React conventions.


439-467: LGTM! Clean UI implementation with i18n support

The cooldown message UI implementation is well-structured:

  • Uses FormattedMessage for internationalization
  • Correctly formats time display
  • Clean conditional rendering
package.json (1)

7-7: Verify impact of removing sitemap generation

The sitemap generation step has been removed from the dev script. Let's verify this won't impact development workflow.

Run this script to check if sitemap.ts is used elsewhere:

✅ Verification successful

Removing sitemap generation from dev script is correct

The sitemap generation is implemented as a protected API endpoint (/api/generate-sitemap) designed to be triggered by a cron job in production. It's not part of the development workflow and doesn't need to run during local development.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if sitemap.ts is referenced in other scripts or build processes
echo "Checking sitemap.ts references..."
rg "sitemap\.ts"

echo "Checking if sitemap generation is moved to other scripts..."
rg "node.*sitemap" package.json

Length of output: 258


Script:

#!/bin/bash
# Search for any sitemap-related files
echo "Searching for sitemap files..."
fd sitemap

# Check for sitemap-related code or configurations
echo -e "\nSearching for sitemap references in code..."
rg -i sitemap

# Display all scripts from package.json
echo -e "\nChecking all package.json scripts..."
jq .scripts package.json

Length of output: 3185

lang/en.json (1)

392-392: LGTM! Well-structured translation for cooldown message

The translation entry is properly formatted with placeholders for dynamic content (button and time).

lang/es.json (1)

390-390: LGTM! The Spanish translation for email cooldown is accurate and consistent.

The translation properly maintains HTML tags and clearly communicates the verification flow to Spanish-speaking users.

Let's verify consistency with other language files:

✅ Verification successful

Translations are consistent across all language files

The email cooldown message maintains consistent structure, HTML tags, and components across English, Spanish, and Catalan translations.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if email cooldown translation exists in all language files and follows same structure
rg -A 1 'label\.email_cooldown' lang/

Length of output: 931

Comment on lines +248 to +257
const intervalId = setInterval(() => {
setCooldownTime(prev => {
if (prev <= 1) {
resetCoolDown();
setDisableVerifyButton(false);
return 0;
}
return prev - 1;
});
}, 1000);
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix potential memory leak in timer implementation

The current timer implementation using setInterval could lead to memory leaks because:

  1. The interval is not cleaned up if the component unmounts
  2. Multiple intervals could be created on re-renders

Wrap the timer logic in a useEffect hook to properly manage the interval:

+ useEffect(() => {
+   let intervalId: NodeJS.Timeout | undefined;
+   
+   if (isCooldown) {
+     intervalId = setInterval(() => {
+       setCooldownTime(prev => {
+         if (prev <= 1) {
+           resetCoolDown();
+           setDisableVerifyButton(false);
+           return 0;
+         }
+         return prev - 1;
+       });
+     }, 1000);
+   }
+   
+   return () => {
+     if (intervalId) {
+       clearInterval(intervalId);
+     }
+   };
+ }, [isCooldown]);

  const verificationEmailHandler = async () => {
    if (isCooldown) {
      return;
    }

    setIsCooldown(true);
    setCooldownTime(180);

-   const intervalId = setInterval(() => {
-     setCooldownTime(prev => {
-       if (prev <= 1) {
-         resetCoolDown();
-         setDisableVerifyButton(false);
-         return 0;
-       }
-       return prev - 1;
-     });
-   }, 1000);

    try {
      const { data } = await client.mutate({
        mutation: SEND_USER_EMAIL_CONFIRMATION_CODE_FLOW,
        variables: {
          email: email,
        },
      });

      // ... rest of the code

-     clearInterval(intervalId);
    } catch (error) {
      if (error instanceof Error) {
-       clearInterval(intervalId);
        resetCoolDown();
        showToastError(error.message);
      }
      console.log(error);
    }
  };

Also applies to: 294-294, 297-297

Copy link
Collaborator

@CarlosQ96 CarlosQ96 left a comment

Choose a reason for hiding this comment

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

LGTM Kechy

@kkatusic kkatusic merged commit c68dbeb into develop Jan 13, 2025
3 checks passed
@kkatusic kkatusic deleted the feat/add_cooldown_varify_email branch January 13, 2025 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants