Add CI workflow for validating C++ API snapshot (#56042)

Summary:

Adds CI workflow for validating whether the current C++ API snapshot is equivalent with the generated one.

Changelog:
[Internal]

Reviewed By: cortinico

Differential Revision: D95963515

Author: coado

.github/workflows/validate-cxx-api-snapshots.yml

@@ -0,0 +1,82 @@
+name: Validate C++ API Snapshots
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - "packages/react-native/ReactCommon/**"
+      - "packages/react-native/ReactAndroid/**"
+      - "packages/react-native/React/**"
+      - "packages/react-native/ReactApple/**"
+      - "packages/react-native/Libraries/**"
+      - "scripts/cxx-api/**"
+  push:
+    branches:
+      - main
+      - "*-stable"
+    paths:
+      - "packages/react-native/ReactCommon/**"
+      - "packages/react-native/ReactAndroid/**"
+      - "packages/react-native/React/**"
+      - "packages/react-native/ReactApple/**"
+      - "packages/react-native/Libraries/**"
+      - "scripts/cxx-api/**"
+
+env:
+  DOXYGEN_VERSION: "1.16.1"
+
+jobs:
+  validate_cxx_api_snapshots:
+    runs-on: ubuntu-latest
+    if: github.repository == 'facebook/react-native'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Setup node.js
+        uses: ./.github/actions/setup-node
+      - name: Run yarn
+        uses: ./.github/actions/yarn-install
+      - name: Restore Doxygen cache
+        id: cache-doxygen
+        uses: actions/cache@v4
+        with:
+          path: /tmp/doxygen-${{ env.DOXYGEN_VERSION }}
+          key: doxygen-${{ env.DOXYGEN_VERSION }}
+      - name: Install Doxygen
+        if: steps.cache-doxygen.outputs.cache-hit != 'true'
+        shell: bash
+        run: |
+          DOXYGEN_URL="https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz"
+          MAX_RETRIES=3
+          for i in $(seq 1 $MAX_RETRIES); do
+            echo "Attempt $i of $MAX_RETRIES: Installing Doxygen ${DOXYGEN_VERSION}..."
+            curl -fsSL "$DOXYGEN_URL" -o /tmp/doxygen.tar.gz && \
+              tar -xzf /tmp/doxygen.tar.gz -C /tmp && \
+              echo "Doxygen installed successfully." && \
+              break
+            echo "Attempt $i failed."
+            if [ $i -eq $MAX_RETRIES ]; then
+              echo "All $MAX_RETRIES attempts failed."
+              exit 1
+            fi
+            sleep 5
+          done
+      - name: Set DOXYGEN_BIN
+        shell: bash
+        run: echo "DOXYGEN_BIN=/tmp/doxygen-${DOXYGEN_VERSION}/bin/doxygen" >> "$GITHUB_ENV"
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install Python dependencies
+        shell: bash
+        run: pip install doxmlparser natsort pyyaml
+      - name: Validate C++ API snapshots
+        shell: bash
+        continue-on-error: true
+        run: yarn cxx-api-validate --output-dir /tmp/cxx-api-snapshots
+      - name: Upload C++ API snapshots
+        uses: actions/upload-artifact@v6
+        with:
+          name: cxx-api-snapshots
+          path: /tmp/cxx-api-snapshots/

scripts/cxx-api/parser/__main__.py

@@ -35,11 +35,14 @@ def run_command(
     """Run a subprocess command with consistent error handling."""
     result = subprocess.run(cmd, **kwargs)
     if result.returncode != 0:
-        if verbose:
-            print(f"{label} finished with error: {result.stderr}")
-        raise RuntimeError(
-            f"{label} finished with error (exit code {result.returncode})"
-        )
+        error_details = [f"{label} finished with error (exit code {result.returncode})"]
+        if hasattr(result, "stdout") and result.stdout:
+            error_details.append(f"stdout:\n{result.stdout}")
+        if hasattr(result, "stderr") and result.stderr:
+            error_details.append(f"stderr:\n{result.stderr}")
+        error_message = "\n".join(error_details)
+        print(error_message)
+        raise RuntimeError(error_message)
     elif verbose:
         print(f"{label} finished successfully")
     return result
@@ -191,6 +194,8 @@ def build_snapshots(
 
                 if errors:
                     failed_views = ", ".join(name for name, _ in errors)
+                    for name, e in errors:
+                        print(f"Error generating {name}: {e}")
                     raise RuntimeError(f"Failed to generate snapshots: {failed_views}")
     else:
         snapshot = build_snapshot_for_view(
@@ -286,7 +291,9 @@ def main():
 
     with tempfile.TemporaryDirectory() as tmpdir:
         snapshot_output_dir = (
-            tmpdir if args.check else args.output_dir or get_default_snapshot_dir()
+            args.output_dir or tmpdir
+            if args.check
+            else args.output_dir or get_default_snapshot_dir()
         )
 
         build_snapshots(