Support for statically compressed gzip content-encoding

Related to #12 (closed), this MR enables serving precompressed gzip content in GitLab Pages.

To use it, static files that are to be served compressed must be present at the same location as the uncompressed file, with the extension .gz. The uncompressed file must remain present so that:

• HTTP clients that do not nominate an Accept-Encoding of gzip can still receive the content,
• Range requests continue to work, by serving the sliced uncompressed content (otherwise the daemon would need to recompress on the fly),
• The daemon can auto-detect the difference between the compressed variant and, for example, a .tar.gz file which should not have the Content-Encoding header attached to the response. (Otherwise the browser may decompress and present a .tar file to the user.)

The gzipped content must be placed in the same directory as the uncompressed content. When the latter is a symlink, the gzipped content must be placed at the symlink target directory with the same file basename as the target. For example, if the file index.html is symlinked to content/frontpage.html, then the gzipped content must be located at content/frontpage.html.gz. This is both to co-locate the gzipped content with the uncompressed variant and to simplify the implementation.

Directory index.html files and the /404.html files can also be compressed by having corresponding index.html.gz and /404.html.gz compressed variants.

HTTP HEAD requests continue to work correctly; the Content-Encoding header is also applied as appropriate, so that HTTP clients can know that they may receive compressed content in that case.

I am keen to see this merged and deployed to GitLab Pages so that my (and everyone's) static sites load much faster: HTML, CSS, and JavaScript as you know often compresses with very high ratios. I'm sure GitLab Inc. would enjoy the bandwidth (cost) savings too.

domain.go

@@ -21,8 +21,40 @@ type domain struct {
 	certificateError error
 }
+func acceptsGZip(r *http.Request) bool {
+	if r.Header.Get("Range") == "" {
+		// Note that Accept-Encoding is never tokenized by the Request
+		acceptedEncodings := strings.Split(r.Header.Get("Accept-Encoding"), ",")
+		if len(acceptedEncodings) > 0 {
+			for _, v := range acceptedEncodings {
+				encoding := strings.Trim(v, " \t")
+				if strings.ToLower(encoding) == "gzip" {
+					return true
+				}
+			}
+		}
+	}
+	return false
+}
+
 func (d *domain) serveFile(w http.ResponseWriter, r *http.Request, fullPath string) error {
 	// Open and serve content of file
+	if acceptsGZip(r) {
+		_, err := os.Stat(fullPath + ".gz")
+		if err == nil {
+			// Set the content type based on the non-gzipped extension
+			_, haveType := w.Header()["Content-Type"]
+			if !haveType {
+				ctype := mime.TypeByExtension(filepath.Ext(fullPath))
+				w.Header().Set("Content-Type", ctype)
+			}
+
+			// Serve up the gzipped version
+			fullPath += ".gz"
+			w.Header().Set("Content-Encoding", "gzip")
+		}
+	}
+
 	file, err := os.Open(fullPath)
 	if err != nil {
 		return err
@@ -41,6 +73,15 @@ func (d *domain) serveFile(w http.ResponseWriter, r *http.Request, fullPath stri
 func (d *domain) serveCustomFile(w http.ResponseWriter, r *http.Request, code int, fullPath string) error {
 	// Open and serve content of file
+	ext := filepath.Ext(fullPath)
+	if acceptsGZip(r) {
+		_, err := os.Stat(fullPath + ".gz")
+		if err == nil {
+			// Serve up the gzipped version
+			fullPath += ".gz"
+			w.Header().Set("Content-Encoding", "gzip")
+		}
+	}
 	file, err := os.Open(fullPath)
 	if err != nil {
 		return err
@@ -57,7 +98,7 @@ func (d *domain) serveCustomFile(w http.ResponseWriter, r *http.Request, code in
 	// Serve the file
 	_, haveType := w.Header()["Content-Type"]
 	if !haveType {
-		ctype := mime.TypeByExtension(filepath.Ext(fullPath))
+		ctype := mime.TypeByExtension(ext)
 		w.Header().Set("Content-Type", ctype)
 	}
 	w.Header().Set("Content-Length", strconv.FormatInt(fi.Size(), 10))