mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-20 21:54:30 +00:00
02110d3f34
## Why this should be merged Adds logging of `libevm` modification of default behaviour. ## How this works 1. Introduces `log.Lazy` functions to allow expensive logging operations to be computed i.f.f. required by the logging level. 2. Adds `Info` logging for registration of types and `Debug` logging for all else. 3. Only paths that change behaviour in a potentially unpredictable manner are logged; of note, RLP / JSON encoding is _not_ considered unpredictable given that registered extras are logged. 4. The minimal viable package, `set`, was necessary because we don't want to depend on `avalanchego` and the `hashicorp/go-set` latest version requires a later version of Go. #153 tracks a swap to the latter when possible. The `eth/tracers/internal/tracetest` test flaked at least twice (unrelated to these changes) so I've marked it as such since it's not worth a separate PR. ## How this was tested New unit test on `log.Lazy` + `set` methods. Existing CI for the rest as it's a refactor.
67 lines
1.8 KiB
Go
67 lines
1.8 KiB
Go
// Copyright 2025 the libevm authors.
|
|
//
|
|
// The libevm additions to go-ethereum are free software: you can redistribute
|
|
// them and/or modify them under the terms of the GNU Lesser General Public License
|
|
// as published by the Free Software Foundation, either version 3 of the License,
|
|
// or (at your option) any later version.
|
|
//
|
|
// The libevm additions are distributed in the hope that they will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
|
|
// General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see
|
|
// <http://www.gnu.org/licenses/>.
|
|
|
|
package log
|
|
|
|
import (
|
|
"bytes"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"golang.org/x/exp/slog"
|
|
)
|
|
|
|
func TestTypeOf(t *testing.T) {
|
|
type foo struct{}
|
|
|
|
tests := map[any]string{
|
|
nil: "<nil>",
|
|
int(0): "int",
|
|
int(1): "int",
|
|
uint(0): "uint",
|
|
foo{}: "log.foo",
|
|
(*foo)(nil): "*log.foo",
|
|
}
|
|
|
|
for in, want := range tests {
|
|
got := TypeOf(in).LogValue()
|
|
assert.Equalf(t, want, got.String(), "TypeOf(%T(%[1]v))", in, in)
|
|
}
|
|
}
|
|
|
|
func TestLazy(t *testing.T) {
|
|
const (
|
|
key = "theKey"
|
|
val = "theVal"
|
|
wantLogged = key + "=" + val
|
|
)
|
|
|
|
var gotNumEvaluations int
|
|
fn := Lazy(func() slog.Value {
|
|
gotNumEvaluations++
|
|
return slog.StringValue(val)
|
|
})
|
|
|
|
var out bytes.Buffer
|
|
log := slog.New(slog.NewTextHandler(&out, &slog.HandlerOptions{
|
|
Level: slog.LevelInfo,
|
|
}))
|
|
log.Info("", key, fn)
|
|
log.Debug("", "not evaluated", fn)
|
|
|
|
assert.Containsf(t, out.String(), wantLogged, "evaluation of %T function is logged", fn)
|
|
assert.Equalf(t, 1, gotNumEvaluations, "number of evaluations of %T function", fn)
|
|
}
|