Skip to content

refactor: validate command orchestration#57

Merged
konradmichalik merged 6 commits intomainfrom
improve/refactor-validate-command-orchestration
Jul 28, 2025
Merged

refactor: validate command orchestration#57
konradmichalik merged 6 commits intomainfrom
improve/refactor-validate-command-orchestration

Conversation

@konradmichalik
Copy link
Copy Markdown
Contributor

@konradmichalik konradmichalik commented Jul 28, 2025

Summary by CodeRabbit

  • New Features

    • Added support for a new "github" output format for translation validation results, enabling integration with GitHub Actions workflow annotations.
    • Introduced a dedicated service to coordinate translation validation tasks.
  • Documentation

    • Updated documentation to describe the new "github" output format and improved option descriptions.
  • Bug Fixes

    • Corrected minor formatting issues in documentation.
  • Tests

    • Added comprehensive tests for the new GitHub output format and orchestration service to ensure correct behavior and output.
  • Refactor

    • Streamlined validation command logic by delegating orchestration responsibilities to a new service class.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 28, 2025

Warning

Rate limit exceeded

@jackd248 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 56 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 for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between d1de972 and 4e2c1b4.

📒 Files selected for processing (11)
  • docs/console-command.md (1 hunks)
  • schema/translation-validator.schema.json (2 hunks)
  • src/Command/ValidateTranslationCommand.php (7 hunks)
  • src/Result/FormatType.php (1 hunks)
  • src/Result/ValidationResultGitHubRenderer.php (1 hunks)
  • src/Result/ValidationResultRendererFactory.php (1 hunks)
  • src/Service/ValidationOrchestrationService.php (1 hunks)
  • tests/src/Result/FormatTypeTest.php (1 hunks)
  • tests/src/Result/ValidationResultGitHubRendererTest.php (1 hunks)
  • tests/src/Result/ValidationResultRendererFactoryTest.php (2 hunks)
  • tests/src/Service/ValidationOrchestrationServiceTest.php (1 hunks)

Walkthrough

This change introduces a new "github" output format for translation validation results, refactors the ValidateTranslationCommand to delegate orchestration logic to a new ValidationOrchestrationService, and adds a dedicated ValidationResultGitHubRenderer. Related documentation, schema, enums, factories, and tests are updated or added to support and verify the new format and refactored orchestration.

Changes

Cohort / File(s) Change Summary
Documentation & Schema
docs/console-command.md, schema/translation-validator.schema.json
Updated documentation and schema to add the "github" output format and clarify option descriptions.
Command Refactor & Orchestration
src/Command/ValidateTranslationCommand.php, src/Service/ValidationOrchestrationService.php
Refactored command to use a new orchestration service for validation logic; moved path, validator, and detector resolution into the service.
Output Format Extension
src/Result/FormatType.php, src/Result/ValidationResultRendererFactory.php
Added "github" to output format enum and extended the renderer factory to support the new format.
GitHub Renderer
src/Result/ValidationResultGitHubRenderer.php
Introduced a new renderer for GitHub Actions workflow annotations, formatting validation results accordingly.
Renderer & Factory Tests
tests/src/Result/ValidationResultGitHubRendererTest.php, tests/src/Result/ValidationResultRendererFactoryTest.php, tests/src/Result/FormatTypeTest.php
Added/updated tests to verify the new GitHub renderer, factory behavior, and enum cases.
Orchestration Service Tests
tests/src/Service/ValidationOrchestrationServiceTest.php
Introduced tests to cover orchestration service logic for validation execution, path, validator, and detector resolution.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ValidateTranslationCommand
    participant ValidationOrchestrationService
    participant ValidationResultRendererFactory
    participant ValidationResultGitHubRenderer

    User->>ValidateTranslationCommand: execute()
    ValidateTranslationCommand->>ValidationOrchestrationService: resolvePaths(), resolveValidators(), resolveFileDetector()
    ValidateTranslationCommand->>ValidationOrchestrationService: executeValidation()
    ValidationOrchestrationService-->>ValidateTranslationCommand: ValidationResult
    ValidateTranslationCommand->>ValidationResultRendererFactory: create(format, ...)
    ValidationResultRendererFactory-->>ValidateTranslationCommand: ValidationResultGitHubRenderer
    ValidateTranslationCommand->>ValidationResultGitHubRenderer: render(ValidationResult)
    ValidationResultGitHubRenderer-->>User: GitHub Actions Annotations Output
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~35 minutes

Possibly related PRs

  • #16: Refactors validator selection logic and command options in ValidateTranslationCommand.php, overlapping with this PR's changes to validator resolution and command structure.
  • #14: Introduces initial enum-based output format handling and centralized output rendering, which this PR extends with the new "github" format.
  • #18: Refactors the command's execute method to use a new object-oriented validation architecture, forming a foundation for the orchestration refactor in this PR.

Poem

A rabbit hops through code anew,
With GitHub format in its view.
Orchestration now refined,
Validation neatly aligned.
Annotations leap with glee—
CI bunnies all agree:
“This is how clean code should be!”
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch improve/refactor-validate-command-orchestration

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests 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.

@konradmichalik konradmichalik merged commit 0fa35ee into main Jul 28, 2025
27 checks passed
@konradmichalik konradmichalik deleted the improve/refactor-validate-command-orchestration branch September 7, 2025 13:17
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.

1 participant