Merge pull request #2 from ChainSafe/use-requests-builder

Use requests builder

Author: AlexeyKrasnoperov

.gitignore

@@ -1,2 +1,11 @@
-.yarn
-node_modules
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+node_modules
+
+methods/requests.json

Makefile

@@ -1,13 +1,16 @@
 all-forest-cloud:
-	k6 cloud run -e K6_TEST_URL=http://localhost:2345/rpc/v1 --local-execution tests/all.js
+	k6 cloud run -e K6_RPC_URL=http://localhost:2345/rpc/v1 --local-execution tests/all.js
 
 all-lotus-cloud:
-	k6 cloud run -e K6_TEST_URL=http://localhost:1234/rpc/v1 --local-execution tests/all.js
+	k6 cloud run -e K6_RPC_URL=http://localhost:1234/rpc/v1 --local-execution tests/all.js
 
 all-forest-local:
-	k6 run -e K6_TEST_URL=http://localhost:2345/rpc/v1 tests/all.js
+	k6 run -e K6_RPC_URL=http://localhost:2345/rpc/v1 tests/all.js
 
 all-lotus-local:
-	k6 run -e K6_TEST_URL=http://localhost:1234/rpc/v1 tests/all.js
+	k6 run -e K6_RPC_URL=http://localhost:1234/rpc/v1 tests/all.js
 
-.PHONY: all-forest-cloud all-lotus-cloud all-forest-local all-lotus-local
+build-requests:
+	yarn build-requests
+
+.PHONY: all-forest-cloud all-lotus-cloud all-forest-local all-lotus-local build-requests

README.md

@@ -6,22 +6,39 @@ Implementation-agnostic benchmark for RPC
 
 This benchmarking suite requires [k6](https://grafana.com/docs/k6/latest/) installed on the host. Follow the instructions for your operating system. Alternatively, you can run them via Docker.
 
+## Methods Definitions
+
+Before running benchmarks, generate method definitions using the command:
+
+```bash
+K6_RPC_URL=http://localhost:2345/rpc/v1 yarn build-requests
+```
+
+It will generate real Filecoin and Ethereum JSON-RPC method definitions with up-to-date parameters from live chain state and will store them in the `methods/requests.json` file.
+Feel free to adjust parameters manually.
+
 ## Local benchmarks
 
 You can run the benchmarks fully locally. To do so, you will need a running Filecoin node; ensure it's synced.
 
-Sample benchmark run:
+Benchmark all supported methods:
+
+```bash
+k6 run -e K6_RPC_URL=http://localhost:2345/rpc/v1 tests/all.js --duration 30s --vus 20
+```
+
+Single method benchmark:
 
 ```bash
-k6 run -e K6_TEST_URL=http://localhost:2345/rpc/v1 tests/all.js --duration 30s --vus 20
+k6 run -e K6_RPC_URL=http://localhost:2345/rpc/v1 K6_METHOD=eth_gasPrice tests/single_method.js --duration 30s --vus 20
 ```
 
 ## Upload benchmarks to Grafana Cloud
 
 You can create a free account on Grafana Cloud (the free tier should suffice if you run the tests locally). Login with `k6 cloud login --token <token>`. Now, you can run the benchmarks locally but have them uploaded to your Grafana Cloud for visual inspection and comparisons.
 
 ```bash
-k6 cloud run -e K6_TEST_URL=http://localhost:2345/rpc/v1 --local-execution tests/top5.js
+k6 cloud run -e K6_RPC_URL=http://localhost:2345/rpc/v1 --local-execution tests/all.js
 ```
 
 ## Configuring benchmarks
@@ -30,10 +47,11 @@ Read about [k6 options](https://grafana.com/docs/k6/latest/using-k6/k6-options/)
 
 ## Environment variables
 
-| Name            | Description                 | Type | Default                        |
-| --------------- | --------------------------- | ---- | ------------------------------ |
-| `K6_TEST_URL`   | Node RPC endpoint           | URL  | `http://localhost:2345/rpc/v1` |
-| `K6_TEST_DEBUG` | Print additional debug info | bool | false                          |
+| Name            | Description                 | Type   | Default                        |
+| --------------- | --------------------------- | ------ | ------------------------------ |
+| `K6_RPC_URL`    | Node RPC endpoint           | URL    | `http://localhost:2345/rpc/v1` |
+| `K6_METHOD`     | Method to benchmark         | string | 'eth_gasPrice'                 |
+| `K6_TEST_DEBUG` | Print additional debug info | bool   | false                          |
 
 ## Pitfalls
 

methods/.keep

@@ -4,13 +4,16 @@
   "scripts": {
     "js-lint": "eslint  '**/*.js'",
     "js-fmt": "prettier --write '**/*.js'",
-    "js-fmt-check": "prettier --check '**/*.js'"
+    "js-fmt-check": "prettier --check '**/*.js'",
+    "build-requests": "node ./scripts/build_requests.js"
   },
   "keywords": [],
+  "type": "module",
   "author": "",
   "license": "MIT",
   "description": "",
   "devDependencies": {
+    "@chainsafe/filecoin-requests-builder": "^0.1.0",
     "@eslint/js": "^9.22.0",
     "@types/k6": "^0.57.1",
     "eslint": "^9.22.0",

methods/index.js

@@ -0,0 +1,15 @@
+import { buildRequests, fetchRpcContext } from '@chainsafe/filecoin-requests-builder';
+import fs from 'fs';
+
+const url = process.env.K6_RPC_URL || "http://localhost:2345/rpc/v1";
+
+try {
+  const context = await fetchRpcContext(url);
+  const requests = buildRequests(context);
+
+  fs.writeFileSync('methods/requests.json', JSON.stringify(requests, null, 2));
+  console.log('Successfully generated methods/requests.json');
+} catch (error) {
+  console.error('Failed to generate requests:', error.message);
+  process.exit(1);
+}

package.json

@@ -1,17 +1,21 @@
-import http from "k6/http";
-
-import { allMethods } from "../methods/index.js";
 import { sendRpcRequest, assertSuccess } from "../utils/rpc.js";
 import { regularBenchmarkParams } from "../utils/benchmark_params.js";
+import { loadRequests } from '../utils/loadRequests.js';
 
-const url = __ENV.K6_TEST_URL || "http://localhost:2345/rpc/v1";
+const url = __ENV.K6_RPC_URL || "http://localhost:2345/rpc/v1";
 
 export let options = regularBenchmarkParams;
+const requests = loadRequests();
 
 // the function that will be executed for each VU (virtual user)
 export default function () {
-  for (const method of allMethods) {
-    const response = sendRpcRequest(url, method);
-    assertSuccess(response);
+  try {
+    for (const [method, { params }] of Object.entries(requests)) {
+      const response = sendRpcRequest(url, method, params);
+      assertSuccess(response);
+    }
+  } catch (error) {
+    console.error('Error processing requests:', error.message);
+    throw error;
   }
 }

scripts/build_requests.js

@@ -0,0 +1,24 @@
+import { assertSuccess, sendRpcRequest } from "../utils/rpc.js";
+import { regularBenchmarkParams } from "../utils/benchmark_params.js";
+import { loadRequests } from '../utils/loadRequests.js';
+
+const url = __ENV.K6_RPC_URL || "http://localhost:2345/rpc/v1";
+const method = __ENV.K6_METHOD || "eth_gasPrice";
+
+export let options = regularBenchmarkParams;
+const requests = loadRequests();
+
+// the function that will be executed for each VU (virtual user)
+export default function () {
+  try {
+    if (!requests[method]) {
+      throw new Error(`Method ${method} is not supported`);
+    }
+
+    const response = sendRpcRequest(url, method, requests[method].params);
+    assertSuccess(response);
+  } catch (error) {
+    console.error('Error processing requests:', error.message);
+    throw error;
+  }
+}