add clippy-sarif for pretty clippy output integrated with github

xmtp · Jan 29, 2025 · b2fc0c2 · b2fc0c2
1 parent b4127f2
commit b2fc0c2
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 15 deletions.
diff --git a/.github/workflows/lint-ffi-bindings.yaml b/.github/workflows/lint-ffi-bindings.yaml
@@ -11,7 +11,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
-  RUSTFLAGS: -D warnings
+  RUSTFLAGS: -D warnings --cfg tracing_unstable
   CARGO_PROFILE_TEST_DEBUG: 0
 jobs:
   lint:
@@ -22,13 +22,20 @@ jobs:
         uses: actions/checkout@v4
       - name: Update rust toolchains
         run: rustup update
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: clippy-sarif,sarif-fmt
       - name: Cache
         uses: Swatinem/rust-cache@v2
         with:
           workspaces: |
             .
             bindings_ffi
       - name: Run clippy and fail on warnings
-        run: cargo clippy --locked --manifest-path bindings_ffi/Cargo.toml --all-features --all-targets --no-deps
+        run: cargo clippy --locked --manifest-path bindings_ffi/Cargo.toml --all-features --all-targets --no-deps --message-format=json | clippy-sarif | tee results.sarif | sarif-fmt
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: results.sarif
       - name: Run format check
         run: cargo fmt --manifest-path bindings_ffi/Cargo.toml --check
diff --git a/.github/workflows/lint-node-bindings.yaml b/.github/workflows/lint-node-bindings.yaml
@@ -8,7 +8,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
-  RUSTFLAGS: -D warnings
+  RUSTFLAGS: -D warnings --cfg tracing_unstable
   CARGO_PROFILE_TEST_DEBUG: 0
 jobs:
   lint:
@@ -19,14 +19,21 @@ jobs:
         uses: actions/checkout@v4
       - name: Update rust toolchains
         run: rustup update
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: clippy-sarif,sarif-fmt
       - name: Cache
         uses: Swatinem/rust-cache@v2
         with:
           workspaces: |
             .
             bindings_node
       - name: Run clippy and fail on warnings
-        run: cargo clippy --locked --manifest-path bindings_node/Cargo.toml --all-features --all-targets --no-deps
+        run: cargo clippy --locked --manifest-path bindings_node/Cargo.toml --all-features --all-targets --no-deps --message-format=json | clippy-sarif | tee results.sarif | sarif-fmt
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: results.sarif
       - name: Run format check
         run: cargo fmt --manifest-path bindings_node/Cargo.toml --check
       - name: Setup node

diff --git a/.github/workflows/lint-wasm-bindings.yaml b/.github/workflows/lint-wasm-bindings.yaml
@@ -8,7 +8,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
-  RUSTFLAGS: -D warnings
+  RUSTFLAGS: -D warnings --cfg tracing_unstable
   CARGO_PROFILE_TEST_DEBUG: 0
 jobs:
   lint:
@@ -19,12 +19,19 @@ jobs:
         uses: actions/checkout@v4
       - name: Update rust toolchains
         run: rustup update
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: clippy-sarif,sarif-fmt
       - name: Cache
         uses: Swatinem/rust-cache@v2
         with:
           workspaces: |
             bindings_wasm
       - name: Run clippy and fail on warnings
-        run: cargo clippy --manifest-path bindings_wasm/Cargo.toml --all-features --target wasm32-unknown-unknown --no-deps
+        run: cargo clippy --locked --manifest-path bindings_wasm/Cargo.toml --all-features --target wasm32-unknown-unknown --no-deps --message-format=json | clippy-sarif | tee results.sarif | sarif-fmt
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: results.sarif
       - name: Run format check
         run: cargo fmt --manifest-path bindings_wasm/Cargo.toml --check
diff --git a/.github/workflows/lint-workspace.yaml b/.github/workflows/lint-workspace.yaml
@@ -22,7 +22,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
-  RUSTFLAGS: -D warnings
+  RUSTFLAGS: -D warnings --cfg tracing_unstable
   CARGO_PROFILE_TEST_DEBUG: 0
 jobs:
   lint:
@@ -33,13 +33,20 @@ jobs:
         uses: actions/checkout@v4
       - name: Update rust toolchains
         run: rustup update
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: clippy-sarif,sarif-fmt
       - name: Cache
         uses: Swatinem/rust-cache@v2
         with:
           workspaces: |
             .
       - name: Run clippy and fail on warnings
         # Exclude bindings_wasm since it only compiles for wasm32
-        run: cargo clippy --locked --workspace --all-features --all-targets --no-deps --exclude bindings_wasm
+        run: cargo clippy --locked --workspace --all-features --all-targets --no-deps --exclude bindings_wasm --message-format=json | clippy-sarif | tee results.sarif | sarif-fmt
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: results.sarif
       - name: Run format check
         run: cargo fmt --check
diff --git a/.github/workflows/test-ffi-bindings.yml b/.github/workflows/test-ffi-bindings.yml
@@ -22,7 +22,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
-  RUSTFLAGS: -D warnings
+  RUSTFLAGS: -D warnings --cfg tracing_unstable
   CARGO_PROFILE_TEST_DEBUG: 0
 jobs:
   test:

diff --git a/.github/workflows/test-http-api.yml b/.github/workflows/test-http-api.yml
@@ -21,7 +21,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
-  RUSTFLAGS: -D warnings
+  RUSTFLAGS: -D warnings --cfg tracing_unstable
   CARGO_PROFILE_TEST_DEBUG: 0
 jobs:
   test:

diff --git a/.github/workflows/test-webassembly.yml b/.github/workflows/test-webassembly.yml
@@ -17,7 +17,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
-  RUSTFLAGS: -D warnings
+  RUSTFLAGS: -D warnings --cfg tracing_unstable
   CARGO_PROFILE_TEST_DEBUG: 0
   WASM_BINDGEN_TEST_TIMEOUT: 240
   WASM_BINDGEN_TEST_ONLY_WEB: 1

diff --git a/.github/workflows/test-workspace.yml b/.github/workflows/test-workspace.yml
@@ -21,7 +21,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0
-  RUSTFLAGS: -D warnings
+  RUSTFLAGS: -D warnings --cfg tracing_unstable
   CARGO_PROFILE_TEST_DEBUG: 0
 jobs:
   test:

diff --git a/common/src/wasm.rs b/common/src/wasm.rs
@@ -1,9 +1,6 @@
 use futures::{FutureExt, Stream, StreamExt};
 use std::{future::Future, pin::Pin, task::Poll};
 
-#[cfg(target_arch = "wasm32")]
-use wasm_bindgen::prelude::*;
-
 /// Global Marker trait for WebAssembly
 #[cfg(target_arch = "wasm32")]
 pub trait Wasm {}