chore: return circuit breaker status if triggered

[sk-portkey]

Description

Motivation

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Refactoring (no functional changes)

How Has This Been Tested?

• Unit Tests
• Integration Tests
• Manual Testing

Screenshots (if applicable)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

Related Issues

[matter-code-review]

Description

Summary By MatterAI

🔄 What Changed

This pull request introduces a new response header, x-powered-by-circuit-breaker-triggered, to indicate when the circuit breaker mechanism has been activated for a request.

• A new constant CIRCUIT_BREAKER_TRIGGERED was added to RESPONSE_HEADER_KEYS in src/globals.ts.
• The tryPost and tryTargetsRecursively functions in src/handlers/handlerUtils.ts were updated to accept and propagate an isCircuitBreakerOpen boolean parameter.
• Inside tryTargetsRecursively, isCircuitBreakerOpen is set to true if the number of healthy targets is less than the total number of targets, indicating a circuit breaker trigger.
• The updateResponseHeaders function was modified to append the new x-powered-by-circuit-breaker-triggered: true header to the response if isCircuitBreakerOpen is true.

🔍 Impact of the Change

This change enhances observability by providing clients with direct information about whether a request encountered a circuit breaker trigger. This can be crucial for debugging, monitoring, and understanding the health of downstream services. It allows for better client-side handling or logging when a circuit breaker is active.

📁 Total Files Changed

2 files were changed:

• src/globals.ts
• src/handlers/handlerUtils.ts

🧪 Test Added

No explicit tests were added or mentioned in the pull request description. The changes primarily involve propagating a new status flag and adding a response header based on existing circuit breaker logic.

🔒Security Vulnerabilities

No security vulnerabilities were detected in the provided code changes. The changes are focused on adding an informational header and do not introduce new attack surfaces or modify existing security-sensitive logic.

Motivation

To provide visibility into the circuit breaker status, allowing clients to understand if a request was affected by the circuit breaker mechanism.

Type of Change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

• Unit Tests
• Integration Tests
• Manual Testing

Screenshots (if applicable)

N/A

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

Related Issues

.

Tip

Quality Recommendations

1. Add unit tests to specifically verify that the x-powered-by-circuit-breaker-triggered header is correctly appended to the response when the circuit breaker logic is triggered (i.e., when healthyTargets.length < currentTarget.targets.length).

2. Update the API documentation (e.g., OpenAPI specification, README, or relevant developer guides) to include the new x-powered-by-circuit-breaker-triggered response header and its possible values, ensuring consumers are aware of this new observability feature.

Sequence Diagram

sequenceDiagram
    participant Client
    participant API_Gateway
    participant HandlerUtils
    participant Globals

    Client->>API_Gateway: HTTP Request
    API_Gateway->>HandlerUtils: Call tryTargetsRecursively(config, fn, method, jsonPath, inheritedConfig, isCircuitBreakerOpen: false)
    HandlerUtils-->>HandlerUtils: Evaluate healthy targets based on circuit breaker status
    alt Circuit Breaker Triggered (healthyTargets < totalTargets)
        HandlerUtils->>HandlerUtils: Set isCircuitBreakerOpen = true
    end
    HandlerUtils->>HandlerUtils: Call tryPost(..., isCircuitBreakerOpen)
    HandlerUtils->>HandlerUtils: Call updateResponseHeaders(response, cacheStatus, retryAttempt, traceId, provider, isCircuitBreakerOpen)
    HandlerUtils->>Globals: Access RESPONSE_HEADER_KEYS.CIRCUIT_BREAKER_TRIGGERED
    Globals-->>HandlerUtils: Return "x-powered-by-circuit-breaker-triggered"
    alt isCircuitBreakerOpen is true
        HandlerUtils->>API_Gateway: Append "x-powered-by-circuit-breaker-triggered: true" header to Response
    end
    API_Gateway-->>Client: HTTP Response with headers

Loading

[matter-code-review]

This PR adds a new feature to return the circuit breaker status in response headers when triggered. The implementation is clean and follows the existing patterns in the codebase. I have a few minor suggestions to improve the code.

[matter-code-review]

Important

PR Review Skipped

PR review skipped as per the configuration setting. Run a manually review by commenting /matter review

💡Tips to use Matter AI

Command List

• /matter summary: Generate AI Summary for the PR
• /matter review: Generate AI Reviews for the latest commit in the PR
• /matter review-full: Generate AI Reviews for the complete PR
• /matter release-notes: Generate AI release-notes for the PR
• /matter : Chat with your PR with Matter AI Agent
• /matter remember : Generate AI memories for the PR
• /matter explain: Get an explanation of the PR
• /matter help: Show the list of available commands and documentation
• Need help? Join our Discord server: https://discord.gg/fJU5DvanU3

[matter-code-review]

Important

PR Review Skipped

PR review skipped as per the configuration setting. Run a manually review by commenting /matter review

💡Tips to use Matter AI

Command List

• /matter summary: Generate AI Summary for the PR
• /matter review: Generate AI Reviews for the latest commit in the PR
• /matter review-full: Generate AI Reviews for the complete PR
• /matter release-notes: Generate AI release-notes for the PR
• /matter : Chat with your PR with Matter AI Agent
• /matter remember : Generate AI memories for the PR
• /matter explain: Get an explanation of the PR
• /matter help: Show the list of available commands and documentation
• Need help? Join our Discord server: https://discord.gg/fJU5DvanU3