billmoling opened a new pull request, #12498:
URL: https://github.com/apache/apisix/pull/12498

   ### Description
   
   <!-- Please include a summary of the change and which issue is fixed. -->
   <!-- Please also include relevant motivation and context. -->
   
   ### Motivation
   
   This PR introduces a new `sse` plugin for Apache APISIX that enables support 
for [Server-Sent Events 
(SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events), a 
mechanism for servers to push updates to the browser over a long-lived HTTP 
connection.
   
   SSE requires specific proxy settings and headers to ensure streaming 
behavior works reliably, which are not enabled by default in APISIX. This 
plugin configures those behaviors for routes or services that serve SSE.
   
   ### Features
   
   - ✅ Disables response buffering and request buffering to allow real-time 
data delivery from upstream.
   - ✅ Sets a long `proxy_read_timeout` to prevent SSE connections from being 
cut off.
   - ✅ Sets essential response headers:
     - `Content-Type: text/event-stream; charset=utf-8`
     - `Cache-Control`
     - `Connection`
     - `X-Accel-Buffering`
   - ✅ Supports configuration of `proxy_read_timeout`, `cache_control`, and 
`connection_header`.
   - ✅ Provides optional override of the `Content-Type` header (enabled by 
default).
   - ✅ Adds debug-level logs to help with observability.
   
   
   #### Which issue(s) this PR fixes:
   <!--
   *Automatically closes linked issue when PR is merged.
   Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
   -->
   Fixes #10030 #10204 
   
   ### Checklist
   
   - [x] I have explained the need for this PR and the problem it solves
   - [x] I have explained the changes or the new features added to this PR
   - [x] I have added tests corresponding to this change
   - [x] I have updated the documentation to reflect this change
   - [ ] I have verified that this change is backward compatible (If not, 
please discuss on the [APISIX mailing 
list](https://github.com/apache/apisix/tree/master#community) first)
   
   <!--
   
   Note
   
   1. Mark the PR as draft until it's ready to be reviewed.
   2. Always add/update tests for any changes unless you have a good reason.
   3. Always update the documentation to reflect the changes made in the PR.
   4. Make a new commit to resolve conversations instead of `push -f`.
   5. To resolve merge conflicts, merge master instead of rebasing.
   6. Use "request review" to notify the reviewer after making changes.
   7. Only a reviewer can mark a conversation as resolved.
   
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to