Protocol Server Latency Optimization - Code changes

[emmayank]

Description

Implement code changes in the Protocol Server based on the decided approach outlined in the Approach Document. The changes should focus on reducing API response latency while ensuring seamless integration with multiple BPPs and maintaining functional stability.

Goals

• Implement code modifications as per the approved approach
• Optimize API response time without affecting core functionality
• Test changes with multiple BPPs to ensure compatibility
• Ensure that no existing functionalities are impacted

Expected Outcome

A faster and more efficient Protocol Server, delivering optimized response times while maintaining compatibility and reliability across multiple BPP integrations.

Acceptance Criteria

• Code changes for API optimization are implemented
• Functionality remains intact with no regressions
• Protocol server successfully interacts with multiple BPPs
• Testing confirms API stability, efficiency, and correctness

Mockups / Wireframes

NA

Product Name

Beckn

Domain

TBD

Tech Skills Needed

Backend Development, API Performance Optimization, Load Testing, Debugging, Protocol Server Enhancements

Complexity

High

Category

Performance Optimization

Sub Category

Protocol Server Enhancements

[emindsajay]

Protocol server POC for the search response optimization is completed.

[emindsajay]

Currently, code changes for the implementation are in progress.

[emindsajay]

Submitted the PR for this task: #251

[emindsajay]

This implementation introduces a streaming response mechanism for search requests. When streamOnSearch is enabled, responses will be streamed in real-time instead of being stored in SyncCache. This improves response times and allows clients to process data incrementally.

1. Configuration Update

• A new configuration flag streamOnSearch is introduced under app settings.
• When streamOnSearch: true, the system streams responses instead of storing them in the cache.

2. Emitting Search Event

• When streaming is enabled, responses are emitted using eventBus:

  • If streaming is enabled, onSearch event is emitted.
  • If disabled, the response is stored in SyncCache.

• Opens a streaming connection when streamOnSearch is enabled.

• Listens to onSearch event and writes responses as they arrive.

• Ends the stream after the waitTime timeout.

Testing & Validation

• Enable streamOnSearch: true and verify real-time responses are streamed.
• Disable streamOnSearch: false and confirm responses are retrieved from SyncCache.
• Validate proper event cleanup to prevent memory leaks.