mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-26 08:26:20 +00:00
1bccf4f2dd
## Why this should be merged The `temporary.WithTempRegisteredExtras()` global lock introduced in #234 wasn't fit for purpose when used in `coreth` as it required central coordination of registration, types, and usage of the payload accessor. ## How this works Instead of a central registration point, the new `libevm.WithTemporaryExtrasLock()` function takes out a global lock and provides the caller with a handle that proves the lock is held. All of the override functions, e.g. `params.WithTempRegisteredExtras()` now require a current lock, which will be propagated by the respective `coreth` functions. See https://github.com/ava-labs/coreth/pull/1328 for intended usage in `coreth` and `subnet-evm`. A consumer of both of these can then safely do the following: ```go import ( "github.com/ava-labs/libevm/libevm" coreth "github.com/ava-labs/coreth/plugin/evm" subnet "github.com/ava-labs/subnet-evm/plugin/evm" ) // asCChain calls `fn` while emulating `coreth`. It is safe for concurrent usage with [asSubnetEVM]. func asCChain(fn func() error) error { return libevm.WithTemporaryExtrasLock(func(l libevm.ExtrasLock) error { return coreth.WithTempRegisteredLibEVMExtras(l, fn) }) } // asSubnetEVM calls `fn` while emulating `subnet-evm`. It is safe for concurrent usage with [asCChain]. func asSubnetEVM(fn func() error) error { return libevm.WithTemporaryExtrasLock(func(l libevm.ExtrasLock) error { return subnet.WithTempRegisteredLibEVMExtras(l, fn) }) } ``` ## How this was tested Unit test of the new function plus existing integration tests of all modified code.
88 lines
2.4 KiB
Go
88 lines
2.4 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 register
|
|
|
|
import (
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestAtMostOnce(t *testing.T) {
|
|
var sut AtMostOnce[int]
|
|
assertRegistered := func(t *testing.T, want int) {
|
|
t.Helper()
|
|
require.True(t, sut.Registered(), "Registered()")
|
|
assert.Equal(t, want, sut.Get(), "Get()")
|
|
}
|
|
|
|
const val int = 42
|
|
require.NoError(t, sut.Register(val), "Register()")
|
|
assertRegistered(t, val)
|
|
|
|
assert.PanicsWithValue(
|
|
t, ErrReRegistration,
|
|
func() { sut.MustRegister(0) },
|
|
"MustRegister() after Register()",
|
|
)
|
|
|
|
t.Run("TestOnlyClear", func(t *testing.T) {
|
|
sut.TestOnlyClear()
|
|
require.False(t, sut.Registered(), "Registered()")
|
|
|
|
t.Run("re-registration", func(t *testing.T) {
|
|
sut.MustRegister(val)
|
|
assertRegistered(t, val)
|
|
})
|
|
})
|
|
if t.Failed() {
|
|
return
|
|
}
|
|
|
|
t.Run("TempOverride", func(t *testing.T) {
|
|
t.Run("during", func(t *testing.T) {
|
|
require.NoError(t, sut.TempOverride(val+1, func() error {
|
|
assertRegistered(t, val+1)
|
|
return nil
|
|
}))
|
|
})
|
|
t.Run("after", func(t *testing.T) {
|
|
assertRegistered(t, val)
|
|
})
|
|
})
|
|
|
|
t.Run("TempClear", func(t *testing.T) {
|
|
t.Run("during", func(t *testing.T) {
|
|
require.NoError(t, sut.TempClear(func() error {
|
|
assert.False(t, sut.Registered(), "Registered()")
|
|
return nil
|
|
}))
|
|
})
|
|
t.Run("after", func(t *testing.T) {
|
|
assertRegistered(t, val)
|
|
})
|
|
})
|
|
|
|
t.Run("error_propagation", func(t *testing.T) {
|
|
errFoo := errors.New("foo")
|
|
fn := func() error { return errFoo }
|
|
assert.ErrorIs(t, sut.TempOverride(0, fn), errFoo, "TempOverride()") //nolint:testifylint // Blindly using require is an anti-pattern!!!
|
|
assert.ErrorIs(t, sut.TempClear(fn), errFoo, "TempClear()")
|
|
})
|
|
}
|