caddy/caddyhttp/push/handler_test.go

// Copyright 2015 Light Code Labs, LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package push

import (
	"errors"
	"io/ioutil"
	"net/http"
	"net/http/httptest"
	"os"
	"path/filepath"
	"reflect"
	"testing"

	"github.com/mholt/caddy/caddyhttp/httpserver"
)

type MockedPusher struct {
	http.ResponseWriter
	pushed        map[string]*http.PushOptions
	returnedError error
}

func (w *MockedPusher) Push(target string, options *http.PushOptions) error {
	if w.pushed == nil {
		w.pushed = make(map[string]*http.PushOptions)
	}

	w.pushed[target] = options
	return w.returnedError
}

func TestMiddlewareWillPushResources(t *testing.T) {

	// given
	request, err := http.NewRequest(http.MethodGet, "/index.html", nil)
	writer := httptest.NewRecorder()

	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			return 0, nil
		}),
		Rules: []Rule{
			{Path: "/index.html", Resources: []Resource{
				{Path: "/index.css", Method: http.MethodHead, Header: http.Header{"Test": []string{"Value"}}},
				{Path: "/index2.css", Method: http.MethodGet},
			}},
		},
	}

	pushingWriter := &MockedPusher{ResponseWriter: writer}

	// when
	middleware.ServeHTTP(pushingWriter, request)

	// then
	expectedPushedResources := map[string]*http.PushOptions{
		"/index.css": {
			Method: http.MethodHead,
			Header: http.Header{"Test": []string{"Value"}},
		},

		"/index2.css": {
			Method: http.MethodGet,
			Header: http.Header{},
		},
	}

	comparePushedResources(t, expectedPushedResources, pushingWriter.pushed)
}

func TestMiddlewareWillPushResourcesWithMergedHeaders(t *testing.T) {

	// given
	request, err := http.NewRequest(http.MethodGet, "/index.html", nil)
	request.Header = http.Header{"Accept-Encoding": []string{"br"}, "Invalid-Header": []string{"Should be filter out"}}
	writer := httptest.NewRecorder()

	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			return 0, nil
		}),
		Rules: []Rule{
			{Path: "/index.html", Resources: []Resource{
				{Path: "/index.css", Method: http.MethodHead, Header: http.Header{"Test": []string{"Value"}}},
				{Path: "/index2.css", Method: http.MethodGet},
			}},
		},
	}

	pushingWriter := &MockedPusher{ResponseWriter: writer}

	// when
	middleware.ServeHTTP(pushingWriter, request)

	// then
	expectedPushedResources := map[string]*http.PushOptions{
		"/index.css": {
			Method: http.MethodHead,
			Header: http.Header{"Test": []string{"Value"}, "Accept-Encoding": []string{"br"}},
		},

		"/index2.css": {
			Method: http.MethodGet,
			Header: http.Header{"Accept-Encoding": []string{"br"}},
		},
	}

	comparePushedResources(t, expectedPushedResources, pushingWriter.pushed)
}

func TestMiddlewareShouldntDoRecursivePush(t *testing.T) {

	// given
	request, err := http.NewRequest(http.MethodGet, "/index.css", nil)
	request.Header.Add(pushHeader, "")

	writer := httptest.NewRecorder()

	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			return 0, nil
		}),
		Rules: []Rule{
			{Path: "/", Resources: []Resource{
				{Path: "/index.css", Method: http.MethodHead, Header: http.Header{"Test": []string{"Value"}}},
				{Path: "/index2.css", Method: http.MethodGet},
			}},
		},
	}

	pushingWriter := &MockedPusher{ResponseWriter: writer}

	// when
	middleware.ServeHTTP(pushingWriter, request)

	// then
	if len(pushingWriter.pushed) > 0 {
		t.Errorf("Expected 0 pushed resources, actual %d", len(pushingWriter.pushed))
	}
}

func TestMiddlewareShouldStopPushingOnError(t *testing.T) {

	// given
	request, err := http.NewRequest(http.MethodGet, "/index.html", nil)
	writer := httptest.NewRecorder()

	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			return 0, nil
		}),
		Rules: []Rule{
			{Path: "/index.html", Resources: []Resource{
				{Path: "/only.css", Method: http.MethodHead, Header: http.Header{"Test": []string{"Value"}}},
				{Path: "/index2.css", Method: http.MethodGet},
				{Path: "/index3.css", Method: http.MethodGet},
			}},
		},
	}

	pushingWriter := &MockedPusher{ResponseWriter: writer, returnedError: errors.New("Cannot push right now")}

	// when
	middleware.ServeHTTP(pushingWriter, request)

	// then
	expectedPushedResources := map[string]*http.PushOptions{
		"/only.css": {
			Method: http.MethodHead,
			Header: http.Header{"Test": []string{"Value"}},
		},
	}

	comparePushedResources(t, expectedPushedResources, pushingWriter.pushed)
}

func TestMiddlewareWillNotPushResources(t *testing.T) {
	// given
	request, err := http.NewRequest(http.MethodGet, "/index.html", nil)

	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			return 0, nil
		}),
		Rules: []Rule{
			{Path: "/index.html", Resources: []Resource{
				{Path: "/index.css", Method: http.MethodHead, Header: http.Header{"Test": []string{"Value"}}},
				{Path: "/index2.css", Method: http.MethodGet},
			}},
		},
	}

	writer := httptest.NewRecorder()

	// when
	_, err2 := middleware.ServeHTTP(writer, request)

	// then
	if err2 != nil {
		t.Error("Should not return error")
	}
}

func TestMiddlewareShouldInterceptLinkHeader(t *testing.T) {
	// given
	request, err := http.NewRequest(http.MethodGet, "/index.html", nil)
	writer := httptest.NewRecorder()

	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			w.Header().Add("Link", "</index.css>; rel=preload; as=stylesheet;")
			w.Header().Add("Link", "</index2.css>; rel=preload; as=stylesheet;")
			w.Header().Add("Link", "")
			w.Header().Add("Link", "</index3.css>")
			w.Header().Add("Link", "</index4.css>; rel=preload; nopush")
			return 0, nil
		}),
		Rules: []Rule{},
	}

	pushingWriter := &MockedPusher{ResponseWriter: writer}

	// when
	_, err2 := middleware.ServeHTTP(pushingWriter, request)

	// then
	if err2 != nil {
		t.Error("Should not return error")
	}

	expectedPushedResources := map[string]*http.PushOptions{
		"/index.css": {
			Method: http.MethodGet,
			Header: http.Header{},
		},
		"/index2.css": {
			Method: http.MethodGet,
			Header: http.Header{},
		},
		"/index3.css": {
			Method: http.MethodGet,
			Header: http.Header{},
		},
	}

	comparePushedResources(t, expectedPushedResources, pushingWriter.pushed)
}

func TestMiddlewareShouldInterceptLinkHeaderWithMultipleResources(t *testing.T) {
	// given
	request, err := http.NewRequest(http.MethodGet, "/index.html", nil)
	writer := httptest.NewRecorder()

	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			w.Header().Add("Link", "</assets/css/screen.css?v=5fc240c512>; rel=preload; as=style,</content/images/2016/06/Timeouts-001.png>; rel=preload; as=image,</content/images/2016/06/Timeouts-002.png>; rel=preload; as=image")
			w.Header().Add("Link", "<//cdn.bizible.com/scripts/bizible.js>; rel=preload; as=script,</resource.png>; rel=preload; as=script; nopush")
			return 0, nil
		}),
		Rules: []Rule{},
	}

	pushingWriter := &MockedPusher{ResponseWriter: writer}

	// when
	_, err2 := middleware.ServeHTTP(pushingWriter, request)

	// then
	if err2 != nil {
		t.Error("Should not return error")
	}

	expectedPushedResources := map[string]*http.PushOptions{
		"/assets/css/screen.css?v=5fc240c512": {
			Method: http.MethodGet,
			Header: http.Header{},
		},
		"/content/images/2016/06/Timeouts-001.png": {
			Method: http.MethodGet,
			Header: http.Header{},
		},
		"/content/images/2016/06/Timeouts-002.png": {
			Method: http.MethodGet,
			Header: http.Header{},
		},
	}

	comparePushedResources(t, expectedPushedResources, pushingWriter.pushed)
}

func TestMiddlewareShouldInterceptLinkHeaderPusherError(t *testing.T) {
	// given
	expectedHeaders := http.Header{"Accept-Encoding": []string{"br"}}
	request, err := http.NewRequest(http.MethodGet, "/index.html", nil)
	request.Header = http.Header{"Accept-Encoding": []string{"br"}, "Invalid-Header": []string{"Should be filter out"}}

	writer := httptest.NewRecorder()

	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			w.Header().Add("Link", "</index.css>; rel=preload; as=stylesheet;")
			w.Header().Add("Link", "</index2.css>; rel=preload; as=stylesheet;")
			return 0, nil
		}),
		Rules: []Rule{},
	}

	pushingWriter := &MockedPusher{ResponseWriter: writer, returnedError: errors.New("Cannot push right now")}

	// when
	_, err2 := middleware.ServeHTTP(pushingWriter, request)

	// then
	if err2 != nil {
		t.Error("Should not return error")
	}

	expectedPushedResources := map[string]*http.PushOptions{
		"/index.css": {
			Method: http.MethodGet,
			Header: expectedHeaders,
		},
	}

	comparePushedResources(t, expectedPushedResources, pushingWriter.pushed)
}

func TestMiddlewareShouldPushIndexFile(t *testing.T) {
	// given
	indexFile := "/index.html"
	request, err := http.NewRequest(http.MethodGet, "/", nil) // Request root directory, not indexfile itself
	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	root, err := ioutil.TempDir("", "caddy")
	if err != nil {
		t.Fatalf("Could not create temporary directory: %v", err)
	}
	defer os.Remove(root)

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			return 0, nil
		}),
		Rules: []Rule{
			{Path: indexFile, Resources: []Resource{
				{Path: "/index.css", Method: http.MethodGet},
			}},
		},
		Root:       http.Dir(root),
		indexPages: []string{indexFile},
	}

	indexFilePath := filepath.Join(root, indexFile)
	_, err = os.Create(indexFilePath)
	if err != nil {
		t.Fatalf("Could not create index file: %s: %v", indexFile, err)
	}
	defer os.Remove(indexFilePath)

	pushingWriter := &MockedPusher{
		ResponseWriter: httptest.NewRecorder(),
		returnedError:  errors.New("Cannot push right now"),
	}

	// when
	_, err2 := middleware.ServeHTTP(pushingWriter, request)

	// then
	if err2 != nil {
		t.Error("Should not return error")
	}

	expectedPushedResources := map[string]*http.PushOptions{
		"/index.css": {
			Method: http.MethodGet,
			Header: http.Header{},
		},
	}

	comparePushedResources(t, expectedPushedResources, pushingWriter.pushed)
}

func TestMiddlewareShouldNotPushIndexFileWhenNotARule(t *testing.T) {
	// given
	indexFile := "/index.html"
	request, err := http.NewRequest(http.MethodGet, "/", nil) // Request root directory, not indexfile itself
	if err != nil {
		t.Fatalf("Could not create HTTP request: %v", err)
	}

	root, err := ioutil.TempDir("", "caddy")
	if err != nil {
		t.Fatalf("Could not create temporary directory: %v", err)
	}
	defer os.Remove(root)

	middleware := Middleware{
		Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
			return 0, nil
		}),
		Rules: []Rule{
			{Path: "dummy.html", Resources: []Resource{
				{Path: "/index.css", Method: http.MethodGet},
			}}},
		Root: http.Dir(root),
	}

	indexFilePath := filepath.Join(root, indexFile)
	_, err = os.Create(indexFilePath)
	if err != nil {
		t.Fatalf("Could not create index file: %s: %v", indexFile, err)
	}
	defer os.Remove(indexFilePath)

	pushingWriter := &MockedPusher{
		ResponseWriter: httptest.NewRecorder(),
		returnedError:  errors.New("Cannot push right now"),
	}

	// when
	_, err2 := middleware.ServeHTTP(pushingWriter, request)

	// then
	if err2 != nil {
		t.Error("Should not return error")
	}

	expectedPushedResources := map[string]*http.PushOptions{}

	comparePushedResources(t, expectedPushedResources, pushingWriter.pushed)
}

func comparePushedResources(t *testing.T, expected, actual map[string]*http.PushOptions) {
	if len(expected) != len(actual) {
		t.Errorf("Expected %d pushed resources, actual: %d", len(expected), len(actual))
	}

	for target, expectedTarget := range expected {
		if actualTarget, exists := actual[target]; exists {

			if expectedTarget.Method != actualTarget.Method {
				t.Errorf("Expected %s resource method to be %s, actual: %s", target, expectedTarget.Method, actualTarget.Method)
			}

			if !reflect.DeepEqual(expectedTarget.Header, actualTarget.Header) {
				t.Errorf("Expected %s resource push headers to be %+v, actual: %+v", target, expectedTarget.Header, actualTarget.Header)
			}
		} else {
			t.Errorf("Expected %s to be pushed", target)
		}
	}
}