Skip to content

Delete the secure param before passing it to the ClickHouse client #2161

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
Jun 10, 2025

Conversation

ericallam
Copy link
Member

No description provided.

Copy link

changeset-bot bot commented Jun 10, 2025

⚠️ No Changeset found

Latest commit: 5b58087

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Jun 10, 2025

Walkthrough

The initialization process for the ClickHouse client was updated to parse the connection URL from the CLICKHOUSE_URL environment variable into a URL object. The "secure" query parameter is explicitly removed from this URL before it is used. The ClickHouse client is then instantiated with the modified URL string. Additionally, the console log message was changed to display the host portion of the URL instead of a generic service-enabled message. No changes were made to the declarations of exported or public entities.

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

@ericallam ericallam merged commit 3f2b748 into main Jun 10, 2025
5 of 33 checks passed
@ericallam ericallam deleted the ea-branch-68 branch June 10, 2025 12:55
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: 1

🧹 Nitpick comments (1)
apps/webapp/app/services/clickhouseInstance.server.ts (1)

15-16: Document why the secure parameter is removed.

The secure parameter removal aligns with the PR objective, but consider adding a comment explaining why this is necessary for the ClickHouse client.

- // Remove secure param
+ // Remove secure param - the ClickHouse client handles TLS configuration separately
  url.searchParams.delete("secure");
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a060cee and 5b58087.

📒 Files selected for processing (1)
  • apps/webapp/app/services/clickhouseInstance.server.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
apps/webapp/app/services/clickhouseInstance.server.ts (2)

18-18: Improved logging for better debugging.

The console log now displays the actual host, which is more informative than the generic message. This is a good improvement for debugging and monitoring.


21-21: Correctly uses the modified URL string.

The implementation correctly converts the modified URL object back to a string after removing the secure parameter, ensuring the ClickHouse client receives the intended URL format.

Comment on lines +13 to +14
const url = new URL(env.CLICKHOUSE_URL);

Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add error handling for URL parsing.

The URL constructor will throw an error if env.CLICKHOUSE_URL is malformed. Consider adding error handling to provide a more informative error message.

- const url = new URL(env.CLICKHOUSE_URL);
+ let url;
+ try {
+   url = new URL(env.CLICKHOUSE_URL);
+ } catch (error) {
+   console.error(`🗃️  Invalid CLICKHOUSE_URL: ${env.CLICKHOUSE_URL}`, error);
+   return;
+ }
🤖 Prompt for AI Agents
In apps/webapp/app/services/clickhouseInstance.server.ts around lines 13 to 14,
the URL constructor is used directly on env.CLICKHOUSE_URL without error
handling, which can throw if the URL is malformed. Wrap the URL construction in
a try-catch block to catch any errors, and throw a new error with a clear,
informative message indicating that the CLICKHOUSE_URL environment variable is
invalid or malformed.

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.

2 participants