Skip to content

Conversation

Bill-hbrhbr
Copy link
Contributor

@Bill-hbrhbr Bill-hbrhbr commented Mar 17, 2025

Description

Change clp::ffi::IrErrorCode to depend on ystdlib::error_handling::ErrorCode.

This PR follows the addition of ystdlib-cpp #730

This PR contributes to #764

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  • Unit tests for clp::ffi::IrErrorCode still pass.

Summary by CodeRabbit

  • Refactor
    • Updated the error handling integration to leverage a new external library, improving consistency and maintainability.
  • Tests
    • Removed legacy error handling tests to align with the streamlined framework.
  • Chores
    • Adjusted build and linting configurations to exclude certain files from the linting process.

These changes enhance the robustness and clarity of error management, ensuring a more reliable experience for end-users without altering visible functionality.

Copy link
Contributor

coderabbitai bot commented Mar 17, 2025

Walkthrough

This pull request removes the custom error handling header and its associated unit tests from the core component while updating error code handling to use the new ystdlib::error_handling framework. Changes include modifications to CMakeLists for test compilation and linking, adjustments in the error code and category definitions in the IR stream files, and an update to the linting configuration.

Changes

File(s) Change Summary
components/core/CMakeLists.txt Removed ErrorCode.hpp and the test-error_handling.cpp entry from unit test sources; added linking against ystdlib::error_handling.
components/core/src/clp/error_handling/ErrorCode.hpp Fully removed the header that provided templates, classes, and macros for error code and error category definitions.
components/core/src/clp/ffi/ir_stream/IrErrorCode.cpp Removed the type alias for IrErrorCategory and now directly imports it from the ystdlib namespace.
components/core/src/clp/ffi/ir_stream/IrErrorCode.hpp Updated the include directive to use an absolute path (<ystdlib/error_handling/ErrorCode.hpp>); revised type aliases and macro usage to refer to the ystdlib namespace.
components/core/tests/test-error_handling.cpp Removed unit tests related to error handling.
lint-tasks.yml Removed the reference to IrErrorCode.cpp from the list of files for linting.

Suggested reviewers

  • LinZhihao-723

📜 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 cf5e528 and 78b7a94.

📒 Files selected for processing (1)
  • components/core/src/clp/ffi/ir_stream/IrErrorCode.cpp (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/core/src/clp/ffi/ir_stream/IrErrorCode.cpp
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: centos-stream-9-static-linked-bins
  • GitHub Check: centos-stream-9-dynamic-linked-bins
  • GitHub Check: ubuntu-jammy-static-linked-bins
  • GitHub Check: ubuntu-jammy-dynamic-linked-bins
  • GitHub Check: ubuntu-jammy-lint
  • GitHub Check: build-macos (macos-14, true)
  • GitHub Check: build-macos (macos-14, false)
  • GitHub Check: build-macos (macos-13, false)
  • GitHub Check: lint-check (ubuntu-latest)
  • GitHub Check: lint-check (macos-latest)
  • GitHub Check: build (macos-latest)

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

@Bill-hbrhbr Bill-hbrhbr changed the title Migrate error handling src build(deps): Remove obsolete clp::error_handling module and migrate all usages ystdlib::error_handling. Mar 17, 2025
@Bill-hbrhbr Bill-hbrhbr changed the title build(deps): Remove obsolete clp::error_handling module and migrate all usages ystdlib::error_handling. chore(deps): Remove obsolete clp::error_handling and its unit tests; fix all reference sites to use ystdlib::error_handling. Mar 17, 2025
@Bill-hbrhbr Bill-hbrhbr marked this pull request as ready for review March 17, 2025 17:22
@Bill-hbrhbr Bill-hbrhbr requested a review from a team as a code owner March 17, 2025 17:22
@Bill-hbrhbr Bill-hbrhbr changed the title chore(deps): Remove obsolete clp::error_handling and its unit tests; fix all reference sites to use ystdlib::error_handling. chore(core-clp): Remove obsolete clp::error_handling and its unit tests; fix all reference sites to use ystdlib::error_handling. Mar 17, 2025
Bill-hbrhbr and others added 3 commits March 20, 2025 03:50
@Bill-hbrhbr Bill-hbrhbr requested a review from davidlion March 20, 2025 07:54
@davidlion davidlion changed the title chore(core-clp): Remove obsolete clp::error_handling and its unit tests; fix all reference sites to use ystdlib::error_handling. refactor(core-clp): Replace clp::error_handling with ystdlib::error_handling. Mar 20, 2025
@Bill-hbrhbr Bill-hbrhbr merged commit fdf3aee into y-scope:main Mar 20, 2025
21 checks passed
@Bill-hbrhbr Bill-hbrhbr deleted the migrate-error-handling-src branch March 20, 2025 17:14
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.

2 participants