-
Notifications
You must be signed in to change notification settings - Fork 82
429 lines (364 loc) · 16.6 KB
/
bench.yml
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
name: Bench
on:
pull_request:
push:
branches:
- main
env:
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
TURBO_TEAM: hashintel
TURBO_REMOTE_ONLY: true
VAULT_ADDR: ${{ secrets.VAULT_ADDR }}
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
setup:
runs-on: ubuntu-24.04
outputs:
unit: ${{ steps.packages.outputs.unit }}
integration: ${{ steps.packages.outputs.integration }}
steps:
- name: Checkout source code
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
with:
fetch-depth: 2
- name: Install turbo
uses: ./.github/actions/install-turbo
- name: Determine changed packages
id: packages
run: |
UNIT_BENCH_FILTER=$(turbo run bench:unit --dry-run=json --filter '...[HEAD^]' | jq -e '.packages | contains(["//"])' > /dev/null && echo '' || echo '--filter ...[HEAD^]')
UNIT_BENCH_TASKS=$(sh -c "turbo run bench:unit --dry-run=json $UNIT_BENCH_FILTER" | jq -c '.tasks[]')
UNIT_BENCH_PACKAGES=$(echo "$UNIT_BENCH_TASKS" \
| jq 'select(.task == "bench:unit" and .command != "<NONEXISTENT>")' \
| jq --compact-output --slurp '{ package: [.[].package] | unique, include: [( .[] | {package: .package, directory: .directory })] | unique }')
INTEGRATION_BENCH_FILTER=$(turbo run bench:integration --dry-run=json --filter '...[HEAD^]' | jq -e '.packages | contains(["//"])' > /dev/null && echo '' || echo '--filter ...[HEAD^]')
INTEGRATION_BENCH_TASKS=$(sh -c "turbo run bench:integration --dry-run=json $INTEGRATION_BENCH_FILTER" | jq -c '.tasks[]')
INTEGRATION_BENCH_PACKAGES=$(echo "$INTEGRATION_BENCH_TASKS" \
| jq 'select(.task == "bench:integration" and .command != "<NONEXISTENT>")' \
| jq --compact-output --slurp '{ package: [.[].package] | unique, include: [( .[] | {package: .package, directory: .directory })] | unique }')
set -x
echo "unit=$UNIT_BENCH_PACKAGES" | tee -a $GITHUB_OUTPUT
echo "integration=$INTEGRATION_BENCH_PACKAGES" | tee -a $GITHUB_OUTPUT
unit-benches:
name: Unit
needs: [setup]
permissions:
id-token: write
contents: read
strategy:
matrix: ${{ fromJSON(needs.setup.outputs.unit) }}
fail-fast: false
if: needs.setup.outputs.unit != '{"package":[],"include":[]}'
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
with:
fetch-depth: 2
- name: Install turbo
uses: ./.github/actions/install-turbo
- name: Find bench steps to run
id: benches
run: |
if [[ "${{ github.event_name == 'pull_request' }}" == 'true' ]]; then
echo "create-baseline=true" | tee -a $GITHUB_OUTPUT
else
echo "create-baseline=false" | tee -a $GITHUB_OUTPUT
fi
HAS_RUST=$([[ -f "${{ matrix.directory }}/Cargo.toml" || ${{ matrix.directory }} = "apps/hash-graph" ]] && echo 'true' || echo 'false')
echo "has-rust=$HAS_RUST" | tee -a $GITHUB_OUTPUT
if [[ $HAS_RUST = 'true' ]]; then
if [[ -f "${{ matrix.directory }}/rust-toolchain.toml" ]]; then
RUST_TOOLCHAIN_FILE="${{ matrix.directory }}/rust-toolchain.toml"
else
RUST_TOOLCHAIN_FILE="rust-toolchain.toml"
fi
echo "rust-toolchain=$(yq '.toolchain.channel' $RUST_TOOLCHAIN_FILE)" | tee -a $GITHUB_OUTPUT
fi
- name: Install Rust tools
if: steps.benches.outputs.has-rust == 'true'
uses: taiki-e/install-action@9bef7e9c3d7c7aa986ef19933b0722880ae377e0 # v2.44.13
with:
- name: Install Protobuf
if: steps.benches.outputs.has-rust == 'true'
run: sudo apt install protobuf-compiler
- name: Checkout base branch
if: steps.benches.outputs.create-baseline == 'true'
run: |
git fetch origin "$GITHUB_BASE_REF"
git checkout FETCH_HEAD
- name: Install Rust toolchain
if: steps.benches.outputs.has-rust == 'true' && steps.benches.outputs.create-baseline == 'true'
uses: ./.github/actions/install-rust-toolchain
with:
toolchain: ${{ steps.benches.outputs.rust-toolchain }}
working-directory: ${{ matrix.directory }}
- name: Prune repository
if: steps.benches.outputs.create-baseline == 'true'
uses: ./.github/actions/prune-repository
with:
scope: |
${{ matrix.package }}
@rust/repo-chores
@apps/hash-external-services
- name: Warm up repository
if: steps.benches.outputs.create-baseline == 'true'
uses: ./.github/actions/warm-up-repo
- name: Cache Rust dependencies
if: steps.benches.outputs.has-rust == 'true'
uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2.7.3
with:
workspaces: ${{ matrix.directory }}
save-if: ${{ !startsWith(github.ref, 'refs/heads/gh-readonly-queue') }}
- name: Run base benches
if: steps.benches.outputs.create-baseline == 'true'
run: turbo run bench:unit --filter "${{ matrix.package }}"
- name: Checkout head branch
if: steps.benches.outputs.create-baseline == 'true'
run: |
git fetch origin "$GITHUB_HEAD_REF"
git reset --hard FETCH_HEAD
- name: Install Rust toolchain
if: steps.benches.outputs.has-rust == 'true'
uses: ./.github/actions/install-rust-toolchain
with:
toolchain: ${{ steps.benches.outputs.rust-toolchain }}
working-directory: ${{ matrix.directory }}
- name: Prune repository
uses: ./.github/actions/prune-repository
with:
scope: |
${{ matrix.package }}
@rust/repo-chores
@apps/hash-external-services
- name: Warm up repository
uses: ./.github/actions/warm-up-repo
- name: Run head benches
run: turbo run bench:unit --filter "${{ matrix.package }}"
- name: Analyze benchmarks
if: steps.benches.outputs.create-baseline == 'true'
run: |
TRIMMED_PACKAGE_NAME=$(echo "${{ matrix.package }}" | sed 's|@||g' | sed 's|/|.|g')
echo "TRIMMED_PACKAGE_NAME=$TRIMMED_PACKAGE_NAME" >> $GITHUB_ENV
echo '<details><summary><h2>${{ matrix.package }} – Units</h2></summary>' > "/tmp/$TRIMMED_PACKAGE_NAME.md"
echo >> "/tmp/$TRIMMED_PACKAGE_NAME.md"
turbo run analyze-benchmarks -- --output "/tmp/benches.md" --artifacts-path "$(pwd)/${{ matrix.directory }}/out" --enforce-flame-graph
cat "/tmp/benches.md" >> "/tmp/$TRIMMED_PACKAGE_NAME.md"
echo '</details>' >> "/tmp/$TRIMMED_PACKAGE_NAME.md"
- name: Authenticate Vault
id: secrets
uses: hashicorp/vault-action@d1720f055e0635fd932a1d2a48f87a666a57906c # v3.0.0
with:
exportToken: true
url: ${{ env.VAULT_ADDR }}
method: jwt
role: dev
secrets: |
aws/creds/dev-deploy access_key | AWS_ACCESS_KEY_ID;
aws/creds/dev-deploy secret_key | AWS_SECRET_ACCESS_KEY;
aws/creds/dev-deploy security_token | AWS_SESSION_TOKEN;
- name: Upload benchmark results
run: turbo run upload-benchmarks --env-mode=loose -- --artifacts-path "$(pwd)/${{ matrix.directory }}/out" --enforce-flame-graph
- name: Upload benchmark summary
if: steps.benches.outputs.create-baseline == 'true'
uses: actions/upload-artifact@604373da6381bf24206979c74d06a550515601b9 # v4.4.1
with:
name: ${{ env.TRIMMED_PACKAGE_NAME }}_${{ github.job }}
path: /tmp/${{ env.TRIMMED_PACKAGE_NAME }}.md
integration-benches:
name: Integration
needs: [setup]
permissions:
id-token: write
contents: read
strategy:
matrix: ${{ fromJSON(needs.setup.outputs.integration) }}
fail-fast: false
if: needs.setup.outputs.integration != '{"package":[],"include":[]}'
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
with:
fetch-depth: 2
- name: Install turbo
uses: ./.github/actions/install-turbo
- name: Find bench steps to run
id: benches
run: |
if [[ "${{ github.event_name == 'pull_request' }}" == 'true' ]]; then
echo "create-baseline=true" | tee -a $GITHUB_OUTPUT
else
echo "create-baseline=false" | tee -a $GITHUB_OUTPUT
fi
HAS_RUST=$([[ -f "${{ matrix.directory }}/Cargo.toml" || ${{ matrix.directory }} = "apps/hash-graph" ]] && echo 'true' || echo 'false')
echo "has-rust=$HAS_RUST" | tee -a $GITHUB_OUTPUT
if [[ $HAS_RUST = 'true' ]]; then
if [[ -f "${{ matrix.directory }}/rust-toolchain.toml" ]]; then
RUST_TOOLCHAIN_FILE="${{ matrix.directory }}/rust-toolchain.toml"
else
RUST_TOOLCHAIN_FILE="rust-toolchain.toml"
fi
echo "rust-toolchain=$(yq '.toolchain.channel' $RUST_TOOLCHAIN_FILE)" | tee -a $GITHUB_OUTPUT
fi
- name: Install Rust tools
if: steps.benches.outputs.has-rust == 'true'
uses: taiki-e/install-action@9bef7e9c3d7c7aa986ef19933b0722880ae377e0 # v2.44.13
with:
- name: Install Protobuf
if: steps.benches.outputs.has-rust == 'true'
run: sudo apt install protobuf-compiler
- name: Checkout base branch
if: steps.benches.outputs.create-baseline == 'true'
run: |
git fetch origin "$GITHUB_BASE_REF"
git checkout FETCH_HEAD
- name: Install Rust toolchain
if: steps.benches.outputs.has-rust == 'true' && steps.benches.outputs.create-baseline == 'true'
uses: ./.github/actions/install-rust-toolchain
with:
toolchain: ${{ steps.benches.outputs.rust-toolchain }}
working-directory: ${{ matrix.directory }}
- name: Prune repository
if: steps.benches.outputs.create-baseline == 'true'
uses: ./.github/actions/prune-repository
with:
scope: |
${{ matrix.package }}
@rust/repo-chores
@apps/hash-external-services
- name: Warm up repository
if: steps.benches.outputs.create-baseline == 'true'
uses: ./.github/actions/warm-up-repo
- name: Cache Rust dependencies
if: steps.benches.outputs.has-rust == 'true'
uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2.7.3
with:
workspaces: ${{ matrix.directory }}
save-if: ${{ !startsWith(github.ref, 'refs/heads/gh-readonly-queue') }}
- name: Launch external services
if: steps.benches.outputs.create-baseline == 'true'
run: |
turbo codegen --filter '@apps/hash-external-services'
SERVICES="hydra kratos redis spicedb"
echo "Running services: $SERVICES"
yarn workspace @apps/hash-external-services deploy:test up $SERVICES --wait
- name: Run base benches
if: steps.benches.outputs.create-baseline == 'true'
run: turbo run bench:integration --filter "${{ matrix.package }}"
- name: Tear down external services
if: steps.benches.outputs.create-baseline == 'true'
run: yarn workspace @apps/hash-external-services deploy:test down
- name: Checkout head branch
if: steps.benches.outputs.create-baseline == 'true'
run: |
git fetch origin "$GITHUB_HEAD_REF"
git reset --hard FETCH_HEAD
- name: Install Rust toolchain
if: steps.benches.outputs.has-rust == 'true'
uses: ./.github/actions/install-rust-toolchain
with:
toolchain: ${{ steps.benches.outputs.rust-toolchain }}
working-directory: ${{ matrix.directory }}
- name: Prune repository
uses: ./.github/actions/prune-repository
with:
scope: |
${{ matrix.package }}
@rust/repo-chores
@apps/hash-external-services
- name: Warm up repository
uses: ./.github/actions/warm-up-repo
- name: Launch external services
run: |
turbo codegen --filter '@apps/hash-external-services'
SERVICES="hydra kratos redis spicedb"
echo "Running services: $SERVICES"
yarn workspace @apps/hash-external-services deploy:test up $SERVICES --wait
- name: Run head benches
run: turbo run bench:integration --filter "${{ matrix.package }}"
- name: Analyze benchmarks
if: steps.benches.outputs.create-baseline == 'true'
run: |
TRIMMED_PACKAGE_NAME=$(echo "${{ matrix.package }}" | sed 's|@||g' | sed 's|/|.|g')
echo "TRIMMED_PACKAGE_NAME=$TRIMMED_PACKAGE_NAME" >> $GITHUB_ENV
echo '<details><summary><h2>${{ matrix.package }} – Integrations</h2></summary>' > "/tmp/$TRIMMED_PACKAGE_NAME.md"
echo >> "/tmp/$TRIMMED_PACKAGE_NAME.md"
turbo run analyze-benchmarks -- --output "/tmp/benches.md" --artifacts-path "$(pwd)/${{ matrix.directory }}/out" --enforce-flame-graph
cat "/tmp/benches.md" >> "/tmp/$TRIMMED_PACKAGE_NAME.md"
echo '</details>' >> "/tmp/$TRIMMED_PACKAGE_NAME.md"
- name: Authenticate Vault
id: secrets
uses: hashicorp/vault-action@d1720f055e0635fd932a1d2a48f87a666a57906c # v3.0.0
with:
exportToken: true
url: ${{ env.VAULT_ADDR }}
method: jwt
role: dev
secrets: |
aws/creds/dev-deploy access_key | AWS_ACCESS_KEY_ID;
aws/creds/dev-deploy secret_key | AWS_SECRET_ACCESS_KEY;
aws/creds/dev-deploy security_token | AWS_SESSION_TOKEN;
- name: Upload benchmark results
run: turbo run upload-benchmarks --env-mode=loose -- --artifacts-path "$(pwd)/${{ matrix.directory }}/out" --enforce-flame-graph
- name: Upload benchmark summary
if: steps.benches.outputs.create-baseline == 'true'
uses: actions/upload-artifact@604373da6381bf24206979c74d06a550515601b9 # v4.4.1
with:
name: ${{ env.TRIMMED_PACKAGE_NAME }}_${{ github.job }}
path: /tmp/${{ env.TRIMMED_PACKAGE_NAME }}.md
- name: Show container logs
if: ${{ success() || failure() }}
run: yarn workspace @apps/hash-external-services deploy logs --timestamps
passed:
name: Benches passed
needs: [setup, unit-benches, integration-benches]
if: always()
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Check setup script
run: |
[[ ${{ needs.setup.result }} = success ]]
- name: Check unit benches
run: |
[[ ${{ needs.unit-benches.result }} =~ success|skipped ]]
- name: Check integration benches
run: |
[[ ${{ needs.integration-benches.result }} =~ success|skipped ]]
- name: Notify Slack on failure
uses: rtCamp/action-slack-notify@c318f0a93a2bbf24828a21c271765cb9a5c92727
if: ${{ failure() && github.event_name == 'merge_group' }}
env:
SLACK_LINK_NAMES: true
SLACK_MESSAGE: "At least one bench job failed for a Pull Request in the Merge Queue failed <@U02NLJY0FGX>" # Notifies T
SLACK_TITLE: Tests failed
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}
SLACK_USERNAME: GitHub
VAULT_ADDR: ""
VAULT_TOKEN: ""
- name: Checkout
if: github.event_name == 'pull_request' && needs.integration-benches.result == 'success'
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
- name: Download reports' artifacts
if: github.event_name == 'pull_request' && needs.integration-benches.result == 'success'
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
with:
path: downloads
- name: Create comment
if: github.event_name == 'pull_request' && needs.integration-benches.result == 'success'
run: |
echo "## Benchmark results" > /tmp/summary.md
cat downloads/*/*.md >> /tmp/summary.md
- name: Post comment
uses: mshick/add-pr-comment@b8f338c590a895d50bcbfa6c5859251edc8952fc # v2.8.2
if: github.event_name == 'pull_request' && needs.integration-benches.result == 'success'
with:
message-path: /tmp/summary.md
message-id: benchmark-results
refresh-message-position: true