🐛 Try to fix "Max client connections reached" errors transaction mode (#1669)

[KATO-Hiro]

Summary by CodeRabbit

• New Features

  • Expanded the development environment by adding an extra forwarded port.
  • Introduced a new environment variable to support improved database connection and migration processes.
  • Updated service connection settings with enhanced query parameters for better database handling.

• Refactor

  • Streamlined configuration formatting and updated database client settings to enable advanced connection options.

[coderabbitai]

Walkthrough

The changes update several configuration files to modify port mappings and environment variables for database connectivity and development processes. The development container now forwards an additional port. The CI workflow and Docker Compose files add a new environment variable, DIRECT_URL, while the Prisma schema is updated to support preview features and use the new direct connection property. These modifications adjust formatting and configuration details without altering the overall control flow.

Changes

File(s)	Change Summary
.devcontainer/devcontainer.json	Added port 6543 to the forwardPorts array and reformatted the array into multi-line syntax.
.github/workflows/ci.yml, compose.yaml, prisma/schema.prisma	Introduced a new environment variable DIRECT_URL. In the CI workflow, DIRECT_URL is set from secrets for both preview and production jobs. In compose.yaml, the db service’s host port was updated to 6543 and web service’s DATABASE_URL now includes extra query parameters with a new DIRECT_URL. In prisma/schema.prisma, the client generator now includes previewFeatures = ["driverAdapters"] and the datasource has a new directUrl property using env("DIRECT_URL").

Sequence Diagram(s)

sequenceDiagram
    participant GA as GitHub Actions
    participant Env as CI Job Environment
    participant Migrate as Migration Script
    participant Prisma as Prisma Client
    participant DB as Database
    GA->>Env: Set up environment with DIRECT_URL (from secrets)
    Env->>Migrate: Execute migration steps
    Migrate->>Prisma: Trigger Prisma migration command
    Prisma->>DB: Connect using DIRECT_URL

Loading

sequenceDiagram
    participant Web as Web Service
    participant DB as Database Service
    Note over Web,DB: Environment uses DATABASE_URL with additional parameters and DIRECT_URL
    Web->>DB: Connect using host port '6543' (mapped to container port 5432)

Loading

Poem

Hi there, I'm a little bunny in the code field,
Hopping through ports and configs with zeal.
I’ve added a new port and a secret URL so clear,
Watch migrations and services work, oh dear!
With direct connections and previews so bright,
My rabbit heart leaps in pure delight!

---

📜 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 aecf1dd and e5b23b8.

📒 Files selected for processing (4)

• .devcontainer/devcontainer.json (1 hunks)
• .github/workflows/ci.yml (2 hunks)
• compose.yaml (2 hunks)
• prisma/schema.prisma (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: preview

🔇 Additional comments (8)

compose.yaml (3)

5-5: Port Mapping Format for Web Service
Changing the port mapping for the web service to a string ('5173:5173') is acceptable and improves consistency with the other string-based mappings.

---

12-13: Enhanced DATABASE_URL and New DIRECT_URL Environment Variables
The DATABASE_URL now includes query parameters to enable pgBouncer (along with connection and timeout limits), which should help manage client connections. Additionally, the new DIRECT_URL variable is introduced without extra query parameters. Ensure that both connection strings are used appropriately in the application (e.g., using DATABASE_URL for pooled connections and DIRECT_URL for direct ones) and that the comment about using port db:6543 is well understood by the team.

---

29-29: Updated DB Service Port Mapping
Mapping the host port to '6543:5432' means that although the container listens on 5432, external connections via the host will use port 6543. Confirm that all consuming services (including local development tools) refer to the correct port as needed.

.devcontainer/devcontainer.json (1)

15-17: Forwarding Multiple Ports in Devcontainer
The forwardPorts array now includes both 5432 (the container’s internal port) and 6543 (the host-mapped port for PostgreSQL). While this may be intentional for allowing different connection methods, please verify that forwarding both is necessary and that it won’t lead to confusion when connecting from the dev container.

.github/workflows/ci.yml (2)

96-97: Preview Job: Inclusion of DIRECT_URL
The preview job now sets the DIRECT_URL environment variable using ${{ secrets.PREVIEW_DIRECT_URL }} alongside the DATABASE_URL. Ensure that the secret PREVIEW_DIRECT_URL is correctly configured and that its format is consistent with the expected connection string in your setup.

---

142-144: Production Job: Inclusion of DIRECT_URL
Similarly, the production job adds DIRECT_URL from ${{ secrets.PRODUCTION_DIRECT_URL }}. Confirm that this secret is securely stored and that the production migration commands correctly recognize and use this new variable.

prisma/schema.prisma (2)

7-11: Enabling Prisma Preview Feature "driverAdapters"
The generator configuration now includes previewFeatures = ["driverAdapters"]. Ensure that your Prisma client version supports this preview feature and that it has been tested in your environment, as preview features can sometimes introduce breaking changes.

---

30-33: Adding directUrl to Datasource Configuration
Introducing directUrl = env("DIRECT_URL") in the datasource block provides an alternative connection string that aligns with the changes in both the Compose and CI configurations. Verify that the use of both url and directUrl meets the intended connection routing (for example, to bypass pooling if needed) and is well-documented in your setup.

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.