Support url in conditional router

[ayush-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]

Summary By MatterAI

🔄 What Changed

The ConditionalRouter now accepts a url object containing the request pathname as part of its context. This url object is passed from the tryTargetsRecursively function in handlerUtils.ts when instantiating the ConditionalRouter. The RouterContext interface in conditionalRouter.ts has been updated to include this new optional url property with a pathname string.

🔍 Impact of the Change

This enhancement provides the ConditionalRouter with the ability to make routing decisions based on the request's URL path. This significantly increases the flexibility and power of conditional routing logic, allowing for more granular control over target resolution based on the incoming request's path.

📁 Total Files Changed

• src/handlers/handlerUtils.ts: Added url: { pathname: c.req.path } to ConditionalRouter constructor.
• src/services/conditionalRouter.ts: Added url?: { pathname: string; }; to the RouterContext interface.

🧪 Test Added

N/A - No explicit tests were added or mentioned in the provided PR data.

🔒Security Vulnerabilities

N/A - The change itself does not introduce direct security vulnerabilities. However, it is crucial that any logic within the ConditionalRouter that utilizes the url.pathname context properly sanitizes or validates this input if it's used in sensitive operations (e.g., file system access, database queries, external API calls) to prevent potential path traversal or injection attacks. This is a consideration for the ConditionalRouter's implementation, not this specific PR's change.

Motivation

This change is motivated by the need to enable more sophisticated conditional routing logic within the gateway, allowing routing decisions to be based on the incoming request's URL path.

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
  N/A - No testing details provided in the PR data.

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
  totalScore: 4

Related Issues

N/A

Tip

Quality Recommendations

1. Add unit tests for ConditionalRouter to specifically cover routing logic based on the new url.pathname context.

2. Implement robust input validation and sanitization within ConditionalRouter for url.pathname if it is used in sensitive operations (e.g., file paths, database queries) to prevent potential security vulnerabilities.

Tanka Poem ♫

URL path now flows,
Router's logic, sharp and keen,
Decisions precise.
New data, a guiding star,
Gateway's wisdom now expands. ✨

Sequence Diagram

sequenceDiagram
    participant Client as Client Request
    participant HU as HandlerUtils (tryTargetsRecursively)
    participant CR as ConditionalRouter

    Client->>HU: Incoming Request (c.req)
    Note over HU: Process request
    HU->>+CR: new ConditionalRouter(currentTarget, { metadata, params, url: { pathname: c.req.path } })
    Note over CR: Initialize with request context
    CR-->>-HU: ConditionalRouter instance
    HU->>CR: resolveTarget()
    CR-->>HU: finalTarget
    HU-->>Client: Response (based on finalTarget)

Loading

[matter-code-review]

Clean implementation adding URL context to conditional router. Code is well-structured with proper type definitions.

[matter-code-review]

🛠️ Code Refactor

Issue: The url property in RouterContext interface lacks JSDoc documentation explaining its purpose and usage
Fix: Add JSDoc comment to document the url property's role in conditional routing
Impact: Improves code maintainability and developer understanding

Suggested change

	interface RouterContext {
	metadata?: Record<string, string>;
	params?: Record<string, any>;
	url?: {
	pathname: string;
	};
	}
	interface RouterContext {
	metadata?: Record<string, string>;
	params?: Record<string, any>;
	/** URL information for conditional routing decisions */
	url?: {
	pathname: string;
	};
	}