AI find snippets when generating prompt

[elie222]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a new test suite for the aiFindSnippets function to validate snippet extraction from emails.
  • Enhanced bulk archiving functionality with improved visibility handling.
  • Added functionality to generate more relevant email management rules based on user interactions and snippets.
  • Introduced a new function to identify frequently used email snippets.
  • Added a new asynchronous function for streaming AI completion tools.

• Bug Fixes

  • Improved error handling and logging for better traceability in various functions.

• Documentation

  • Updated function signatures and added new types for better clarity and maintainability.

[vercel]

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

Name	Status	Preview	Updated (UTC)
inbox-zero	🔄 Building (Inspect)	Visit Preview	Dec 9, 2024 9:20am

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces several enhancements across multiple files, primarily focusing on the functionality related to Gmail label handling, user interactions with rules, and the testing of the aiFindSnippets function. Key changes include the addition of a new test suite for aiFindSnippets, modifications to improve the handling of visibility options in bulk archiving, and updates to the rules generation process to incorporate snippets from user emails. Additionally, new types and constants are introduced to enhance type safety and maintainability throughout the codebase.

Changes

File Path	Change Summary
apps/web/__tests__/ai-find-snippets.test.ts	Introduced a new test suite for aiFindSnippets using Vitest, including tests for identifying snippets from emails and handling unique emails. Added helper functions for mock email and user data, and included a mock implementation for server dependencies.
apps/web/app/api/user/bulk-archive/route.ts	Added imports for labelVisibility and messageVisibility, replacing string literals in getOrCreateInboxZeroLabel. Maintained existing logic while enhancing clarity and maintainability.
apps/web/utils/actions/ai-rule.ts	Expanded Gmail label imports and updated generateRulesPromptAction to retrieve more emails (50 instead of 20) and process labels with thread counts. Incorporated aiFindSnippets to enhance rule generation context. Updated error handling for user authentication.
apps/web/utils/ai/choose-rule/execute.ts	Updated imports to include visibility constants and modified parameters for getOrCreateInboxZeroLabel. Maintained existing logic while improving code clarity.
apps/web/utils/ai/rule/generate-rules-prompt.ts	Enhanced aiGenerateRulesPrompt to include a new snippets parameter, updated prompt construction, and introduced parseRulesResponse for handling AI responses based on snippets. Improved logging for tracing.
apps/web/utils/ai/rule/prompt-to-rules.ts	Modified aiPromptToRules to include new logging and updated prompt formatting for handling snippets. Adjusted schema validation based on the isEditing flag.
apps/web/utils/ai/snippets/find-snippets.ts	Introduced aiFindSnippets function to analyze email content for frequently used snippets. Defined a response schema using Zod and structured the function to return identified snippets or an empty array.
apps/web/utils/gmail/label.ts	Redefined MessageVisibility and LabelVisibility types to use constant objects for improved type safety. Updated getLabels function to limit API response fields. Maintained existing function logic and error handling.
apps/web/utils/llms/index.ts	Added a new asynchronous function streamCompletionTools to handle AI model interactions. No changes to existing functions or error handling logic.

Possibly related PRs

• AI prompt for each generated argument #191: The main PR introduces a new test suite for the aiFindSnippets function, which is directly related to the changes in the ai-rule.ts file where the aiFindSnippets function is added and utilized in generating rules prompts.

🐰 In a world of emails, so bright and wide,
Snippets are found, with joy we abide.
From tests to rules, our code takes flight,
With every change, we hop with delight!
So here's to the snippets, both clever and neat,
In our coding garden, they make life sweet! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2554647 and 3e89a83.

📒 Files selected for processing (9)

• apps/web/__tests__/ai-find-snippets.test.ts (1 hunks)
• apps/web/app/api/user/bulk-archive/route.ts (2 hunks)
• apps/web/utils/actions/ai-rule.ts (4 hunks)
• apps/web/utils/ai/choose-rule/execute.ts (2 hunks)
• apps/web/utils/ai/rule/generate-rules-prompt.ts (3 hunks)
• apps/web/utils/ai/rule/prompt-to-rules.ts (3 hunks)
• apps/web/utils/ai/snippets/find-snippets.ts (1 hunks)
• apps/web/utils/gmail/label.ts (2 hunks)
• apps/web/utils/llms/index.ts (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.