feat: Support separate registration and published paths in WebMvcSseS… #80
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…erverTransportProvider Adds a new constructor to WebMvcSseServerTransportProvider that accepts separate parameters for server registration paths and client-facing published paths. This enhancement allows the provider to work correctly in environments with servlet context paths or global URL prefixes (like Spring Boot's spring.mvc.servlet.path) by: - Using messageEndpoint for server-side router registration - Using publishedMessageEndpoint when communicating with clients The implementation maintains backward compatibility
|
Thank you @minguncle ! will review it shortly. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #79
Support separate registration and published paths in WebMvcSseServerTransportProvider
Adds a new constructor to WebMvcSseServerTransportProvider that accepts separate parameters for server registration paths and client-facing published paths.
This enhancement allows the provider to work correctly in environments with servlet context paths or global URL prefixes (like Spring Boot's spring.mvc.servlet.path) by:
The implementation maintains backward compatibility with existing code while addressing the needs of deployments behind proxies or with context paths.
Motivation and Context
When using WebMvcSseServerTransportProvider in environments with servlet context paths or global URL prefixes, there's a mismatch between the path where handlers are registered with Spring's RouterFunction and the full path that needs to be communicated to clients. This enhancement solves that problem by allowing these paths to be configured separately.
For example, in Spring Boot applications with
spring.mvc.servlet.path=/api/v1, the server needs to register handlers at bare paths like/message, but clients need to use the full path/api/v1/message.How Has This Been Tested?
Tested in a Spring Boot application with servlet context paths configured. Verified both the registration of handlers at the correct paths and the communication of full paths to clients through the SSE connection.
Breaking Changes
No breaking changes. Existing code using the current constructors will continue to work as before.
Types of changes
Checklist
Additional context
This implementation adds a new field
publishedMessageEndpointand modifies thehandleSseConnectionmethod to use this published endpoint when communicating with clients. All existing constructors are preserved, maintaining backward compatibility.