Simple assistant onboarding #382
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Caution Review failedThe pull request is closed. WalkthroughThe pull request introduces modifications across multiple areas of the codebase. It updates component conditions, adds new onboarding and form components, and streamlines cold email and reply tracker functionalities. The changes include new API routes, updated validation schemas, refined error handling, and adjusted logging. Additionally, the onboarding flow now incorporates cookie checks and database queries for redirection. Minor UI updates, such as renaming a navigation label, further enhance the user interface. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant A as AutomationPage
participant DB as Database (Prisma)
U->>A: Request automation page
A->>A: Check for onboarding cookie (ONBOARDING_COOKIE_NAME)
alt Cookie absent
A->>DB: Query user's rules
alt No rules found
A->>U: Redirect to OnboardingPage
else Rules exist
A->>U: Render AutomationPage
end
else Cookie present
A->>U: Render AutomationPage
end
sequenceDiagram
participant U as User
participant D as DraftRepliesPage
participant AE as enableDraftRepliesAction
participant R as Router
U->>D: Selects "Yes" for enabling AI draft replies
D->>AE: Invoke enableDraftRepliesAction
AE-->>D: Return success or error
alt Success
D->>D: Set sidebar cookie
D->>R: Redirect to CompletedPage
else Error
D->>D: Display error notification
D->>R: Redirect to CompletedPage
end
Poem
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
apps/web/app/api/reply-tracker/process-previous/route.tsOops! Something went wrong! :( ESLint: 9.23.0 ESLint couldn't find an eslint.config.(js|mjs|cjs) file. From ESLint v9.0.0, the default configuration file is now eslint.config.js. https://eslint.org/docs/latest/use/configure/migration-guide If you still have problems after following the migration guide, please stop by 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (11)
apps/web/app/(app)/automation/onboarding/draft-replies/page.tsx (1)
28-32: Consider cookie expiration.The cookie is effectively never expiring by using
Number.MAX_SAFE_INTEGER. If user preferences might change or re-onboarding is required, consider limiting the lifespan or using a session-based solution.apps/web/app/(app)/automation/onboarding/completed/page.tsx (1)
38-46: Unused commented-out code.If the “Customize Rules” section is not immediately needed, consider removing the commented code to maintain clarity and reduce clutter.
apps/web/utils/reply-tracker/enable.ts (1)
108-109: Inconsistent naming in error message.The log references “Reply Zero,” whereas the function is named
enableReplyTracker. For clarity, unify the naming to match the “Reply Tracker” terminology.apps/web/app/api/reply-tracker/process-previous/route.ts (2)
40-43: Check for missing accounts or tokens could be consolidatedThe account validation checks could be more concisely written.
- const account = user.accounts[0]; - if (!account) return NextResponse.json({ error: "No Google account found" }); - if (!account.access_token) - return NextResponse.json({ error: "No access token or refresh token" }); + const account = user.accounts[0]; + if (!account?.access_token) { + const error = !account ? "No Google account found" : "No access token or refresh token"; + return NextResponse.json({ error }); + }
45-52: Proper Gmail client initialization and processingThe endpoint correctly:
- Initializes the Gmail client with the user's tokens
- Calls the processing function with the necessary parameters
- Returns the result to the caller
However, consider adding appropriate error logging if
processPreviousSentEmailsfails.- const result = await processPreviousSentEmails(gmail, user); - - return NextResponse.json(result); + try { + const result = await processPreviousSentEmails(gmail, user); + return NextResponse.json(result); + } catch (error) { + logger.error("Error processing previous emails", { + userId: user.id, + error: error instanceof Error ? error.message : String(error) + }); + return NextResponse.json({ error: "Failed to process emails" }, { status: 500 }); + }apps/web/utils/reply-tracker/check-previous-emails.ts (2)
18-18: Consider externalizing the default limit
Having a defaultmaxResults = 100is helpful, but you might consider making it a configurable value (e.g., environment variable) to accommodate varying loads seamlessly.
65-68: Skipping already-processed messages
Neatly avoids duplicated processing. Consider logging atinfolevel if you need more visibility into how often messages are skipped in production.apps/web/utils/actions/rule.ts (2)
299-323:enableDraftRepliesAction
Enabling draft replies through a dedicated action fosters clear separation of concerns. This approach is consistent with the existing pattern of server actions.Consider adding a confirmation log or revalidation specifically targeting a user-facing component to notify the UI of this capability’s status.
477-543: NestedcreateRulefunction
- Efficiently updates or creates rules for each category.
- Logs remain minimal, but consider adding debug logs if you suspect silent conflicts.
You could unify this logic with an “upsert” approach to reduce branching.
apps/web/utils/actions/cold-email.ts (1)
61-61: UsingMarkNotColdEmailBody
Switching to this typed argument clarifies the expected structure, reducing risk of shape mismatches.If additional fields are ever needed, ensure consistent usage across the codebase to avoid confusion.
apps/web/components/ui/form.tsx (1)
31-42:FormFieldcomponent
Using<Controller>under the hood provides a straightforward interface for controlled components. The context pattern keeps the field name in scope, simplifying nested usage.Consider adding logging or error boundaries for debugging form synchronization issues.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (23)
apps/web/app/(app)/automation/ProcessingPromptFileDialog.tsx(1 hunks)apps/web/app/(app)/automation/consts.ts(1 hunks)apps/web/app/(app)/automation/onboarding/CategoriesSetup.tsx(1 hunks)apps/web/app/(app)/automation/onboarding/completed/page.tsx(1 hunks)apps/web/app/(app)/automation/onboarding/draft-replies/page.tsx(1 hunks)apps/web/app/(app)/automation/onboarding/page.tsx(1 hunks)apps/web/app/(app)/automation/page.tsx(3 hunks)apps/web/app/(app)/cold-email-blocker/ColdEmailPromptForm.tsx(3 hunks)apps/web/app/(app)/cold-email-blocker/ColdEmailSettings.tsx(2 hunks)apps/web/app/api/google/watch/controller.ts(1 hunks)apps/web/app/api/reply-tracker/process-previous/route.ts(1 hunks)apps/web/app/api/user/settings/cold-email/route.ts(0 hunks)apps/web/app/api/user/settings/cold-email/validation.ts(0 hunks)apps/web/components/SideNav.tsx(1 hunks)apps/web/components/ui/form.tsx(1 hunks)apps/web/utils/actions/cold-email.ts(1 hunks)apps/web/utils/actions/cold-email.validation.ts(2 hunks)apps/web/utils/actions/reply-tracking.ts(3 hunks)apps/web/utils/actions/rule.ts(4 hunks)apps/web/utils/actions/rule.validation.ts(2 hunks)apps/web/utils/gmail/thread.ts(1 hunks)apps/web/utils/reply-tracker/check-previous-emails.ts(1 hunks)apps/web/utils/reply-tracker/enable.ts(1 hunks)
💤 Files with no reviewable changes (2)
- apps/web/app/api/user/settings/cold-email/route.ts
- apps/web/app/api/user/settings/cold-email/validation.ts
🧰 Additional context used
🧬 Code Definitions (9)
apps/web/app/(app)/automation/onboarding/page.tsx (1)
apps/web/app/(app)/automation/onboarding/CategoriesSetup.tsx (1)
CategoriesSetup(39-132)
apps/web/app/(app)/automation/onboarding/draft-replies/page.tsx (2)
apps/web/utils/actions/rule.ts (1)
enableDraftRepliesAction(299-322)apps/web/app/(app)/automation/consts.ts (1)
ONBOARDING_COOKIE_NAME(1-1)
apps/web/app/(app)/cold-email-blocker/ColdEmailSettings.tsx (1)
apps/web/utils/actions/cold-email.ts (1)
updateColdEmailSettingsAction(27-41)
apps/web/utils/gmail/thread.ts (1)
apps/web/app/api/google/threads/controller.ts (1)
getThreads(19-99)
apps/web/app/(app)/automation/page.tsx (2)
apps/web/app/(app)/reply-zero/page.tsx (1)
maxDuration(32-32)apps/web/app/(app)/automation/consts.ts (1)
ONBOARDING_COOKIE_NAME(1-1)
apps/web/app/api/reply-tracker/process-previous/route.ts (1)
apps/web/utils/reply-tracker/check-previous-emails.ts (1)
processPreviousSentEmails(15-91)
apps/web/utils/actions/reply-tracking.ts (2)
apps/web/utils/reply-tracker/enable.ts (1)
enableReplyTracker(11-139)apps/web/utils/reply-tracker/check-previous-emails.ts (1)
processPreviousSentEmails(15-91)
apps/web/app/(app)/cold-email-blocker/ColdEmailPromptForm.tsx (2)
apps/web/utils/actions/cold-email.validation.ts (2)
UpdateColdEmailPromptBody(35-37)updateColdEmailPromptBody(32-34)apps/web/utils/actions/cold-email.ts (1)
updateColdEmailPromptAction(43-57)
apps/web/utils/actions/cold-email.ts (1)
apps/web/utils/actions/cold-email.validation.ts (5)
UpdateColdEmailSettingsBody(28-30)updateColdEmailSettingsBody(17-27)UpdateColdEmailPromptBody(35-37)updateColdEmailPromptBody(32-34)MarkNotColdEmailBody(40-40)
🔇 Additional comments (61)
apps/web/app/api/google/watch/controller.ts (1)
45-47: Change in error logging level is sensible.Changing from
logger.errortologger.warnfor "invalid_grant" errors is appropriate since these are often expected when tokens expire naturally, rather than indicating a critical failure.apps/web/app/(app)/automation/consts.ts (1)
1-1: LGTM! Clear constant naming for onboarding state.The constant is well-named and follows the pattern of using uppercase for constant values. It clearly communicates its purpose for tracking onboarding progress via cookies.
apps/web/components/SideNav.tsx (1)
64-64: LGTM! Simplified navigation label.Changing from "AI Personal Assistant" to just "Personal Assistant" makes the interface more approachable and streamlined.
apps/web/app/(app)/automation/onboarding/page.tsx (1)
1-10: LGTM! Clean component structure for onboarding.The component has a clean structure that properly uses the Card component for containing the categories setup form. The responsive design classes (my-4, max-w-2xl, sm:mx-4, md:mx-auto) ensure proper display across different screen sizes.
apps/web/app/(app)/automation/ProcessingPromptFileDialog.tsx (1)
55-58: Check the logic for marking the dialog as viewed.When
currentStepbecomes greater than 0, the dialog is marked as viewed. Confirm that this is the intended behavior so that the user doesn't prematurely skip any initial-step interaction.apps/web/app/(app)/automation/onboarding/draft-replies/page.tsx (2)
16-26: Reevaluate user flow on error.If an error occurs while enabling draft replies, the code still sets the cookie and redirects the user. Double-check whether you'd prefer to halt and retry or rely on this flow that moves forward regardless of the error.
36-66: Straightforward UI flow.The survey mechanism and callback logic appear well organized. No immediate functional or security concerns noted.
apps/web/app/(app)/automation/onboarding/completed/page.tsx (1)
9-37: Looks good overall.The success message and navigational button offer a clear finishing touch to the onboarding process.
apps/web/app/(app)/cold-email-blocker/ColdEmailSettings.tsx (2)
9-15: Updated imports to use server actions instead of API calls.The code has been modernized to use Next.js server actions instead of making API requests through the previously used
postRequestutility.
60-62: Successfully refactored to use server actions.The implementation now uses
updateColdEmailSettingsActiondirectly instead of making an API request, which simplifies the flow and reduces network overhead. The error handling has been appropriately updated to useisActionError.apps/web/utils/gmail/thread.ts (2)
19-23: Good addition of MinimalThread interface.This provides a clear type definition for thread objects returned from Gmail API, improving type safety throughout the codebase.
25-46: Enhanced return type with additional metadata.The function now returns more comprehensive data including:
nextPageTokenfor paginationresultSizeEstimatefor result set size information- Properly typed
threadsarrayThis improvement allows for more advanced features like pagination and better error handling.
apps/web/utils/actions/reply-tracking.ts (3)
15-15: Added import for extracted functionality.Good separation of concerns by importing the dedicated utility function.
26-26: Improved separation of concerns.The complex logic for enabling the reply tracker has been moved to a dedicated utility function, which makes this action more focused on its core responsibility.
55-55: Removed hardcoded parameter.Removing the hardcoded limit allows the function to use its default parameter value, making the code more flexible.
apps/web/app/(app)/automation/page.tsx (3)
2-5: Added necessary imports for onboarding flow.The new imports support cookie management, database queries, and UI components needed for the onboarding enhancements.
Also applies to: 18-19
61-76: Enhanced UI with dedicated "Set Up" button.The onboarding modal has been improved by adding a direct link to the onboarding page, making it more accessible to users who want to revisit the setup process.
27-41:❓ Verification inconclusive
Implemented onboarding redirect logic.
This is a good user experience improvement that directs new users to the onboarding flow when appropriate. The implementation checks both cookie state and database state before redirecting.
Verify that the onboarding cookie is being set somewhere in the onboarding flow, possibly in the onboarding page component:
🏁 Script executed:
#!/bin/bash # Check if cookie is set in the onboarding page fd "ONBOARDING_COOKIE_NAME" --type f --exec grep -A 5 -B 5 "cookies().set" {} \;Length of output: 83
Attention: Verify Onboarding Cookie Setting
The onboarding redirect implementation correctly checks both the cookie state and the database state. However, our initial script to search for where the onboarding cookie (using
ONBOARDING_COOKIE_NAME) is set did not return any output. This lack of evidence requires manual verification to ensure that the cookie is indeed being set within the onboarding flow (for example, in the onboarding page component).
- Please verify that somewhere in the onboarding flow (likely in a file such as
apps/web/app/(app)/automation/onboarding/page.tsxor another related component) the onboarding cookie is initialized using a code pattern similar tocookies().set(ONBOARDING_COOKIE_NAME, ...).apps/web/app/(app)/cold-email-blocker/ColdEmailPromptForm.tsx (5)
7-9: Import changes correctly aligned with new form handling approachThe imports have been updated to use the new
updateColdEmailPromptBodyschema andUpdateColdEmailPromptBodytype from the cold-email validation module, which is consistent with the refactoring of cold email functionality.
12-13: Error handling and action imports properly updatedThe change from generic error handling to using the more specific
isActionErrorfunction and importing the newupdateColdEmailPromptActionis appropriate for the updated form submission approach.
23-24: Form hook correctly typed with the new validation schemaThe form hook has been properly updated to use the new
UpdateColdEmailPromptBodytype and Zod resolver, ensuring type safety and validation consistency.
32-41: Form submission handler properly migrated to use the new actionThe submission handler now correctly:
- Uses the proper type (
UpdateColdEmailPromptBody)- Calls the new
updateColdEmailPromptActionfunction- Preserves the existing logic for handling default prompts
This change aligns with the server action pattern.
43-48: Error handling updated to work with action resultsThe error handling has been properly updated to use
isActionErrorinstead of the previous error checking mechanism, maintaining consistent error reporting to the user.apps/web/utils/actions/rule.validation.ts (3)
137-137: Code simplification: Single-line definition of rulesExamplesBodyThe declaration has been simplified by removing unnecessary line breaks, which improves code readability without changing functionality.
148-149: New schema for enabling/disabling draft repliesThis schema provides a clean, typed interface for enabling or disabling draft replies with proper Zod validation.
151-163: Well-structured schema for onboarding rules creationThe implementation:
- Creates a reusable
categoryActionenum with clear action options- Defines a comprehensive schema covering all major email categories
- Exports the properly typed interface for the onboarding form
This will provide good type safety and validation for the onboarding process.
apps/web/app/(app)/automation/onboarding/CategoriesSetup.tsx (6)
37-38: Define Next URL as a constantGood practice to define the navigation URL as a constant, making it easy to update if routing changes.
42-53: Form setup with sensible defaultsThe form is properly initialized with:
- Zod validation through zodResolver
- Sensible defaults for each email category
- Comprehensive coverage of common email types
The default selections align with typical user preferences (e.g., archive for marketing and cold emails).
67-73: Clear instructions and context for the userThe heading and paragraph provide clear instructions to the user, setting proper expectations about what they're configuring and the ability to customize further later.
75-118: Well-organized category cards with consistent stylingThe grid layout with consistent category cards provides a clean UI. Each category uses appropriate icons with distinct colors for visual differentiation, making it easy for users to scan and configure.
120-128: User-friendly navigation optionsGood UX design with:
- Primary action (Next) as the prominent button
- Skip option clearly available but visually secondary
- Full-width buttons that are easy to tap on mobile
134-187: Well-implemented reusable CategoryCard componentThe component:
- Takes appropriate props with proper TypeScript typing
- Properly integrates with the form context
- Creates a consistent UI with clear visual hierarchy
- Uses semantic UI components (Card, Select, etc.)
The type definition for the field prop on line 157-161 ensures type safety when binding to the form.
apps/web/app/api/reply-tracker/process-previous/route.ts (5)
13-13: Long-running operation with appropriate timeout settingSetting
maxDurationto 300 seconds is appropriate for this operation as it may need to process many emails, which could take substantial time.
15-16: Simple and focused validation schemaThe schema correctly validates that the request must include a user ID, keeping the API focused on its purpose.
18-22: Robust API key validationThe endpoint correctly validates the internal API key before processing the request, providing security against unauthorized access.
24-26: Request validation using ZodThe endpoint properly parses and validates the incoming JSON against the defined schema.
27-36: Comprehensive user lookup with necessary relationsThe database query efficiently retrieves the user along with their Google account information in a single query, including only the necessary fields for authentication.
apps/web/utils/reply-tracker/check-previous-emails.ts (7)
4-4: ImportinggetThreadMessagesandgetThreads
Using these specialized functions for Gmail threads is a cleaner approach than fetching messages individually in multiple steps. This also reduces the risk of confusion between messages and threads.
11-11: New Prisma import
Leveraging Prisma to record processed messages aligns with best practices for consistent data handling.
25-30: Switch togetThreads
Retrieving sent messages via threads instead of individual messages is more coherent with Gmail’s structure, potentially reducing the number of network calls.
32-32: Check for empty threads
Good defensive check ensuring early return when no threads are found. This prevents unnecessary processing.
38-45: Sorting and accessing the latest message
Sorting byinternalDatedescending ensures the first element is indeed the most recent. The approach is clear and straightforward.
48-57: Database lookup for pre-processed messages
Using a composite unique index is an effective pattern to prevent re-processing messages. This should gracefully handle concurrency without creating duplicates.
70-70: Improved error handling
Thetry/catchblock is a good addition for safer handling of processing errors.apps/web/utils/actions/rule.ts (5)
15-18: New validation imports
ImportingcreateRulesOnboardingBodyandenableDraftRepliesBodyensures robust input validation for new actions.
26-26: Expanded Prisma client import
IncludingActionType,ColdEmailSetting, andLogicalOperatorhints at broader usage for dynamic rule creation.
37-40: Additional imports for enabling reply tracker
Centralizing environment variables and an internal API key header is a secure approach for behind-the-scenes requests.
415-475:createRulesOnboardingAction– session & input validation
Ensuring the user is logged in and safely parsing the input with Zod helps maintain a secure boundary. This early exit pattern prevents accidental rule creation for unauthorized users.
544-610: Category-specific rule creation
- Cohesively handles user choices for newsletters, marketing, calendars, etc.
- Using
Promise.allSettledensures partial failures don’t halt the entire process.apps/web/utils/actions/cold-email.ts (3)
18-23: Added validation imports
New types for updating cold email settings and prompts help maintain consistency in your validation logic.
27-41:updateColdEmailSettingsAction
- Properly checks if the user is logged in.
- Uses Zod-safe parsed data to update
coldEmailBlocker.
This approach is clear and maintains a single source of truth.
43-57:updateColdEmailPromptAction
Allows updating a user’scoldEmailPromptwhile preserving strong validation. This is consistent with the existing pattern.apps/web/components/ui/form.tsx (5)
1-19: Introduction of a reusable form context
WrappingFormProviderin a customFormcomponent sets a clean foundation for advanced form usage withreact-hook-form.
44-65:useFormFieldhook
Well-structured approach retrieving field state & IDs. Throwing an error ifFormFieldcontext is missing is a robust safeguard.
75-87:FormItemcomposition
Forwarding refs and leveragingReact.useId()ensures stable, unique IDs for each item. Clear separation of concerns.
89-128:FormLabelandFormControl
Dynamicaria-invalidand descriptive IDs enable better accessibility. Noting an error with a destructive style is a nice touch.
146-169:FormMessage
Rendering conditionally based onerrorkeeps the UI focused. The pattern is consistent with the rest of the form components.apps/web/utils/actions/cold-email.validation.ts (4)
2-2: Good addition of the ColdEmailSetting importThe import of ColdEmailSetting from @prisma/client properly enables type-safe validation for the cold email settings enum values used later in this file.
17-30: Well-structured validation schema for cold email settingsThe implementation of
updateColdEmailSettingsBodyis clean and correctly uses Zod's enum validation with the imported ColdEmailSetting values. The.nullish()modifier appropriately allows both null and undefined values, giving flexibility for the API consumers.
32-37: Good implementation of prompt validation schemaThe
updateColdEmailPromptBodyschema correctly validates the cold email prompt as a string that can also be nullish, allowing users to either set a new prompt or clear an existing one.
39-40: Properly defined schema for marking non-cold emailsThe
markNotColdEmailBodyschema is concise and correctly validates that a sender string is provided, which is essential for identifying which sender should not be treated as a cold email.
Summary by CodeRabbit
New Features
CategoriesSetup,CompletedPage,DraftRepliesPage, andOnboardingPage.Improvements