resort to paginated requests for changed files

[2bndy5]

resolves #32

Summary by CodeRabbit

• New Features

  • Introduced a new method for retrieving paginated changes from GitHub, enhancing API interaction.
  • Added a new test module to validate paginated file retrieval based on GitHub events.

• Bug Fixes

  • Updated conditions in workflow configurations to ensure proper execution based on the runner's operating system.

• Documentation

  • Enhanced test environment setup by modifying function parameters for better control.

• Refactor

  • Streamlined response handling and request logic in the API client for improved readability and efficiency.

• Style

  • Simplified code structure and improved method naming for clarity in the Dummy class.

[2bndy5]

This change should complete feature parity with the pure python code.

After this is merged, I plan to start testing it in the test repo... 🤞🏼
I may also do some pre-releases to verify the CI release steps are working.

[codecov]

Codecov Report

Attention: Patch coverage is 95.45455% with 3 lines in your changes missing coverage. Please review.

Project coverage is 98.50%. Comparing base (740bdf2) to head (278e314).
Report is 21 commits behind head on main.

Files with missing lines	Patch %	Lines
cpp-linter-lib/src/rest_api/github_api.rs	95.45%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #37      +/-   ##
==========================================
- Coverage   98.57%   98.50%   -0.07%     
==========================================
  Files          12       12              
  Lines        3087     3144      +57     
==========================================
+ Hits         3043     3097      +54     
- Misses         44       47       +3     

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes primarily involve updates to the GitHub Actions workflow for handling different operating systems and enhancements to the GithubApiClient for better management of paginated API responses. Additionally, modifications to testing functions and the introduction of new test cases for paginated changes have been made. These updates aim to improve the efficiency and functionality of the codebase.

Changes

File	Change Summary
.github/workflows/run-dev-tests.yml	Updated conditional checks from matrix.os to runner.os for executing steps related to clang installations and coverage collection.
cpp-linter-lib/src/rest_api/github_api.rs	Introduced get_changed_files_paginated method for handling paginated API responses, updated response parsing logic, and refactored request handling for clarity.
cpp-linter-lib/src/rest_api/mod.rs	Added get_changed_files_paginated method to the RestApiClient trait for retrieving changed files with pagination support.
cpp-linter-lib/tests/comments.rs	Modified test_comment function to pass a boolean argument to create_test_space().
cpp-linter-lib/tests/common/mod.rs	Updated create_test_space function to accept a boolean parameter, altering its control flow based on the value of setup_meson.
cpp-linter-lib/tests/paginated_changed_files.rs	Introduced a new test module for validating paginated changes retrieval from GitHub, including multiple asynchronous test functions for push and pull request events.
cpp-linter-lib/tests/paginated_changes/*.json	Changes to workflow and source files to accommodate new triggers and updates, including modifications to the Dummy class and the introduction of a constructor.
cpp-linter-lib/tests/reviews.rs	Modified test_review function to pass a boolean argument to create_test_space().

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHubAPI
    participant GithubApiClient
    participant RestApiClient

    User->>GitHubAPI: Trigger event (push/pull request)
    GitHubAPI->>GithubApiClient: Request changed files
    GithubApiClient->>RestApiClient: Call get_changed_files_paginated
    RestApiClient->>GithubApiClient: Return paginated changed files
    GithubApiClient->>GitHubAPI: Return files to user

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Resort to paginated diff for events with large diff ( #32 )	✅

🐰 In a world of code, so bright and new,
Changes abound, with a hop and a view.
Paginated files dance in the light,
Tests now flourish, all set for flight.
With clang and GitHub, we leap with glee,
A rabbit's delight in code harmony! 🌟

---

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