Remove extra newline that was written to cf logs output

* This line is necessary in the access log (WriteTo) so they show up  as
distinct lines
* It was redundant in `cf logs` (LogMessage); this was problematic
because it sent extra envelopes through the loggregator system.

Fixes cloudfoundry/routing-release#124
Fixes #202

Co-authored-by: Renee Chu <[email protected]>

Author: 2 people

accesslog/file_and_loggregator_access_logger_test.go

@@ -52,7 +52,7 @@ var _ = Describe("AccessLog", func() {
 				Eventually(ls.SendAppLogCallCount).Should(Equal(1))
 				appID, message, tags := ls.SendAppLogArgsForCall(0)
 				Expect(appID).To(Equal("my_awesome_id"))
-				Expect(message).To(MatchRegexp("^.*foo.bar.*\n"))
+				Expect(message).To(MatchRegexp("^.*foo.bar.*"))
 				Expect(tags).To(BeNil())
 
 				accessLogger.Stop()

accesslog/schema/access_log_record.go

@@ -2,7 +2,6 @@ package schema
 
 import (
 	"bytes"
-	"code.cloudfoundry.org/gorouter/config"
 	"crypto/sha1"
 	"encoding/hex"
 	"fmt"
@@ -12,6 +11,8 @@ import (
 	"strings"
 	"time"
 
+	"code.cloudfoundry.org/gorouter/config"
+
 	"code.cloudfoundry.org/gorouter/route"
 )
 
@@ -203,8 +204,6 @@ func (r *AccessLogRecord) makeRecord() []byte {
 
 	r.addExtraHeaders(b)
 
-	b.WriteByte('\n')
-
 	return b.Bytes()
 }
 
@@ -230,7 +229,11 @@ func redactURI(r AccessLogRecord) string {
 // WriteTo allows the AccessLogRecord to implement the io.WriterTo interface
 func (r *AccessLogRecord) WriteTo(w io.Writer) (int64, error) {
 	bytesWritten, err := w.Write(r.getRecord())
-	return int64(bytesWritten), err
+	if err != nil {
+		return int64(bytesWritten), err
+	}
+	newline, err := w.Write([]byte("\n"))
+	return int64(bytesWritten + newline), err
 }
 
 func (r *AccessLogRecord) SendLog(ls LogSender) {

accesslog/schema/access_log_record_test.go

@@ -2,6 +2,7 @@ package schema_test
 
 import (
 	"bytes"
+
 	"code.cloudfoundry.org/gorouter/accesslog/schema"
 	"code.cloudfoundry.org/gorouter/config"
 	"code.cloudfoundry.org/gorouter/handlers"
@@ -68,7 +69,7 @@ var _ = Describe("AccessLogRecord", func() {
 			Eventually(r).Should(Say(`x_forwarded_proto:"FakeOriginalRequestProto" `))
 			Eventually(r).Should(Say(`vcap_request_id:"abc-123-xyz-pdq" response_time:60.000000 gorouter_time:10.000000 app_id:"FakeApplicationId" `))
 			Eventually(r).Should(Say(`app_index:"3"`))
-			Eventually(r).Should(Say(`x_cf_routererror:"some-router-error"\n`))
+			Eventually(r).Should(Say(`x_cf_routererror:"some-router-error"`))
 		})
 
 		Context("when DisableSourceIPLogging is specified", func() {
@@ -153,7 +154,7 @@ var _ = Describe("AccessLogRecord", func() {
 				Eventually(r).Should(Say(`x_forwarded_proto:"FooOriginalRequestProto" `))
 				Eventually(r).Should(Say(`vcap_request_id:"abc-123-xyz-pdq" response_time:60.000000 gorouter_time:10.000000 app_id:"FakeApplicationId" `))
 				Eventually(r).Should(Say(`app_index:"3"`))
-				Eventually(r).Should(Say(`x_cf_routererror:"some-router-error"\n`))
+				Eventually(r).Should(Say(`x_cf_routererror:"some-router-error"`))
 			})
 		})
 
@@ -181,7 +182,7 @@ var _ = Describe("AccessLogRecord", func() {
 				Eventually(r).Should(Say(`x_forwarded_proto:"-" `))
 				Eventually(r).Should(Say(`vcap_request_id:"-" response_time:"-" gorouter_time:"-" app_id:"FakeApplicationId" `))
 				Eventually(r).Should(Say(`app_index:"-"`))
-				Eventually(r).Should(Say(`x_cf_routererror:"-"\n`))
+				Eventually(r).Should(Say(`x_cf_routererror:"-"`))
 			})
 		})
 
@@ -212,7 +213,7 @@ var _ = Describe("AccessLogRecord", func() {
 				Eventually(r).Should(Say(`x_forwarded_proto:"FakeOriginalRequestProto" `))
 				Eventually(r).Should(Say(`vcap_request_id:"abc-123-xyz-pdq" response_time:60.000000 gorouter_time:10.000000 app_id:"FakeApplicationId" `))
 				Eventually(r).Should(Say(`app_index:"3" x_cf_routererror:"some-router-error" cache_control:"no-cache" accept_encoding:"gzip, deflate" `))
-				Eventually(r).Should(Say(`if_match:"737060cd8c284d8af7ad3082f209582d" doesnt_exist:"-"\n`))
+				Eventually(r).Should(Say(`if_match:"737060cd8c284d8af7ad3082f209582d" doesnt_exist:"-"`))
 			})
 		})
 
@@ -254,7 +255,7 @@ var _ = Describe("AccessLogRecord", func() {
 				Eventually(r).Should(Say(`x_forwarded_proto:"FakeOriginalRequestProto" `))
 				Eventually(r).Should(Say(`vcap_request_id:"abc-123-xyz-pdq" response_time:60.000000 gorouter_time:10.000000 app_id:"FakeApplicationId" `))
 				Eventually(r).Should(Say(`app_index:"3"`))
-				Eventually(r).Should(Say(`x_cf_routererror:"-"\n`))
+				Eventually(r).Should(Say(`x_cf_routererror:"-"`))
 			})
 		})
 	})