OSOE-353: Add duplicate SQL query detector in Lombiq.UITestingToolbox

[dministro]

OSOE-353 Fixes #93

Summary by CodeRabbit

• New Features

  • Introduced a "Duplicated SQL query detector" to improve test efficiency and resource usage.
  • Added configuration settings for UI Testing Toolbox to enhance SQL query monitoring.
  • Implemented a new set of tests for detecting duplicated SQL queries.

• Enhancements

  • Improved test environment with additional configuration options for database command execution thresholds.
  • Enhanced navigation and page load testing with new counter data collection and assertion capabilities.
  • Expanded testing toolbox with classes and interfaces to support performance metric collection.

• Documentation

  • Updated the Readme to reflect new testing features and configurations.

• Bug Fixes

  • Fixed issues related to database command execution tracking during tests.

• Refactor

  • Refactored database connection and command wrappers to support performance data collection.

• Tests

  • Added tests for new functionality and performance monitoring features.

• Chores

  • Updated internal test infrastructure to incorporate new counter data collector services.

[github-actions[bot]]

This pull request has merge conflicts. Please resolve those before requesting a review.

[Piedone]

@coderabbitai review

I'm testing the AI code review tool CodeRabbit here. Please bear with me. And if it comments some useful feedback, please address it.

[coderabbitai[bot]]

Walkthrough

Walkthrough

The changes implement a detection system for duplicated SQL queries and excessive row fetching during page loads, aiming to enhance testing efficiency and application performance. The system allows setting thresholds for query duplication and integrates with the UI Testing Toolbox. It introduces new classes and extensions for data collection, counter management, and performance probing, as well as modifications to existing services to support the new functionality.

Changes

File Path	Change Summary
Lombiq.Tests.UI.Samples/Readme.md Lombiq.Tests.UI.Samples/Tests/...	Added "Duplicated SQL query detector" and additional configuration settings for the UI Testing Toolbox.
Lombiq.Tests.UI/Exceptions/CounterThresholdException.cs Lombiq.Tests.UI/Services/Counters/... Lombiq.Tests.UI/Services/OrchardCoreHosting/OrchardApplicationFactory.cs Lombiq.Tests.UI/Services/OrchardCoreInstance.cs Lombiq.Tests.UI/Services/OrchardCoreUITestExecutorConfiguration.cs Lombiq.Tests.UI/Services/UITestContext.cs Lombiq.Tests.UI/Services/UITestExecutionSession.cs Lombiq.Tests.UI/Services/UITestExecutor.cs	Introduced classes and changes related to counter threshold management, data collection, and performance probing.
Lombiq.Tests.UI/Services/ProbedConnectionFactory.cs Lombiq.Tests.UI/Services/Counters/Data/ProbedDbConnection.cs Lombiq.Tests.UI/Services/Counters/Data/ProbedDbCommand.cs Lombiq.Tests.UI/Services/Counters/Data/ProbedDbDataReader.cs Lombiq.Tests.UI/Services/Counters/Data/ProbedSqliteConnection.cs	Added classes for performance counting for database commands and connections.

Assessment against linked issues

Objective	Addressed	Explanation
Implement a feature to detect duplicated SQL queries during page load (#93)	✅
Allow configuration of a threshold for query duplication (#93)	✅
Use Orchard Core Mini Profiler for query detection or implement similar logic (#93)	❓	The summary does not explicitly mention the Mini Profiler, but similar profiling logic may have been implemented.
Detect queries fetching too many rows and implement configurable thresholds (#93)	❓	The summary mentions detection and thresholds, but it's unclear if this specifically includes row fetching.
Leverage common APIs for integration with Jira issue OSOE-353 (#93)	❓	There is no specific mention of leveraging common APIs, but the extensive changes suggest some level of integration may have been achieved.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai[bot]]

@Piedone, I'm ready to review the pull request as requested. Please provide any specific files or code snippets you would like me to focus on, or I will proceed with a general review of the changes.

Action performed

Review triggered.

[Piedone]

@coderabbitai review

Sorry about that.

[coderabbitai[bot]]

@Piedone, no worries at all! I'm here to assist you. If you have any specific areas or files in the pull request that you would like me to review, please let me know. Otherwise, I will proceed with a general review of the changes.

Action performed

Review triggered.

[Piedone]

These comments seem useful, please check them out. You can also chat with the bot, see the tips under https://github.com/Lombiq/UI-Testing-Toolbox/pull/216#issuecomment-1872376517.