ScribbleLabApp / SFFileManagementKit

The official ScribbleLabApp's Scribble Foundation File Management Kit for document interaction in ScribbleLab
Apache License 2.0
4 stars 1 forks source link

Refactor 0A000102 Codebase & add swtchdog & benchmark tests templates #8

Closed N3v1 closed 1 month ago

N3v1 commented 1 month ago

Description

Related Issue

none

Checklist

Additional Notices

None

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@N3v1 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 43 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between bea8d80ef5399ed14d3b138d0ca3fa1dd7499bfe and b1e1753bfa4b6488468bb1f6f9c6f62b8bbb3e40.

Walkthrough

The recent changes significantly enhance the ScribbleFoundation project by introducing robust performance benchmarking capabilities and refining build processes. Key updates include the addition of a benchmarking utility with detailed performance measurement features, along with improved configuration scripts and CMake files. These modifications streamline development, improve usability, and foster a more efficient developer experience.

Changes

File(s) Change Summary
.gitignore Added entries for development artifacts (cmake-build-debug, .idea, benchmark), improving project cleanliness.
Sources/_SFUtils/include/bench.h Introduced a benchmarking framework, enabling performance measurement with various utilities for recording and analyzing benchmarks.
Tests/Benchmarks/CMakeLists.txt Created build configuration for benchmark tests, facilitating performance evaluation.
Tests/Benchmarks/include/bchsuite.h Added benchmarking test function, enhancing performance testing capabilities.
Tests/Benchmarks/main.c Implemented a main utility for running benchmarks, providing a straightforward control flow for tests.
scripts/benchmark.sh Introduced an automated script for executing benchmark tests, streamlining the testing process.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script as Benchmark Script
    participant CMake
    participant Ninja

    User->>Script: Run benchmark.sh
    Script->>Script: Check for verbose output
    Script->>Script: Clean build directory
    Script->>CMake: Configure project
    CMake->>Ninja: Generate build files
    Script->>Ninja: Build project
    Ninja-->>Script: Compilation complete
    Script->>Script: Run benchmarks
    Script-->>User: Display results

🐰 In the meadow of code, where bunnies hop free,
New benchmarks and scripts, oh what joy there will be!
With each little test, our hopes take to flight,
Measuring speed, making everything right!
Hopping along, with tools in our paws,
Celebrating our code with binkies and applause! 🌸✨


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
N3v1 commented 1 month ago

Issue must be in 8c84e819e8c57d08258efdd1cbe6f22e2e35b20c

N3v1 commented 1 month ago

Files that needs to be checked:

Sources/_SFUtils/include/bench.h Tests/Benchmarks/CMakeLists.txt Tests/Benchmarks/include/bchsuite.h Tests/Benchmarks/include/bench.h Tests/Benchmarks/main.c scripts/benchmark.sh

Issue in 8c84e819e8c57d08258efdd1cbe6f22e2e35b20c

N3v1 commented 1 month ago

@kilianbalaguer Are you down to find the problem causing the CI Workflow to fail?