Skip to content

add new useInMemoryDbForTesting option#36

Merged
joshunrau merged 10 commits intomainfrom
dev
Apr 12, 2025
Merged

add new useInMemoryDbForTesting option#36
joshunrau merged 10 commits intomainfrom
dev

Conversation

@joshunrau
Copy link
Collaborator

@joshunrau joshunrau commented Apr 12, 2025

Summary by CodeRabbit

  • New Features

    • Introduced a logging configuration option that allows custom log-level management based on environment settings.
    • Enhanced database connection handling with a more structured approach, including support for in-memory databases during testing.
  • Refactor

    • Streamlined configuration initialization and connection setup for improved reliability and maintainability.
  • Tests

    • Expanded test coverage to ensure robust connection lifecycle management and graceful shutdown behavior.

@joshunrau joshunrau merged commit 39f182f into main Apr 12, 2025
@coderabbitai
Copy link

coderabbitai bot commented Apr 12, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request updates multiple modules and tests to enhance type safety and configuration clarity for MongoDB connections. Key modifications include introducing and using the explicit MongoConnection type, updating tests to verify properties of connection objects, and refining dependency injection in Prisma-related modules. Additionally, the PR adjusts environment variable initialization and logging configuration, and it introduces a new ConnectionFactory class to manage both standard and in-memory MongoDB connections.

Changes

File(s) Summary
src/app/__tests__/app.factory.test.ts, src/modules/prisma/__tests__/prisma.factory.test.ts, src/modules/prisma/__tests__/prisma.module.test.ts, src/testing/helpers/e2e.ts Updated tests to import and use the explicit MongoConnection type, checking mongoConnection.url.href instead of simple URL strings.
src/meta/dev.ts Modified NODE_ENV assignment using the nullish coalescing assignment operator to preserve pre-set values.
src/modules/logging/logging.module.ts Adjusted logging configuration to first use the LOG setting, falling back to the previous environment check when missing.
src/modules/prisma/connection.factory.ts, src/modules/prisma/prisma.factory.ts, src/modules/prisma/prisma.module.ts Introduced a new ConnectionFactory and shifted Prisma modules/factories to rely on MongoConnection for connection details, with updated dependency injection and in-memory DB options.
src/modules/prisma/prisma.config.ts, src/schemas/env.schema.ts Added configuration options including useInMemoryDbForTesting and a new optional LOG property.
src/modules/prisma/__tests__/connection.factory.test.ts Added new tests to verify the lifecycle and shutdown behavior of the ConnectionFactory with in-memory MongoDB.

Sequence Diagram(s)

sequenceDiagram
    participant PM as PrismaModule
    participant CF as ConnectionFactory
    participant PF as PrismaFactory
    participant DB as MongoDB/InMemoryDB

    PM->>CF: Request connection via create()
    alt Testing Environment with in-memory DB
        CF->>DB: createMemoryConnection()
    else
        CF->>DB: createDefaultConnection()
    end
    CF-->>PM: Return MongoConnection object
    PM->>PF: Inject MongoConnection
    PF->>DB: Use connection.url.href to initialize PrismaClient
Loading

Possibly related PRs

  • update #29: Updates related to the handling of the MongoConnection type and its usage in tests, which aligns closely with the modifications in this PR.

Poem

I'm a little rabbit, hopping with glee,
Type safety improved, now as clear as can be.
Mongo connections dance in a structured delight,
Tests and modules sparkle, everything's right.
With nibbles of code and a joyful leap,
We celebrate changes—straight and deep!
Hoppy days ahead in our code retreat!


📜 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 00c787d and 24028b0.

📒 Files selected for processing (12)
  • src/app/__tests__/app.factory.test.ts (2 hunks)
  • src/meta/dev.ts (1 hunks)
  • src/modules/logging/logging.module.ts (1 hunks)
  • src/modules/prisma/__tests__/connection.factory.test.ts (1 hunks)
  • src/modules/prisma/__tests__/prisma.factory.test.ts (3 hunks)
  • src/modules/prisma/__tests__/prisma.module.test.ts (3 hunks)
  • src/modules/prisma/connection.factory.ts (1 hunks)
  • src/modules/prisma/prisma.config.ts (1 hunks)
  • src/modules/prisma/prisma.factory.ts (2 hunks)
  • src/modules/prisma/prisma.module.ts (2 hunks)
  • src/schemas/env.schema.ts (1 hunks)
  • src/testing/helpers/e2e.ts (2 hunks)
✨ 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.
    • 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@github-actions
Copy link

🎉 This PR is included in version 4.3.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@coderabbitai coderabbitai bot mentioned this pull request Apr 24, 2025
@coderabbitai coderabbitai bot mentioned this pull request Oct 15, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant