fix: On adding notes server error message

[samrathreddy]

Description

While adding notes, a server error message appears even though the note is successfully inserted into the database.

The root cause is related to Drizzle ORM by default, it does not return any data after an insert operation unless the .returning() method is explicitly used.

Without .returning(), the insert query executes correctly, but returns undefined or an empty array. This causes the backend logic (which expects a returned value for validation or response) to throw an error, leading to a false server error message.

Adding .returning() to the insert statement resolves the issue by returning the inserted record’s metadata, which can then be used to confirm successful insertion and send a proper response.

---

Type of Change

Please delete options that are not relevant.

• [x] 🐛 Bug fix (non-breaking change which fixes an issue)
• [ ] ✨ New feature (non-breaking change which adds functionality)
• [ ] 💥 Breaking change (fix or feature with breaking changes)
• [ ] 📝 Documentation update
• [ ] 🎨 UI/UX improvement
• [ ] 🔒 Security enhancement
• [ ] ⚡ Performance improvement

Areas Affected

Please check all that apply:

• [ ] Email Integration (Gmail, IMAP, etc.)
• [ ] User Interface/Experience
• [ ] Authentication/Authorization
• [ ] Data Storage/Management
• [x] API Endpoints
• [ ] Documentation
• [ ] Testing Infrastructure
• [ ] Development Workflow
• [ ] Deployment/Infrastructure

Testing Done

Describe the tests you've done:

• [ ] Unit tests added/updated
• [ ] Integration tests added/updated
• [ ] Manual testing performed
• [ ] Cross-browser testing (if UI changes)
• [ ] Mobile responsiveness verified (if UI changes)

Security Considerations

For changes involving data or authentication:

• [ ] No sensitive data is exposed
• [ ] Authentication checks are in place
• [ ] Input validation is implemented
• [ ] Rate limiting is considered (if applicable)

Checklist

• [x] I have read the CONTRIBUTING document
• [x] My code follows the project's style guidelines
• [x] I have performed a self-review of my code
• [ ] I have commented my code, particularly in complex areas
• [ ] I have updated the documentation
• [ ] My changes generate no new warnings
• [ ] I have added tests that prove my fix/feature works
• [ ] All tests pass locally
• [ ] Any dependent changes are merged and published

Additional Notes

Add any other context about the pull request here.

Screenshots/Recordings

Add screenshots or recordings here if applicable.

---

By submitting this pull request, I confirm that my contribution is made under the terms of the project's license.

Summary by CodeRabbit

• Bug Fixes

  • Improved error handling and logging when creating notes, ensuring clearer feedback if note creation fails.

• New Features

  • Note creation now returns the newly created note, providing immediate feedback after adding a note.

[coderabbitai[bot]]

"""

Walkthrough

The changes introduce improved error handling in the NotesManager.createNote method by wrapping the note creation logic in a try-catch block and refining result validation and logging. Additionally, the ZeroDB.createNote method is updated to return the inserted note record by appending a .returning() call to the database insert operation.

Changes

File(s)	Change Summary
apps/server/src/lib/notes-manager.ts	Wrapped createNote logic in try-catch, improved error checking, added logging, rethrow errors.
apps/server/src/main.ts	Modified ZeroDB.createNote to return the inserted note record using .returning().

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant NotesManager
    participant ZeroDB
    participant Database

    Client->>NotesManager: createNote(payload, userId)
    NotesManager->>ZeroDB: createNote(payload, userId)
    ZeroDB->>Database: INSERT note (with .returning())
    Database-->>ZeroDB: Inserted note record(s)
    ZeroDB-->>NotesManager: Inserted note record(s)
    NotesManager-->>Client: Created note or error (with logging)

Possibly related PRs

• Mail-0/Zero#1345: Refactored NotesManager to delegate note creation to ZeroDB.createNote, setting the stage for the current enhancements in error handling and result management.

Poem

A note is born with care anew,
Wrapped in try-catch, errors in view.
The database now returns its prize,
While logs will catch unwelcome surprise.
With every hop, the code grows strong—
🐇 Onward, notes, you can't go wrong! """

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bc309851fef41b7120f0115271d8b9f1789b341c and 4de0748e26368f837f1816b754566c235b942d99.

📒 Files selected for processing (1)

• apps/server/src/lib/notes-manager.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• apps/server/src/lib/notes-manager.ts

✨ 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

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