Bazel 7 and Sonarlint don't play nice

[Attempt3035]

Hey all!
I've just spend a few hours endlessly searching to figure out why on earth Sonarlint randomly stopped working. My setup uses vscodium, clangd and sonarlint for quite a nice c++ development setup. After much searching, I figured out the issue was in the compile commands, which had changed not due to an update in this tool, but instead from when I updated from bazel 6.4.0 to 7. The key difference is this:
Compile commands with this tool AND BAZEL 6.4 ends up having clang as the compiler on my setup (first line of args)
"arguments": [ "clang",
Where as Bazel 7 ends up as:
"arguments": [ "external/bazel_tools~cc_configure_extension~local_config_cc/cc_wrapper.sh",

Sonarlint says "I have no idea what this compiler is, I won't lint any of your code anymore"
I don't think it's on Sonarlint to come up with a solution, and Bazel presumably has a good reason for having the wrapper in-between? Has anyone else come across this issue yet, and any ideas on how we might be able to solve it? Maybe we can extract what compiler the wrapper decides to use, or guess via some other method?

At the moment I've got a .bazelversion file with contents 6.4.0 so that bazelisk gets everything playing nicely for now😅

[cpsauer]

Ah, shoot. clangd can penetrate simple wrappers like this with --query-driver, but that doesn't mean it'd extend to other tools. (You can see some notes about the unwrapping we do in more problematic cases in _apple_platform_patch.) Thanks for reporting, Luke. We should unwrap them as part of our de-bazeling.

There're some flags you can add that reveal the underlying compiler...someone else had proposed them in a PR that didn't end up getting merged because --query_driver was good enough from them. Could I ask you to take a look at #40 and see if you can repurpose the code (and clean it up a little)? That way we can get you back on Bazel 7. (Or rolling, which I'd recommend to get the latest fixes :)

(Would also like to know if this is Apple or Linux where you're running into the issue.)

[cpsauer]

One other thought: We'll need to be careful to not unwrap emcc.sh by mistake.

[Attempt3035]

Thank you for the detailed reply! It's a little over my head at the moment, I'll try and look into everything you've pointed out over the next couple of weeks and see what I can propose! Also, that was on Apple (newest os, M2). Only occurred now as I wasn't using bazelisk (I had bazel straight through brew), and as soon as I installed bazelisk it updated to 7.

[cpsauer]

Thanks for being down to help!
(Strong rec for bazelisk--and Bazel rolling, so you get bug fixes faster!)

[Attempt3035]

Hey @cpsauer!

I'm back after a while haha, have revisited this issue though! (as it's still a problem, even after major updates to SonarQube ide extension). I've checked out #40, but I don't think it's a suitable solution as the compiler that's used by the cc_wrapper.sh is actually a templated variable that gets substituted in depending on bazel's toolchain configuration. This means it could be GCC or Clang, (or possibly others too for web and other targets?). Therefore I'm proposing an unwrapper that essentially runs the script but with a regex style capture to capture the compiler and the path it's being invoked at. This should be suitable even for things like android or embedded builds, where it's not the system native compiler being used. At the moment it's got clang & gcc but can definitely expand for all the bazel supported compilers, and PR if you think this would be a suitable solution to unwrap the wrapper (and don't see it breaking anything else, or introducing security vulnerabilities by running scripts etc)

#!/bin/bash

# DEBUG & Traps need to be inherited by subshells
set -T

# shellcheck disable=SC2154
# A trap to capture the compiler command, even if it's a path to the executable
trap 'if [[ $BASH_COMMAND =~ ^[[:space:]]*(/[^[:space:]]*/)?(clang|gcc)([[:space:]]|$|[^-]) ]]; then
          echo $(read -ra arr <<< "$BASH_COMMAND" && echo "${arr[0]}") # Split BASH_COMMAND into an array and read just the first element
          exit 0  # End execution now that we have the compiler command
      fi' DEBUG

# shellcheck disable=SC1090
# Run the passed-in script within this script's context
source "$1"

Currently I've got this script working by passing the script and then the cc_wrapper path immediately after on the cmd line