Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add lazy loading to regular expressions #16

Merged
merged 3 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions pkg/rules/regex.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package rules

import (
"regexp"
"sync"
)

// nolint: lll
// Define all regular expressions here:
var (
validUUIDRegexp = lazyRegexCompile(`^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`)
asciiRegexp = lazyRegexCompile(`^[\x00-\x7F]*$`)
)

// lazyRegexCompile returns a function that compiles the regular expression
// once, when the function is called for the first time.
// If the function is never called, the regular expression is never compiled,
// thus saving on performance.
//
// All regular expression literals should be compiled using this function.
//
// Credits: https://github.com/go-playground/validator/commit/2e1df48b5ab876bdd461bdccc51d109389e7572f
func lazyRegexCompile(str string) func() *regexp.Regexp {
var (
regex *regexp.Regexp
once sync.Once
)
return func() *regexp.Regexp {
once.Do(func() {
regex = regexp.MustCompile(str)
})
return regex
}
}
18 changes: 18 additions & 0 deletions pkg/rules/regex_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package rules

import (
"testing"

"github.com/stretchr/testify/assert"
)

func TestLazyRegexCompile(t *testing.T) {
lazyRegexp := lazyRegexCompile("^test$")

re1 := lazyRegexp()
assert.True(t, re1.MatchString("test"))
re2 := lazyRegexp()
assert.True(t, re2.MatchString("test"))

assert.True(t, re1 == re2, "both regular expression must be the same pointer")
}
9 changes: 2 additions & 7 deletions pkg/rules/string.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,24 +73,19 @@ func StringDNSLabel() govy.RuleSet[string] {
).WithErrorCode(ErrorCodeStringDNSLabel)
}

var validUUIDRegexp = regexp.
MustCompile("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$")

// StringUUID ensures property's value is a valid UUID string.
func StringUUID() govy.Rule[string] {
return StringMatchRegexp(validUUIDRegexp,
return StringMatchRegexp(validUUIDRegexp(),
"00000000-0000-0000-0000-000000000000",
"e190c630-8873-11ee-b9d1-0242ac120002",
"79258D24-01A7-47E5-ACBB-7E762DE52298").
WithDetails("expected RFC-4122 compliant UUID string").
WithErrorCode(ErrorCodeStringUUID)
}

var asciiRegexp = regexp.MustCompile("^[\x00-\x7F]*$")

// StringASCII ensures property's value contains only ASCII characters.
func StringASCII() govy.Rule[string] {
return StringMatchRegexp(asciiRegexp).WithErrorCode(ErrorCodeStringASCII)
return StringMatchRegexp(asciiRegexp()).WithErrorCode(ErrorCodeStringASCII)
}

// StringURL ensures property's value is a valid URL as defined by [url.Parse] function.
Expand Down
Loading