Merge branch 'main' into elmattic/chain-get-events

Author: elmattic

.github/workflows/js-lint.yml

@@ -0,0 +1,32 @@
+name: JS linters
+
+# Cancel workflow if there is a new change to the branch.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+on:
+  merge_group:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+  paths:
+    - 'benchmarks/**'
+
+jobs:
+  run-js-linters:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: "18"
+    - run: |
+        cd benchmarks/
+        corepack enable
+        yarn install --immutable
+        yarn js-lint
+        yarn js-fmt-check

.gitignore

@@ -189,7 +189,6 @@ web_modules/
 .yarn-integrity
 
 # dotenv environment variable files
-.env
 .env.development.local
 .env.test.local
 .env.production.local
@@ -389,4 +388,4 @@ rust-project.json
 
 # End of https://www.toptal.com/developers/gitignore/api/go,rust,rust-analyzer,osx,visualstudiocode,intellij+all,yarn,node,ruby
 
-lychee-report.md
+lychee-report.md

CHANGELOG.md

@@ -31,10 +31,16 @@
 
 ### Changed
 
+- [#5452](https://github.com/ChainSafe/forest/pull/5452) Speed up void database migration.
+
 ### Removed
 
+- [#5449](https://github.com/ChainSafe/forest/pull/5449) Remove unnecessary/duplicate metrics.
+
 ### Fixed
 
+- [#5458](https://github.com/ChainSafe/forest/pull/5458) Fix stack overflow occurring when running Forest in debug mode.
+
 ## Forest v0.25.0 "Bombadil"
 
 This is a mandatory release for calibnet node operators. It includes the revised NV25 _Teep_ network upgrade at epoch `2_523_454` which corresponds to `2025-03-26T23:00:00Z`. This release also includes a number of new RPC methods, fixes and other improvements. Be sure to check the breaking changes before upgrading.

Cargo.lock

@@ -49,6 +49,7 @@ cfg-vis = "0.3"
 chrono = { version = "0.4", default-features = false, features = ["clock"] }
 cid = { workspace = true }
 clap = { version = "4", features = ["derive"] }
+clap_complete = "4"
 colored = "3"
 crypto_secretbox = "0.1"
 daemonize-me = "2"
@@ -220,7 +221,6 @@ walkdir = "2"
 zstd = "0.13"
 
 # optional dependencies
-clap_complete = "4.5.46"
 console-subscriber = { version = "0.4", features = ["parking_lot"], optional = true }
 mimalloc = { version = "0.1", optional = true, default-features = false }
 paste = "1"

Cargo.toml

@@ -0,0 +1,2 @@
+.yarn
+node_modules

benchmarks/.gitignore

@@ -0,0 +1,13 @@
+all-forest-cloud:
+	k6 cloud run -e K6_TEST_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
+
+all-forest-local:
+	k6 run -e K6_TEST_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
+
+.PHONY: all-forest-cloud all-lotus-cloud all-forest-local all-lotus-local

benchmarks/Makefile

@@ -0,0 +1,48 @@
+# K6 benchmarking for Filecoin JSON-RPC
+
+Implementation-agnostic benchmark for RPC
+
+## Requirements
+
+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.
+
+## 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:
+
+```bash
+k6 run -e K6_TEST_URL=http://localhost:2345/rpc/v1 tests/all.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
+```
+
+## Configuring benchmarks
+
+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                          |
+
+## Pitfalls
+
+- Don't run the benchmarks in a environment with shared CPU, e.g., on a VPS. The results will vary depending on the load on that CPU.
+- Don't run the node in a virtualized environment, e.g., Docker for Mac. Use a native build.
+- Ensure your test parameters match your hardware. Ensure your machine is not saturated, e.g., `k6` itself using most of the resources and leaving the node with too little CPU/RAM. If need be, run the test on separate machines. `k6` and the node could also be limited, e.g., via Docker.
+
+## Potential improvements
+
+- [ ] include more methods
+- [ ] rewrite in TypeScript
+- [ ] visualize results locally

benchmarks/README.md

@@ -0,0 +1,14 @@
+import { defineConfig } from "eslint/config";
+import globals from "globals";
+import js from "@eslint/js";
+
+
+export default defineConfig([
+  { files: ["**/*.{js,mjs,cjs}"] },
+  { files: ["**/*.{js,mjs,cjs}"], languageOptions: { globals: globals.browser } },
+  { files: ["**/*.{js,mjs,cjs}"], plugins: { js }, extends: ["js/recommended"] },
+
+  // Those don't play well with `k6`
+  { files: ["**/*.{js,mjs,cjs}"], rules: { "no-unused-vars": "off" } },
+  { files: ["**/*.{js,mjs,cjs}"], rules: { "no-undef": "off" } },
+]);