Bring back CI stage to measure contract size regressions (#2440)

* Use v2 of `rust-cache`

* Only fuzz multiple times on `master`

* First iteration over submitting contract sizes

* Fix yaml

* Fix yaml

* Fix available toolchains

* Replace `substrate-contracts-node` with `ink-node`

* Replace Twitter with X

* Simplify readme

* Use branch name in file name

* Use branch

* Fix yaml

* Update readme

* Use `bash` to support shell substitution

* Revert "Use `bash` to support shell substitution"

This reverts commit 13228e1.

* Use `github.ref`

* Use `github.ref_name`

* Extract branch name

* Update readme

* Revert me: debug stage

* Debug toolchains

* Fix syntax

* Debug script

* Debug script

* Debug script

* Debug script

* Debug script

* Debug script

* Debug script

* Debug script

* Debug script

* Revert "Revert me: debug stage"

This reverts commit c9e08e8.

Author: cmichi

.github/rust-info/action.yml

@@ -9,7 +9,7 @@ runs:
         rustup +nightly show
         cargo +nightly --version
         bash --version
-        substrate-contracts-node --version
+        ink-node --version
         cargo contract --version
         git --version
       shell: bash

.github/workflows/ci.yml

@@ -139,7 +139,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -174,7 +174,7 @@ jobs:
                 fetch-depth: 1
 
           - name: Cache
-            uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+            uses: Swatinem/rust-cache@v2
             with:
                 cache-directories: ${{ env.CARGO_TARGET_DIR }}
                 cache-all-crates: true
@@ -213,7 +213,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -253,7 +253,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -295,7 +295,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -332,7 +332,7 @@ jobs:
                 fetch-depth: 1
 
           - name: Cache
-            uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+            uses: Swatinem/rust-cache@v2
             with:
                 cache-directories: ${{ env.CARGO_TARGET_DIR }}
                 cache-all-crates: true
@@ -371,7 +371,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -421,7 +421,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -436,7 +436,8 @@ jobs:
           # at the same time, hence we use this workaround.
           QUICKCHECK_TESTS: 0
         run: |
-            rustup toolchain remove nightly-2025-02-20; rustup toolchain remove stable; rustup toolchain remove 1.85.0;
+            rustup toolchain remove nightly-2025-02-20
+            rustup toolchain remove stable
             cargo +nightly nextest run --all-features --no-fail-fast --workspace --locked --jobs 1 --partition count:${{ matrix.partition }}/30
 
   test-docs:
@@ -458,7 +459,7 @@ jobs:
                 fetch-depth: 1
 
           - name: Cache
-            uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+            uses: Swatinem/rust-cache@v2
             with:
                 cache-directories: ${{ env.CARGO_TARGET_DIR }}
                 cache-all-crates: true
@@ -503,7 +504,7 @@ jobs:
                 fetch-depth: 1
 
           - name: Cache
-            uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+            uses: Swatinem/rust-cache@v2
             with:
                 cache-directories: ${{ env.CARGO_TARGET_DIR }}
                 cache-all-crates: true
@@ -539,7 +540,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -588,7 +589,7 @@ jobs:
 #        uses: ./.github/rust-info
 #
 #      - name: Cache
-#        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+#        uses: Swatinem/rust-cache@v2
 #        with:
 #            cache-on-failure: true
 #            cache-directories: ${{ env.CARGO_TARGET_DIR }}
@@ -630,7 +631,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -661,7 +662,7 @@ jobs:
                 fetch-depth: 1
 
           - name: Cache
-            uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+            uses: Swatinem/rust-cache@v2
             with:
                 cache-directories: ${{ env.CARGO_TARGET_DIR }}
                 cache-all-crates: true
@@ -698,7 +699,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -725,7 +726,7 @@ jobs:
           RUSTFLAGS: -Clink-arg=-z -Clink-arg=nostart-stop-gc -Clink-dead-code
         run: |
           # run flipper E2E test with on-chain contract
-          substrate-contracts-node -lruntime::revive=debug 2>&1 &
+          ink-node -lruntime::revive=debug 2>&1 &
           cargo +nightly contract build --release --manifest-path integration-tests/public/flipper/Cargo.toml
           export CONTRACT_ADDR_HEX=$(cargo +nightly-2025-02-20 contract instantiate \
             --manifest-path integration-tests/public/flipper/Cargo.toml \
@@ -737,7 +738,7 @@ jobs:
             e2e_test_deployed_contract \
             -- --ignored --nocapture
 
-  examples-contract-build:
+  examples-contract-build-riscv:
     runs-on: ubuntu-latest
     needs: [set-image, build]
     defaults:
@@ -748,36 +749,77 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        type: [RISCV]
-        partition: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
+        partition: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
 
       - name: Rust Info
         uses: ./.github/rust-info
 
-      - name: Build Contract RISCV Examples
-        if: ${{ matrix.type == 'RISCV' }}
+      - name: Extract branch name
+        shell: bash
+        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+        id: extract_branch
+
+      - name: Build Contract Examples for RISC-V
         env:
           RUSTC_BOOTSTRAP: 1
+          MANIFEST_PATH: ""
+          CONTRACT_SIZE_FILE: "measurements-${{ steps.extract_branch.outputs.branch }}/contract_size_"
         run: |
-          # We skip some examples for those reasons:
-          # This uses dlmalloc which is only supported on select targets.
-          #   - custom_allocator
-          # Pulls in sp-std which needlessly requires atomic pointers (TODO: Fix sp-std and enable this example)
-          #   - call-runtime
-          scripts/for_all_contracts_exec.sh --path integration-tests --ignore public/custom-allocator --ignore public/call-runtime --ignore public/contract-xcm \
-            --partition ${{ matrix.partition }}/15 -- \
-            cargo +nightly build --manifest-path {} --no-default-features --target $RISCV_TARGET -Zbuild-std="core,alloc"
+          mkdir -p measurements-${{ steps.extract_branch.outputs.branch }}/
+          scripts/for_all_contracts_exec2.sh --path integration-tests --partition ${{ matrix.partition }}/20 --ignore integration-tests/public/multi-contract-caller -- \
+            scripts/build_and_determine_contract_size.sh {}
+
+            #bash -c "scripts/build_and_determine_contract_size.sh {} >> ${CONTRACT_SIZE_FILE} && \
+            #sed -ie 's/^integration-tests\/\(public\/\|internal\/\)\?//' ${CONTRACT_SIZE_FILE}"
+
+      - uses: actions/upload-artifact@v4
+        #env:
+            #CONTRACT_SIZE_FILE: ${{ matrix.branch }}_contract_size_${{ matrix.partition }}
+        with:
+            #name: ${{ github.job }}-${{ matrix.branch }}-data
+            #name: ./measurements-${{ PR_NUMBER }}
+            path: ./measurements-${{ steps.extract_branch.outputs.branch }}/*
+            name: ${{ env.RUN_UNIQUE_ID }}_artifact_${{ matrix.partition }}
+            retention-days: 1
+
+  process-contract-sizes:
+    needs: [examples-contract-build-riscv]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download reports' artifacts
+        uses: actions/download-artifact@v4
+        with:
+            path: downloaded_artifacts
+
+      - name: Extract branch name
+        shell: bash
+        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+        id: extract_branch
+
+      - name: Combine contract sizes from individual examples
+        run: |
+            find .
+            cat downloaded_artifacts/*/*  | \
+            sed -e 's/^integration-tests\/\(public\/\|internal\/\)\?//' | \
+            sort | uniq > measurements-${{ steps.extract_branch.outputs.branch }}
+            echo "----"
+            cat measurements-${{ steps.extract_branch.outputs.branch }}
+
+      - uses: actions/upload-artifact@v4
+        with:
+            path: ./measurements-${{ steps.extract_branch.outputs.branch }}
+            retention-days: 31
 
   examples-docs:
     runs-on: ubuntu-latest
@@ -794,7 +836,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true
@@ -823,13 +865,10 @@ jobs:
 # fuzz
   fuzz:
     runs-on: ubuntu-latest
-    # todo bring back more needs, so that we only run this `fuzz` stage
-    # if pre-conditions are filled.
-    #needs: [set-image, examples-docs, examples-contract-build, examples-test, examples-custom-test]
-    needs: [set-image]
-    #if: >
-      #github.event_name == 'push' &&
-        #github.ref == 'refs/heads/master'
+    needs: [set-image, examples-docs, examples-contract-build-riscv, examples-test, examples-custom-test]
+    if: >
+      github.event_name == 'push' &&
+        github.ref == 'refs/heads/master'
     permissions:
       issues: write
     defaults:
@@ -844,7 +883,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
+        uses: Swatinem/rust-cache@v2
         with:
           cache-directories: ${{ env.CARGO_TARGET_DIR }}
           cache-all-crates: true

.github/workflows/issue-notifier.yml

@@ -25,7 +25,7 @@ jobs:
           - link
           - squink-splash-advanced
           - squink-splash-beginner
-          - substrate-contracts-node
+          - ink-node
     steps:
       - name: Generate token
         id: generate_token

.github/workflows/measurements.yml

@@ -7,7 +7,7 @@ env:
   CARGO_TARGET_DIR: /ci-cache/${{ github.repository }}/targets/${{ github.ref_name }}/${{ github.job }}
 
 jobs:
-  contract-sizes:
+  compare-contract-sizes:
     if: ${{ github.event_name == 'pull_request' }}
     runs-on: ubuntu-latest
     defaults:
@@ -20,29 +20,10 @@ jobs:
       matrix:
         branch: [master, pull_request]
     steps:
-      - name: Checkout Pull Request
-        if: ${{ matrix.branch == 'pull_request' }}
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 1
-
-      - name: Checkout Master
-        if: ${{ matrix.branch == 'master' }}
-        uses: actions/checkout@v4
-        with:
-          ref: master
-          fetch-depth: 1
-
-      - name: Cache
-        uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
-        with:
-          cache-directories: ${{ env.CARGO_TARGET_DIR }}
-          cache-all-crates: true
-
       - name: Rust Info
         uses: ./.github/rust-info
 
-      - name: Measure Contract Sizes
+      - name: Post Contract Sizes Measurements
         env:
           PR_NUMBER: ${{ github.event.number }}
         run: |

.github/workflows/pr-notifier.yml

@@ -27,7 +27,7 @@ jobs:
           - smart-bench
           - squink-splash-advanced
           - squink-splash-beginner
-          - substrate-contracts-node
+          - ink-node
     steps:
       - name: Generate token
         id: generate_token

.github/workflows/submit-contract-sizes.yml

@@ -20,22 +20,25 @@ jobs:
       github.event.workflow_run.event == 'pull_request' &&
         github.event.workflow_run.conclusion == 'success'
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 100
-
       - name: Download Master Contract Sizes
         uses: ./.github/download-artifact
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          ARTIFACT_NAME: contract-sizes-master-data
+          ARTIFACT_NAME: measurements-master
+
+      - name: Extract branch name
+        shell: bash
+        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+        id: extract_branch
 
       - name: Download Pull-Request Contract Sizes
         uses: ./.github/download-artifact
+            #PR_NUMBER: ${{ github.event.number }}
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          ARTIFACT_NAME: contract-sizes-pull_request-data
+          #ARTIFACT_NAME: contract-sizes-pull_request-data
+          #ARTIFACT_NAME: contract-sizes-${{ github.event.number }}
+          ARTIFACT_NAME: measurements-${{ steps.extract_branch.outputs.branch }}
 
       - name: Collect Contract Sizes
         run: |

ARCHITECTURE.md

@@ -1,4 +1,4 @@
-# ink!ternals
+# ink! v6 Architecture
 
 This document describes the architecture of ink!. The information
 here targets those who want to understand or modify the inner