-
-
Notifications
You must be signed in to change notification settings - Fork 229
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: adds memoize implementation for regexes.
Currently we create and allocate memory for every regex we compile, however there are cases where you compile the same regex over and over e.g. corazawaf/coraza-caddy#76. Here we implement the memoize pattern to be able to reuse the regex and reduce the memory consumption.
- Loading branch information
Showing
12 changed files
with
287 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| // Copyright 2023 Juan Pablo Tosso and the OWASP Coraza contributors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| //go:build !tinygo | ||
|
|
||
| // Highly inspired in https://github.com/patrickmn/go-cache/blob/master/cache.go | ||
|
|
||
| package memoize | ||
|
|
||
| import ( | ||
| "sync" | ||
| ) | ||
|
|
||
| type cache struct { | ||
| mu sync.RWMutex | ||
| entries map[string]interface{} | ||
| } | ||
|
|
||
| func newCache() *cache { | ||
| return &cache{ | ||
| entries: make(map[string]interface{}), | ||
| } | ||
| } | ||
|
|
||
| func (c *cache) set(key string, value interface{}) { | ||
| c.mu.Lock() | ||
| c.entries[key] = value | ||
| c.mu.Unlock() | ||
| } | ||
|
|
||
| func (c *cache) get(key string) (interface{}, bool) { | ||
| c.mu.RLock() | ||
| item, found := c.entries[key] | ||
| if !found { | ||
| c.mu.RUnlock() | ||
| return nil, false | ||
| } | ||
| c.mu.RUnlock() | ||
| return item, true | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| // Copyright 2023 Juan Pablo Tosso and the OWASP Coraza contributors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| //go:build !tinygo | ||
|
|
||
| package memoize | ||
|
|
||
| import "testing" | ||
|
|
||
| func TestCache(t *testing.T) { | ||
| tc := newCache() | ||
|
|
||
| _, found := tc.get("key1") | ||
| if want, have := false, found; want != have { | ||
| t.Fatalf("unexpected value, want %t, have %t", want, have) | ||
| } | ||
|
|
||
| tc.set("key1", 1) | ||
|
|
||
| item, found := tc.get("key1") | ||
| if want, have := true, found; want != have { | ||
| t.Fatalf("unexpected value, want %t, have %t", want, have) | ||
| } | ||
|
|
||
| if want, have := 1, item.(int); want != have { | ||
| t.Fatalf("unexpected value, want %d, have %d", want, have) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // Copyright 2023 Juan Pablo Tosso and the OWASP Coraza contributors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| //go:build !tinygo | ||
|
|
||
| // https://github.com/kofalt/go-memoize/blob/master/memoize.go | ||
|
|
||
| package memoize | ||
|
|
||
| import ( | ||
| "golang.org/x/sync/singleflight" | ||
| ) | ||
|
|
||
| var doer = makeDoer(newCache(), &singleflight.Group{}) | ||
|
|
||
| // Do executes and returns the results of the given function, unless there was a cached | ||
| // value of the same key. Only one execution is in-flight for a given key at a time. | ||
| // The boolean return value indicates whether v was previously stored. | ||
| func Do(key string, fn func() (interface{}, error)) (interface{}, error) { | ||
| value, err, _ := doer(key, fn) | ||
| return value, err | ||
| } | ||
|
|
||
| // makeDoer returns a function that executes and returns the results of the given function | ||
| func makeDoer(cache *cache, group *singleflight.Group) func(string, func() (interface{}, error)) (interface{}, error, bool) { | ||
| return func(key string, fn func() (interface{}, error)) (interface{}, error, bool) { | ||
| // Check cache | ||
| value, found := cache.get(key) | ||
| if found { | ||
| return value, nil, true | ||
| } | ||
|
|
||
| // Combine memoized function with a cache store | ||
| value, err, _ := group.Do(key, func() (interface{}, error) { | ||
| data, innerErr := fn() | ||
| if innerErr == nil { | ||
| cache.set(key, data) | ||
| } | ||
|
|
||
| return data, innerErr | ||
| }) | ||
|
|
||
| return value, err, false | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| // Copyright 2023 Juan Pablo Tosso and the OWASP Coraza contributors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| //go:build !tinygo | ||
|
|
||
| // https://github.com/kofalt/go-memoize/blob/master/memoize.go | ||
|
|
||
| package memoize | ||
|
|
||
| import ( | ||
| "errors" | ||
| "testing" | ||
|
|
||
| "golang.org/x/sync/singleflight" | ||
| ) | ||
|
|
||
| func TestSuccessCall(t *testing.T) { | ||
| do := makeDoer(newCache(), &singleflight.Group{}) | ||
|
|
||
| expensiveCalls := 0 | ||
|
|
||
| // Function tracks how many times its been called | ||
| expensive := func() (interface{}, error) { | ||
| expensiveCalls++ | ||
| return expensiveCalls, nil | ||
| } | ||
|
|
||
| // First call SHOULD NOT be cached | ||
| result, err, cached := do("key1", expensive) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %s", err.Error()) | ||
| } | ||
|
|
||
| if want, have := 1, result.(int); want != have { | ||
| t.Fatalf("unexpected value, want %d, have %d", want, have) | ||
| } | ||
|
|
||
| if want, have := false, cached; want != have { | ||
| t.Fatalf("unexpected caching, want %t, have %t", want, have) | ||
| } | ||
|
|
||
| // Second call on same key SHOULD be cached | ||
| result, err, cached = do("key1", expensive) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %s", err.Error()) | ||
| } | ||
|
|
||
| if want, have := 1, result.(int); want != have { | ||
| t.Fatalf("unexpected value, want %d, have %d", want, have) | ||
| } | ||
|
|
||
| if want, have := true, cached; want != have { | ||
| t.Fatalf("unexpected caching, want %t, have %t", want, have) | ||
| } | ||
|
|
||
| // First call on a new key SHOULD NOT be cached | ||
| result, err, cached = do("key2", expensive) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %s", err.Error()) | ||
| } | ||
|
|
||
| if want, have := 2, result.(int); want != have { | ||
| t.Fatalf("unexpected value, want %d, have %d", want, have) | ||
| } | ||
|
|
||
| if want, have := false, cached; want != have { | ||
| t.Fatalf("unexpected caching, want %t, have %t", want, have) | ||
| } | ||
| } | ||
|
|
||
| func TestFailedCall(t *testing.T) { | ||
| do := makeDoer(newCache(), &singleflight.Group{}) | ||
|
|
||
| calls := 0 | ||
|
|
||
| // This function will fail IFF it has not been called before. | ||
| twoForTheMoney := func() (interface{}, error) { | ||
| calls++ | ||
|
|
||
| if calls == 1 { | ||
| return calls, errors.New("Try again") | ||
| } else { | ||
| return calls, nil | ||
| } | ||
| } | ||
|
|
||
| // First call should fail, and not be cached | ||
| result, err, cached := do("key1", twoForTheMoney) | ||
| if err == nil { | ||
| t.Fatalf("expected error") | ||
| } | ||
|
|
||
| if want, have := 1, result.(int); want != have { | ||
| t.Fatalf("unexpected value, want %d, have %d", want, have) | ||
| } | ||
|
|
||
| if want, have := false, cached; want != have { | ||
| t.Fatalf("unexpected caching, want %t, have %t", want, have) | ||
| } | ||
|
|
||
| // Second call should succeed, and not be cached | ||
| result, err, cached = do("key1", twoForTheMoney) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %s", err.Error()) | ||
| } | ||
|
|
||
| if want, have := 2, result.(int); want != have { | ||
| t.Fatalf("unexpected value, want %d, have %d", want, have) | ||
| } | ||
|
|
||
| if want, have := false, cached; want != have { | ||
| t.Fatalf("unexpected caching, want %t, have %t", want, have) | ||
| } | ||
|
|
||
| // Third call should succeed, and be cached | ||
| result, err, cached = do("key1", twoForTheMoney) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %s", err.Error()) | ||
| } | ||
|
|
||
| if want, have := 2, result.(int); want != have { | ||
| t.Fatalf("unexpected value, want %d, have %d", want, have) | ||
| } | ||
|
|
||
| if want, have := true, cached; want != have { | ||
| t.Fatalf("unexpected caching, want %t, have %t", want, have) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| // Copyright 2023 Juan Pablo Tosso and the OWASP Coraza contributors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| //go:build tinygo | ||
|
|
||
| package memoize | ||
|
|
||
| func Do(_ string, fn func() (interface{}, error)) (interface{}, error) { | ||
| return fn() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.