Skip to content

feat: add upsert repo #209

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

Merged
merged 1 commit into from
May 28, 2025
Merged

feat: add upsert repo #209

merged 1 commit into from
May 28, 2025

Conversation

Behzad-rabiei
Copy link
Member

@Behzad-rabiei Behzad-rabiei commented May 28, 2025

Summary by CodeRabbit

  • New Features

    • Introduced the ability to create or update documents in a single operation within repositories.
  • Chores

    • Removed the changelog file from the project.

Copy link

coderabbitai bot commented May 28, 2025

Walkthrough

The changelog file documenting the project's release history was deleted. In the codebase, the BaseRepository class was updated to include a new asynchronous upsert method, enabling atomic create-or-update operations. Additionally, import statements from the Mongoose library were adjusted to remove explicit type-only imports.

Changes

File(s) Change Summary
CHANGELOG.md Entire changelog file deleted, removing the project's historical release notes and summaries.
src/repositories/base.repository.ts Added an upsert method to BaseRepository for atomic create-or-update; adjusted Mongoose imports.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant BaseRepository
    participant MongooseModel

    Caller->>BaseRepository: upsert(filter, update, options)
    BaseRepository->>MongooseModel: updateOne(filter, update, { upsert: true, ...options })
    MongooseModel-->>BaseRepository: Promise (result)
    BaseRepository-->>Caller: Promise (result)
Loading

Poem

A changelog hops away, its tales now out of sight,
While upsert joins the warren, merging day with night.
With one swift leap, it writes or mends,
The database now has clever friends!
🐇✨

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.

npm warn config production Use --omit=dev instead.
npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-05-28T10_06_07_076Z-debug-0.log

✨ 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

@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 (1)
src/repositories/base.repository.ts (1)

2-9: Consider the implications of removing type-only imports.

The change from import type { ... } to import { ... } could impact bundle size and compilation. Since these are all TypeScript types from mongoose, using import type is generally preferred unless these imports are needed at runtime.

If these types are only used for type annotations, consider reverting to type-only imports:

import {
- FilterQuery,
- HydratedDocument,
- LeanDocument,
- Model,
- PopulateOptions,
- ProjectionType,
- QueryOptions,
- UpdateQuery,
+ type FilterQuery,
+ type HydratedDocument,
+ type LeanDocument,
+ type Model,
+ type PopulateOptions,
+ type ProjectionType,
+ type QueryOptions,
+ type UpdateQuery,
} from 'mongoose';

However, if this change was made to resolve TypeScript compilation issues, the current approach is acceptable.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 67b56dc and a20f695.

📒 Files selected for processing (2)
  • CHANGELOG.md (0 hunks)
  • src/repositories/base.repository.ts (2 hunks)
💤 Files with no reviewable changes (1)
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: ci / build-push / Build + Push Image
🔇 Additional comments (1)
src/repositories/base.repository.ts (1)

66-71: LGTM! Well-implemented upsert method.

The upsert method implementation is correct and follows established patterns:

  • Properly wraps updateOne with upsert: true option
  • Correctly spreads existing options to preserve any additional query options
  • Maintains consistency with other repository methods
  • Provides atomic create-or-update functionality as intended

This is a valuable addition to the repository that enables efficient upsert operations.

@Behzad-rabiei Behzad-rabiei merged commit 647ec7a into main May 28, 2025
3 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