Merge pull request #113 from smartcontractkit/vrf-perf-metrics

Per request id metrics for VRF/Runlog tests

Author: skudasov

Makefile

@@ -64,6 +64,10 @@ test_keeper: ## run keeper tests
 test_ocr: ## run ocr tests
 	ginkgo -r --focus=@ocr
 
+.PHONY: test_flux_perf
+test_flux_perf: ## run Flux perf test
+	NETWORK="ethereum_geth_performance" ginkgo -r --focus="@perf-flux"
+
 .PHONY: test_ocr_soak
 test_ocr_soak: ## run OCR soak test
 	NETWORK="ethereum_geth_performance" ginkgo -r --focus="@soak-ocr"
@@ -72,6 +76,10 @@ test_ocr_soak: ## run OCR soak test
 test_runlog_soak: ## run Runlog soak test
 	NETWORK="ethereum_geth_performance" ginkgo -r --focus="@soak-runlog"
 
+.PHONY: test_runlog_perf
+test_runlog_perf: ## run Runlog perf test
+	NETWORK="ethereum_geth_performance" ginkgo -r --focus="@perf-runlog"
+
 .PHONY: test_keeper_soak
 test_keeper_soak: ## run Keeper soak/performance test
 	NETWORK="ethereum_geth_performance" ginkgo -r --focus="@performance-keeper"
@@ -80,6 +88,10 @@ test_keeper_soak: ## run Keeper soak/performance test
 test_vrf_soak: ## run VRF soak test
 	NETWORK="ethereum_geth_performance" ginkgo -r --focus="@soak-vrf"
 
+.PHONY: test_vrf_perf
+test_vrf_perf: ## run VRF perf test
+	NETWORK="ethereum_geth_performance" ginkgo -r --focus="@perf-vrf"
+
 .PHONY: test_runlog
 test_runlog: ## run runlog tests
 	ginkgo -r --focus=@runlog

actions/actions.go

@@ -1,6 +1,7 @@
 package actions
 
 import (
+	"encoding/json"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/pkg/errors"
 	"github.com/satori/go.uuid"
@@ -57,6 +58,22 @@ func EncodeOnChainExternalJobID(jobID uuid.UUID) [32]byte {
 	return ji
 }
 
+// ExtractRequestIDFromJobRun extracts RequestID from job runs response
+func ExtractRequestIDFromJobRun(jobDecodeData client.RunsResponseData) ([]byte, error) {
+	var taskRun client.TaskRun
+	for _, tr := range jobDecodeData.Attributes.TaskRuns {
+		if tr.Type == "ethabidecodelog" {
+			taskRun = tr
+		}
+	}
+	var decodeLogTaskRun *client.DecodeLogTaskRun
+	if err := json.Unmarshal([]byte(taskRun.Output), &decodeLogTaskRun); err != nil {
+		return nil, err
+	}
+	rqInts := decodeLogTaskRun.RequestID
+	return rqInts, nil
+}
+
 // EncodeOnChainVRFProvingKey encodes uncompressed public VRF key to on-chain representation
 func EncodeOnChainVRFProvingKey(vrfKey client.VRFKey) ([2]*big.Int, error) {
 	uncompressed := vrfKey.Attributes.Uncompressed

client/chainlink_models.go

@@ -43,10 +43,31 @@ type RunsAttributesResponse struct {
 	Meta       interface{}   `json:"meta"`
 	Errors     []interface{} `json:"errors"`
 	Inputs     RunInputs     `json:"inputs"`
+	TaskRuns   []TaskRun     `json:"taskRuns"`
 	CreatedAt  time.Time     `json:"createdAt"`
 	FinishedAt time.Time     `json:"finishedAt"`
 }
 
+//DecodeLogTaskRun is "ethabidecodelog" task run info,
+// also used for "RequestID" tracing in perf tests
+type DecodeLogTaskRun struct {
+	Fee       int    `json:"fee"`
+	JobID     []int  `json:"jobID"`
+	KeyHash   []int  `json:"keyHash"`
+	RequestID []byte `json:"requestID"`
+	Sender    string `json:"sender"`
+}
+
+//TaskRun is pipeline task run info
+type TaskRun struct {
+	Type       string      `json:"type"`
+	CreatedAt  time.Time   `json:"createdAt"`
+	FinishedAt time.Time   `json:"finishedAt"`
+	Output     string      `json:"output"`
+	Error      interface{} `json:"error"`
+	DotID      string      `json:"dotId"`
+}
+
 // RunInputs run inputs (value)
 type RunInputs struct {
 	Parse int `json:"parse"`

contracts/contract_models.go

@@ -143,6 +143,7 @@ type APIConsumer interface {
 		path string,
 		times *big.Int,
 	) error
+	WatchPerfEvents(ctx context.Context, eventChan chan<- *PerfEvent) error
 }
 
 type Storage interface {
@@ -263,6 +264,7 @@ type VRFConsumer interface {
 	RequestRandomness(fromWallet client.BlockchainWallet, hash [32]byte, fee *big.Int) error
 	CurrentRoundID(ctx context.Context) (*big.Int, error)
 	RandomnessOutput(ctx context.Context) (*big.Int, error)
+	WatchPerfEvents(ctx context.Context, eventChan chan<- *PerfEvent) error
 	Fund(fromWallet client.BlockchainWallet, ethAmount, linkAmount *big.Float) error
 }
 
@@ -292,3 +294,12 @@ type Flags interface {
 type DeviationFlaggingValidator interface {
 	Address() string
 }
+
+// PerfEvent is used to get some metrics for contracts,
+// it contrains roundID for Keeper/OCR/Flux tests and request id for VRF/Runlog
+type PerfEvent struct {
+	Contract       DeviationFlaggingValidator
+	Round          *big.Int
+	RequestID      [32]byte
+	BlockTimestamp *big.Int
+}

contracts/ethereum/APIConsumer.go

@@ -68,6 +68,31 @@
     "name": "OwnershipTransferred",
     "type": "event"
   },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "roundID",
+        "type": "uint256"
+      },
+      {
+        "indexed": false,
+        "internalType": "bytes32",
+        "name": "requestId",
+        "type": "bytes32"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "timestamp",
+        "type": "uint256"
+      }
+    ],
+    "name": "PerfMetricsEvent",
+    "type": "event"
+  },
   {
     "inputs": [
       {
@@ -140,6 +165,19 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [],
+    "name": "currentRoundID",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "data",
@@ -210,19 +248,6 @@
     "stateMutability": "view",
     "type": "function"
   },
-  {
-    "inputs": [],
-    "name": "roundID",
-    "outputs": [
-      {
-        "internalType": "uint256",
-        "name": "",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "view",
-    "type": "function"
-  },
   {
     "inputs": [],
     "name": "selector",