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(frontend): add email confirmation mutations and response types and adding control section bg #157

Merged
merged 2 commits into from
Mar 5, 2025

Conversation

Sma1lboy
Copy link
Owner

@Sma1lboy Sma1lboy commented Mar 5, 2025

Summary by CodeRabbit

  • Style

    • Refined the prompt form's control section for improved spacing and consistent background display across light and dark themes.
  • New Features

    • Enhanced the email confirmation process with detailed status responses for confirmation and resend requests.
    • Introduced the ability to query remaining project limits and updated user account details with email confirmation status and timing information.

Copy link
Contributor

coderabbitai bot commented Mar 5, 2025

Walkthrough

The changes update both a React UI component and the GraphQL API. In the UI, the PromptForm component’s control section padding is adjusted and a light mode background is added. The GraphQL API now includes a new scalar type, mutations, an input type, and a query for managing email confirmations and project limits, along with updates to the User type to track email confirmation state and last email send time.

Changes

File(s) Summary
frontend/.../prompt-form.tsx Revised the controls container styling: replaced py-3 with pb-3 and pt-1, and added bg-white for light mode while preserving dark mode styling.
frontend/.../graphql/{schema.gql, type.tsx} Updated the GraphQL schema and types: introduced EmailConfirmationResponse, modified the confirmEmail mutation to return this type, added resendConfirmationEmail mutation and ResendEmailInput, added getRemainingProjectLimit query, and updated the User type with new fields.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GraphQL
    participant Database

    Client->>GraphQL: confirmEmail(token)
    GraphQL-->>Client: EmailConfirmationResponse (message, success)

    Client->>GraphQL: resendConfirmationEmail(input)
    GraphQL-->>Client: EmailConfirmationResponse (message, success)

    Client->>GraphQL: getRemainingProjectLimit
    GraphQL-->>Client: Integer (project limit)
Loading

Suggested reviewers

  • Sma1lboy
  • NarwhalChen

Poem

Hop, hop, I code all day,
Changes bloom in a bright display.
My paws tap keys with joyful cheer,
Email confirmations now shine so clear!
A bunny's delight in every line,
🐇 Leaping through updates, feeling divine!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

frontend/src/graphql/schema.gql

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/frontend/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

frontend/src/graphql/type.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/frontend/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

frontend/src/components/root/prompt-form.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/frontend/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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: 0

🧹 Nitpick comments (2)
frontend/src/graphql/schema.gql (2)

147-148: Minor formatting improvement.

The comment formatting change for the subscribers field improves readability.


241-241: Deprecated field formatting improved.

The comment for the deprecated field is now on a single line, which is cleaner.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4ca3a2c and e7441d3.

📒 Files selected for processing (3)
  • frontend/src/components/root/prompt-form.tsx (1 hunks)
  • frontend/src/graphql/schema.gql (7 hunks)
  • frontend/src/graphql/type.tsx (18 hunks)
✅ Files skipped from review due to trivial changes (1)
  • frontend/src/components/root/prompt-form.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Install and Build Frontend
🔇 Additional comments (16)
frontend/src/graphql/schema.gql (6)

60-63: Well-structured response type.

The new EmailConfirmationResponse type is well-designed, providing both a required message for user feedback and an optional success flag to indicate the operation result.


109-109: Good API design using specific response type instead of boolean.

Changing the confirmEmail mutation to return EmailConfirmationResponse instead of a boolean is a good improvement, as it provides more detailed feedback to users about the confirmation process.


119-119: Email functionality successfully expanded.

Adding the resendConfirmationEmail mutation completes the email confirmation workflow by giving users a way to request a new confirmation email if needed.


179-179: Project limit query added.

The getRemainingProjectLimit query provides a way for the frontend to check limitations, which is useful for showing appropriate UI feedback to users.


199-201: Simple and focused input type.

The ResendEmailInput type is appropriately focused with just the email field needed for the operation.


238-240: User type appropriately extended.

The addition of isEmailConfirmed and lastEmailSendTime fields to the User type provides necessary tracking for email confirmation status and helps with rate limiting for email sending.

frontend/src/graphql/type.tsx (10)

99-103: TypeScript type matches GraphQL schema.

The EmailConfirmationResponse TypeScript type correctly mirrors the GraphQL schema definition.


153-153: Mutation return types properly updated.

Both email-related mutations correctly return the EmailConfirmationResponse type, maintaining consistency with the schema.

Also applies to: 163-163


175-177: Mutation argument types well-defined.

The argument types for both email confirmation mutations are properly typed, ensuring type safety when these mutations are used in the application.

Also applies to: 215-217


339-341: Input type correctly implemented.

The ResendEmailInput TypeScript type matches its GraphQL schema definition.


502-502: Resolver types properly updated.

The EmailConfirmationResponse and Int types have been added to both ResolversTypes and ResolversParentTypes, ensuring all resolvers will work correctly with these types.

Also applies to: 506-506, 542-542, 546-546


647-655: Resolver implementation for new type.

The EmailConfirmationResponseResolvers type is properly defined with all required fields, ensuring proper TypeScript type checking for the resolvers.


710-715: Mutation resolvers correctly typed.

Both email confirmation mutation resolvers are properly typed with their respective argument types and return the EmailConfirmationResponse type.

Also applies to: 770-775


915-919: Project limit query resolver properly typed.

The getRemainingProjectLimit query resolver is correctly typed to return an Int.


985-990: User resolver updated with new fields.

The User resolver now includes the new isEmailConfirmed and lastEmailSendTime fields with proper types.


1012-1012: Resolver map updated.

The Resolvers object correctly includes the new EmailConfirmationResponse resolver.

@Sma1lboy Sma1lboy merged commit 6be8368 into main Mar 5, 2025
3 of 4 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.

1 participant