feat(range): mvp support (#653)

* feat(range): mvp support

* feat(cache-tests): mostly pass combining partial content

Author: darkweak

.github/workflows/non-regression.yml

@@ -50,5 +50,5 @@ jobs:
         name: Build the stack
         run: docker compose -f docker-compose.yml.prod up -d --build --force-recreate --remove-orphans
       -
-        name: Souin container healthceck
+        name: Souin container healthcheck
         run: docker compose -f docker-compose.yml.prod exec -T souin ls

pkg/middleware/middleware.go

@@ -14,7 +14,7 @@ import (
 	"sync"
 	"time"
 
-	xxhash "github.com/cespare/xxhash/v2"
+	"github.com/cespare/xxhash/v2"
 	"github.com/darkweak/souin/configurationtypes"
 	"github.com/darkweak/souin/context"
 	"github.com/darkweak/souin/helpers"
@@ -730,7 +730,11 @@ func (s *SouinBaseHandler) ServeHTTP(rw http.ResponseWriter, rq *http.Request, n
 	bufPool := s.bufPool.Get().(*bytes.Buffer)
 	bufPool.Reset()
 	defer s.bufPool.Put(bufPool)
+
 	customWriter := NewCustomWriter(req, rw, bufPool)
+	customWriter.Headers.Add("Range", req.Header.Get("Range"))
+	// req.Header.Del("Range")
+
 	go func(req *http.Request, crw *CustomWriter) {
 		<-req.Context().Done()
 		crw.mutex.Lock()

pkg/middleware/writer.go

@@ -2,8 +2,10 @@ package middleware
 
 import (
 	"bytes"
+	"fmt"
 	"net/http"
 	"strconv"
+	"strings"
 	"sync"
 
 	"github.com/darkweak/go-esi/esi"
@@ -85,6 +87,59 @@ func (r *CustomWriter) Write(b []byte) (int, error) {
 	return len(b), nil
 }
 
+type rangeValue struct {
+	from, to int64
+}
+
+const separator = "--SOUIN-HTTP-CACHE-SEPARATOR"
+
+func parseRange(rangeHeaders []string, contentRange string) ([]rangeValue, rangeValue, int64) {
+	if len(rangeHeaders) == 0 {
+		return nil, rangeValue{}, -1
+	}
+
+	crv := rangeValue{from: 0, to: 0}
+	var total int64 = -1
+	if contentRange != "" {
+		crVal := strings.Split(strings.TrimPrefix(contentRange, "bytes "), "/")
+		total, _ = strconv.ParseInt(crVal[1], 10, 64)
+		total--
+
+		crSplit := strings.Split(crVal[0], "-")
+		crv.from, _ = strconv.ParseInt(crSplit[0], 10, 64)
+		crv.to, _ = strconv.ParseInt(crSplit[1], 10, 64)
+	}
+
+	values := make([]rangeValue, len(rangeHeaders))
+
+	for idx, header := range rangeHeaders {
+		ranges := strings.Split(header, "-")
+		rv := rangeValue{from: -1, to: total}
+
+		// e.g. Range: -5
+		if len(ranges) == 2 && ranges[0] == "" {
+			ranges[0] = "-" + ranges[1]
+			from, _ := strconv.ParseInt(ranges[0], 10, 64)
+			rv.from = total + from
+
+			values[idx] = rv
+
+			continue
+		}
+
+		rv.from, _ = strconv.ParseInt(ranges[0], 10, 64)
+
+		if ranges[1] != "" {
+			rv.to, _ = strconv.ParseInt(ranges[1], 10, 64)
+			rv.to++
+		}
+
+		values[idx] = rv
+	}
+
+	return values, crv, total + 1
+}
+
 // Send delays the response to handle Cache-Status
 func (r *CustomWriter) Send() (int, error) {
 	defer r.handleBuffer(func(b *bytes.Buffer) {
@@ -94,10 +149,72 @@ func (r *CustomWriter) Send() (int, error) {
 	if storedLength != "" {
 		r.Header().Set("Content-Length", storedLength)
 	}
-	b := esi.Parse(r.Buf.Bytes(), r.Req)
-	if len(b) != 0 {
-		r.Header().Set("Content-Length", strconv.Itoa(len(b)))
+
+	result := r.Buf.Bytes()
+
+	result = esi.Parse(result, r.Req)
+
+	if r.Headers.Get("Range") != "" {
+
+		var bufStr string
+		mimeType := r.Header().Get("Content-Type")
+
+		r.WriteHeader(http.StatusPartialContent)
+
+		rangeHeader, contentRangeValue, total := parseRange(
+			strings.Split(strings.TrimPrefix(r.Headers.Get("Range"), "bytes="), ", "),
+			r.Header().Get("Content-Range"),
+		)
+		bodyBytes := r.Buf.Bytes()
+		bufLen := int64(r.Buf.Len())
+		if total > 0 {
+			bufLen = total
+		}
+
+		if len(rangeHeader) == 1 {
+			header := rangeHeader[0]
+			internalFrom := (header.from - contentRangeValue.from) % bufLen
+			internalTo := (header.to - contentRangeValue.from) % bufLen
+
+			content := bodyBytes[internalFrom:]
+
+			r.Header().Set("Content-Range", fmt.Sprintf("bytes %d-%d/%d", contentRangeValue.from, contentRangeValue.to, bufLen))
+
+			if internalTo >= 0 {
+				content = content[:internalTo-internalFrom]
+				r.Header().Set("Content-Range", fmt.Sprintf("bytes %d-%d/%d", header.from, header.to, bufLen))
+			}
+
+			result = content
+		}
+
+		if len(rangeHeader) > 1 {
+			r.Header().Set("Content-Type", "multipart/byteranges; boundary="+separator)
+
+			for _, header := range rangeHeader {
+
+				content := bodyBytes[header.from:]
+				if header.to >= 0 {
+					content = content[:header.to-header.from]
+				}
+
+				bufStr += fmt.Sprintf(`
+%s
+Content-Type: %s
+Content-Range: bytes %d-%d/%d
+
+%s
+`, separator, mimeType, header.from, header.to, r.Buf.Len(), content)
+			}
+
+			result = []byte(bufStr + separator + "--")
+		}
+	}
+
+	if len(result) != 0 {
+		r.Header().Set("Content-Length", strconv.Itoa(len(result)))
 	}
+
 	r.Header().Del(rfc.StoredLengthHeader)
 	r.Header().Del(rfc.StoredTTLHeader)
 
@@ -106,5 +223,5 @@ func (r *CustomWriter) Send() (int, error) {
 		r.headersSent = true
 	}
 
-	return r.Rw.Write(b)
+	return r.Rw.Write(result)
 }

plugins/caddy/httpcache_test.go

@@ -1504,3 +1504,72 @@ func TestAPIPlatformInvalidation(t *testing.T) {
 		t.Errorf("unexpected list %#v", items)
 	}
 }
+
+func TestRange(t *testing.T) {
+	tester := caddytest.NewTester(t)
+	tester.InitServer(`
+	{
+		debug
+		admin localhost:2999
+		http_port     9080
+		cache {
+			api {
+				souin
+			}
+		}
+	}
+	localhost:9080 {
+		route /range-request {
+			cache
+
+			respond "Hello range-request!"
+		}
+	}`, "caddyfile")
+
+	reqRange, _ := http.NewRequest(http.MethodGet, "http://localhost:9080/range-request", nil)
+	reqRange.Header.Set("Range", "bytes=0-4, 6-10")
+
+	resp1, _ := tester.AssertResponse(reqRange, http.StatusPartialContent, `
+--SOUIN-HTTP-CACHE-SEPARATOR
+Content-Type: text/plain; charset=utf-8
+Content-Range: bytes 0-5/20
+
+Hello
+
+--SOUIN-HTTP-CACHE-SEPARATOR
+Content-Type: text/plain; charset=utf-8
+Content-Range: bytes 6-11/20
+
+range
+--SOUIN-HTTP-CACHE-SEPARATOR--`)
+
+	if resp1.Header.Get("Cache-Status") != "Souin; fwd=uri-miss; stored; key=GET-http-localhost:9080-/range-request" {
+		t.Errorf("unexpected resp1 Cache-Status header %v", resp1.Header.Get("Cache-Status"))
+	}
+
+	if resp1.Header.Get("Age") != "" {
+		t.Errorf("unexpected resp1 Age header %v", resp1.Header.Get("Age"))
+	}
+
+	resp2, _ := tester.AssertResponse(reqRange, http.StatusPartialContent, `
+--SOUIN-HTTP-CACHE-SEPARATOR
+Content-Type: text/plain; charset=utf-8
+Content-Range: bytes 0-5/20
+
+Hello
+
+--SOUIN-HTTP-CACHE-SEPARATOR
+Content-Type: text/plain; charset=utf-8
+Content-Range: bytes 6-11/20
+
+range
+--SOUIN-HTTP-CACHE-SEPARATOR--`)
+
+	if resp2.Header.Get("Cache-Status") != "Souin; hit; ttl=119; key=GET-http-localhost:9080-/range-request; detail=DEFAULT" {
+		t.Errorf("unexpected resp2 Cache-Status header %v", resp2.Header.Get("Cache-Status"))
+	}
+
+	if resp2.Header.Get("Age") != "1" {
+		t.Errorf("unexpected resp2 Age header %v", resp2.Header.Get("Age"))
+	}
+}