Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Octocov custom metrix #3

Merged
merged 19 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 17 additions & 49 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,8 @@ jobs:
name: coverage-lambda-edge
path: coverage/

perf-measures-type-check-on-pr:
name: 'Type Check on PR'
perf-measures-type-and-bundle-check-on-pr:
name: 'Type & Bundle size Check on PR'
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
steps:
Expand All @@ -194,15 +194,20 @@ jobs:
bun scripts/generate-app.ts
bun tsc -p tsconfig.build.json --diagnostics | bun scripts/process-results.ts > diagnostics.json
working-directory: perf-measures/type-check
- name: Performance measurement of bundle check
run: |
bun run build
bun perf-measures/bundle-check/scripts/check-bundle-size.ts > perf-measures/bundle-check/size.json
- name: Run octocov
uses: k1LoW/octocov-action@v1
with:
config: perf-measures/type-check/.octocov.perf-measures.yml
config: perf-measures/.octocov.perf-measures.yml
env:
OCTOCOV_CUSTOM_METRICS_BENCHMARK: perf-measures/type-check/diagnostics.json
OCTOCOV_CUSTOM_METRICS_BENCHMARK_BUNDLE: perf-measures/bundle-check/size.json
OCTOCOV_CUSTOM_METRICS_BENCHMARK_TYPE: perf-measures/type-check/diagnostics.json

perf-measures-type-check-on-main:
name: 'Type Check on Main'
perf-measures-type-and-bundle-check-on-main:
name: 'Type & Bundle size Check on Main'
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
Expand All @@ -214,52 +219,15 @@ jobs:
bun scripts/generate-app.ts
bun tsc -p tsconfig.build.json --diagnostics | bun scripts/process-results.ts > diagnostics.json
working-directory: perf-measures/type-check
- name: Performance measurement of bundle check
run: |
bun run build
bun perf-measures/bundle-check/scripts/check-bundle-size.ts > perf-measures/bundle-check/size.json
- name: Run octocov (main)
uses: k1LoW/octocov-action@v1
with:
config: perf-measures/type-check/.octocov.perf-measures.main.yml
env:
OCTOCOV_GITHUB_REF: refs/heads/main
OCTOCOV_GITHUB_SHA: none
OCTOCOV_CUSTOM_METRICS_BENCHMARK: perf-measures/type-check/diagnostics.json

perf-measures-bundle-check-on-pr:
name: 'Bundle Check on PR'
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
- run: bun install
- run: bun run build
- run: bunx esbuild --minify --bundle dist/index.js --format=esm --outfile=perf-measures/bundle-check/generated/after.js
- uses: actions/cache/restore@v4
with:
path: perf-measures/bundle-check/generated/before.js
restore-keys: |
perf-measures-bundle-check-previous-file-
key: perf-measures-bundle-check-previous-file-
- run: |
{
echo 'COMPARISON<<EOF'
bun scripts/process-results.ts | column -s '|' -t
echo 'EOF'
} >> "$GITHUB_ENV"
working-directory: perf-measures/bundle-check
- run: echo "$COMPARISON"
name: display comparison

perf-measures-bundle-check-on-main:
name: 'Bundle Check on Main'
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
- run: bun install
- run: bun run build
- run: bunx esbuild --minify --bundle dist/index.js --format=esm --outfile=perf-measures/bundle-check/generated/before.js
- uses: actions/cache/save@v4
with:
path: perf-measures/bundle-check/generated/before.js
key: perf-measures-bundle-check-previous-file-${{ github.sha }}
OCTOCOV_CUSTOM_METRICS_BENCHMARK_BUNDLE: perf-measures/bundle-check/size.json
OCTOCOV_CUSTOM_METRICS_BENCHMARK_TYPE: perf-measures/type-check/diagnostics.json
1 change: 1 addition & 0 deletions perf-measures/bundle-check/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
generated
!generated/.gitkeep
size.json
43 changes: 43 additions & 0 deletions perf-measures/bundle-check/scripts/check-bundle-size.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import * as os from 'os'
import * as path from 'path'
import * as esbuild from 'esbuild'
import * as fs from 'node:fs'

async function main() {
const tempDir = os.tmpdir()
const tempFilePath = path.join(tempDir, 'bundle.tmp.js')

try {
await esbuild.build({
entryPoints: ['dist/index.js'],
bundle: true,
minify: true,
format: 'esm' as esbuild.Format,
target: 'es2022',
outfile: tempFilePath,
})

const bundleSize = fs.statSync(tempFilePath).size
const metrics = []
metrics.push({
key: 'bundle-size',
name: 'Bundle Size',
value: bundleSize,
unit: 'B',
})
const benchmark = {
key: 'bundle-size-check',
name: 'Bundle size check',
metrics,
}
console.log(JSON.stringify(benchmark, null, 2))
} catch (error) {
console.error('Build failed:', error)
} finally {
if (fs.existsSync(tempFilePath)) {
fs.unlinkSync(tempFilePath)
}
}
}

main()
14 changes: 0 additions & 14 deletions perf-measures/bundle-check/scripts/process-results.ts

This file was deleted.

1 change: 1 addition & 0 deletions perf-measures/type-check/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ generated
!generated/.gitkeep
trace
*result.txt
diagnostics.json
76 changes: 38 additions & 38 deletions perf-measures/type-check/scripts/process-results.ts
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
import * as readline from 'node:readline';
import * as readline from 'node:readline'

async function main() {
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
terminal: false
})
const toKebabCase = (str: string): string => {
return str
.replace(/([a-z])([A-Z])/g, '$1-$2')
.replace(/[\s_\/]+/g, '-')
.toLowerCase()
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
terminal: false,
})
const toKebabCase = (str: string): string => {
return str
.replace(/([a-z])([A-Z])/g, '$1-$2')
.replace(/[\s_\/]+/g, '-')
.toLowerCase()
}
const metrics = []
for await (const line of rl) {
if (!line || line.trim() === '') continue
const [name, value] = line.split(':')
const unitMatch = value?.trim().match(/^(\d+(\.\d+)?)([a-zA-Z]*)$/)
if (unitMatch) {
const [, number, , unit] = unitMatch
metrics.push({
key: toKebabCase(name?.trim()),
name: name?.trim(),
value: parseFloat(number),
unit: unit || undefined,
})
} else {
metrics.push({
key: toKebabCase(name?.trim()),
name: name?.trim(),
value: parseFloat(value?.trim()),
})
}
const metrics = []
for await (const line of rl) {
if (!line || line.trim() === '') continue
const [name, value] = line.split(':')
const unitMatch = value?.trim().match(/^(\d+(\.\d+)?)([a-zA-Z]*)$/)
if (unitMatch) {
const [, number, , unit] = unitMatch;
metrics.push({
key: toKebabCase(name?.trim()),
name: name?.trim(),
value: parseFloat(number),
unit: unit || undefined
})
} else {
metrics.push({
key: toKebabCase(name?.trim()),
name: name?.trim(),
value: parseFloat(value?.trim()),
})
}
}
const diagnostics = {
key: "diagnostics",
name: "Compiler Diagnostics",
metrics
}
console.log(JSON.stringify(diagnostics, null, 2))
}
const benchmark = {
key: 'diagnostics',
name: 'Compiler Diagnostics',
metrics,
}
console.log(JSON.stringify(benchmark, null, 2))
}

main()
Loading