You are working on the hyperswitch repository (Rust payment processing system).…
- User
You are working on the hyperswitch repository (Rust payment processing system).
REPOSITORY SETUP:
- Repository: juspay/hyperswitch
- Working directory: ./repos/hyperswitch_pool_2 (already cloned)
- Base commit: c58e93bfdba4cbd70d69e6d3947e0e1c68504e7e
- Task ID: juspay__hyperswitch-7809
- Version: v1.113.0
TASK DESCRIPTION: Bug: Deep health check failing because of OpenSearch
When you don't have OpenSearch deployed for Global Search feature on dashboard , the
/health/ready( deep health check ) API which checks health of all the underlying queryable resources fails because if OpenSearch is not present the health check fails which should not be the case.DETAILED CONTEXT & HINTS:
Type of Change
- Bugfix
- New feature
- Enhancement
- Refactoring
- Dependency updates
- Documentation
- CI/CD
Description
Making
OpenSearchClientoptional based on the config for querying OpenSearch Server for dashboard based on the Deployment status of the same ( OpenSearch Server ).Additional Changes
- This PR modifies the API contract
- This PR modifies the database schema
- This PR modifies application configuration/environment variables
Motivation and Context
When you don't have OpenSearch deployed for Global Search feature on dashboard , the
/health/ready( deep health check ) API which checks health of all the underlying queryable resources fails because OpenSearch is not present.To make it optional based on the deployment type needs changes and should be dependent on a config which should be given out on time of router deployment
Currently if you don't have OpenSearch Deployment and have router running
curl http://localhost:8080/health/ready -v * Host localhost:8080 was resolved. * IPv6: ::1 * IPv4: 127.0.0.1 % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0* Trying [::1]:8080... * Connected to localhost (::1) port 8080 > GET /health/ready HTTP/1.1 > Host: localhost:8080 > User-Agent: curl/8.7.1 > Accept: */* > * Request completely sent off < HTTP/1.1 500 Internal Server Error < content-length: 136 < access-control-expose-headers: x-request-id, content-type, via, strict-transport-security < via: HyperSwitch < x-request-id: 019634f7-a837-7d50-9a50-bb8e7651bd62 < content-type: application/json < vary: Origin, Access-Control-Request-Method, Access-Control-Request-Headers < strict-transport-security: max-age=31536000 < date: Mon, 14 Apr 2025 15:42:47 GMT < { [136 bytes data] 100 136 100 136 0 0 7613 0 --:--:-- --:--:-- --:--:-- 8000 * Connection #0 to host localhost left intact { "error": { "type": "api", "message": "Opensearch health check failed with error: Error while executing query in Opensearch", "code": "HE_00" } }How did you test it?
curl http://localhost:8080/health/ready -v | jq . * Host localhost:8080 was resolved. * IPv6: ::1 * IPv4: 127.0.0.1 % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0* Trying [::1]:8080... * Connected to localhost (::1) port 8080 > GET /health/ready HTTP/1.1 > Host: localhost:8080 > User-Agent: curl/8.7.1 > Accept: */* > * Request completely sent off < HTTP/1.1 200 OK < content-length: 90 < content-type: application/json < x-request-id: 01963e0a-e41d-7251-b20a-e9a0a6d1a67a < vary: Origin, Access-Control-Request-Method, Access-Control-Request-Headers < access-control-expose-headers: content-type, strict-transport-security, x-request-id, via < strict-transport-security: max-age=31536000 < via: HyperSwitch < date: Wed, 16 Apr 2025 10:00:23 GMT < { [90 bytes data] 100 90 100 90 0 0 236 0 --:--:-- --:--:-- --:--:-- 236 * Connection #0 to host localhost left intact { "database": true, "redis": true, "analytics": true, "opensearch": false, "outgoing_request": true }Checklist
- I formatted the code
cargo +nightly fmt --all - I addressed lints thrown by
cargo clippy - I reviewed the submitted code
- I added unit tests for my changes where possible
CRITICAL INSTRUCTIONS - WORK FAST AND EFFICIENTLY:
-
Create DENSE, ACTION-FOCUSED todos IMMEDIATELY
- Make todos specific and actionable
- Focus on HIGH-IMPACT actions only
- 5-8 todos maximum - be surgical, not exhaustive
-
Execute aggressively:
- Use bash commands to search efficiently
- Read multiple related files in quick succession
- Make ALL related changes in one edit
- Skip unnecessary exploration
-
File operations:
- All repo files: './repos/hyperswitch_pool_2/'
- Use targeted edits over whole file rewrites
-
NO TESTING UNLESS CRITICAL:
- Focus on making the actual code changes
- Only test if explicitly required
-
Maximize information density:
- Each turn should accomplish significant work
- Batch file reads when examining related code
- Use search commands to locate code quickly
EFFICIENCY IS CRITICAL. Make substantial progress every turn.
Assistant
I'll tackle this bug where the deep health check fails when OpenSearch is not deployed. Let me first understand the current implementation and locate the relevant files.
Assistant
Let me first search for the health check implementation to understand how it currently works:
Assistant
Let me check the current directory structure first:
Assistant
Now let me search for health check implementations in the crates directory:
Assistant
Let me search more broadly for health-related code:
Assistant
Let me just search in the current directory:
Assistant
(no content)
Assistant
Let me search for health routes more specifically:
Assistant
Let me check the routes directory structure to understand where the health endpoints are defined:
Assistant
Perfect! Now let me examine the health route files:
Assistant
Now I can see the issue! At line 113-120, the OpenSearch health check is guarded by
#[cfg(feature = "olap")], which means it only runs when that feature is enabled. However, the error message shows that it's still failing when OpenSearch is not present, indicating that it's running even when the feature is disabled. Let me also check the v2_health.rs file:Assistant
Let me look for OpenSearch-related configurations and client initialization:
Assistant
Let me check the analytics module which seems to contain OpenSearch-related code:
Assistant
Now let me check the AppState to understand how the OpenSearch client is initialized and used:
Assistant
(no content)
Assistant
Now I need to understand how the AppState is configured to see how opensearch is initialized. Let me check the app.rs file:
Assistant
Let me continue reading the app.rs file to see where OpenSearch client is initialized:
Assistant
Let me search for initialization code where OpenSearchClient is created:
Assistant
Let me check where AppState is initialized, looking for the main initialization function:
Assistant
Let me check the config files to understand how OpenSearch is configured:
Assistant
Now I can see from line 124 that
opensearchis configured as a setting. Let me now search for the initialization code of AppState to understand how OpenSearch is created:Assistant
Let me check the main lib.rs file to understand how AppState is initialized:
Assistant
Now let me find the actual AppState::new implementation:
Assistant
Let me check the AppState implementation more closely:
Assistant
Let me search more broadly for AppState::new:
Assistant
Let me look for the AppState::new function differently:
Assistant
Let me search for AppState::new function in a broader way to see where it's implemented:
Assistant
Looking at the issue more closely, I need to examine the root cause of why the OpenSearch health check fails when it shouldn't. Based on the current code analysis:
-
In
health.rsfile (lines 113-120), the OpenSearch health check is already wrapped with#[cfg(feature = "olap")], which means it should only run when the olap feature is enabled. -
However, the error shows that it's still executing even when OpenSearch is not present.
Let me check how AppState is actually built to see if there's an initialization issue that bypasses this configuration guard.
-
Assistant
Perfect! Now I can see the issue clearly. Looking at lines 344-350 in the AppState::with_storage function:
#[cfg(feature = "olap")] let opensearch_client = Arc::new( conf.opensearch .get_opensearch_client() .await .expect("Failed to create opensearch client"), );The problem is that when
olapfeature is enabled, the code creates an OpenSearch client regardless of whether it's actually needed or whether OpenSearch is configured properly. And importantly, it's not guarded by a check to see if OpenSearch is actually configured.Let me now create a plan to fix this issue:
Assistant
Let me examine how the OpenSearch configuration and client initialization works more carefully:
Assistant
Let me also check how the OpenSearchConfig is validated to understand what makes it "configured":
Assistant
Now I understand the problem better. The issue isn't just with the feature flag - it's that when the
olapfeature is enabled, the OpenSearch client is created without checking if the configuration is valid (i.e., if OpenSearch is actually available or configured).The real fix is to make the health check conditional on whether OpenSearch is actually configured and available. The health check logic should not fail the whole health check just because OpenSearch is not available.
Let me create a comprehensive fix:
Assistant
Let me first make sure I understand the correct imports and types I need to work with. Let me check what
HealthStateis and whatis_default_or_empty()function does:Assistant
(no content)
Assistant
(no content)
Assistant
Perfect! Now I can see that
HealthStatehasNotApplicablevariant. Let me check whatis_default_or_emptyfunction is from the common_utils crate:Assistant
Let me look at what imports are needed and write a simpler approach:
Assistant
Let me make a simpler and cleaner approach. Since the issue is that the health check should not fail if OpenSearch is not configured or not available, I need to make the health check itself handle this case gracefully. Looking at the error from the issue description, it seems like the
health_check_opensearchfunction is still getting called when the opensearch configuration is missing, causing the health check to fail.Let me simplify the approach and fix the code by making the OpenSearch health check conditional in a more appropriate way:
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.
Identical first prompt
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →
claude-sonnet-4-5-20250929Compare side by side →