Skip to content

Commit

Permalink
chore: add unit test and benchmark to URL function
Browse files Browse the repository at this point in the history
  • Loading branch information
a-h committed Apr 2, 2024
1 parent 6365f94 commit 8cc2e94
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.2.648
0.2.655
19 changes: 0 additions & 19 deletions runtime.go
Original file line number Diff line number Diff line change
Expand Up @@ -461,25 +461,6 @@ func SanitizeCSS[T ~string](property string, value T) SafeCSS {
return SafeCSS(p + ":" + v + ";")
}

// Hyperlink sanitization.

// FailedSanitizationURL is returned if a URL fails sanitization checks.
const FailedSanitizationURL = SafeURL("about:invalid#TemplFailedSanitizationURL")

// URL sanitizes the input string s and returns a SafeURL.
func URL(s string) SafeURL {
if i := strings.IndexRune(s, ':'); i >= 0 && !strings.ContainsRune(s[:i], '/') {
protocol := s[:i]
if !strings.EqualFold(protocol, "http") && !strings.EqualFold(protocol, "https") && !strings.EqualFold(protocol, "mailto") && !strings.EqualFold(protocol, "tel") && !strings.EqualFold(protocol, "ftp") && !strings.EqualFold(protocol, "ftps") {
return FailedSanitizationURL
}
}
return SafeURL(s)
}

// SafeURL is a URL that has been sanitized.
type SafeURL string

// Attributes is an alias to map[string]any made for spread attributes.
type Attributes map[string]any

Expand Down
20 changes: 20 additions & 0 deletions url.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package templ

import "strings"

// FailedSanitizationURL is returned if a URL fails sanitization checks.
const FailedSanitizationURL = SafeURL("about:invalid#TemplFailedSanitizationURL")

// URL sanitizes the input string s and returns a SafeURL.
func URL(s string) SafeURL {
if i := strings.IndexRune(s, ':'); i >= 0 && !strings.ContainsRune(s[:i], '/') {
protocol := s[:i]
if !strings.EqualFold(protocol, "http") && !strings.EqualFold(protocol, "https") && !strings.EqualFold(protocol, "mailto") && !strings.EqualFold(protocol, "tel") && !strings.EqualFold(protocol, "ftp") && !strings.EqualFold(protocol, "ftps") {
return FailedSanitizationURL
}
}
return SafeURL(s)
}

// SafeURL is a URL that has been sanitized.
type SafeURL string
57 changes: 57 additions & 0 deletions url_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package templ

import (
"strings"
"testing"
)

type urlTest struct {
url string
expectSanitized bool
}

var urlTests = []urlTest{
{"//example.com", false},
{"/", false},
{"/index", false},
{"http://example.com", false},
{"https://example.com", false},
{"mailto:[email protected]", false},
{"tel:+1234567890", false},
{"ftp://example.com", false},
{"ftps://example.com", false},
{"irc://example.com", true},
{"bitcoin://example.com", true},
}

func testURL(t *testing.T, url string, expectSanitized bool) {
u := URL(url)
wasSanitized := u == FailedSanitizationURL
if expectSanitized != wasSanitized {
t.Errorf("expected sanitized=%v, got %v", expectSanitized, wasSanitized)
}
}

func TestURL(t *testing.T) {
for _, test := range urlTests {
t.Run(test.url, func(t *testing.T) {
testURL(t, test.url, test.expectSanitized)
})
test.url = strings.ToUpper(test.url)
t.Run(strings.ToUpper(test.url), func(t *testing.T) {
testURL(t, test.url, test.expectSanitized)
})
}
}

func BenchmarkURL(b *testing.B) {
for i := 0; i < b.N; i++ {
for _, test := range urlTests {
u := URL(test.url)
wasSanitized := u == FailedSanitizationURL
if test.expectSanitized != wasSanitized {
b.Errorf("expected sanitized=%v, got %v", test.expectSanitized, wasSanitized)
}
}
}
}

0 comments on commit 8cc2e94

Please sign in to comment.