Add status information for subscriptions & contract listeners

[shorsher]

If the fetchstatus query param is supplied when querying subscriptions or listeners by ID, firefly will return additional status information, if it is available.

Contract listeners:

FF environments connected to evm connectors will return listener checkpoint formation under the status key.

Example query: http://localhost:5000/api/v1/namespaces/default/contracts/listeners/92e3bc0c-3c3f-455b-81d3-4124a0270b1d?fetchstatus

Response:

{
    "id": "92e3bc0c-3c3f-455b-81d3-4124a0270b1d",
    "interface": {
        "id": "30775d45-61af-4f76-9d35-69b5d8ffbf42"
    },
    "namespace": "default",
    "name": "0182f410-a686-79ed-23a5-ac8c62acbf51",
    "backendId": "0182f410-a686-79ed-23a5-ac8c62acbf51",
    "location": {
        "address": "0x62d365e68fc55845ba904acef688feba7a598c9c"
    },
    "created": "2022-08-31T13:21:48.1687995Z",
    "event": {
        "name": "Changed",
        "description": "",
        "params": [
            {
                "name": "from",
                "schema": {
                    "type": "string",
                    "details": {
                        "type": "address",
                        "internalType": "address",
                        "indexed": true
                    }
                }
            },
            {
                "name": "value",
                "schema": {
                    "type": "integer",
                    "details": {
                        "type": "uint256",
                        "internalType": "uint256"
                    }
                }
            }
        ]
    },
    "signature": "Changed(address,uint256)",
    "topic": "bsc",
    "options": {
        "firstEvent": "oldest"
    },
    "status": {
        "checkpoint": {
            "block": 0,
            "transactionIndex": -1,
            "logIndex": -1
        }
    }
}

Subscriptions

Subscriptions will provide offset information if available

Example Query: http://localhost:5000/api/v1/namespaces/default/subscriptions/32cddc74-cc1a-4493-b376-45781e2d8d35?fetchstatus

Response:

{
    "id": "32cddc74-cc1a-4493-b376-45781e2d8d35",
    "namespace": "default",
    "name": "simple-storage",
    "transport": "websockets",
    "filter": {
        "message": {},
        "transaction": {},
        "blockchainevent": {}
    },
    "options": {
        "firstEvent": "-1",
        "withData": false
    },
    "created": "2022-08-31T17:13:04.295134Z",
    "updated": null,
    "status": {
        "currentOffset": 31
    }
}

[codecov-commenter]

Codecov Report

Merging #1028 (d20f34f) into main (e281a17) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1028   +/-   ##
=======================================
  Coverage   99.98%   99.98%           
=======================================
  Files         302      302           
  Lines       19919    19956   +37     
=======================================
+ Hits        19917    19954   +37     
  Misses          2        2           

Impacted Files	Coverage Δ
internal/orchestrator/orchestrator.go	100.00% <ø> (ø)
pkg/core/contract_listener.go	100.00% <ø> (ø)
pkg/core/subscription.go	100.00% <ø> (ø)
...erver/route_get_contract_listener_by_name_or_id.go	100.00% <100.00%> (ø)
internal/apiserver/route_get_subscription_by_id.go	100.00% <100.00%> (ø)
internal/blockchain/ethereum/ethereum.go	100.00% <100.00%> (ø)
internal/blockchain/ethereum/eventstream.go	100.00% <100.00%> (ø)
internal/blockchain/fabric/fabric.go	100.00% <100.00%> (ø)
internal/contracts/manager.go	100.00% <100.00%> (ø)
internal/orchestrator/subscriptions.go	100.00% <100.00%> (ø)
... and 2 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[peterbroadhurst]

Thanks for making those extra changes 👍