feat: add code coverage for packages with PR comparison

.github/workflows/all-checks.yml

@@ -24,6 +24,11 @@ jobs:
     uses: ./.github/workflows/unit-tests.yml
     secrets: inherit
 
+  code-coverage:
+    name: Coverage
+    uses: ./.github/workflows/code-coverage.yml
+    secrets: inherit
+
   api-v2-unit-test:
     name: Tests
     uses: ./.github/workflows/api-v2-unit-tests.yml

.github/workflows/code-coverage.yml

@@ -0,0 +1,201 @@
+name: Code Coverage
+
+on:
+  workflow_call:
+
+env:
+  LINGO_DOT_DEV_API_KEY: ${{ secrets.CI_LINGO_DOT_DEV_API_KEY }}
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  coverage:
+    name: Coverage
+    timeout-minutes: 30
+    runs-on: blacksmith-4vcpu-ubuntu-2404
+    outputs:
+      lines: ${{ steps.coverage.outputs.lines }}
+      statements: ${{ steps.coverage.outputs.statements }}
+      functions: ${{ steps.coverage.outputs.functions }}
+      branches: ${{ steps.coverage.outputs.branches }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: .github
+      - uses: ./.github/actions/cache-checkout
+      - uses: ./.github/actions/yarn-install
+      - run: yarn prisma generate
+
+      - name: Run tests with coverage
+        run: yarn test:coverage -- --no-isolate
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report-${{ github.sha }}
+          path: coverage/
+          retention-days: 7
+
+      - name: Generate coverage summary
+        id: coverage
+        run: |
+          if [ ! -f coverage/coverage-summary.json ]; then
+            echo "No coverage summary found"
+            echo "lines=0" >> $GITHUB_OUTPUT
+            echo "statements=0" >> $GITHUB_OUTPUT
+            echo "functions=0" >> $GITHUB_OUTPUT
+            echo "branches=0" >> $GITHUB_OUTPUT
+            exit 0
+          fi
+
+          LINES=$(jq '.total.lines.pct' coverage/coverage-summary.json)
+          STATEMENTS=$(jq '.total.statements.pct' coverage/coverage-summary.json)
+          FUNCTIONS=$(jq '.total.functions.pct' coverage/coverage-summary.json)
+          BRANCHES=$(jq '.total.branches.pct' coverage/coverage-summary.json)
+
+          echo "lines=$LINES" >> $GITHUB_OUTPUT
+          echo "statements=$STATEMENTS" >> $GITHUB_OUTPUT
+          echo "functions=$FUNCTIONS" >> $GITHUB_OUTPUT
+          echo "branches=$BRANCHES" >> $GITHUB_OUTPUT
+
+          echo "## Coverage Summary (Packages)" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "| Metric | Coverage |" >> $GITHUB_STEP_SUMMARY
+          echo "|--------|----------|" >> $GITHUB_STEP_SUMMARY
+          echo "| Lines | ${LINES}% |" >> $GITHUB_STEP_SUMMARY
+          echo "| Statements | ${STATEMENTS}% |" >> $GITHUB_STEP_SUMMARY
+          echo "| Functions | ${FUNCTIONS}% |" >> $GITHUB_STEP_SUMMARY
+          echo "| Branches | ${BRANCHES}% |" >> $GITHUB_STEP_SUMMARY
+
+  coverage-base:
+    name: Coverage (Base)
+    timeout-minutes: 30
+    runs-on: blacksmith-4vcpu-ubuntu-2404
+    outputs:
+      lines: ${{ steps.coverage-base.outputs.lines }}
+      statements: ${{ steps.coverage-base.outputs.statements }}
+      functions: ${{ steps.coverage-base.outputs.functions }}
+      branches: ${{ steps.coverage-base.outputs.branches }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.base.sha || github.event.merge_group.base_sha || 'main' }}
+          sparse-checkout: .github
+      - uses: ./.github/actions/cache-checkout
+        with:
+          ref: ${{ github.event.pull_request.base.sha || github.event.merge_group.base_sha || 'main' }}
+      - uses: ./.github/actions/yarn-install
+      - run: yarn prisma generate
+
+      - name: Run tests with coverage on base
+        run: |
+          if grep -q "test:coverage" package.json; then
+            yarn test:coverage -- --no-isolate || true
+          else
+            echo "test:coverage script not found in base branch, skipping"
+            mkdir -p coverage
+            echo '{"total":{"lines":{"pct":0},"statements":{"pct":0},"functions":{"pct":0},"branches":{"pct":0}}}' > coverage/coverage-summary.json
+          fi
+
+      - name: Upload base coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report-base
+          path: coverage/
+          retention-days: 7
+
+      - name: Generate base coverage summary
+        id: coverage-base
+        run: |
+          if [ ! -f coverage/coverage-summary.json ]; then
+            echo "No coverage summary found for base"
+            echo "lines=0" >> $GITHUB_OUTPUT
+            echo "statements=0" >> $GITHUB_OUTPUT
+            echo "functions=0" >> $GITHUB_OUTPUT
+            echo "branches=0" >> $GITHUB_OUTPUT
+            exit 0
+          fi
+
+          LINES=$(jq '.total.lines.pct' coverage/coverage-summary.json)
+          STATEMENTS=$(jq '.total.statements.pct' coverage/coverage-summary.json)
+          FUNCTIONS=$(jq '.total.functions.pct' coverage/coverage-summary.json)
+          BRANCHES=$(jq '.total.branches.pct' coverage/coverage-summary.json)
+
+          echo "lines=$LINES" >> $GITHUB_OUTPUT
+          echo "statements=$STATEMENTS" >> $GITHUB_OUTPUT
+          echo "functions=$FUNCTIONS" >> $GITHUB_OUTPUT
+          echo "branches=$BRANCHES" >> $GITHUB_OUTPUT
+
+  compare-coverage:
+    name: Compare Coverage
+    needs: [coverage, coverage-base]
+    runs-on: blacksmith-2vcpu-ubuntu-2404
+    steps:
+      - name: Compare coverage
+        id: compare
+        run: |
+          PR_LINES="${{ needs.coverage.outputs.lines }}"
+          PR_STATEMENTS="${{ needs.coverage.outputs.statements }}"
+          PR_FUNCTIONS="${{ needs.coverage.outputs.functions }}"
+          PR_BRANCHES="${{ needs.coverage.outputs.branches }}"
+
+          BASE_LINES="${{ needs.coverage-base.outputs.lines }}"
+          BASE_STATEMENTS="${{ needs.coverage-base.outputs.statements }}"
+          BASE_FUNCTIONS="${{ needs.coverage-base.outputs.functions }}"
+          BASE_BRANCHES="${{ needs.coverage-base.outputs.branches }}"
+
+          # Handle empty values
+          PR_LINES=${PR_LINES:-0}
+          PR_STATEMENTS=${PR_STATEMENTS:-0}
+          PR_FUNCTIONS=${PR_FUNCTIONS:-0}
+          PR_BRANCHES=${PR_BRANCHES:-0}
+          BASE_LINES=${BASE_LINES:-0}
+          BASE_STATEMENTS=${BASE_STATEMENTS:-0}
+          BASE_FUNCTIONS=${BASE_FUNCTIONS:-0}
+          BASE_BRANCHES=${BASE_BRANCHES:-0}
+
+          LINES_DIFF=$(echo "$PR_LINES - $BASE_LINES" | bc)
+          STATEMENTS_DIFF=$(echo "$PR_STATEMENTS - $BASE_STATEMENTS" | bc)
+          FUNCTIONS_DIFF=$(echo "$PR_FUNCTIONS - $BASE_FUNCTIONS" | bc)
+          BRANCHES_DIFF=$(echo "$PR_BRANCHES - $BASE_BRANCHES" | bc)
+
+          echo "## Coverage Comparison (Packages)" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "| Metric | Base | PR | Diff |" >> $GITHUB_STEP_SUMMARY
+          echo "|--------|------|-----|------|" >> $GITHUB_STEP_SUMMARY
+          echo "| Lines | ${BASE_LINES}% | ${PR_LINES}% | ${LINES_DIFF}% |" >> $GITHUB_STEP_SUMMARY
+          echo "| Statements | ${BASE_STATEMENTS}% | ${PR_STATEMENTS}% | ${STATEMENTS_DIFF}% |" >> $GITHUB_STEP_SUMMARY
+          echo "| Functions | ${BASE_FUNCTIONS}% | ${PR_FUNCTIONS}% | ${FUNCTIONS_DIFF}% |" >> $GITHUB_STEP_SUMMARY
+          echo "| Branches | ${BASE_BRANCHES}% | ${PR_BRANCHES}% | ${BRANCHES_DIFF}% |" >> $GITHUB_STEP_SUMMARY
+
+          COVERAGE_DECREASED="false"
+          if (( $(echo "$LINES_DIFF < -0.5" | bc -l) )); then
+            echo "::warning::Lines coverage decreased by ${LINES_DIFF}%"
+            COVERAGE_DECREASED="true"
+          fi
+          if (( $(echo "$STATEMENTS_DIFF < -0.5" | bc -l) )); then
+            echo "::warning::Statements coverage decreased by ${STATEMENTS_DIFF}%"
+            COVERAGE_DECREASED="true"
+          fi
+          if (( $(echo "$FUNCTIONS_DIFF < -0.5" | bc -l) )); then
+            echo "::warning::Functions coverage decreased by ${FUNCTIONS_DIFF}%"
+            COVERAGE_DECREASED="true"
+          fi
+          if (( $(echo "$BRANCHES_DIFF < -0.5" | bc -l) )); then
+            echo "::warning::Branches coverage decreased by ${BRANCHES_DIFF}%"
+            COVERAGE_DECREASED="true"
+          fi
+
+          echo "coverage_decreased=$COVERAGE_DECREASED" >> $GITHUB_OUTPUT
+
+          if [ "$COVERAGE_DECREASED" = "true" ]; then
+            echo "" >> $GITHUB_STEP_SUMMARY
+            echo "> **Warning**: Code coverage has decreased by more than 0.5%. Please add tests to maintain coverage." >> $GITHUB_STEP_SUMMARY
+            echo "::error::Code coverage has decreased. Please add tests to maintain coverage."
+            exit 1
+          fi
+
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "> Coverage check passed!" >> $GITHUB_STEP_SUMMARY

.github/workflows/pr.yml

@@ -319,6 +319,13 @@ jobs:
     uses: ./.github/workflows/unit-tests.yml
     secrets: inherit
 
+  code-coverage:
+    name: Coverage
+    needs: [prepare]
+    if: ${{ needs.prepare.outputs.has-files-requiring-all-checks == 'true' }}
+    uses: ./.github/workflows/code-coverage.yml
+    secrets: inherit
+
   api-v2-unit-test:
     name: Tests
     needs: [prepare]

package.json

@@ -75,6 +75,7 @@
     "test-e2e:embed-react": "yarn db-seed && yarn e2e:embed-react",
     "test-playwright": "yarn playwright test --config=playwright.config.ts",
     "test": "TZ=UTC vitest run",
+    "test:coverage": "TZ=UTC vitest run --coverage",
     "test:ui": "TZ=UTC vitest --ui",
     "type-check": "turbo run type-check",
     "type-check:ci": "turbo run type-check:ci --log-prefix=none",

vitest.config.mts

@@ -1,4 +1,5 @@
 import path from "node:path";
+import process from "node:process";
 import react from "@vitejs/plugin-react";
 import { loadEnv } from "vite";
 import { defineConfig } from "vitest/config";
@@ -13,7 +14,8 @@ for (const [key, value] of Object.entries(env)) {
 const vitestMode = process.env.VITEST_MODE;
 // Support both new VITEST_MODE env var and legacy CLI flags for backwards compatibility
 // The CLI flags are passed through but Vitest 4.0 doesn't reject them when using yarn test
-const isPackagedEmbedMode = vitestMode === "packaged-embed" || process.argv.includes("--packaged-embed-tests-only");
+const isPackagedEmbedMode =
+  vitestMode === "packaged-embed" || process.argv.includes("--packaged-embed-tests-only");
 const isIntegrationMode = vitestMode === "integration" || process.argv.includes("--integrationTestsOnly");
 const isTimezoneMode = vitestMode === "timezone" || process.argv.includes("--timeZoneDependentTestsOnly");
 
@@ -63,10 +65,7 @@ export default defineConfig({
       },
       {
         find: /^\.\/tailwind\.generated\.css\?inline$/,
-        replacement: path.resolve(
-          __dirname,
-          "vitest-mocks/tailwind.generated.css"
-        ),
+        replacement: path.resolve(__dirname, "vitest-mocks/tailwind.generated.css"),
       },
       // Alias Node.js built-ins for jsdom environment
       { find: "crypto", replacement: "node:crypto" },
@@ -79,24 +78,15 @@ export default defineConfig({
       // Platform packages that need to be resolved from source in CI
       {
         find: "@calcom/platform-constants",
-        replacement: path.resolve(
-          __dirname,
-          "packages/platform/constants/index.ts"
-        ),
+        replacement: path.resolve(__dirname, "packages/platform/constants/index.ts"),
       },
       {
         find: "@calcom/embed-react",
-        replacement: path.resolve(
-          __dirname,
-          "packages/embeds/embed-react/src/index.ts"
-        ),
+        replacement: path.resolve(__dirname, "packages/embeds/embed-react/src/index.ts"),
       },
       {
         find: "@calcom/embed-snippet",
-        replacement: path.resolve(
-          __dirname,
-          "packages/embeds/embed-snippet/src/index.ts"
-        ),
+        replacement: path.resolve(__dirname, "packages/embeds/embed-snippet/src/index.ts"),
       },
     ],
   },
@@ -115,6 +105,26 @@ export default defineConfig({
     },
     coverage: {
       provider: "v8",
+      reporter: ["text", "json", "json-summary"],
+      reportsDirectory: "./coverage",
+      include: ["packages/**/*.{ts,tsx}"],
+      exclude: [
+        "**/node_modules/**",
+        "**/dist/**",
+        "**/*.test.{ts,tsx}",
+        "**/*.spec.{ts,tsx}",
+        "**/*.d.ts",
+        "**/types/**",
+        "**/__mocks__/**",
+        "**/test/**",
+        "**/testing/**",
+        "packages/embeds/**",
+        "packages/platform/examples/**",
+        "packages/app-store/**/api/**",
+        "packages/app-store/**/components/**",
+        "packages/tsconfig/**",
+        "packages/config/**",
+      ],
     },
     passWithNoTests: true,
     testTimeout: 500000,
@@ -128,8 +138,6 @@ function setEnvVariablesThatAreUsedBeforeSetup() {
   process.env.DAILY_API_KEY = "MOCK_DAILY_API_KEY";
   // With same env variable, we can test both non org and org booking scenarios
   process.env.NEXT_PUBLIC_WEBAPP_URL = "http://app.cal.local:3000";
-  process.env.CALCOM_SERVICE_ACCOUNT_ENCRYPTION_KEY =
-    "UNIT_TEST_ENCRYPTION_KEY";
-  process.env.STRIPE_PRIVATE_KEY =
-    process.env.STRIPE_PRIVATE_KEY || "sk_test_dummy_unit_test_key";
+  process.env.CALCOM_SERVICE_ACCOUNT_ENCRYPTION_KEY = "UNIT_TEST_ENCRYPTION_KEY";
+  process.env.STRIPE_PRIVATE_KEY = process.env.STRIPE_PRIVATE_KEY || "sk_test_dummy_unit_test_key";
 }