Merge

Author: kalverra

.github/workflows/lint.yaml

@@ -21,6 +21,26 @@ jobs:
       - name: Run pre-commit checks
         run: |
           nix develop -c sh -c "pre-commit run --hook-stage pre-commit --show-diff-on-failure --color=always"
+
+  clean-go-mods:
+    name: Clean go mods
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go 1.23.3
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.23.3'
+      - name: Install gomods
+        run: go install github.com/jmank88/[email protected]
+      - name: Check out code
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      - name: Run gomods tidy
+        run: gomods tidy
+      - name: Ensure clean after tidy
+        run: |
+          git add --all
+          git diff --minimal --cached --exit-code
+
   tools:
     name: Get tool-versions
     runs-on: ubuntu-latest

.github/workflows/rc-breaking-changes.yaml

@@ -25,4 +25,6 @@ jobs:
           go install golang.org/x/exp/cmd/gorelease@latest
       - name: Run Breaking Changes Script
         run: |
-          go run ./tools/breakingchanges/cmd/main.go --ignore tools
+          cd ./tools/breakingchanges
+          go mod tidy
+          go run cmd/main.go --ignore tools --root ../../

.github/workflows/release-go-module.yml

@@ -51,7 +51,7 @@ jobs:
           fi
 
           # Extract the version part of the last tag
-          LAST_TAG_VERSION="${LAST_TAG##*/}"  
+          LAST_TAG_VERSION="${LAST_TAG##*/}"
           echo "Last tag version: $LAST_TAG_VERSION"
           echo "LAST_TAG_VERSION=${LAST_TAG_VERSION}" >> "$GITHUB_ENV"
 

.nancy-ignore

@@ -13,4 +13,5 @@ CVE-2024-32972 # CWE-400: Uncontrolled Resource Consumption ('Resource Exhaustio
 CVE-2023-42319 # CWE-noinfo: lol... go-ethereum v1.13.8 again
 CVE-2024-10086 # Improper Neutralization of Input During Web Page Generation ('Cross-site Scripting')
 CVE-2024-51744 # CWE-755: Improper Handling of Exceptional Conditions
-CVE-2024-45338 # CWE-770: Allocation of Resources Without Limits or Throttling
+CVE-2024-45338 # CWE-770: Allocation of Resources Without Limits or Throttling
+CVE-2024-45337 # CWE-863: Incorrect Authorization in golang.org/x/[email protected]

book/src/SUMMARY.md

@@ -80,6 +80,7 @@
       - [Custom Prometheus metrics](./libs/wasp/benchspy/prometheus_custom.md)
       - [To Loki or not to Loki?](./libs/wasp/benchspy/loki_dillema.md)
       - [Real world example](./libs/wasp/benchspy/real_world.md)
+      - [Debugging](./libs/wasp/benchspy/debugging.md)
       - [Reports](./libs/wasp/benchspy/reports/overview.md)
         - [Standard Report](./libs/wasp/benchspy/reports/standard_report.md)
           - [Adding new QueryExecutor](./libs/wasp/benchspy/reports/new_executor.md)

book/src/libs/seth.md

@@ -70,7 +70,7 @@ Reliable and debug-friendly Ethereum client
 - [ ] Tracing support (prestate)
 - [x] Tracing decoding
 - [x] Tracing tests
-- [ ] More tests for corner cases of decoding/tracing
+- [x] More tests for corner cases of decoding/tracing
 - [x] Saving of deployed contracts mapping (`address -> ABI_name`) for live networks
 - [x] Reading of deployed contracts mappings for live networks
 - [x] Automatic gas estimator (experimental)
@@ -233,7 +233,9 @@ client, err := NewClientBuilder().
     // EIP-1559 and gas estimations
     WithEIP1559DynamicFees(true).
     WithDynamicGasPrices(120_000_000_000, 44_000_000_000).
-    WithGasPriceEstimations(true, 10, seth.Priority_Fast).
+    // estimate gas prices based on the information from the RPC based on 10 last blocks
+    // adjust the value to fast priority and 3 attempts to get the estimations
+    WithGasPriceEstimations(true, 10, seth.Priority_Fast, 3).
     // gas bumping: retries, max gas price, bumping strategy function
     WithGasBumping(5, 100_000_000_000, PriorityBasedGasBumpingStrategyFn).
     Build()
@@ -441,6 +443,8 @@ For real networks, the estimation process differs for legacy transactions and th
 5. **Final Fee Calculation**: Sum the base fee and adjusted tip to set the `gas_fee_cap`.
 6. **Congestion Buffer**: Similar to legacy transactions, analyze congestion and apply a buffer to both the fee cap and the tip to secure transaction inclusion.
 
+Regardless of transaction type, if fetching data from RPC or calculating prices fails due to any issue and `gas_price_estimation_attempt_count` is > 1 we will retry it N-1 number of times.
+
 Understanding and setting these parameters correctly ensures that your transactions are processed efficiently and cost-effectively on the network.
 
 When fetching historical base fee and tip data, we will use the last `gas_price_estimation_blocks` blocks. If it's set to `0` we will default to `100` last blocks. If the blockchain has less than `100` blocks we will use all of them.
@@ -492,6 +496,14 @@ case Congestion_VeryHigh:
 For low congestion rate we will increase gas price by 10%, for medium by 20%, for high by 30% and for very high by 40%. We cache block header data in an in-memory cache, so we don't have to fetch it every time we estimate gas. The cache has capacity equal to `gas_price_estimation_blocks` and every time we add a new element, we remove one that is least frequently used and oldest (with block number being a constant and chain always moving forward it makes no sense to keep old blocks). It's important to know that in order to use congestion metrics we need to fetch at least 80% of the requested blocks. If that fails, we will skip this part of the estimation and only adjust the gas price based on priority.
 For both transaction types if any of the steps fails, we fall back to hardcoded values.
 
+##### Gas estimations attemps
+
+If for any reason fetching gas price suggestions or fee history from the RPC fails, or subsequent calulation of percentiles fails, it can be retried. This behaviour is controlled by `gas_price_estimation_attempt_count`, which if empty or set to `0` will default to
+just one attempt, which means that if it fails, it won't be retried. Set it to `2` to allow a single retry, etc.
+
+> [!NOTE]
+> To disable gas estimation set `gas_price_estimation_enabled` to `false`. Setting `gas_price_estimation_attempt_count` to `0` won't have such effect.
+
 ### DOT graphs
 
 There are multiple ways of visualising DOT graphs:

book/src/libs/wasp/benchspy/debugging.md

@@ -0,0 +1,3 @@
+# BenchSpy - Debugging
+
+If you run into any issues with `BenchSpy` it might help to lower the default logging level to either `debug` or `trace`. It's controlled by environment variable called `BENCHSPY_LOG_LEVEL`.

book/src/libs/wasp/benchspy/getting_started.md

@@ -11,4 +11,7 @@ The following examples assume you have access to the following applications:
 
 Since BenchSpy is tightly coupled with WASP, we highly recommend that you [get familiar with it first](../overview.md) if you haven't already.
 
-Ready? [Let's get started!](./first_test.md)
+Ready? [Let's get started!](./first_test.md)
+
+> [!NOTE]
+> You can `BENCHSPY_LOG_LEVEL` environment variable to control the log level.

book/src/libs/wasp/benchspy/real_world.md

@@ -87,15 +87,17 @@ This function fetches the current report (for version passed as environment vari
 Let’s assume you want to ensure that none of the performance metrics degrade by more than **1%** between releases (and that error rate has not changed at all). Here's how you can write assertions using a convenient function for the `Direct` query executor:
 
 ```go
-hasErrors, errors := benchspy.CompareDirectWithThresholds(
+hasFailed, error := benchspy.CompareDirectWithThresholds(
     1.0, // Max 1% worse median latency
     1.0, // Max 1% worse p95 latency
     1.0, // Max 1% worse maximum latency
     0.0, // No increase in error rate
     currentReport, previousReport)
-require.False(t, hasErrors, fmt.Sprintf("errors found: %v", errors))
+require.False(t, hasError, fmt.Sprintf("issues found: %v", error))
 ```
 
+Error returned by this function is a concatenation of all threshold violations found for each standard metric and generator.
+
 ---
 
 ## Conclusion

framework/.changeset/v0.4.2.md

@@ -0,0 +1,3 @@
+- Name logs subdir as test name
+- Mutex for concurrent mock Record access
+- Remove Promtail only through CLI