Skip to content

Fixed missing space after colon in fields in compliance with SEE specs #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AmiZya wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed missing space after colon in fields in compliance with SEE specs #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions sse-encoder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ var fieldReplacer = strings.NewReplacer(
"\r", "\\r")

var dataReplacer = strings.NewReplacer(
"\n", "\ndata:",
"\n", "\ndata: ",
"\r", "\\r")

type Event struct {
Event string
Event string `default:"message"`
Id string
Retry uint
Data interface{}
Expand All @@ -50,30 +50,30 @@ func Encode(writer io.Writer, event Event) error {

func writeId(w stringWriter, id string) {
if len(id) > 0 {
_, _ = w.WriteString("id:")
_, _ = w.WriteString("id: ")
_, _ = fieldReplacer.WriteString(w, id)
_, _ = w.WriteString("\n")
}
}

func writeEvent(w stringWriter, event string) {
if len(event) > 0 {
_, _ = w.WriteString("event:")
_, _ = w.WriteString("event: ")
_, _ = fieldReplacer.WriteString(w, event)
_, _ = w.WriteString("\n")
}
}

func writeRetry(w stringWriter, retry uint) {
if retry > 0 {
_, _ = w.WriteString("retry:")
_, _ = w.WriteString("retry: ")
_, _ = w.WriteString(strconv.FormatUint(uint64(retry), 10))
_, _ = w.WriteString("\n")
}
}

func writeData(w stringWriter, data interface{}) error {
_, _ = w.WriteString("data:")
_, _ = w.WriteString("data: ")

bData, ok := data.([]byte)
if ok {
Expand Down
62 changes: 31 additions & 31 deletions sse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ func TestEncodeOnlyData(t *testing.T) {
err := Encode(w, event)
assert.NoError(t, err)
assert.Equal(t, w.String(),
`data:junk
data:
data:jk
data:id:fake
`data: junk
data:
data: jk
data: id:fake

`)

Expand All @@ -41,11 +41,11 @@ func TestEncodeWithEvent(t *testing.T) {
err := Encode(w, event)
assert.NoError(t, err)
assert.Equal(t, w.String(),
`event:t\n:<>\r est
data:junk
data:
data:jk
data:id:fake
`event: t\n:<>\r est
data: junk
data:
data: jk
data: id:fake

`)

Expand All @@ -62,11 +62,11 @@ func TestEncodeWithId(t *testing.T) {
})
assert.NoError(t, err)
assert.Equal(t, w.String(),
`id:t\n:<>\r est
data:junk
data:
data:jk
data:id:fa\rke
`id: t\n:<>\r est
data: junk
data:
data: jk
data: id:fa\rke

`)
}
Expand All @@ -79,12 +79,12 @@ func TestEncodeWithRetry(t *testing.T) {
})
assert.NoError(t, err)
assert.Equal(t, w.String(),
`retry:11
data:junk
data:
data:jk
data:id:fake
data:
`retry: 11
data: junk
data:
data: jk
data: id:fake
data:

`)
}
Expand All @@ -98,7 +98,7 @@ func TestEncodeWithEverything(t *testing.T) {
Data: "some data",
})
assert.NoError(t, err)
assert.Equal(t, w.String(), "id:12345\nevent:abc\nretry:10\ndata:some data\n\n")
assert.Equal(t, w.String(), "id: 12345\nevent: abc\nretry: 10\ndata: some data\n\n")
}

func TestEncodeMap(t *testing.T) {
Expand All @@ -111,7 +111,7 @@ func TestEncodeMap(t *testing.T) {
},
})
assert.NoError(t, err)
assert.Equal(t, w.String(), "event:a map\ndata:{\"bar\":\"id: 2\",\"foo\":\"b\\n\\rar\"}\n\n")
assert.Equal(t, w.String(), "event: a map\ndata: {\"bar\":\"id: 2\",\"foo\":\"b\\n\\rar\"}\n\n")
}

func TestEncodeSlice(t *testing.T) {
Expand All @@ -121,7 +121,7 @@ func TestEncodeSlice(t *testing.T) {
Data: []interface{}{1, "text", map[string]interface{}{"foo": "bar"}},
})
assert.NoError(t, err)
assert.Equal(t, w.String(), "event:a slice\ndata:[1,\"text\",{\"foo\":\"bar\"}]\n\n")
assert.Equal(t, w.String(), "event: a slice\ndata: [1,\"text\",{\"foo\":\"bar\"}]\n\n")
}

func TestEncodeStruct(t *testing.T) {
Expand All @@ -136,15 +136,15 @@ func TestEncodeStruct(t *testing.T) {
Data: myStruct,
})
assert.NoError(t, err)
assert.Equal(t, w.String(), "event:a struct\ndata:{\"A\":1,\"value\":\"number\"}\n\n")
assert.Equal(t, w.String(), "event: a struct\ndata: {\"A\":1,\"value\":\"number\"}\n\n")

w.Reset()
err = Encode(w, Event{
Event: "a struct",
Data: &myStruct,
})
assert.NoError(t, err)
assert.Equal(t, w.String(), "event:a struct\ndata:{\"A\":1,\"value\":\"number\"}\n\n")
assert.Equal(t, w.String(), "event: a struct\ndata: {\"A\":1,\"value\":\"number\"}\n\n")
}

func TestEncodeInteger(t *testing.T) {
Expand All @@ -154,7 +154,7 @@ func TestEncodeInteger(t *testing.T) {
Data: 1,
})
assert.NoError(t, err)
assert.Equal(t, w.String(), "event:an integer\ndata:1\n\n")
assert.Equal(t, w.String(), "event: an integer\ndata: 1\n\n")
}

func TestEncodeFloat(t *testing.T) {
Expand All @@ -164,7 +164,7 @@ func TestEncodeFloat(t *testing.T) {
Data: 1.5,
})
assert.NoError(t, err)
assert.Equal(t, w.String(), "event:Float\ndata:1.5\n\n")
assert.Equal(t, w.String(), "event: Float\ndata: 1.5\n\n")
}

func TestEncodeStream(t *testing.T) {
Expand All @@ -186,9 +186,9 @@ func TestEncodeStream(t *testing.T) {
Data: "hi! dude",
})
assert.Equal(t, w.String(),
"event:float\ndata:1.5\n\n"+
"id:123\ndata:{\"bar\":\"foo\",\"foo\":\"bar\"}\n\n"+
"id:124\nevent:chat\ndata:hi! dude\n\n")
"event: float\ndata: 1.5\n\n"+
"id: 123\ndata: {\"bar\":\"foo\",\"foo\":\"bar\"}\n\n"+
"id: 124\nevent: chat\ndata: hi! dude\n\n")
}

func TestRenderSSE(t *testing.T) {
Expand All @@ -200,7 +200,7 @@ func TestRenderSSE(t *testing.T) {
}).Render(w)

assert.NoError(t, err)
assert.Equal(t, w.Body.String(), "event:msg\ndata:hi! how are you?\n\n")
assert.Equal(t, w.Body.String(), "event: msg\ndata: hi! how are you?\n\n")
assert.Equal(t, w.Header().Get("Content-Type"), "text/event-stream;charset=utf-8")
assert.Equal(t, w.Header().Get("Cache-Control"), "no-cache")
}
Expand Down