redact_sensitive feature flag (#176)

demo for @ZanCorDX Idea is to redact the error `Display` and `Debug` implementation where the error is defined, rather than creating new layers of wrapper we need to maintain and remember to use --------- Co-authored-by: Daniel Xifra <[email protected]>
flashbots · Oct 3, 2024 · 9b67084 · 9b67084
1 parent 4144286
commit 9b67084
Show file tree

Hide file tree

Showing 12 changed files with 386 additions and 140 deletions.
diff --git a/.github/workflows/checks.yaml b/.github/workflows/checks.yaml
@@ -14,12 +14,16 @@ jobs:
   lint_and_test:
     name: Lint and test
     runs-on: warp-ubuntu-latest-x64-16x
+    env:
+      # Set features for the Makefile
+      FEATURES: ${{ matrix.features }}
     strategy:
       matrix:
         toolchain:
           - stable
-          #- beta
-          #- nightly
+        features:
+          - ""
+          - "redact_sensitive"
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -53,9 +57,11 @@ jobs:
       - name: Install native dependencies
         run: sudo apt-get install -y libsqlite3-dev
 
-      # lint and test
-      - run: make lint
-      - run: make test
+      - name: Lint
+        run: make lint
+
+      - name: Test
+        run: make test
 
   integration:
     name: Integration tests
@@ -65,8 +71,9 @@ jobs:
       matrix:
         toolchain:
           - stable
-          #- beta
-          #- nightly
+        features:
+          - ""
+          - "redact_sensitive"
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -92,13 +99,13 @@ jobs:
           echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
 
       - name: Build the rbuilder
-        run: cargo build
+        run: cargo build --features="${{ matrix.features }}"
 
       - name: Run the playground
         run: builder-playground &
 
-      - name: Run integration tests
-        run: cargo test --package rbuilder --lib -- integration
+      - name: Run integration tests with flags
+        run: cargo test --features="${{ matrix.features }}" --package rbuilder --lib -- integration
         env:
           PLAYGROUND: TRUE
 

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -3,21 +3,21 @@ name: Release
 on:
   push:
     tags:
-      - 'v*'
+      - "v*"
   workflow_dispatch:
     inputs:
       build-docker:
-        description: 'Build Docker'
+        description: "Build Docker"
         required: false
         type: boolean
         default: false
       build-binary:
-        description: 'Build Binary'
+        description: "Build Binary"
         required: false
         type: boolean
         default: true
       draft-release:
-        description: 'Draft Release'
+        description: "Draft Release"
         required: false
         type: boolean
         default: false
@@ -77,6 +77,9 @@ jobs:
             runner: warp-ubuntu-latest-arm64-16x
           - target: aarch64-apple-darwin
             runner: warp-macos-14-arm64-6x
+        features:
+          - ""
+          - "redact_sensitive"
 
     steps:
       - name: Checkout sources
@@ -107,12 +110,16 @@ jobs:
 
       - name: Prepare output filename
         run: |
-          OUTPUT_FILENAME="rbuilder-${VERSION}-${{ matrix.configs.target }}.tar.gz"
+          if [ -z "${{ matrix.features }}" ]; then
+            OUTPUT_FILENAME="rbuilder-${VERSION}-${{ matrix.configs.target }}.tar.gz"
+          else
+            OUTPUT_FILENAME="rbuilder-${VERSION}-${{ matrix.configs.target }}-${{ matrix.features }}.tar.gz"
+          fi
           echo "OUTPUT_FILENAME=$OUTPUT_FILENAME" >> $GITHUB_ENV
           echo "Filename: ${OUTPUT_FILENAME}"
 
       - name: Build rbuilder binary
-        run: cargo build --release
+        run: cargo build --release --features=${{ matrix.features }}
 
       - name: Prepare artifacts
         run: |

diff --git a/Dockerfile b/Dockerfile
@@ -8,6 +8,8 @@
 #
 FROM rust:1.79 as base
 
+ARG FEATURES
+
 RUN cargo install sccache --version ^0.8
 RUN cargo install cargo-chef --version ^0.1
 
@@ -53,7 +55,7 @@ COPY ./crates/ ./crates/
 RUN --mount=type=cache,target=/usr/local/cargo/registry \
     --mount=type=cache,target=/usr/local/cargo/git \
     --mount=type=cache,target=$SCCACHE_DIR,sharing=locked \
-    cargo build --release
+    cargo build --release --features="$FEATURES"
 
 #
 # Runtime container

diff --git a/Makefile b/Makefile
@@ -5,6 +5,8 @@
 GIT_VER ?= $(shell git describe --tags --always --dirty="-dev")
 GIT_TAG ?= $(shell git describe --tags --abbrev=0)
 
+FEATURES ?=
+
 ##@ Help
 
 .PHONY: help
@@ -23,22 +25,22 @@ clean: ## Clean up
 
 .PHONY: build
 build: ## Build (debug version)
-	cargo build
+	cargo build --features "$(FEATURES)"
 
 .PHONY: docker-image
 docker-image: ## Build a rbuilder Docker image
-	docker build --platform linux/amd64 . -t rbuilder
+	docker build --platform linux/amd64 --build-arg FEATURES="$(FEATURES)" . -t rbuilder
 
 ##@ Dev
 
 .PHONY: lint
 lint: ## Run the linters
 	cargo fmt -- --check
-	cargo clippy -- -D warnings
+	cargo clippy --features "$(FEATURES)" -- -D warnings
 
 .PHONY: test
 test: ## Run the tests
-	cargo test --verbose
+	cargo test --verbose --features "$(FEATURES)"
 
 .PHONY: lt
 lt: lint test ## Run "lint" and "test"
@@ -47,11 +49,11 @@ lt: lint test ## Run "lint" and "test"
 fmt: ## Format the code
 	cargo fmt
 	cargo fix --allow-staged
-	cargo clippy --fix --allow-staged
+	cargo clippy --features "$(FEATURES)" --fix --allow-staged
 
 .PHONY: bench
 bench: ## Run benchmarks
-	cargo bench --bench bench_main
+	cargo bench --features "$(FEATURES)" --bench bench_main
 #	 cargo bench --bench bench_main -- --verbose
 
 .PHONY: bench-report-open

diff --git a/crates/rbuilder/Cargo.toml b/crates/rbuilder/Cargo.toml
@@ -135,3 +135,6 @@ criterion = { version = "0.5.1", features = ["html_reports", "async_tokio"] }
 [[bench]]
 name = "bench_main"
 harness = false
+
+[features]
+redact_sensitive = []