feat: add helpful notes when tables are missing due to clickhouse misconfiguration #407
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Reviewer's Guide by SourceryThis PR adds helpful documentation links and error messages when ClickHouse system tables are missing due to misconfiguration. The implementation adds a new Class diagram for ErrorAlert componentclassDiagram
class ErrorAlertProps {
+string title
+string|React.ReactNode|React.ReactNode[] message
+string|React.ReactNode|React.ReactNode[] docs
+string query
+void reset()
+string className
}
class ErrorAlert {
+string title
+string|React.ReactNode|React.ReactNode[] message
+string|React.ReactNode|React.ReactNode[] docs
+string query
+void reset()
+string className
+renderContent(message)
+renderAccordion(title, content)
+renderDocs(docs)
}
note for ErrorAlert "Added docs property and renderDocs method"
Class diagram for QueryConfig interfaceclassDiagram
class QueryConfig {
+string name
+string description
+string sql
+ClickHouseSettings clickhouseSettings
+string docs
}
note for QueryConfig "Added docs property for documentation links"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @duyet - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #407 +/- ##
=======================================
Coverage 78.34% 78.34%
=======================================
Files 5 5
Lines 157 157
Branches 57 57
=======================================
Hits 123 123
Misses 34 34 ☔ View full report in Codecov by Sentry. |
Bundle ReportChanges will increase total bundle size by 8.51kB (0.14%) ⬆️. This is within the configured threshold ✅ Detailed changes
|
|
cc @gregzuro |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Introduce a feature to provide users with helpful notes and documentation links when tables are missing due to ClickHouse misconfiguration. Enhance the ErrorAlert component to support displaying these notes, improving user guidance during error scenarios. Update the ClickHouse documentation to reflect these changes.
New Features:
Enhancements:
Documentation: