-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Also move the non crypto hash funcs into this new package. This is much faster than e.g. MD5, especially for larger inputs: ``` BenchmarkXxHash/xxHash_43-10 9917955 112.2 ns/op 56 B/op 4 allocs/op BenchmarkXxHash/mdb5_43-10 6017239 204.1 ns/op 96 B/op 3 allocs/op BenchmarkXxHash/fnv32a_43-10 14407333 82.30 ns/op 16 B/op 1 allocs/op BenchmarkXxHash/xxHash_4300-10 2916892 409.7 ns/op 56 B/op 4 allocs/op BenchmarkXxHash/mdb5_4300-10 159748 7491 ns/op 4912 B/op 3 allocs/op BenchmarkXxHash/fnv32a_4300-10 218210 5510 ns/op 16 B/op 1 allocs/op ``` Fixes #12635
- Loading branch information
Showing
7 changed files
with
183 additions
and
7 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
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,93 @@ | ||
| // Copyright 2024 The Hugo Authors. All rights reserved. | ||
| // | ||
| // 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 hash provides non-cryptographic hash functions for template use. | ||
| package hash | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/hex" | ||
| "hash/fnv" | ||
|
|
||
| "github.com/cespare/xxhash/v2" | ||
| "github.com/gohugoio/hugo/deps" | ||
| "github.com/gohugoio/hugo/tpl/internal" | ||
| "github.com/spf13/cast" | ||
| ) | ||
|
|
||
| // New returns a new instance of the hash-namespaced template functions. | ||
| func New() *Namespace { | ||
| return &Namespace{} | ||
| } | ||
|
|
||
| // Namespace provides template functions for the "hash" namespace. | ||
| type Namespace struct{} | ||
|
|
||
| // FNV32a hashes v using fnv32a algorithm. | ||
| func (ns *Namespace) FNV32a(v any) (int, error) { | ||
| conv, err := cast.ToStringE(v) | ||
| if err != nil { | ||
| return 0, err | ||
| } | ||
| algorithm := fnv.New32a() | ||
| algorithm.Write([]byte(conv)) | ||
| return int(algorithm.Sum32()), nil | ||
| } | ||
|
|
||
| // XxHash returns the xxHash of the input string. | ||
| func (ns *Namespace) XxHash(v any) (string, error) { | ||
| conv, err := cast.ToStringE(v) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| hasher := xxhash.New() | ||
|
|
||
| _, err = hasher.WriteString(conv) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| hash := hasher.Sum(nil) | ||
| return hex.EncodeToString(hash), nil | ||
| } | ||
|
|
||
| const name = "hash" | ||
|
|
||
| func init() { | ||
| f := func(d *deps.Deps) *internal.TemplateFuncsNamespace { | ||
| ctx := New() | ||
|
|
||
| ns := &internal.TemplateFuncsNamespace{ | ||
| Name: name, | ||
| Context: func(cctx context.Context, args ...any) (any, error) { return ctx, nil }, | ||
| } | ||
|
|
||
| ns.AddMethodMapping(ctx.XxHash, | ||
| []string{"xxhash"}, | ||
| [][2]string{ | ||
| {`{{ hash.XxHash "The quick brown fox jumps over the lazy dog" }}`, `0b242d361fda71bc`}, | ||
| }, | ||
| ) | ||
|
|
||
| ns.AddMethodMapping(ctx.FNV32a, | ||
| nil, | ||
| [][2]string{ | ||
| {`{{ hash.FNV32a "Hugo Rocks!!" }}`, `1515779328`}, | ||
| }, | ||
| ) | ||
|
|
||
| return ns | ||
| } | ||
|
|
||
| internal.AddTemplateFuncsNamespace(f) | ||
| } |
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,84 @@ | ||
| // Copyright 2024 The Hugo Authors. All rights reserved. | ||
| // | ||
| // 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 hash provides non-cryptographic hash functions for template use. | ||
| package hash | ||
|
|
||
| import ( | ||
| "crypto/md5" | ||
| "encoding/hex" | ||
| "fmt" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| qt "github.com/frankban/quicktest" | ||
| "github.com/spf13/cast" | ||
| ) | ||
|
|
||
| func TestXxHash(t *testing.T) { | ||
| t.Parallel() | ||
| c := qt.New(t) | ||
|
|
||
| ns := New() | ||
|
|
||
| h, err := ns.XxHash("The quick brown fox jumps over the lazy dog") | ||
| c.Assert(err, qt.IsNil) | ||
| // Facit: https://asecuritysite.com/encryption/xxhash?val=The%20quick%20brown%20fox%20jumps%20over%20the%20lazy%20dog | ||
| c.Assert(h, qt.Equals, "0b242d361fda71bc") | ||
| } | ||
|
|
||
| func BenchmarkXxHash(b *testing.B) { | ||
| const inputSmall = "The quick brown fox jumps over the lazy dog" | ||
| inputLarge := strings.Repeat(inputSmall, 100) | ||
|
|
||
| runBench := func(name, input string, b *testing.B, fn func(v any)) { | ||
| b.Run(fmt.Sprintf("%s_%d", name, len(input)), func(b *testing.B) { | ||
| for i := 0; i < b.N; i++ { | ||
| fn(input) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| ns := New() | ||
| fnXxHash := func(v any) { | ||
| _, err := ns.XxHash(v) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| } | ||
|
|
||
| fnFNv32a := func(v any) { | ||
| _, err := ns.FNV32a(v) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| } | ||
|
|
||
| // Copied from the crypto tpl/crypto package, | ||
| // just to have something to compare the above with. | ||
| fnMD5 := func(v any) { | ||
| conv, err := cast.ToStringE(v) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| hash := md5.Sum([]byte(conv)) | ||
| _ = hex.EncodeToString(hash[:]) | ||
| } | ||
|
|
||
| for _, input := range []string{inputSmall, inputLarge} { | ||
| runBench("xxHash", input, b, fnXxHash) | ||
| runBench("mdb5", input, b, fnMD5) | ||
| runBench("fnv32a", input, b, fnFNv32a) | ||
| } | ||
| } |
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