Skip to content
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

Dev #3397

Merged
merged 2 commits into from
Jan 22, 2025
Merged

Dev #3397

merged 2 commits into from
Jan 22, 2025

Conversation

KouShenhai
Copy link
Owner

@KouShenhai KouShenhai commented Jan 22, 2025

Summary by Sourcery

Bug 修复:

  • 修复了 SQL 日志不包含参数值的问题,这使得调试变得困难。
Original summary in English

Summary by Sourcery

Bug Fixes:

  • Fixed a bug where SQL logs did not include parameter values, making debugging difficult.

Summary by CodeRabbit

Release Notes

  • Issue Templates

    • Replaced markdown issue templates with more structured YAML templates for bug reports and feature requests
    • Disabled blank issue creation
    • Added official website contact link
  • Development Improvements

    • Enhanced SQL monitoring interceptor to provide more detailed logging of SQL statements with parameter values
  • Configuration

    • Updated GitHub issue template settings to improve issue reporting process

Copy link

coderabbitai bot commented Jan 22, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant changes to the GitHub issue templates and the SQL monitoring interceptor. The project has transitioned from Markdown-based issue templates to YAML-based templates for bug reports and feature requests. The configuration has been updated to disable blank issues and add a contact link to the official website. Additionally, the SqlMonitorInterceptor has been modified to improve SQL logging by enhancing parameter handling and JSON processing.

Changes

File Change Summary
.github/ISSUE_TEMPLATE/bug_report.md Removed old Markdown-based bug report template
.github/ISSUE_TEMPLATE/bug_report.yml Added new YAML-based bug report template with structured inputs
.github/ISSUE_TEMPLATE/config.yml Disabled blank issues and added official website contact link
.github/ISSUE_TEMPLATE/custom.md Removed a blank line from the template
.github/ISSUE_TEMPLATE/feature_request.md Removed old Markdown-based feature request template
.github/ISSUE_TEMPLATE/feature_request.yml Added new YAML-based feature request template with detailed guidelines
laokou-common/laokou-common-mybatis-plus/.../SqlMonitorInterceptor.java Updated SQL logging method to improve parameter handling using JSON processing

Sequence Diagram

sequenceDiagram
    participant User as GitHub User
    participant Template as Issue Template
    participant Repo as Repository

    User->>Template: Fills out structured template
    Template->>Repo: Submits issue with detailed information
    Repo->>Repo: Validates issue contents
    Repo-->>User: Processes or requests more information
Loading

Poem

🐰 A Rabbit's Ode to Issue Templates 🐰

YAML templates, crisp and clean,
Guiding issues with a gleam so keen,
No more blank forms running wild,
Structured thoughts, precisely styled,
Our coding rabbit hops with glee! 🚀


📜 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 8526149 and 37a48a8.

📒 Files selected for processing (7)
  • .github/ISSUE_TEMPLATE/bug_report.md (0 hunks)
  • .github/ISSUE_TEMPLATE/bug_report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/custom.md (0 hunks)
  • .github/ISSUE_TEMPLATE/feature_request.md (0 hunks)
  • .github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
  • laokou-common/laokou-common-mybatis-plus/src/main/java/org/laokou/common/mybatisplus/config/SqlMonitorInterceptor.java (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

@KouShenhai KouShenhai merged commit b1f9519 into master Jan 22, 2025
9 of 13 checks passed
Copy link

sourcery-ai bot commented Jan 22, 2025

Here's the translation of the review guide to Chinese:

审阅者指南 by Sourcery

此拉取请求重构了 SQL 日志记录机制并更新了问题模板。

更新后的 SQL 监控流程序列图

sequenceDiagram
    participant App as Application
    participant SI as SqlMonitorInterceptor
    participant SH as StatementHandler
    participant JU as JacksonUtil

    App->>SI: intercept(invocation)
    SI->>SH: getBoundSql()
    SH-->>SI: return BoundSql
    alt SQL contains parameters (?)
        SI->>JU: toJsonStr(parameterObject)
        JU-->>SI: return JSON string
        SI->>JU: readTree(parameter)
        JU-->>SI: return JsonNode
        Note over SI: Extract and sort parameters
        SI->>SI: Replace ? with parameter values
    end
    SI-->>App: return formatted SQL
Loading

SQL 监控变更类图

classDiagram
    class SqlMonitorInterceptor {
        -String SPACE
        +Object intercept(Invocation invocation)
        -String getSql(StatementHandler statementHandler)
    }

    class StatementHandler {
        +BoundSql getBoundSql()
    }

    class BoundSql {
        +String getSql()
        +Object getParameterObject()
    }

    SqlMonitorInterceptor ..> StatementHandler
    StatementHandler ..> BoundSql

    note for SqlMonitorInterceptor "重构以使用 JSON 处理参数"
Loading

文件级变更

变更 详情 文件
重构 SQL 日志记录以包含参数值。
  • 修改 getSql 方法以提取并包含日志中的参数值。
  • 用新的实现替换原始 SQL 检索逻辑,该实现可处理参数。
  • 利用 JacksonUtil 将参数对象转换为 JSON 进行日志记录。
  • 替换使用 PreparedStatement.toString() 获取 SQL 字符串的方法。
laokou-common/laokou-common-mybatis-plus/src/main/java/org/laokou/common/mybatisplus/config/SqlMonitorInterceptor.java
更新问题模板以使用 YAML 格式。
  • 将旧的 Markdown 问题模板替换为新的基于 YAML 的模板。
  • 添加问题模板的配置文件。
  • 删除旧的 Markdown 问题模板文件。
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/config.yml

提示和命令

与 Sourcery 交互

  • 触发新的审阅: 在拉取请求中评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审阅评论。
  • 从审阅评论生成 GitHub 问题: 通过回复评论要求 Sourcery 创建问题。
  • 生成拉取请求标题: 在拉取请求标题的任何位置写 @sourcery-ai 以随时生成标题。
  • 生成拉取请求摘要: 在拉取请求正文的任何位置写 @sourcery-ai summary 以随时生成 PR 摘要。您还可以使用此命令指定摘要的插入位置。

自定义您的体验

访问您的仪表板以:

  • 启用或禁用审阅功能,如 Sourcery 生成的拉取请求摘要、审阅者指南等。
  • 更改审阅语言。
  • 添加、删除或编辑自定义审阅说明。
  • 调整其他审阅设置。

获取帮助

Original review guide in English

Reviewer's Guide by Sourcery

This pull request refactors the SQL logging mechanism and updates the issue templates.

Sequence diagram for the updated SQL monitoring process

sequenceDiagram
    participant App as Application
    participant SI as SqlMonitorInterceptor
    participant SH as StatementHandler
    participant JU as JacksonUtil

    App->>SI: intercept(invocation)
    SI->>SH: getBoundSql()
    SH-->>SI: return BoundSql
    alt SQL contains parameters (?)
        SI->>JU: toJsonStr(parameterObject)
        JU-->>SI: return JSON string
        SI->>JU: readTree(parameter)
        JU-->>SI: return JsonNode
        Note over SI: Extract and sort parameters
        SI->>SI: Replace ? with parameter values
    end
    SI-->>App: return formatted SQL
Loading

Class diagram for SQL monitoring changes

classDiagram
    class SqlMonitorInterceptor {
        -String SPACE
        +Object intercept(Invocation invocation)
        -String getSql(StatementHandler statementHandler)
    }

    class StatementHandler {
        +BoundSql getBoundSql()
    }

    class BoundSql {
        +String getSql()
        +Object getParameterObject()
    }

    SqlMonitorInterceptor ..> StatementHandler
    StatementHandler ..> BoundSql

    note for SqlMonitorInterceptor "Refactored to use JSON processing
for parameter handling"
Loading

File-Level Changes

Change Details Files
Refactor SQL logging to include parameter values.
  • Modified the getSql method to extract and include parameter values in the log.
  • Replaced the original SQL retrieval logic with a new implementation that handles parameters.
  • Utilized JacksonUtil to convert parameter objects to JSON for logging.
  • Replaced the use of PreparedStatement.toString() to get the SQL string.
laokou-common/laokou-common-mybatis-plus/src/main/java/org/laokou/common/mybatisplus/config/SqlMonitorInterceptor.java
Update issue templates to use YAML format.
  • Replaced the old markdown issue templates with new YAML-based templates.
  • Added a configuration file for issue templates.
  • Removed the old markdown issue template files.
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/config.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

@KouShenhai - 我已经审查了你的更改 - 以下是一些反馈:

整体评论

  • 考虑在 getSql() 方法中为 JSON 结构可能不匹配预期格式的情况添加错误处理(缺少 'ew' 或 'paramNameValuePairs' 字段,空值等)
以下是我在审查期间查看的内容
  • 🟢 一般问题:一切看起来都很好
  • 🟢 安全性:一切看起来都很好
  • 🟢 测试:一切看起来都很好
  • 🟢 复杂性:一切看起来都很好
  • 🟢 文档:一切看起来都很好

Sourcery 对开源项目是免费的 - 如果你喜欢我们的评论,请考虑分享它们 ✨
帮助我变得更有用!请在每条评论上点击 👍 或 👎,我将使用这些反馈来改进你的评论。
Original comment in English

Hey @KouShenhai - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding error handling in getSql() method for cases where JSON structure may not match expected format (missing 'ew' or 'paramNameValuePairs' fields, null values, etc)
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Jan 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 23.74%. Comparing base (6ed7e7d) to head (37a48a8).
Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master    #3397   +/-   ##
=========================================
  Coverage     23.74%   23.74%           
  Complexity      202      202           
=========================================
  Files           158      158           
  Lines          2089     2089           
  Branches        141      141           
=========================================
  Hits            496      496           
  Misses         1531     1531           
  Partials         62       62           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

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