feat: add memory report into the CI (#6630)

Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>

.github/workflows/memory_report.yml

@@ -0,0 +1,88 @@
+name: Report Peak Memory
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build-nargo:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: [x86_64-unknown-linux-gnu]
+
+    steps:
+      - name: Checkout Noir repo
+        uses: actions/checkout@v4
+
+      - name: Setup toolchain
+        uses: dtolnay/rust-toolchain@1.74.1
+
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: ${{ matrix.target }}
+          cache-on-failure: true
+          save-if: ${{ github.event_name != 'merge_group' }}
+
+      - name: Build Nargo
+        run: cargo build --package nargo_cli --release
+
+      - name: Package artifacts
+        run: |
+          mkdir dist
+          cp ./target/release/nargo ./dist/nargo
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: nargo
+          path: ./dist/*
+          retention-days: 3
+
+  generate_memory_report:
+    needs: [build-nargo]
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download nargo binary
+        uses: actions/download-artifact@v4
+        with:
+          name: nargo
+          path: ./nargo
+
+      - name: Set nargo on PATH
+        run: |
+          nargo_binary="${{ github.workspace }}/nargo/nargo"
+          chmod +x $nargo_binary
+          echo "$(dirname $nargo_binary)" >> $GITHUB_PATH
+          export PATH="$PATH:$(dirname $nargo_binary)"
+          nargo -V
+
+      - name: Generate Memory report
+        working-directory: ./test_programs
+        run: |
+          chmod +x memory_report.sh
+          ./memory_report.sh
+          mv memory_report.json ../memory_report.json
+
+      - name: Parse memory report
+        id: memory_report
+        uses: noir-lang/noir-bench-report@d61bc78ece3c8df1e72914b3d5136bad403d5bdf
+        with:
+          report: memory_report.json
+          header: |
+            # Memory Report
+          memory_report: true
+
+      - name: Add memory report to sticky comment
+        if: github.event_name == 'pull_request' || github.event_name == 'pull_request_target'
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: memory
+          message: ${{ steps.memory_report.outputs.markdown }}

cspell.json

@@ -106,6 +106,7 @@
         "Guillaume",
         "gzipped",
         "hasher",
+        "heaptrack",
         "hexdigit",
         "higher-kinded",
         "Hindley-Milner",

test_programs/memory_report.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+set -e
+
+sudo apt-get install heaptrack
+
+NARGO="nargo"
+
+
+# Tests to be profiled for memory report
+tests_to_profile=("keccak256" "workspace" "regression_4709")
+
+current_dir=$(pwd)
+execution_success_path="$current_dir/execution_success"
+test_dirs=$(ls $execution_success_path)
+
+FIRST="1"
+
+echo "{\"memory_reports\": [ " > memory_report.json
+
+
+for test_name in ${tests_to_profile[@]}; do    
+        full_path=$execution_success_path"/"$test_name
+        cd $full_path
+
+        if [ $FIRST = "1" ]
+        then
+            FIRST="0"
+        else
+            echo " ," >> $current_dir"/memory_report.json"
+        fi
+        heaptrack --output $current_dir/$test_name"_heap" $NARGO compile --force
+        if test -f $current_dir/$test_name"_heap.gz"; 
+        then 
+            heaptrack --analyze $current_dir/$test_name"_heap.gz" > $current_dir/$test_name"_heap_analysis.txt"
+            rm $current_dir/$test_name"_heap.gz"
+        else 
+            heaptrack --analyze $current_dir/$test_name"_heap.zst" > $current_dir/$test_name"_heap_analysis.txt"
+            rm $current_dir/$test_name"_heap.zst"
+        fi
+        consumption="$(grep 'peak heap memory consumption'  $current_dir/$test_name'_heap_analysis.txt')"
+        len=${#consumption}-30
+        peak=${consumption:30:len}
+        rm $current_dir/$test_name"_heap_analysis.txt"
+        echo -e " {\n    \"artifact_name\":\"$test_name\",\n    \"peak_memory\":\"$peak\"\n }" >> $current_dir"/memory_report.json"
+done
+
+echo "]}" >> $current_dir"/memory_report.json"
+