Merge pull request #9 from launchdarkly/eb/ch81628/sse-comment

add comment methods to SSEStreamControl

Author: eli-darkly

Makefile

@@ -13,14 +13,12 @@ clean:
 	go clean
 
 test: build
-	@# Note, we need to specify all these packages individually for go test in order to remain 1.8-compatible
-	go test -race -v . ./httphelpers ./ldservices
+	go test -race -v ./...
 
 $(LINTER_VERSION_FILE):
 	rm -f $(LINTER)
 	curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | bash -s $(GOLANGCI_LINT_VERSION)
 	touch $(LINTER_VERSION_FILE)
 
 lint: $(LINTER_VERSION_FILE)
-	go get ./...
 	$(LINTER) run ./...

httphelpers/handlers_sse.go

@@ -41,6 +41,14 @@ type SSEStreamControl interface {
 	// event is sent to all of them. If there are no open connections, the event is discarded.
 	Send(event SSEEvent)
 
+	// EnqueueComment is the same as Enqueue, except that it sends a comment line instead of an
+	// event. A colon is prepended to the comment.
+	EnqueueComment(comment string)
+
+	// SendComment is the same as Send, except that it sends a comment line instead of an event.
+	// A colon is prepended to the comment.
+	SendComment(comment string)
+
 	// EndAll terminates any existing connections to this endpoint, but allows new connections
 	// afterward.
 	EndAll()
@@ -99,6 +107,14 @@ func (s *sseStreamControlImpl) Send(event SSEEvent) {
 	s.streamControl.Send(event.Bytes())
 }
 
+func (s *sseStreamControlImpl) EnqueueComment(comment string) {
+	s.streamControl.Enqueue([]byte(fmt.Sprintf(":%s\n", comment)))
+}
+
+func (s *sseStreamControlImpl) SendComment(comment string) {
+	s.streamControl.Send([]byte(fmt.Sprintf(":%s\n", comment)))
+}
+
 func (s *sseStreamControlImpl) EndAll() {
 	s.streamControl.EndAll()
 }

httphelpers/handlers_sse_test.go

@@ -16,6 +16,7 @@ func TestSSEHandler(t *testing.T) {
 	defer stream.Close()
 
 	stream.Enqueue(SSEEvent{"", "event2", "data2"})
+	stream.EnqueueComment("comment1")
 	stream.Send(SSEEvent{"", "", "this isn't sent becauset here are no connections"})
 
 	WithServer(handler, func(server *httptest.Server) {
@@ -26,6 +27,7 @@ func TestSSEHandler(t *testing.T) {
 		assert.Equal(t, 200, resp1.StatusCode)
 		assert.Equal(t, "text/event-stream; charset=utf-8", resp1.Header.Get("Content-Type"))
 
+		stream.SendComment("comment2")
 		stream.Enqueue(SSEEvent{"", "event3", "data3"})
 		stream.EndAll()
 
@@ -39,6 +41,8 @@ data: data1
 event: event2
 data: data2
 
+:comment1
+:comment2
 event: event3
 data: data3