fix: transform x-ai error response to open-ai format #1250
Conversation
|
Summary By MatterAI
🔄 What ChangedThis PR modifies 🔍 Impact of the ChangeThis change ensures consistent error handling across different AI providers by standardizing the error response format from X-AI to match OpenAI's format. This makes error handling more predictable for consumers of the API and improves the developer experience when working with multiple providers. 📁 Total Files Changed
🧪 Test AddedN/A - No new tests were included in this PR. It is recommended to add unit tests for the error transformation logic to ensure its correctness across various error scenarios. 🔒 Security VulnerabilitiesN/A - No security vulnerabilities were identified in this change. MotivationTo standardize error responses across different AI providers for consistent error handling. Type of Change
How Has This Been Tested?
Screenshots (if applicable)N/A Checklist
Related IssuesN/A Tip Quality Recommendations
Tanka Poem ♫
Sequence DiagramsequenceDiagram
actor Client
participant XAIProvider as X-AI Provider
participant XAIAPI as X-AI API
participant TransformLogic as Error Transformation Logic
Client->>XAIProvider: Request (e.g., /chat/completions)
XAIProvider->>XAIAPI: API Call (request_payload)
XAIAPI-->>XAIProvider: XAIErrorResponse (error_details)
XAIProvider->>TransformLogic: Process XAIErrorResponse
TransformLogic-->>XAIProvider: OpenAIErrorResponse (transformed_error)
XAIProvider-->>Client: OpenAIErrorResponse
|
![matter-code-review[bot]](https://avatars.githubusercontent.com/in/474549?s=60&v=4){kind=small}
| let _response = response as XAIErrorResponse; | ||
| if ('error' in _response) { | ||
| return { | ||
| error: { | ||
| message: _response.error as string, | ||
| code: _response.code ?? null, | ||
| param: null, | ||
| type: null, | ||
| }, | ||
| provider: X_AI, | ||
| }; | ||
| } | ||
| return response; |
There was a problem hiding this comment.
🐛 Bug Fix
Issue: The error handling doesn't properly handle the case when the error property is an object rather than a string, despite the interface defining it as potentially being an object.
Fix: Add proper type checking and handle both string and object error formats.
Impact: Prevents potential runtime errors when X-AI returns an error object instead of a string.
| let _response = response as XAIErrorResponse; | |
| if ('error' in _response) { | |
| return { | |
| error: { | |
| message: _response.error as string, | |
| code: _response.code ?? null, | |
| param: null, | |
| type: null, | |
| }, | |
| provider: X_AI, | |
| }; | |
| } | |
| return response; | |
| let _response = response as XAIErrorResponse; | |
| if ('error' in _response) { | |
| return { | |
| error: { | |
| message: typeof _response.error === 'string' | |
| ? _response.error | |
| : _response.error?.message ?? 'Unknown error', | |
| code: _response.code ?? _response.error?.code ?? null, | |
| param: _response.error?.param ?? null, | |
| type: _response.error?.type ?? null, | |
| }, | |
| provider: X_AI, | |
| }; | |
| } | |
| return response; |
| code?: string; | ||
| } | ||
|
|
||
| const xAIResponseTransform = <T>(response: T) => { |
There was a problem hiding this comment.
🛠️ Code Refactor
Issue: The function lacks documentation explaining its purpose and behavior.
Fix: Add JSDoc comments to explain the function's purpose and return value.
Impact: Improves code maintainability and makes it easier for other developers to understand the transformation logic.
| const xAIResponseTransform = <T>(response: T) => { | |
| /** | |
| * Transforms X-AI error responses to match the OpenAI error format | |
| * for consistent error handling across providers. | |
| * @param response The original response from X-AI | |
| * @returns Transformed response in OpenAI-compatible format or the original response if not an error | |
| */ | |
| const xAIResponseTransform = <T>(response: T) => { |
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
2 participants
Description
Transfrom X-AI Error responses to OAI format.
Motivation
Type of Change
How Has This Been Tested?
Screenshots (if applicable)
Checklist
Related Issues