StakeSquid/dshackle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix lower matcher - sort by lower bound type (#490)

Browse Source
This commit is contained in:
KirillPamPam
2024-05-29 14:53:22 +04:00
committed by GitHub
parent 5e35a8880d
commit f3ab6b3443
11 changed files with 180 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
emerald-grpc

Submodule emerald-grpc updated: 9397863a13...d8067885f5

4
src/main/kotlin/io/emeraldpay/dshackle/upstream/Multistream.kt
View File

@@ -342,6 +342,10 @@ abstract class Multistream(
return lowerBounds.values
}
override fun getLowerBound(lowerBoundType: LowerBoundType): LowerBoundData? {
return lowerBounds[lowerBoundType]
}
override fun getUpstreamSettingsData(): Upstream.UpstreamSettingsData? {
return Upstream.UpstreamSettingsData(
nodeId(),

19
src/main/kotlin/io/emeraldpay/dshackle/upstream/Selector.kt
View File

@@ -27,6 +27,7 @@ import io.emeraldpay.dshackle.upstream.MatchesResponse.NotMatchedResponse
import io.emeraldpay.dshackle.upstream.MatchesResponse.SameNodeResponse
import io.emeraldpay.dshackle.upstream.MatchesResponse.SlotHeightResponse
import io.emeraldpay.dshackle.upstream.MatchesResponse.Success
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundType
import org.apache.commons.lang3.StringUtils
import java.util.Collections
@@ -72,13 +73,27 @@ class Selector {
selectors.forEach { selector ->
if (selector.hasHeightSelector() && selector.heightSelector.height == -1L) {
return Sort(compareByDescending { it.getHead().getCurrentHeight() })
} else if (selector.hasLowerHeightSelector() && selector.lowerHeightSelector.height == 0L) {
return Sort(compareBy(nullsLast()) { it.getHead().getCurrentHeight() })
} else if (selector.hasLowerHeightSelector()) {
return Sort(
compareBy(nullsLast()) {
it.getLowerBound(fromProtoType(selector.lowerHeightSelector.lowerBoundType))?.lowerBound
},
)
}
}
return Sort.default
}
private fun fromProtoType(type: BlockchainOuterClass.LowerBoundType): LowerBoundType {
return when (type) {
BlockchainOuterClass.LowerBoundType.LOWER_BOUND_SLOT -> LowerBoundType.SLOT
BlockchainOuterClass.LowerBoundType.LOWER_BOUND_UNSPECIFIED -> LowerBoundType.UNKNOWN
BlockchainOuterClass.LowerBoundType.LOWER_BOUND_STATE -> LowerBoundType.STATE
BlockchainOuterClass.LowerBoundType.LOWER_BOUND_BLOCK -> LowerBoundType.BLOCK
BlockchainOuterClass.LowerBoundType.UNRECOGNIZED -> LowerBoundType.UNKNOWN
}
}
@JvmStatic
fun convertToMatcher(req: BlockchainOuterClass.Selector?): LabelSelectorMatcher {
return when {

1
src/main/kotlin/io/emeraldpay/dshackle/upstream/Upstream.kt
View File

@@ -47,6 +47,7 @@ interface Upstream : Lifecycle {
fun getCapabilities(): Set<Capability>
fun isGrpc(): Boolean
fun getLowerBounds(): Collection<LowerBoundData>
fun getLowerBound(lowerBoundType: LowerBoundType): LowerBoundData?
fun getUpstreamSettingsData(): UpstreamSettingsData?
fun updateLowerBound(lowerBound: Long, type: LowerBoundType)

5
src/main/kotlin/io/emeraldpay/dshackle/upstream/bitcoin/BitcoinRpcUpstream.kt
View File

@@ -29,6 +29,7 @@ import io.emeraldpay.dshackle.upstream.Upstream
import io.emeraldpay.dshackle.upstream.UpstreamAvailability
import io.emeraldpay.dshackle.upstream.calls.CallMethods
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundData
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundType
import reactor.core.Disposable
open class BitcoinRpcUpstream(
@@ -76,6 +77,10 @@ open class BitcoinRpcUpstream(
return emptyList()
}
override fun getLowerBound(lowerBoundType: LowerBoundType): LowerBoundData? {
return null
}
override fun getUpstreamSettingsData(): Upstream.UpstreamSettingsData? {
return null
}

4
src/main/kotlin/io/emeraldpay/dshackle/upstream/generic/GenericUpstream.kt
View File

@@ -95,6 +95,10 @@ open class GenericUpstream(
return lowerBoundService.getLowerBounds()
}
override fun getLowerBound(lowerBoundType: LowerBoundType): LowerBoundData? {
return lowerBoundService.getLowerBound(lowerBoundType)
}
override fun getUpstreamSettingsData(): Upstream.UpstreamSettingsData? {
return Upstream.UpstreamSettingsData(
nodeId(),

5
src/main/kotlin/io/emeraldpay/dshackle/upstream/grpc/BitcoinGrpcUpstream.kt
View File

@@ -38,6 +38,7 @@ import io.emeraldpay.dshackle.upstream.bitcoin.ExtractBlock
import io.emeraldpay.dshackle.upstream.ethereum.rpc.RpcException
import io.emeraldpay.dshackle.upstream.forkchoice.MostWorkForkChoice
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundData
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundType
import io.emeraldpay.dshackle.upstream.rpcclient.JsonRpcGrpcClient
import io.emeraldpay.dshackle.upstream.rpcclient.ListParams
import org.reactivestreams.Publisher
@@ -154,6 +155,10 @@ class BitcoinGrpcUpstream(
return emptyList()
}
override fun getLowerBound(lowerBoundType: LowerBoundType): LowerBoundData? {
return null
}
override fun getUpstreamSettingsData(): Upstream.UpstreamSettingsData? {
return null
}

5
src/main/kotlin/io/emeraldpay/dshackle/upstream/grpc/GenericGrpcUpstream.kt
View File

@@ -36,6 +36,7 @@ import io.emeraldpay.dshackle.upstream.calls.CallMethods
import io.emeraldpay.dshackle.upstream.ethereum.domain.BlockHash
import io.emeraldpay.dshackle.upstream.forkchoice.NoChoiceWithPriorityForkChoice
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundData
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundType
import io.emeraldpay.dshackle.upstream.rpcclient.JsonRpcGrpcClient
import reactor.core.publisher.Flux
import reactor.core.scheduler.Scheduler
@@ -183,6 +184,10 @@ open class GenericGrpcUpstream(
return emptyList()
}
override fun getLowerBound(lowerBoundType: LowerBoundType): LowerBoundData? {
return null
}
override fun getUpstreamSettingsData(): Upstream.UpstreamSettingsData? {
return null
}

2
src/main/kotlin/io/emeraldpay/dshackle/upstream/lowerbound/LowerBoundService.kt
View File

@@ -35,5 +35,7 @@ abstract class LowerBoundService(
fun getLowerBounds(): Collection<LowerBoundData> = lowerBounds.values
fun getLowerBound(lowerBoundType: LowerBoundType): LowerBoundData? = lowerBounds[lowerBoundType]
protected abstract fun detectors(): List<LowerBoundDetector>
}

5
src/test/groovy/io/emeraldpay/dshackle/test/GenericUpstreamMock.groovy
View File

@@ -112,4 +112,9 @@ class GenericUpstreamMock extends GenericUpstream {
Collection<LowerBoundData> getLowerBounds() {
return List.of(new LowerBoundData(0, LowerBoundType.STATE))
}
@Override
LowerBoundData getLowerBound(@NotNull LowerBoundType lowerBoundType) {
return new LowerBoundData(0, LowerBoundType.STATE)
}
}

131
src/test/kotlin/io/emeraldpay/dshackle/upstream/SelectorTest.kt Normal file
View File

@@ -0,0 +1,131 @@
package io.emeraldpay.dshackle.upstream
import io.emeraldpay.api.proto.BlockchainOuterClass
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundData
import io.emeraldpay.dshackle.upstream.lowerbound.LowerBoundType
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.Arguments
import org.junit.jupiter.params.provider.Arguments.of
import org.junit.jupiter.params.provider.MethodSource
import org.mockito.kotlin.doReturn
import org.mockito.kotlin.mock
class SelectorTest {
@ParameterizedTest
@MethodSource("data")
fun `sort with lower height matcher`(
lowerBoundType: LowerBoundType,
protoLowerBoundType: BlockchainOuterClass.LowerBoundType,
) {
val up1 = mock<Upstream> {
on { getLowerBound(lowerBoundType) } doReturn LowerBoundData(1, lowerBoundType)
}
val up2 = mock<Upstream> {
on { getLowerBound(lowerBoundType) } doReturn LowerBoundData(1000, lowerBoundType)
}
val up3 = mock<Upstream> {
on { getLowerBound(lowerBoundType) } doReturn LowerBoundData(100000, lowerBoundType)
}
val up4 = mock<Upstream> {
on { getLowerBound(lowerBoundType) } doReturn null
}
val ups = listOf(up4, up3, up2, up1)
val requestSelectors = listOf(
BlockchainOuterClass.Selector.newBuilder()
.setLowerHeightSelector(
BlockchainOuterClass.LowerHeightSelector.newBuilder()
.setLowerBoundType(protoLowerBoundType)
.build(),
)
.build(),
)
val upstreamFilter = Selector.convertToUpstreamFilter(requestSelectors)
val actual = ups.sortedWith(upstreamFilter.sort.comparator)
assertEquals(
listOf(up1, up2, up3, up4),
actual,
)
}
@Test
fun `preserve the same order if no lower bound type`() {
val up1 = mock<Upstream> {
on { getLowerBound(LowerBoundType.STATE) } doReturn LowerBoundData(1, LowerBoundType.STATE)
}
val up2 = mock<Upstream> {
on { getLowerBound(LowerBoundType.STATE) } doReturn LowerBoundData(1000, LowerBoundType.STATE)
}
val up3 = mock<Upstream> {
on { getLowerBound(LowerBoundType.STATE) } doReturn LowerBoundData(100000, LowerBoundType.STATE)
}
val up4 = mock<Upstream> {
on { getLowerBound(LowerBoundType.STATE) } doReturn null
}
val ups = listOf(up4, up3, up2, up1)
val requestSelectors = listOf(
BlockchainOuterClass.Selector.newBuilder()
.setLowerHeightSelector(
BlockchainOuterClass.LowerHeightSelector.newBuilder()
.build(),
)
.build(),
)
val upstreamFilter = Selector.convertToUpstreamFilter(requestSelectors)
val actual = ups.sortedWith(upstreamFilter.sort.comparator)
assertEquals(
listOf(up4, up3, up2, up1),
actual,
)
}
@Test
fun `ignore upstream with no needed lower bound`() {
val up1 = mock<Upstream> {
on { getLowerBound(LowerBoundType.STATE) } doReturn LowerBoundData(1, LowerBoundType.STATE)
}
val up2 = mock<Upstream> {
on { getLowerBound(LowerBoundType.BLOCK) } doReturn LowerBoundData(1000, LowerBoundType.BLOCK)
}
val up3 = mock<Upstream> {
on { getLowerBound(LowerBoundType.BLOCK) } doReturn LowerBoundData(100000, LowerBoundType.BLOCK)
}
val ups = listOf(up1, up3, up2)
val requestSelectors = listOf(
BlockchainOuterClass.Selector.newBuilder()
.setLowerHeightSelector(
BlockchainOuterClass.LowerHeightSelector.newBuilder()
.setLowerBoundType(BlockchainOuterClass.LowerBoundType.LOWER_BOUND_BLOCK)
.build(),
)
.build(),
)
val upstreamFilter = Selector.convertToUpstreamFilter(requestSelectors)
val actual = ups.sortedWith(upstreamFilter.sort.comparator)
assertEquals(
listOf(up2, up3, up1),
actual,
)
}
companion object {
@JvmStatic
fun data(): List<Arguments> =
listOf(
of(LowerBoundType.STATE, BlockchainOuterClass.LowerBoundType.LOWER_BOUND_STATE),
of(LowerBoundType.BLOCK, BlockchainOuterClass.LowerBoundType.LOWER_BOUND_BLOCK),
of(LowerBoundType.SLOT, BlockchainOuterClass.LowerBoundType.LOWER_BOUND_SLOT),
)
}
}