summaryrefslogtreecommitdiff
path: root/.github/workflows/report-backend-memory.yml
blob: 8ae33bc582446e381327fa5dfcde2b34e8347388 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
name: Report backend memory

on:
  workflow_run:
    types: [completed]
    workflows:
      - Get backend memory usage # get-backend-memory.yml

jobs:
  compare-memory:
    runs-on: ubuntu-latest
    if: ${{ github.event.workflow_run.conclusion == 'success' }}
    permissions:
      pull-requests: write

    steps:
      - name: Download artifact
        uses: actions/github-script@v7.1.0
        with:
          script: |
            const fs = require('fs');
            let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
               owner: context.repo.owner,
               repo: context.repo.repo,
               run_id: context.payload.workflow_run.id,
            });
            let matchArtifacts = allArtifacts.data.artifacts.filter((artifact) => {
              return artifact.name.startsWith("memory-artifact-") || artifact.name == "memory-artifact"
            });
            await Promise.all(matchArtifacts.map(async (artifact) => {
              let download = await github.rest.actions.downloadArtifact({
                owner: context.repo.owner,
                repo: context.repo.repo,
                artifact_id: artifact.id,
                archive_format: 'zip',
              });
              await fs.promises.writeFile(`${process.env.GITHUB_WORKSPACE}/${artifact.name}.zip`, Buffer.from(download.data));
            }));
      - name: Extract all artifacts
        run: |
          find . -mindepth 1 -maxdepth 1 -type f -name '*.zip' -exec unzip {} -d artifacts ';'
          ls -la artifacts/
      - name: Load PR Number
        id: load-pr-num
        run: echo "pr-number=$(cat artifacts/pr_number)" >> "$GITHUB_OUTPUT"

      - name: Output base
        run: cat ./artifacts/memory-base.json
      - name: Output head
        run: cat ./artifacts/memory-head.json
      - name: Compare memory usage
        id: compare
        run: |
          BASE_MEMORY=$(cat ./artifacts/memory-base.json)
          HEAD_MEMORY=$(cat ./artifacts/memory-head.json)

          BASE_RSS=$(echo "$BASE_MEMORY" | jq -r '.memory.rss // 0')
          HEAD_RSS=$(echo "$HEAD_MEMORY" | jq -r '.memory.rss // 0')

          # Calculate difference
          if [ "$BASE_RSS" -gt 0 ] && [ "$HEAD_RSS" -gt 0 ]; then
            DIFF=$((HEAD_RSS - BASE_RSS))
            DIFF_PERCENT=$(echo "scale=2; ($DIFF * 100) / $BASE_RSS" | bc)
            
            # Convert to MB for readability
            BASE_MB=$(echo "scale=2; $BASE_RSS / 1048576" | bc)
            HEAD_MB=$(echo "scale=2; $HEAD_RSS / 1048576" | bc)
            DIFF_MB=$(echo "scale=2; $DIFF / 1048576" | bc)
            
            echo "base_mb=$BASE_MB" >> "$GITHUB_OUTPUT"
            echo "head_mb=$HEAD_MB" >> "$GITHUB_OUTPUT"
            echo "diff_mb=$DIFF_MB" >> "$GITHUB_OUTPUT"
            echo "diff_percent=$DIFF_PERCENT" >> "$GITHUB_OUTPUT"
            echo "has_data=true" >> "$GITHUB_OUTPUT"
            
            # Determine if this is a significant change (more than 5% increase)
            if [ "$(echo "$DIFF_PERCENT > 5" | bc)" -eq 1 ]; then
              echo "significant_increase=true" >> "$GITHUB_OUTPUT"
            else
              echo "significant_increase=false" >> "$GITHUB_OUTPUT"
            fi
          else
            echo "has_data=false" >> "$GITHUB_OUTPUT"
          fi
      - id: build-comment
        name: Build memory comment
        run: |
          HEADER="## Backend Memory Usage Comparison"
          FOOTER="[See workflow logs for details](https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID})"

          echo "$HEADER" > ./output.md
          echo >> ./output.md

          if [ "${{ steps.compare.outputs.has_data }}" == "true" ]; then
            echo "| Metric | base | head | Diff |" >> ./output.md
            echo "|--------|------|------|------|" >> ./output.md
            echo "| RSS | ${{ steps.compare.outputs.base_mb }} MB | ${{ steps.compare.outputs.head_mb }} MB | ${{ steps.compare.outputs.diff_mb }} MB (${{ steps.compare.outputs.diff_percent }}%) |" >> ./output.md
            echo >> ./output.md

            if [ "${{ steps.compare.outputs.significant_increase }}" == "true" ]; then
              echo "⚠️ **Warning**: Memory usage has increased by more than 5%. Please verify this is not an unintended change." >> ./output.md
              echo >> ./output.md
            fi
          else
            echo "Could not retrieve memory usage data." >> ./output.md
            echo >> ./output.md
          fi

          echo "$FOOTER" >> ./output.md
      - uses: thollander/actions-comment-pull-request@v2
        with:
          pr_number: ${{ steps.load-pr-num.outputs.pr-number }}
          comment_tag: show_memory_diff
          filePath: ./output.md
      - name: Tell error to PR
        uses: thollander/actions-comment-pull-request@v2
        if: failure() && steps.load-pr-num.outputs.pr-number
        with:
          pr_number: ${{ steps.load-pr-num.outputs.pr-number }}
          comment_tag: show_memory_diff_error
          message: |
            An error occurred while comparing backend memory usage. See [workflow logs](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) for details.