Skip to content

Comments

Add tests for disbale drafting#490

Merged
elie222 merged 1 commit intomainfrom
chore/test-unused
Jun 5, 2025
Merged

Add tests for disbale drafting#490
elie222 merged 1 commit intomainfrom
chore/test-unused

Conversation

@elie222
Copy link
Owner

@elie222 elie222 commented Jun 5, 2025

Summary by CodeRabbit

  • New Features
    • Introduced a process to automatically disable the auto-draft feature for users with 10 or more unused drafts older than one day.
  • Bug Fixes
    • Improved error handling during the auto-draft disabling process to ensure errors are logged and summarized without interruption.
  • Tests
    • Added comprehensive tests to verify the correct disabling of unused auto-drafts and proper error handling.
  • Chores
    • Updated version to v1.3.22.

@vercel
Copy link

vercel bot commented Jun 5, 2025

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

Name Status Preview Updated (UTC)
inbox-zero ✅ Ready (Inspect) Visit Preview Jun 5, 2025 7:37pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 5, 2025

Walkthrough

The changes introduce a modularized implementation of the disableUnusedAutoDrafts function, moving its logic out of the API route file into a dedicated module. Comprehensive tests for this function are added. The API route now imports and invokes the new implementation. The project version is incremented.

Changes

Files/Groups Change Summary
.../disable-unused-auto-draft/disable-unused-auto-drafts.ts New module with the disableUnusedAutoDrafts function, implementing user draft analysis logic.
.../disable-unused-auto-draft/disable-unused-auto-drafts.test.ts New test suite covering multiple scenarios for disableUnusedAutoDrafts.
.../disable-unused-auto-draft/route.ts Refactored to import and invoke disableUnusedAutoDrafts from the new module.
version.txt Version updated from v1.3.21 to v1.3.22.

Sequence Diagram(s)

sequenceDiagram
    participant CronJob as Cron Job (POST)
    participant API as API Route
    participant Logic as disableUnusedAutoDrafts Module
    participant DB as Database

    CronJob->>API: POST /reply-tracker/disable-unused-auto-draft
    API->>Logic: disableUnusedAutoDrafts()
    Logic->>DB: Query users with auto-draft enabled
    loop For each user
        Logic->>DB: Fetch last 10 drafts older than 1 day
        alt All drafts unused
            Logic->>DB: Delete DRAFT_EMAIL actions
        else At least one draft used
            Logic->>Logic: Skip disabling
        end
    end
    Logic-->>API: {usersChecked, usersDisabled, errors}
    API-->>CronJob: JSON response
Loading

Possibly related PRs

  • Disable unused drafts #409: Originally implemented the disable-unused-auto-draft API route and core logic, which this PR refactors and modularizes.

Poem

In a warren of code, we hop and we draft,
Tidying up features, old logic we craft.
Now modules are neat, and tests run with cheer,
Auto-drafts pruned, the intent is clear.
With version anew, we leap to the sun—
Another fine update, another job done!
🐇✨

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.

apps/web/app/api/reply-tracker/disable-unused-auto-draft/disable-unused-auto-drafts.test.ts

Oops! Something went wrong! :(

ESLint: 9.28.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.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

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

apps/web/app/api/reply-tracker/disable-unused-auto-draft/disable-unused-auto-drafts.ts

Oops! Something went wrong! :(

ESLint: 9.28.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.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

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

apps/web/app/api/reply-tracker/disable-unused-auto-draft/route.ts

Oops! Something went wrong! :(

ESLint: 9.28.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.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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 (3)
apps/web/app/api/reply-tracker/disable-unused-auto-draft/disable-unused-auto-drafts.ts (3)

20-20: Address the efficiency TODO or create a tracking issue.

The TODO comment indicates potential performance concerns with the current query strategy. Consider either optimizing the query or creating a tracking issue to address this in the future.

Would you like me to help optimize the query or create an issue to track this performance concern?


112-121: Clarify the content: null filter in the deletion query.

The deletion query specifically targets actions with content: null. This seems intentional but could benefit from a comment explaining why only null content actions are deleted.

Consider adding a comment to explain why the deletion is limited to actions with null content:

        // Delete the DRAFT_EMAIL actions from all TO_REPLY rules
+        // Only delete actions with null content as these are auto-generated draft actions
        await prisma.action.deleteMany({
          where: {
            rule: {
              emailAccountId,
              systemType: SystemType.TO_REPLY,
            },
            type: ActionType.DRAFT_EMAIL,
            content: null,
          },
        });

7-7: Consider making the draft threshold configurable.

The hard-coded MAX_DRAFTS_TO_CHECK = 10 could benefit from being configurable, especially as usage patterns may vary across different user bases.

Consider making this configurable through environment variables or function parameters for better flexibility.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1d54dc4 and a6bd3b9.

📒 Files selected for processing (4)
  • apps/web/app/api/reply-tracker/disable-unused-auto-draft/disable-unused-auto-drafts.test.ts (1 hunks)
  • apps/web/app/api/reply-tracker/disable-unused-auto-draft/disable-unused-auto-drafts.ts (1 hunks)
  • apps/web/app/api/reply-tracker/disable-unused-auto-draft/route.ts (1 hunks)
  • version.txt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (7)
version.txt (1)

1-1: LGTM! Version bump aligns with the new functionality.

The version increment is appropriate for the addition of comprehensive test coverage and code refactoring.

apps/web/app/api/reply-tracker/disable-unused-auto-draft/disable-unused-auto-drafts.ts (1)

15-134: LGTM! Well-structured function with comprehensive logic.

The function is well-implemented with proper error handling, logging, and clear business logic. The extraction from the route handler improves code organization and testability.

apps/web/app/api/reply-tracker/disable-unused-auto-draft/route.ts (2)

5-5: LGTM! Clean refactoring improves separation of concerns.

The extraction of business logic into a dedicated module while maintaining the same API contract is excellent. This improves testability and code organization.


17-18: LGTM! Preserved functionality with cleaner implementation.

The route handler now focuses solely on HTTP concerns while delegating business logic to the appropriate module.

apps/web/app/api/reply-tracker/disable-unused-auto-draft/disable-unused-auto-drafts.test.ts (3)

1-249: Excellent comprehensive test coverage!

The test suite thoroughly covers all the main scenarios:

  • Users with unused drafts (should be disabled)
  • Users with sent drafts (should not be disabled)
  • Users with draft send logs (should not be disabled)
  • Users with insufficient drafts (should be skipped)
  • Multiple user scenarios
  • Error handling

The tests are well-structured with clear descriptions and proper mocking. This significantly improves the reliability of the codebase.


46-51: Good test data generation pattern.

Using Array.from with a mapping function to generate test data is clean and readable. This pattern makes it easy to create realistic test scenarios.


182-209: Excellent use of mock chaining for complex scenarios.

The use of mockResolvedValueOnce to simulate different responses for multiple users is a great testing pattern that clearly demonstrates the expected behavior for each user type.

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Bug: Cron Job Data Stale After Config Change

The export const dynamic = "force-dynamic"; declaration was removed. This Next.js configuration is essential for cron job routes to ensure they run dynamically and fetch fresh database data on each execution, rather than being cached or statically optimized. Its removal could lead to stale data being used by the cron job logic.

apps/web/app/api/reply-tracker/disable-unused-auto-draft/route.ts#L1-L18

import { NextResponse } from "next/server";
import { withError } from "@/utils/middleware";
import { hasPostCronSecret } from "@/utils/cron";
import { captureException } from "@/utils/error";
import { disableUnusedAutoDrafts } from "./disable-unused-auto-drafts";
export const maxDuration = 300;
export const POST = withError(async (request) => {
if (!(await hasPostCronSecret(request))) {
captureException(
new Error("Unauthorized cron request: api/auto-draft/disable-unused"),
);
return new Response("Unauthorized", { status: 401 });
}
const results = await disableUnusedAutoDrafts();
return NextResponse.json(results);

Fix in Cursor


BugBot free trial expires on June 9, 2025
You have used $0.00 of your $50.00 spend limit so far. Manage your spend limit in the Cursor dashboard.

Was this report helpful? Give feedback by reacting with 👍 or 👎

@elie222 elie222 merged commit 81df554 into main Jun 5, 2025
10 checks passed
@elie222 elie222 deleted the chore/test-unused branch June 5, 2025 20:15
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