mirror of
https://github.com/logos-storage/nim-ethers.git
synced 2026-01-02 13:43:06 +00:00
b68bea9909
* fix: modify unsubscribe cleanup routine Ignore exceptions (other than CancelledError) if uninstallation of the filter fails. If it's the last step in the subscription cleanup, then filter changes for this filter will no longer be polled so if the filter continues to live on in geth for whatever reason, then it doesn't matter. This includes a number of fixes: - `CancelledError` is now caught inside of `getChanges`. This was causing conditions during `subscriptions.close`, where the `CancelledError` would get consumed by the `except CatchableError`, if there was an ongoing `poll` happening at the time of close. - After creating a new filter inside of `getChanges`, the new filter is polled for changes before returning. - `getChanges` also does not swallow `CatchableError` by returning an empty array, and instead re-raises the error if it is not `filter not found`. - The tests were simplified by accessing the private fields of `PollingSubscriptions`. That way, there wasn't a race condition for the `newFilterId` counter inside of the mock. - The `MockRpcHttpServer` was simplified by keeping track of the active filters only, and invalidation simply removes the filter. The tests then only needed to rely on the fact that the filter id changed in the mapping. - Because of the above changes, we no longer needed to sleep inside of the tests, so the sleeps were removed, and the polling interval could be changed to 1ms, which not only makes the tests faster, but would further highlight any race conditions if present. * docs: rpc custom port documentation --------- Co-authored-by: Adam Uhlíř <adam@uhlir.dev>
156 lines
4.7 KiB
Nim
156 lines
4.7 KiB
Nim
import std/json
|
|
import std/os
|
|
import std/sequtils
|
|
import std/importutils
|
|
import pkg/asynctest
|
|
import pkg/serde
|
|
import pkg/json_rpc/rpcclient
|
|
import pkg/json_rpc/rpcserver
|
|
import ethers/provider
|
|
import ethers/providers/jsonrpc/subscriptions
|
|
|
|
import ../../examples
|
|
import ./rpc_mock
|
|
|
|
suite "JsonRpcSubscriptions":
|
|
|
|
test "can be instantiated with an http client":
|
|
let client = newRpcHttpClient()
|
|
let subscriptions = JsonRpcSubscriptions.new(client)
|
|
check not isNil subscriptions
|
|
|
|
test "can be instantiated with a websocket client":
|
|
let client = newRpcWebSocketClient()
|
|
let subscriptions = JsonRpcSubscriptions.new(client)
|
|
check not isNil subscriptions
|
|
|
|
template subscriptionTests(subscriptions, client) =
|
|
|
|
test "subscribes to new blocks":
|
|
var latestBlock: Block
|
|
proc callback(blck: Block) =
|
|
latestBlock = blck
|
|
let subscription = await subscriptions.subscribeBlocks(callback)
|
|
discard await client.call("evm_mine", newJArray())
|
|
check eventually latestBlock.number.isSome
|
|
check latestBlock.hash.isSome
|
|
check latestBlock.timestamp > 0.u256
|
|
await subscriptions.unsubscribe(subscription)
|
|
|
|
test "stops listening to new blocks when unsubscribed":
|
|
var count = 0
|
|
proc callback(blck: Block) =
|
|
inc count
|
|
let subscription = await subscriptions.subscribeBlocks(callback)
|
|
discard await client.call("evm_mine", newJArray())
|
|
check eventually count > 0
|
|
await subscriptions.unsubscribe(subscription)
|
|
count = 0
|
|
discard await client.call("evm_mine", newJArray())
|
|
await sleepAsync(100.millis)
|
|
check count == 0
|
|
|
|
test "stops listening to new blocks when provider is closed":
|
|
var count = 0
|
|
proc callback(blck: Block) =
|
|
inc count
|
|
discard await subscriptions.subscribeBlocks(callback)
|
|
discard await client.call("evm_mine", newJArray())
|
|
check eventually count > 0
|
|
await subscriptions.close()
|
|
count = 0
|
|
discard await client.call("evm_mine", newJArray())
|
|
await sleepAsync(100.millis)
|
|
check count == 0
|
|
|
|
suite "Web socket subscriptions":
|
|
|
|
var subscriptions: JsonRpcSubscriptions
|
|
var client: RpcWebSocketClient
|
|
|
|
setup:
|
|
client = newRpcWebSocketClient()
|
|
await client.connect("ws://" & getEnv("ETHERS_TEST_PROVIDER", "localhost:8545"))
|
|
subscriptions = JsonRpcSubscriptions.new(client)
|
|
subscriptions.start()
|
|
|
|
teardown:
|
|
await subscriptions.close()
|
|
await client.close()
|
|
|
|
subscriptionTests(subscriptions, client)
|
|
|
|
suite "HTTP polling subscriptions":
|
|
|
|
var subscriptions: JsonRpcSubscriptions
|
|
var client: RpcHttpClient
|
|
|
|
setup:
|
|
client = newRpcHttpClient()
|
|
await client.connect("http://" & getEnv("ETHERS_TEST_PROVIDER", "localhost:8545"))
|
|
subscriptions = JsonRpcSubscriptions.new(client,
|
|
pollingInterval = 100.millis)
|
|
subscriptions.start()
|
|
|
|
teardown:
|
|
await subscriptions.close()
|
|
await client.close()
|
|
|
|
subscriptionTests(subscriptions, client)
|
|
|
|
suite "HTTP polling subscriptions - filter not found":
|
|
|
|
var subscriptions: PollingSubscriptions
|
|
var client: RpcHttpClient
|
|
var mockServer: MockRpcHttpServer
|
|
|
|
privateAccess(PollingSubscriptions)
|
|
|
|
setup:
|
|
mockServer = MockRpcHttpServer.new()
|
|
mockServer.start()
|
|
|
|
client = newRpcHttpClient()
|
|
await client.connect("http://" & $mockServer.localAddress()[0])
|
|
|
|
subscriptions = PollingSubscriptions(
|
|
JsonRpcSubscriptions.new(
|
|
client,
|
|
pollingInterval = 1.millis))
|
|
subscriptions.start()
|
|
|
|
teardown:
|
|
await subscriptions.close()
|
|
await client.close()
|
|
await mockServer.stop()
|
|
|
|
test "filter not found error recreates filter":
|
|
let filter = EventFilter(address: Address.example, topics: @[array[32, byte].example])
|
|
let emptyHandler = proc(log: Log) = discard
|
|
|
|
check subscriptions.filters.len == 0
|
|
check subscriptions.subscriptionMapping.len == 0
|
|
|
|
let id = await subscriptions.subscribeLogs(filter, emptyHandler)
|
|
|
|
check subscriptions.filters[id] == filter
|
|
check subscriptions.subscriptionMapping[id] == id
|
|
check subscriptions.filters.len == 1
|
|
check subscriptions.subscriptionMapping.len == 1
|
|
|
|
mockServer.invalidateFilter(id)
|
|
|
|
check eventually subscriptions.subscriptionMapping[id] != id
|
|
|
|
test "recreated filter can be still unsubscribed using the original id":
|
|
let filter = EventFilter(address: Address.example, topics: @[array[32, byte].example])
|
|
let emptyHandler = proc(log: Log) = discard
|
|
let id = await subscriptions.subscribeLogs(filter, emptyHandler)
|
|
mockServer.invalidateFilter(id)
|
|
check eventually subscriptions.subscriptionMapping[id] != id
|
|
|
|
await subscriptions.unsubscribe(id)
|
|
|
|
check not subscriptions.filters.hasKey id
|
|
check not subscriptions.subscriptionMapping.hasKey id
|