Skip to content

Commit

Permalink
Add space between SSE field and value for compatibility (#2149)
Browse files Browse the repository at this point in the history
Co-authored-by: David Pedersen <david.pdrsn@gmail.com>
  • Loading branch information
ttys3 and davidpdrsn committed Sep 16, 2023
1 parent 92ecbfc commit 0b7bf4b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
2 changes: 2 additions & 0 deletions axum/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
# Unreleased

- **added:** Implement `IntoResponse` for `(R,) where R: IntoResponse` ([#2143])
- **changed:** For SSE, add space between field and value for compatibility ([#2149])

[#2143]: https://github.com/tokio-rs/axum/pull/2143
[#2149]: https://github.com/tokio-rs/axum/pull/2149

# 0.6.20 (03. August, 2023)

Expand Down
15 changes: 6 additions & 9 deletions axum/src/response/sse.rs
Original file line number Diff line number Diff line change
Expand Up @@ -171,9 +171,9 @@ pub struct Event {
}

impl Event {
/// Set the event's data data field(s) (`data:<content>`)
/// Set the event's data data field(s) (`data: <content>`)
///
/// Newlines in `data` will automatically be broken across `data:` fields.
/// Newlines in `data` will automatically be broken across `data: ` fields.
///
/// This corresponds to [`MessageEvent`'s data field].
///
Expand Down Expand Up @@ -202,7 +202,7 @@ impl Event {
self
}

/// Set the event's data field to a value serialized as unformatted JSON (`data:<content>`).
/// Set the event's data field to a value serialized as unformatted JSON (`data: <content>`).
///
/// This corresponds to [`MessageEvent`'s data field].
///
Expand All @@ -220,7 +220,7 @@ impl Event {
panic!("Called `EventBuilder::json_data` multiple times");
}

self.buffer.extend_from_slice(b"data:");
self.buffer.extend_from_slice(b"data: ");
serde_json::to_writer((&mut self.buffer).writer(), &data)?;
self.buffer.put_u8(b'\n');

Expand Down Expand Up @@ -358,10 +358,7 @@ impl Event {
);
self.buffer.extend_from_slice(name.as_bytes());
self.buffer.put_u8(b':');
// Prevent values that start with spaces having that space stripped
if value.starts_with(b" ") {
self.buffer.put_u8(b' ');
}
self.buffer.put_u8(b' ');
self.buffer.extend_from_slice(value);
self.buffer.put_u8(b'\n');
}
Expand Down Expand Up @@ -516,7 +513,7 @@ mod tests {
#[test]
fn leading_space_is_not_stripped() {
let no_leading_space = Event::default().data("\tfoobar");
assert_eq!(&*no_leading_space.finalize(), b"data:\tfoobar\n\n");
assert_eq!(&*no_leading_space.finalize(), b"data: \tfoobar\n\n");

let leading_space = Event::default().data(" foobar");
assert_eq!(&*leading_space.finalize(), b"data: foobar\n\n");
Expand Down

0 comments on commit 0b7bf4b

Please sign in to comment.