Add clang-tidy support (#97)

Added clang-tidy checks locally and via CI, resolved all code that made sense to. Ignored the bridge.

Author: alan-george-lk

.clang-tidy

@@ -0,0 +1,37 @@
+Checks: >
+  -*,
+  bugprone-*,
+  performance-*,
+  modernize-*,
+  readability-misleading-indentation,
+  readability-redundant-smartptr-get,
+  -bugprone-easily-swappable-parameters,
+  -modernize-use-trailing-return-type,
+  -modernize-avoid-c-arrays,
+  -modernize-use-auto,
+  -modernize-use-nodiscard,
+  -modernize-return-braced-init-list,
+  -performance-enum-size,
+  -readability-braces-around-statements,
+
+# These warnings have determined to be critical and are as such treated as errors
+WarningsAsErrors: >
+  clang-analyzer-*,
+  bugprone-use-after-move,
+  bugprone-dangling-handle,
+  bugprone-infinite-loop,
+  bugprone-narrowing-conversions,
+  bugprone-undefined-memory-manipulation,
+  bugprone-move-forwarding-reference,
+  bugprone-incorrect-roundings,
+  bugprone-sizeof-expression,
+  bugprone-string-literal-with-embedded-nul,
+  bugprone-suspicious-memset-usage,
+
+HeaderFilterRegex: '(include/livekit|src|examples)'
+
+FormatStyle: file
+
+CheckOptions:
+  - key: modernize-use-nullptr.NullMacros
+    value: 'NULL'

.github/workflows/builds.yml

@@ -37,6 +37,7 @@ on:
 
 permissions:
   contents: read
+  actions: read
   packages: read
 
 env:
@@ -64,23 +65,23 @@ jobs:
         include:
           - os: ubuntu-latest
             name: linux-x64
-            build_cmd: ./build.sh release-tests && ./build.sh release-examples
+            build_cmd: ./build.sh release-all
             build_dir: build-release
           - os: ubuntu-24.04-arm
             name: linux-arm64
-            build_cmd: ./build.sh release-tests && ./build.sh release-examples
+            build_cmd: ./build.sh release-all
             build_dir: build-release
           - os: macos-latest
             name: macos-arm64
-            build_cmd: ./build.sh release-tests && ./build.sh release-examples
+            build_cmd: ./build.sh release-all
             build_dir: build-release
           - os: macos-latest
             name: macos-x64
-            build_cmd: ./build.sh release-tests && ./build.sh release-examples --macos-arch x86_64
+            build_cmd: ./build.sh release-all --macos-arch x86_64
             build_dir: build-release
           - os: windows-latest
             name: windows-x64
-            build_cmd: .\build.cmd release-tests && .\build.cmd release-examples
+            build_cmd: .\build.cmd release-all
             build_dir: build-release
 
     name: Build (${{ matrix.name }})
@@ -545,3 +546,77 @@ jobs:
             cmake -S . -B build -DLIVEKIT_LOCAL_SDK_DIR=/opt/livekit-sdk
             cmake --build build --parallel
           '
+
+  clang-tidy:
+    name: clang-tidy
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - name: Checkout (with submodules)
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          submodules: recursive
+          fetch-depth: 1
+
+      - name: Install dependencies
+        run: |
+          set -eux
+          sudo apt-get update
+          sudo apt-get install -y \
+            build-essential cmake ninja-build pkg-config \
+            llvm-dev libclang-dev clang clang-tidy \
+            libssl-dev
+
+      - name: Install Rust (stable)
+        uses: dtolnay/rust-toolchain@3c5f7ea28cd621ae0bf5283f0e981fb97b8a7af9
+        with:
+          toolchain: stable
+
+      - name: Set Linux build environment
+        run: |
+          echo "CXXFLAGS=-Wno-deprecated-declarations" >> $GITHUB_ENV
+          echo "CFLAGS=-Wno-deprecated-declarations" >> $GITHUB_ENV
+          LLVM_VERSION=$(llvm-config --version | cut -d. -f1)
+          echo "LIBCLANG_PATH=/usr/lib/llvm-${LLVM_VERSION}/lib" >> $GITHUB_ENV
+
+      - name: CMake configure
+        run: cmake --preset linux-release
+
+      - name: Generate protobuf headers
+        run: cmake --build build-release --target livekit_proto
+
+      - name: Run clang-tidy
+        uses: cpp-linter/cpp-linter-action@77c390c5ba9c947ebc185a3e49cc754f1558abb5 # v2.18.0
+        id: linter
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          style: ''
+          tidy-checks: ''
+          database: build-release
+          files-changed-only: false
+          lines-changed-only: true
+          extensions: 'c,cpp,cc,cxx'
+          ignore: 'build-*|cpp-example-collection|client-sdk-rust|vcpkg_installed|src/tests|bridge|src/room_event_converter.cpp'
+          file-annotations: true
+          thread-comments: update
+          step-summary: true
+          tidy-review: false
+          no-lgtm: true
+          jobs: 0   # 0 == use all available CPU cores
+
+      - name: Check warning thresholds
+        env:
+          TIDY_FINDINGS: ${{ steps.linter.outputs.clang-tidy-checks-failed }}
+          MAX_TIDY_FINDINGS: '0'
+        run: |
+          echo "clang-tidy findings: ${TIDY_FINDINGS}"
+          if [ "${TIDY_FINDINGS}" -gt "${MAX_TIDY_FINDINGS}" ]; then
+            echo "::warning::clang-tidy found ${TIDY_FINDINGS} issue(s), threshold is ${MAX_TIDY_FINDINGS}"
+            exit 1
+          fi
+          echo "clang-tidy findings within threshold"

AGENTS.md

@@ -157,6 +157,10 @@ All source files must have the LiveKit Apache 2.0 copyright header. Use the curr
 
 ### Readability and Performance
 Code should be easy to read and understand. If a sacrifice is made for performance or readability, it should be documented.
+
+### Static Analysis
+Adhere to clang-tidy checks configured in `.clang-tidy`.
+
 ## Dependencies
 
 | Dependency | Scope | Notes |

CMakePresets.json

@@ -207,6 +207,32 @@
         "LIVEKIT_BUILD_TESTS": "OFF"
       }
     },
+    {
+      "name": "windows-release-all",
+      "displayName": "Windows x64 Release with Tests + Examples",
+      "description": "Build for Windows x64 Release with tests and examples",
+      "inherits": "windows-base",
+      "binaryDir": "${sourceDir}/build-release",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "LIVEKIT_BUILD_EXAMPLES": "ON",
+        "LIVEKIT_BUILD_TESTS": "ON",
+        "VCPKG_MANIFEST_FEATURES": "examples"
+      }
+    },
+    {
+      "name": "windows-debug-all",
+      "displayName": "Windows x64 Debug with Tests + Examples",
+      "description": "Build for Windows x64 Debug with tests and examples",
+      "inherits": "windows-base",
+      "binaryDir": "${sourceDir}/build-debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "LIVEKIT_BUILD_EXAMPLES": "ON",
+        "LIVEKIT_BUILD_TESTS": "ON",
+        "VCPKG_MANIFEST_FEATURES": "examples"
+      }
+    },
     {
       "name": "windows-release-tests",
       "displayName": "Windows x64 Release with Tests",
@@ -231,6 +257,30 @@
         "LIVEKIT_BUILD_TESTS": "ON"
       }
     },
+    {
+      "name": "linux-release-all",
+      "displayName": "Linux Release with Tests + Examples",
+      "description": "Build for Linux Release with tests and examples",
+      "inherits": "linux-base",
+      "binaryDir": "${sourceDir}/build-release",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "LIVEKIT_BUILD_EXAMPLES": "ON",
+        "LIVEKIT_BUILD_TESTS": "ON"
+      }
+    },
+    {
+      "name": "linux-debug-all",
+      "displayName": "Linux Debug with Tests + Examples",
+      "description": "Build for Linux Debug with tests and examples",
+      "inherits": "linux-base",
+      "binaryDir": "${sourceDir}/build-debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "LIVEKIT_BUILD_EXAMPLES": "ON",
+        "LIVEKIT_BUILD_TESTS": "ON"
+      }
+    },
     {
       "name": "linux-release-tests",
       "displayName": "Linux Release with Tests",
@@ -255,6 +305,30 @@
         "LIVEKIT_BUILD_TESTS": "ON"
       }
     },
+    {
+      "name": "macos-release-all",
+      "displayName": "macOS Release with Tests + Examples",
+      "description": "Build for macOS Release with tests and examples",
+      "inherits": "macos-base",
+      "binaryDir": "${sourceDir}/build-release",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "LIVEKIT_BUILD_EXAMPLES": "ON",
+        "LIVEKIT_BUILD_TESTS": "ON"
+      }
+    },
+    {
+      "name": "macos-debug-all",
+      "displayName": "macOS Debug with Tests + Examples",
+      "description": "Build for macOS Debug with tests and examples",
+      "inherits": "macos-base",
+      "binaryDir": "${sourceDir}/build-debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "LIVEKIT_BUILD_EXAMPLES": "ON",
+        "LIVEKIT_BUILD_TESTS": "ON"
+      }
+    },
     {
       "name": "macos-release-tests",
       "displayName": "macOS Release with Tests",
@@ -333,6 +407,32 @@
       "name": "macos-debug-examples",
       "configurePreset": "macos-debug-examples"
     },
+    {
+      "name": "windows-release-all",
+      "configurePreset": "windows-release-all",
+      "configuration": "Release"
+    },
+    {
+      "name": "windows-debug-all",
+      "configurePreset": "windows-debug-all",
+      "configuration": "Debug"
+    },
+    {
+      "name": "linux-release-all",
+      "configurePreset": "linux-release-all"
+    },
+    {
+      "name": "linux-debug-all",
+      "configurePreset": "linux-debug-all"
+    },
+    {
+      "name": "macos-release-all",
+      "configurePreset": "macos-release-all"
+    },
+    {
+      "name": "macos-debug-all",
+      "configurePreset": "macos-debug-all"
+    },
     {
       "name": "windows-release-tests",
       "configurePreset": "windows-release-tests",

README.md

@@ -67,7 +67,9 @@ git lfs pull
 ./build.sh debug-examples     # Build Debug with examples
 ./build.sh release-examples   # Build Release with examples
 ./build.sh debug-tests        # Build Debug with tests
+./build.sh debug-all          # Build Debug with tests + examples
 ./build.sh release-tests      # Build Release with tests
+./build.sh release-all        # Build Release with tests + examples
 ```
 **Windows**
 Using build scripts:
@@ -79,7 +81,9 @@ Using build scripts:
 .\build.cmd debug-examples    # Build Debug with examples
 .\build.cmd release-examples  # Build Release with examples
 .\build.cmd debug-tests       # Build Debug with tests
+.\build.cmd debug-all         # Build Debug with tests + examples
 .\build.cmd release-tests     # Build Release with tests
+.\build.cmd release-all       # Build Release with tests + examples
 ```
 
 ### Windows build using cmake/vcpkg
@@ -488,15 +492,47 @@ In some cases, you may need to perform a full clean that deletes all build artif
 ./build.sh clean-all
 ```
 
-### Clang format
-CPP SDK is using clang C++ format
+## Quality Checks
+
+This SDK leverages various tools and checks to ensure the highest quality of the code.
+
+### Clang Tools
+
+- `clang-tidy`: static analysis checks to catch common C++ pitfalls. See [.clang-tidy](./.clang-tidy) for the list of current checks (enforced in CI on PR)
+- `clang-format`: (coming soon) code formatting and style consistency
+
+> **Note**: clang-tidy is not currently supported on Windows for this project because the Visual Studio CMake generator does not produce the compile_commands.json database that clang-tidy requires.
+
+To run locally, first install the following:
+
+**macOS:**
+
+```bash
+brew install llvm
+```
+
+This installs `clang-format`, `clang-tidy`, and `run-clang-tidy`. Homebrew may ask you to add `/opt/homebrew/opt/llvm/bin` to your `PATH`.
+
+**Linux:**
+
 ```bash
-brew install clang-format
+# Ubuntu / Debian:
+sudo apt-get install clang-format clang-tidy clang-tools
 ```
 
+To run:
+
+1. Run a build script command, such that `compile_command.json` is present at the root of the repository
+2. Run:
+
+```bash
+clang-tidy -p . src/*.cpp
+```
+
+### Memory Checks
 
-#### Memory Checks
 Run valgrind on various examples or tests to check for memory leaks and other issues.
+
 ```bash
 valgrind --leak-check=full ./build-debug/bin/livekit_integration_tests
 valgrind --leak-check=full ./build-debug/bin/livekit_stress_tests