BM-309: Add gas-comparison workflow (#125)

Author: capossele

.github/workflows/gas-comparison.yml

@@ -0,0 +1,97 @@
+name: Gas comparison
+
+on:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  pull-requests: write
+
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  files-changed:
+    runs-on: ubuntu-latest
+    outputs:
+      contracts: ${{ steps.changes.outputs.contracts }}
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v4
+
+      - uses: dorny/[email protected]
+        id: changes
+        with:
+          filters: |
+            src:
+              - 'contracts/src/**'
+              - 'foundry.toml'
+
+  gas-comparison:
+    runs-on: [self-hosted, Linux, X64, prod, cpu]
+    needs: files-changed
+    if: needs.files-changed.outputs.contracts == 'true'
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: install foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Run gas report on PR branch
+        run: |
+          forge test --gas-report | grep "|" > pr-gas-report.txt
+
+      - name: Upload PR Gas Report
+        uses: actions/upload-artifact@v3
+        with:
+          name: pr-gas-report
+          path: pr-gas-report.txt
+
+      - name: checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          submodules: recursive
+
+      - name: Run gas report on main branch
+        run: |
+          forge test --gas-report | grep "|" > main-gas-report.txt
+
+      - name: Download PR Gas Report
+        uses: actions/download-artifact@v3
+        with:
+          name: pr-gas-report
+          path: .
+        
+      - name: Compare Gas Reports
+        run: |
+          echo "# Gas Cost Comparison for `${GITHUB_HEAD_REF}` vs `main`" > gas-comparison.md
+          echo "" >> gas-comparison.md
+          echo '```diff' >> gas-comparison.md
+
+          # Use diff to capture changes in gas costs
+          diff -u main-gas-report.txt pr-gas-report.txt >> gas-comparison.md || true
+
+          echo '```' >> gas-comparison.md
+          echo "" >> gas-comparison.md
+          cat gas-comparison.md
+
+      - name: Post Comment on Pull Request
+        run: |
+          COMMENT_BODY=$(cat gas-comparison.md)
+          COMMENT_PAYLOAD=$(jq -n --arg body "$COMMENT_BODY" '{body: $body}')
+          PR_NUMBER=${{ github.event.pull_request.number }}
+          curl -s -H "Authorization: token $GITHUB_TOKEN" \
+               -H "Content-Type: application/json" \
+               -X POST \
+               -d "$COMMENT_PAYLOAD" \
+               "https://api.github.com/repos/${{ github.repository }}/issues/$PR_NUMBER/comments"

.github/workflows/main.yml

@@ -315,4 +315,4 @@ jobs:
         run: docker buildx create --driver docker-container --use
 
       - name: docker compose build
-        run: docker compose --profile broker --env-file ./.env-compose -f compose.yml -f ./dockerfiles/compose.ci.yml build
+        run: docker compose --profile broker --env-file ./.env-compose -f compose.yml -f ./dockerfiles/compose.ci.yml build

foundry.toml

@@ -14,6 +14,7 @@ optimizer_runs = 10000
 ast = true
 build_info = true
 extra_output = ["storageLayout"]
+gas_reports = ["ProofMarket"]
 
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options