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

separated checking for solana and etherium users #1876

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

kkatusic
Copy link
Collaborator

@kkatusic kkatusic commented Nov 26, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced email verification checks for project management actions, ensuring only verified users can create, update, or delete projects.
    • Improved wallet address validation in the user email confirmation process to accommodate both Solana and Ethereum formats.
  • Bug Fixes

    • Refined error handling for various user and project-related operations, providing clearer messages and preventing unauthorized actions.
  • Tests

    • Introduced a comprehensive suite of tests for project functionalities, covering scenarios such as creation, updates, and error handling.

@kkatusic kkatusic requested a review from CarlosQ96 November 26, 2024 14:38
@kkatusic kkatusic self-assigned this Nov 26, 2024
Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

Walkthrough

The changes introduce a comprehensive suite of tests for project-related functionalities in projectResolver.test.ts, covering project creation, updates, activation, fetching, and error handling. In projectResolver.ts, email verification checks are added to several mutation methods to ensure users have verified emails before performing sensitive actions. The userResolver.ts also sees enhancements to email verification, incorporating wallet address checks for Solana and Ethereum formats, refining error handling, and clarifying conditions for user updates.

Changes

File Change Summary
src/resolvers/projectResolver.test.ts Added tests for project creation, updates, activation, fetching, and error handling scenarios.
src/resolvers/projectResolver.ts Enhanced error handling with email verification checks before project updates and deletions.
src/resolvers/userResolver.ts Modified email verification process to include wallet address checks and refined error handling.

Possibly related PRs

  • Feat/User email verification #1874: This PR enhances the email verification process, which is directly related to the changes in the main PR that also involve email verification checks in project-related functionalities.
  • Fix/Email verification only for verified users #1875: This PR modifies the email verification logic to ensure that only verified emails are considered for certain operations, aligning with the main PR's focus on enforcing email verification before project updates and creations.

Suggested labels

Code Review

Suggested reviewers

  • mohammadranjbarz
  • Meriem-BM

Poem

🐰 In the meadow where projects bloom,
A rabbit hops to dispel the gloom.
With verified emails, we take our stand,
Ensuring each project is carefully planned.
Tests are written, errors caught,
A world of projects, all well-thought! 🌼

Warning

Rate limit exceeded

@kkatusic has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 16 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 04b3a19 and b77a500.


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 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: 5

🧹 Outside diff range and nitpick comments (4)
src/resolvers/projectResolver.ts (2)

1639-1648: LGTM: Email verification check properly implemented, but consider refactoring

The email verification check is well-implemented, but this pattern is repeated across multiple mutations. Consider extracting this into a reusable middleware or decorator.

Example implementation:

const requireVerifiedEmail = async (userId: number): Promise<void> => {
  const user = await findUserById(userId);
  if (!user) {
    throw new Error(i18n.__(translationErrorMessagesKeys.USER_NOT_FOUND));
  }
  if (!user.isEmailVerified) {
    throw new Error(i18n.__(translationErrorMessagesKeys.EMAIL_NOT_VERIFIED));
  }
};

Line range hint 1579-1690: Consider implementing a declarative approach for email verification

While the email verification checks are well-implemented, the current approach leads to code duplication. Consider one of these architectural improvements:

  1. TypeGraphQL decorator:
function RequireVerifiedEmail() {
  return createMethodDecorator(async ({ context }, next) => {
    const { user } = context.req;
    await requireVerifiedEmail(user.userId);
    return next();
  });
}
  1. GraphQL middleware:
const emailVerificationMiddleware = async (
  resolve: any,
  root: any,
  args: any,
  context: any,
  info: any
) => {
  const { user } = context.req;
  await requireVerifiedEmail(user.userId);
  return resolve(root, args, context, info);
};

This would make the code more maintainable and reduce duplication while keeping the same security checks.

src/resolvers/projectResolver.test.ts (2)

5532-5533: Use saveUserDirectlyToDb helper function for user creation

In this test case, you're manually creating a User instance and saving it directly to the database. To ensure consistency and maintainability across tests, consider using the saveUserDirectlyToDb helper function, which handles default properties and setups required for a user.

Apply this diff to refactor:

-        const user = await User.create({
-          walletAddress: generateRandomEtheriumAddress(),
-          loginType: 'wallet',
-          firstName: 'testEditProjectUpdateFateme',
          isEmailVerified: true,
-        }).save();
+        const user = await saveUserDirectlyToDb(generateRandomEtheriumAddress());

5648-5649: Use saveUserDirectlyToDb helper function for user creation

Similarly, in this test, you're manually creating a User object. It's recommended to use the saveUserDirectlyToDb helper function for consistency and to handle any default user properties.

Apply this diff to refactor:

-        const user = await User.create({
-          walletAddress: generateRandomEtheriumAddress(),
-          loginType: 'wallet',
-          firstName: 'testDeleteProjectUpdateFateme',
          isEmailVerified: true,
-        }).save();
+        const user = await saveUserDirectlyToDb(generateRandomEtheriumAddress());
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 04b3a19 and b77a500.

📒 Files selected for processing (3)
  • src/resolvers/projectResolver.test.ts (2 hunks)
  • src/resolvers/projectResolver.ts (3 hunks)
  • src/resolvers/userResolver.ts (3 hunks)
🔇 Additional comments (2)
src/resolvers/projectResolver.ts (1)

1579-1583: LGTM: Email verification check properly implemented

The email verification check is well-placed before any project operations and uses proper error handling with internationalized messages.

src/resolvers/userResolver.ts (1)

35-35: Importing isSolanaAddress Function

The addition of isSolanaAddress import is necessary for the new Solana address checks and is correctly implemented.

src/resolvers/projectResolver.ts Show resolved Hide resolved
src/resolvers/userResolver.ts Show resolved Hide resolved
src/resolvers/userResolver.ts Show resolved Hide resolved
src/resolvers/userResolver.ts Show resolved Hide resolved
src/resolvers/userResolver.ts Show resolved Hide resolved
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!

@kkatusic kkatusic merged commit 4c4ae45 into staging Nov 26, 2024
5 checks passed
@kkatusic kkatusic deleted the fix/email_verification_check branch November 26, 2024 21:14
@coderabbitai coderabbitai bot mentioned this pull request Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants