Merge pull request #174 from buechele/compression-content-range

Fixing compression issue if content-range header is present

CHANGELOG.md

@@ -9,6 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+## [1.4.2] - 2024-07-16
+
+### Changed
+
+- Prevent compression if Content-Range header is present.
+- Fix bug which leads to a missing Content-Length header.
+
 ## [1.4.1] - 2024-05-09
 
 ### Changed

compression_handler.go

@@ -5,6 +5,7 @@ import (
 	"compress/gzip"
 	"io"
 	"net/http"
+	"strings"
 
 	abstractions "github.com/microsoft/kiota-abstractions-go"
 	"go.opentelemetry.io/otel"
@@ -35,7 +36,7 @@ func NewCompressionHandler() *CompressionHandler {
 	return NewCompressionHandlerWithOptions(options)
 }
 
-// NewCompressionHandlerWithOptions creates an instance of the compression middlerware with
+// NewCompressionHandlerWithOptions creates an instance of the compression middleware with
 // specified configurations.
 func NewCompressionHandlerWithOptions(option CompressionOptions) *CompressionHandler {
 	return &CompressionHandler{options: option}
@@ -74,7 +75,7 @@ func (c *CompressionHandler) Intercept(pipeline Pipeline, middlewareIndex int, r
 		req = req.WithContext(ctx)
 	}
 
-	if !reqOption.ShouldCompress() || req.Body == nil {
+	if !reqOption.ShouldCompress() || contentRangeBytesIsPresent(req.Header) || req.Body == nil {
 		return pipeline.Next(req, middlewareIndex)
 	}
 	if span != nil {
@@ -129,6 +130,16 @@ func (c *CompressionHandler) Intercept(pipeline Pipeline, middlewareIndex int, r
 	return resp, nil
 }
 
+func contentRangeBytesIsPresent(header http.Header) bool {
+	contentRanges, _ := header["Content-Range"]
+	for _, contentRange := range contentRanges {
+		if strings.Contains(strings.ToLower(contentRange), "bytes") {
+			return true
+		}
+	}
+	return false
+}
+
 func compressReqBody(reqBody []byte) (io.ReadCloser, int, error) {
 	var buffer bytes.Buffer
 	gzipWriter := gzip.NewWriter(&buffer)

compression_handler_test.go

@@ -42,7 +42,7 @@ func TestCompressionHandlerAddsContentEncodingHeader(t *testing.T) {
 	assert.Equal(t, contentTypeHeader, "gzip")
 }
 
-func TestCopmressionHandlerCopmressesRequestBody(t *testing.T) {
+func TestCompressionHandlerCompressesRequestBody(t *testing.T) {
 	postBody, _ := json.Marshal(map[string]string{"name": `Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.a line in section 1.10.32.
     `, "email": "[email protected]"})
 	var compressedBody []byte
@@ -59,6 +59,24 @@ func TestCopmressionHandlerCopmressesRequestBody(t *testing.T) {
 
 }
 
+func TestCompressionHandlerContentRangeRequestBody(t *testing.T) {
+	postBody, _ := json.Marshal(map[string]string{"name": `Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.a line in section 1.10.32.
+    `, "email": "[email protected]"})
+	var compressedBody []byte
+	testServer := httptest.NewServer(nethttp.HandlerFunc(func(res nethttp.ResponseWriter, req *nethttp.Request) {
+		compressedBody, _ = io.ReadAll(req.Body)
+		fmt.Fprint(res, `{}`)
+	}))
+	defer testServer.Close()
+
+	client := GetDefaultClient(NewCompressionHandler())
+	req, _ := nethttp.NewRequest("PUT", testServer.URL, bytes.NewBuffer(postBody))
+	req.Header.Add("Content-Range", "bytes 0-3/4")
+	client.Do(req)
+
+	assert.Equal(t, len(postBody), len(compressedBody))
+}
+
 func TestCompressionHandlerRetriesRequest(t *testing.T) {
 	postBody, _ := json.Marshal(map[string]string{"name": "Test", "email": "[email protected]"})
 	status := 415

nethttp_request_adapter.go

@@ -295,6 +295,7 @@ func (a *NetHttpRequestAdapter) getRequestFromRequestInformation(ctx context.Con
 		}
 		if request.Header.Get("Content-Length") != "" {
 			contentLenVal, _ := strconv.Atoi(request.Header.Get("Content-Length"))
+			request.ContentLength = int64(contentLenVal)
 			spanForAttributes.SetAttributes(
 				attribute.Int("http.request_content_length", contentLenVal),
 			)