alkir-rahc icon indicating copy to clipboard operation
alkir-rahc copied to clipboard

Feature/refactoring

Open nixel2007 opened this issue 1 year ago • 1 comments

Summary by CodeRabbit

  • New Features

    • Application now launches in web mode by default.
    • Introduced a command for cluster deletion and enhanced session listing with flexible filtering.
    • Added new configuration properties for management and monitoring features.
  • Refactor

    • Improved CLI feedback with refined success/error displays and centralized error handling.
    • Enabled profile-based activation for web controllers and authentication components.
    • Enhanced API documentation for JSON-RPC services via OpenAPI support.
  • Chores

    • Upgraded underlying dependencies and streamlined configuration settings for improved stability.

nixel2007 avatar Mar 29 '25 21:03 nixel2007

Walkthrough

The updates modify the build configuration by updating plugin versions and adding a new dependency. The default command in the main application is changed from “cli” to “web”. Several new AOP aspects, exception handlers, and CLI interfaces (including a new print writer interface and result record) have been introduced to better manage error handling and output. Authentication, configuration, and controller classes have been annotated with profiles to separate web and CLI contexts. The retry mechanism in both configuration and service layers has been refined, and new JSON-RPC API support for OpenAPI documentation has been added.

Changes

File(s) Change Summary
build.gradle.kts Plugin versions bumped from 8.13 to 8.13.1; added io.freefair.aspectj.post-compile-weaving plugin and new dependency for aspectjrt (1.9.22.1).
RahcApplication.java Updated DEFAULT_COMMAND from "cli" to "web", affecting default command handling and web application type determination.
ru/digilabs/alkir/rahc/aop/* Added new AOP classes (CliErrorHandlerAspect, CliRetrayableRacMethodExceptionHandler, WebRetrayableRacMethodExceptionHandler) and interface (RetrayableRacMethodExceptionHandler), plus significant changes in RetryableRacMethodAspect to improve retry and error handling via dependency injection and asynchronous execution.
ru/digilabs/alkir/rahc/command/cli/* and ru/digilabs/alkir/rahc/command/cli/options/* Introduced CliPrintWriter interface, new record CliResult, and a new ConsolePrintWriter implementation; updated subcommands (ClusterManagerSubcommand, ClusterSubcommand, SessionSubcommand) and option classes (ClusterAdminOptions, new ClusterIdOption); removed deprecated RacCliSubCommand.
ru/digilabs/alkir/rahc/auth/* and AuthConfigurationProperties.java Added @Profile("web") to authentication and configuration classes to enforce profile-based activation.
ru/digilabs/alkir/rahc/configuration/* Renamed and restructured retry configuration in AppConfiguration (now using racRetryTemplate), removed JSON-RPC API customization, introduced WebConfiguration with a new jsonrpcApi method, added AspectJConfiguration, and removed the @Retryable annotation from RetryableRacMethod.
ru/digilabs/alkir/rahc/controller/v1/* and ru/digilabs/alkir/rahc/controller/v2/* Added @Profile("web") annotations to multiple controllers to restrict them to the web environment.
ru/digilabs/alkir/rahc/service/* In RacService, added a new deleteCluster method, updated factory initialization, and changed init method access; RacServiceProvider now injects an additional IAgentAdminConnectorFactory dependency in service retrieval.
src/main/resources/application-cli.properties Added numerous properties to disable Spring admin features, management endpoints, JMX support, and several auto-configurations.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant R as RetryableRacMethodAspect
    participant T as racRetryTemplate
    participant E as Execution Thread
    participant H as RetrayableRacMethodExceptionHandler

    C->>R: Invoke retrayable method
    R->>T: Execute method call with retry callback
    T->>E: Start method execution in new thread
    E->>E: Execute joinPoint.proceed()
    alt Exception occurs
        E-->>R: Exception thrown
        R->>H: Handle exception via error handler
        H-->>R: Process exception
        R-->>C: Return null (error handled)
    else No exception
        E-->>R: Return result
        R-->>C: Return success result
    end

Poem

I hop through lines of updated code,
Leaping over bugs where new aspects glowed.
CLI commands now sing a “web” tune,
With profiles set to make errors swoon.
In retry loops and JSON tales so bright,
CodeRabbit hops—celebrating change in flight!

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

🪧 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 plan to trigger planning for file edits and PR creation.
  • @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.

coderabbitai[bot] avatar Mar 29 '25 21:03 coderabbitai[bot]