curly_test.go

package restful

import (
	"io"
	"net/http"
	"regexp"
	"sync"
	"testing"
)

var requestPaths = []struct {
	// url with path (1) is handled by service with root (2) and remainder has value final (3)
	path, root string
}{
	{"/", "/"},
	{"/p", "/p"},
	{"/p/x", "/p/{q}"},
	{"/q/x", "/q"},
	{"/p/x/", "/p/{q}"},
	{"/p/x/y", "/p/{q}"},
	{"/q/x/y", "/q"},
	{"/z/q", "/{p}/q"},
	{"/a/b/c/q", "/"},
}

// go test -v -test.run TestCurlyDetectWebService ...restful
func TestCurlyDetectWebService(t *testing.T) {
	ws1 := new(WebService).Path("/")
	ws2 := new(WebService).Path("/p")
	ws3 := new(WebService).Path("/q")
	ws4 := new(WebService).Path("/p/q")
	ws5 := new(WebService).Path("/p/{q}")
	ws7 := new(WebService).Path("/{p}/q")
	var wss = []*WebService{ws1, ws2, ws3, ws4, ws5, ws7}

	for _, each := range wss {
		t.Logf("path=%s,toks=%v\n", each.pathExpr.Source, each.pathExpr.tokens)
	}

	router := CurlyRouter{}

	ok := true
	for i, fixture := range requestPaths {
		requestTokens := tokenizePath(fixture.path)
		who := router.detectWebService(requestTokens, wss)
		if who != nil && who.RootPath() != fixture.root {
			t.Logf("[line:%v] Unexpected dispatcher, expected:%v, actual:%v", i, fixture.root, who.RootPath())
			ok = false
		}
	}
	if !ok {
		t.Fail()
	}
}

var serviceDetects = []struct {
	path  string
	found bool
	root  string
}{
	{"/a/b", true, "/{p}/{q}/{r}"},
	{"/p/q", true, "/p/q"},
	{"/q/p", true, "/q"},
	{"/", true, "/"},
	{"/p/q/r", true, "/p/q"},
}

// go test -v -test.run Test_detectWebService ...restful
func Test_detectWebService(t *testing.T) {
	router := CurlyRouter{}
	ws1 := new(WebService).Path("/")
	ws2 := new(WebService).Path("/p")
	ws3 := new(WebService).Path("/q")
	ws4 := new(WebService).Path("/p/q")
	ws5 := new(WebService).Path("/p/{q}")
	ws6 := new(WebService).Path("/p/{q}/")
	ws7 := new(WebService).Path("/{p}/q")
	ws8 := new(WebService).Path("/{p}/{q}/{r}")
	var wss = []*WebService{ws8, ws7, ws6, ws5, ws4, ws3, ws2, ws1}
	for _, fix := range serviceDetects {
		requestPath := fix.path
		requestTokens := tokenizePath(requestPath)
		for _, ws := range wss {
			serviceTokens := ws.pathExpr.tokens
			matches, score := router.computeWebserviceScore(requestTokens, serviceTokens)
			t.Logf("req=%s,toks:%v,ws=%s,toks:%v,score=%d,matches=%v", requestPath, requestTokens, ws.RootPath(), serviceTokens, score, matches)
		}
		best := router.detectWebService(requestTokens, wss)
		if best != nil {
			if fix.found {
				t.Logf("best=%s", best.RootPath())
			} else {
				t.Fatalf("should have found:%s", fix.root)
			}
		}
	}
}

func Test_detectWebServiceWithRegexPath(t *testing.T) {
	router := CurlyRouter{}
	holaWS := new(WebService).Path("/{:hola}")
	helloWS := new(WebService).Path("/{:hello}")

	var wss = []*WebService{holaWS, helloWS}

	holaJuanInTokens := tokenizePath("/hola/juan")
	selected := router.detectWebService(holaJuanInTokens, wss)
	if selected != holaWS {
		t.Fatalf("expected holaWS, got %v", selected.rootPath)
	}

	helloJuanInTokens := tokenizePath("/hello/juan")
	selected = router.detectWebService(helloJuanInTokens, wss)
	if selected != helloWS {
		t.Fatalf("expected helloWS, got %v", selected.rootPath)
	}
}

var routeMatchers = []struct {
	route         string
	path          string
	matches       bool
	paramCount    int
	staticCount   int
	hasCustomVerb bool
}{
	// route, request-path
	{"/a", "/a", true, 0, 1, false},
	{"/a", "/b", false, 0, 0, false},
	{"/a", "/b", false, 0, 0, false},
	{"/a/{b}/c/", "/a/2/c", true, 1, 2, false},
	{"/{a}/{b}/{c}/", "/a/b", false, 0, 0, false},
	{"/{x:*}", "/", false, 0, 0, false},
	{"/{x:*}", "/a", true, 1, 0, false},
	{"/{x:*}", "/a/b", true, 1, 0, false},
	{"/a/{x:*}", "/a/b", true, 1, 1, false},
	{"/a/{x:[A-Z][A-Z]}", "/a/ZX", true, 1, 1, false},
	{"/basepath/{resource:*}", "/basepath/some/other/location/test.xml", true, 1, 1, false},
	{"/resources:run", "/resources:run", true, 0, 2, true},
	{"/resources:run", "/user:run", false, 0, 0, true},
	{"/resources:run", "/resources", false, 0, 0, true},
	{"/users/{userId:^prefix-}:start", "/users/prefix-}:startUserId", false, 0, 0, true},
	{"/users/{userId:^prefix-}:start", "/users/prefix-userId:start", true, 1, 2, true},
}

// clear && go test -v -test.run Test_matchesRouteByPathTokens ...restful
func Test_matchesRouteByPathTokens(t *testing.T) {
	router := CurlyRouter{}
	for i, each := range routeMatchers {
		routeToks := tokenizePath(each.route)
		reqToks := tokenizePath(each.path)
		matches, pCount, sCount := router.matchesRouteByPathTokens(routeToks, reqToks, each.hasCustomVerb)
		if matches != each.matches {
			t.Fatalf("[%d] unexpected matches outcome route:%s, path:%s, matches:%v", i, each.route, each.path, matches)
		}
		if pCount != each.paramCount {
			t.Fatalf("[%d] unexpected paramCount got:%d want:%d ", i, pCount, each.paramCount)
		}
		if sCount != each.staticCount {
			t.Fatalf("[%d] unexpected staticCount got:%d want:%d ", i, sCount, each.staticCount)
		}
	}
}

// clear && go test -v -test.run TestExtractParameters_Wildcard1 ...restful
func TestExtractParameters_Wildcard1(t *testing.T) {
	params := doExtractParams("/fixed/{var:*}", 2, "/fixed/remainder", t)
	if params["var"] != "remainder" {
		t.Errorf("parameter mismatch var: %s", params["var"])
	}
}

// clear && go test -v -test.run TestExtractParameters_Wildcard2 ...restful
func TestExtractParameters_Wildcard2(t *testing.T) {
	params := doExtractParams("/fixed/{var:*}", 2, "/fixed/remain/der", t)
	if params["var"] != "remain/der" {
		t.Errorf("parameter mismatch var: %s", params["var"])
	}
}

// clear && go test -v -test.run TestExtractParameters_Wildcard3 ...restful
func TestExtractParameters_Wildcard3(t *testing.T) {
	params := doExtractParams("/static/{var:*}", 2, "/static/test/sub/hi.html", t)
	if params["var"] != "test/sub/hi.html" {
		t.Errorf("parameter mismatch var: %s", params["var"])
	}
}

func TestExtractParameters_Wildcard4(t *testing.T) {
	params := doExtractParams("/static/{var:*}/sub", 3, "/static/test/sub", t)
	if params["var"] != "test/sub" {
		t.Errorf("parameter mismatch var: %s", params["var"])
	}
}

// clear && go test -v -test.run TestCurly_ISSUE_34 ...restful
func TestCurly_ISSUE_34(t *testing.T) {
	ws1 := new(WebService).Path("/")
	ws1.Route(ws1.GET("/{type}/{id}").To(curlyDummy))
	ws1.Route(ws1.GET("/network/{id}").To(curlyDummy))
	croutes := CurlyRouter{}.selectRoutes(ws1, tokenizePath("/network/12"))
	if len(croutes) != 2 {
		t.Fatal("expected 2 routes")
	}
	if got, want := croutes[0].route.Path, "/network/{id}"; got != want {
		t.Errorf("got %v want %v", got, want)
	}
}

// clear && go test -v -test.run TestCurly_ISSUE_34_2 ...restful
func TestCurly_ISSUE_34_2(t *testing.T) {
	ws1 := new(WebService)
	ws1.Route(ws1.GET("/network/{id}").To(curlyDummy))
	ws1.Route(ws1.GET("/{type}/{id}").To(curlyDummy))
	croutes := CurlyRouter{}.selectRoutes(ws1, tokenizePath("/network/12"))
	if len(croutes) != 2 {
		t.Fatal("expected 2 routes")
	}
	if got, want := croutes[0].route.Path, "/network/{id}"; got != want {
		t.Errorf("got %v want %v", got, want)
	}
}

// clear && go test -v -test.run TestCurly_JsonHtml ...restful
func TestCurly_JsonHtml(t *testing.T) {
	ws1 := new(WebService)
	ws1.Path("/")
	ws1.Route(ws1.GET("/some.html").To(curlyDummy).Consumes("*/*").Produces("text/html"))
	req, _ := http.NewRequest("GET", "/some.html", nil)
	req.Header.Set("Accept", "application/json")
	_, route, err := CurlyRouter{}.SelectRoute([]*WebService{ws1}, req)
	if err == nil {
		t.Error("error expected")
	}
	if route != nil {
		t.Error("no route expected")
	}
}

// go test -v -test.run TestCurly_ISSUE_137 ...restful
func TestCurly_ISSUE_137(t *testing.T) {
	ws1 := new(WebService)
	ws1.Route(ws1.GET("/hello").To(curlyDummy))
	ws1.Path("/")
	req, _ := http.NewRequest("GET", "/", nil)
	_, route, _ := CurlyRouter{}.SelectRoute([]*WebService{ws1}, req)
	t.Log(route)
	if route != nil {
		t.Error("no route expected")
	}
}

// go test -v -test.run TestCurly_ISSUE_137_2 ...restful
func TestCurly_ISSUE_137_2(t *testing.T) {
	ws1 := new(WebService)
	ws1.Route(ws1.GET("/hello").To(curlyDummy))
	ws1.Path("/")
	req, _ := http.NewRequest("GET", "/hello/bob", nil)
	_, route, _ := CurlyRouter{}.SelectRoute([]*WebService{ws1}, req)
	t.Log(route)
	if route != nil {
		t.Errorf("no route expected, got %v", route)
	}
}

func curlyDummy(req *Request, resp *Response) { io.WriteString(resp.ResponseWriter, "curlyDummy") }

func TestRegexCaching(t *testing.T) {
	// Store original state and enable caching for this test
	originalEnabled := pathTokenCacheEnabled
	defer func() {
		SetPathTokenCacheEnabled(originalEnabled)
	}()
	SetPathTokenCacheEnabled(true)
	
	// Clear cache before test
	regexCache = sync.Map{}
	
	router := CurlyRouter{}
	
	// Test with regex pattern
	routeToken := "{id:[0-9]+}"
	requestToken := "123"
	
	// First call should cache the regex
	matches1, _ := router.regularMatchesPathToken(routeToken, 3, requestToken)
	if !matches1 {
		t.Error("Expected first call to match")
	}
	
	// Verify cache contains the pattern
	pattern := "[0-9]+"
	_, found := regexCache.Load(pattern)
	if !found {
		t.Error("Expected pattern to be cached")
	}
	
	// Second call should use cached regex
	matches2, _ := router.regularMatchesPathToken(routeToken, 3, requestToken)
	if !matches2 {
		t.Error("Expected second call to match using cache")
	}
	
	// Test with different pattern to ensure separate caching
	routeToken2 := "{name:[a-z]+}"
	requestToken2 := "john"
	
	matches3, _ := router.regularMatchesPathToken(routeToken2, 5, requestToken2)
	if !matches3 {
		t.Error("Expected name pattern to match")
	}
	
	// Verify both patterns are cached
	pattern2 := "[a-z]+"
	_, found2 := regexCache.Load(pattern2)
	if !found2 {
		t.Error("Expected name pattern to be cached")
	}
}

func TestRegexCacheDisabled(t *testing.T) {
	// Store original state
	originalEnabled := pathTokenCacheEnabled
	defer func() {
		SetPathTokenCacheEnabled(originalEnabled)
	}()
	
	// Clear cache before test
	regexCache = sync.Map{}
	
	// Disable caching
	SetPathTokenCacheEnabled(false)
	
	router := CurlyRouter{}
	routeToken := "{id:[0-9]+}"
	requestToken := "123"
	
	// Call should work but not cache
	matches, _ := router.regularMatchesPathToken(routeToken, 3, requestToken)
	if !matches {
		t.Error("Expected call to match")
	}
	
	// Verify pattern is not cached
	pattern := "[0-9]+"
	_, found := regexCache.Load(pattern)
	if found {
		t.Error("Expected pattern to not be cached when caching is disabled")
	}
	
	// Re-enable caching
	SetPathTokenCacheEnabled(true)
	
	// Now it should cache
	matches2, _ := router.regularMatchesPathToken(routeToken, 3, requestToken)
	if !matches2 {
		t.Error("Expected call to match")
	}
	
	// Verify pattern is now cached
	_, found2 := regexCache.Load(pattern)
	if !found2 {
		t.Error("Expected pattern to be cached when caching is re-enabled")
	}
}

func TestRegexCachePanicSafety(t *testing.T) {
	// Store original state
	originalEnabled := pathTokenCacheEnabled
	defer func() {
		SetPathTokenCacheEnabled(originalEnabled)
		regexCache = sync.Map{} // Clean up
	}()
	
	SetPathTokenCacheEnabled(true)
	
	// Poison cache with wrong type
	pattern := "[0-9]+"
	regexCache.Store(pattern, "not a regex")
	
	router := CurlyRouter{}
	routeToken := "{id:[0-9]+}"
	requestToken := "123"
	
	// Should not panic, should handle invalid cache entry gracefully
	matches, _ := router.regularMatchesPathToken(routeToken, 3, requestToken)
	if !matches {
		t.Error("Expected call to match even with corrupted cache")
	}
	
	// After the call, the invalid entry should be overwritten with valid regex
	if cached, found := regexCache.Load(pattern); found {
		if _, ok := cached.(*regexp.Regexp); ok {
			// Success: cache entry is now a valid regex
		} else {
			t.Error("Expected invalid cache entry to be overwritten with valid regex")
		}
	} else {
		t.Error("Expected valid regex to be cached")
	}
}