mirror of https://github.com/hyperledger/besu
Less strict engine QoS timer (#4411)
* reset engine QoS timer with every call to the engine API, ExchangeTransitionConfiguration mismatch will only submit a debug log not a warning anymore Signed-off-by: Daniel Lehrner <daniel.lehrner@consensys.net>pull/4416/head
Daniel Lehrner
2 years ago
committed by
GitHub
parent
5e156253ab
commit
bc9ff867c4
@ -0,0 +1,19 @@ |
||||
/* |
||||
* Copyright Hyperledger Besu Contributors. |
||||
* |
||||
* 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. |
||||
* |
||||
* SPDX-License-Identifier: Apache-2.0 |
||||
*/ |
||||
package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.engine; |
||||
|
||||
public interface EngineCallListener { |
||||
void executionEngineCalled(); |
||||
} |
||||
@ -0,0 +1,50 @@ |
||||
/* |
||||
* Copyright Hyperledger Besu Contributors. |
||||
* |
||||
* 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. |
||||
* |
||||
* SPDX-License-Identifier: Apache-2.0 |
||||
*/ |
||||
package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.engine; |
||||
|
||||
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.QosTimer; |
||||
|
||||
import com.google.common.annotations.VisibleForTesting; |
||||
import io.vertx.core.Vertx; |
||||
import org.slf4j.Logger; |
||||
import org.slf4j.LoggerFactory; |
||||
|
||||
public class EngineQosTimer implements EngineCallListener { |
||||
static final long QOS_TIMEOUT_MILLIS = 120000L; |
||||
private static final Logger LOG = LoggerFactory.getLogger(EngineQosTimer.class); |
||||
|
||||
private final QosTimer qosTimer; |
||||
|
||||
public EngineQosTimer(final Vertx vertx) { |
||||
qosTimer = new QosTimer(vertx, QOS_TIMEOUT_MILLIS, lastCall -> logTimeoutWarning()); |
||||
qosTimer.resetTimer(); |
||||
} |
||||
|
||||
@Override |
||||
public void executionEngineCalled() { |
||||
getQosTimer().resetTimer(); |
||||
} |
||||
|
||||
public void logTimeoutWarning() { |
||||
LOG.warn( |
||||
"Execution engine not called in {} seconds, consensus client may not be connected", |
||||
QOS_TIMEOUT_MILLIS / 1000L); |
||||
} |
||||
|
||||
@VisibleForTesting |
||||
public QosTimer getQosTimer() { |
||||
return qosTimer; |
||||
} |
||||
} |
||||
@ -0,0 +1,101 @@ |
||||
/* |
||||
* Copyright Hyperledger Besu Contributors. |
||||
* |
||||
* 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. |
||||
* |
||||
* SPDX-License-Identifier: Apache-2.0 |
||||
*/ |
||||
package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.engine; |
||||
|
||||
import static org.mockito.Mockito.atLeast; |
||||
import static org.mockito.Mockito.atLeastOnce; |
||||
import static org.mockito.Mockito.never; |
||||
import static org.mockito.Mockito.spy; |
||||
import static org.mockito.Mockito.verify; |
||||
import static org.mockito.Mockito.when; |
||||
|
||||
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.QosTimer; |
||||
|
||||
import io.vertx.core.Vertx; |
||||
import io.vertx.ext.unit.Async; |
||||
import io.vertx.ext.unit.TestContext; |
||||
import io.vertx.ext.unit.junit.VertxUnitRunner; |
||||
import org.junit.After; |
||||
import org.junit.Before; |
||||
import org.junit.Test; |
||||
import org.junit.runner.RunWith; |
||||
|
||||
@RunWith(VertxUnitRunner.class) |
||||
public class EngineQosTimerTest { |
||||
private EngineQosTimer engineQosTimer; |
||||
private Vertx vertx; |
||||
|
||||
@Before |
||||
public void setUp() throws Exception { |
||||
vertx = Vertx.vertx(); |
||||
engineQosTimer = new EngineQosTimer(vertx); |
||||
} |
||||
|
||||
@After |
||||
public void cleanUp() { |
||||
vertx.close(); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldNotWarnWhenCalledWithinTimeout(final TestContext ctx) { |
||||
final long TEST_QOS_TIMEOUT = 75L; |
||||
final Async async = ctx.async(); |
||||
final var spyEngineQosTimer = spy(engineQosTimer); |
||||
final var spyTimer = |
||||
spy(new QosTimer(vertx, TEST_QOS_TIMEOUT, z -> spyEngineQosTimer.logTimeoutWarning())); |
||||
spyTimer.resetTimer(); |
||||
when(spyEngineQosTimer.getQosTimer()).thenReturn(spyTimer); |
||||
|
||||
// call executionEngineCalled() 50 milliseconds hence to reset our QoS timer
|
||||
vertx.setTimer(50L, z -> spyEngineQosTimer.executionEngineCalled()); |
||||
|
||||
vertx.setTimer( |
||||
100L, |
||||
z -> { |
||||
try { |
||||
verify(spyTimer, atLeast(2)).resetTimer(); |
||||
// should not warn
|
||||
verify(spyEngineQosTimer, never()).logTimeoutWarning(); |
||||
async.complete(); |
||||
} catch (Exception ex) { |
||||
ctx.fail(ex); |
||||
} |
||||
}); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldWarnWhenNotCalledWithinTimeout(final TestContext ctx) { |
||||
final long TEST_QOS_TIMEOUT = 75L; |
||||
final Async async = ctx.async(); |
||||
final var spyEngineQosTimer = spy(engineQosTimer); |
||||
final var spyTimer = |
||||
spy(new QosTimer(vertx, TEST_QOS_TIMEOUT, z -> spyEngineQosTimer.logTimeoutWarning())); |
||||
spyTimer.resetTimer(); |
||||
when(spyEngineQosTimer.getQosTimer()).thenReturn(spyTimer); |
||||
|
||||
vertx.setTimer( |
||||
100L, |
||||
z -> { |
||||
try { |
||||
verify(spyTimer, atLeastOnce()).resetTimer(); |
||||
// should warn
|
||||
verify(spyEngineQosTimer, atLeastOnce()).logTimeoutWarning(); |
||||
async.complete(); |
||||
} catch (Exception ex) { |
||||
ctx.fail(ex); |
||||
} |
||||
}); |
||||
} |
||||
} |
||||
Loading…
Reference in new issue