Merge pull request #1337 from Open-Source-Legal/claude/fix-codecov-badge-gEMAE

JSv4 · web-flow · commit a5173f50dbaa · 2026-04-20T08:27:38.000-07:00
Fix Codecov frontend badge by aggregating flags server-side
diff --git a/.codecov.yml b/.codecov.yml
@@ -45,13 +45,17 @@ flags:
     paths:
       - frontend/src/
     carryforward: true
-  # Merged frontend flag uploaded by codecov-notify.yml after combining the
-  # three per-suite lcovs (frontend-unit, frontend-component, frontend-e2e).
-  # This is what the README badge reads so it reflects the union of all
-  # frontend test suites, not just the Vitest slice. Intentionally does NOT
+  # Merged frontend flag that the README badge reads. Populated by tagging
+  # each per-suite upload (`frontend-unit`, `frontend-component`,
+  # `frontend-e2e`) with `frontend` as an additional flag in its workflow,
+  # so Codecov aggregates the union of the three uploads server-side.
+  # `carryforward: true` is load-bearing — a backend-only commit path-filters
+  # all three producing workflows out, so without carryforward the badge
+  # would drop to "unknown" on those commits; with it, the flag reuses the
+  # last known coverage from the parent commit. Intentionally does NOT
   # match the `frontend-.*` regex used by the component_management block
   # below, so the `frontend` component keeps aggregating only the three
-  # per-suite flags and doesn't double-count this merged upload.
+  # per-suite flags and doesn't double-count this merged flag.
   frontend:
     paths:
       - frontend/src/
diff --git a/.github/workflows/codecov-notify.yml b/.github/workflows/codecov-notify.yml
@@ -8,14 +8,11 @@ name: Codecov Notify
 # the triggering SHA. Workflows that skipped due to path filters don't block
 # the notify step.
 #
-# This workflow also merges the three per-suite frontend lcov reports
-# (`frontend-unit-lcov`, `frontend-ct-lcov`, `frontend-e2e-lcov`, each
-# published as a GitHub Actions artifact by its producing job) into a
-# single lcov and uploads it to Codecov under the `frontend` flag. That
-# gives one authoritative Frontend coverage number — the README badge
-# reads it, and PR comments show the merged total alongside the per-suite
-# flags. The three individual flag uploads still happen in their own
-# workflows, so drill-in by suite continues to work.
+# The merged `frontend` flag that the README badge reads is produced
+# server-side: each per-suite frontend upload (`frontend-unit`,
+# `frontend-component`, `frontend-e2e`) is tagged with `frontend` as an
+# additional flag in its own workflow, so Codecov aggregates the union
+# of all three without any cross-workflow lcov merging here.
 
 on:
   workflow_run:
@@ -60,7 +57,6 @@ jobs:
             );
 
             let allDone = true;
-            const runIds = {};
             for (const name of expected) {
               const matching = runs
                 .filter((r) => r.name === name)
@@ -77,102 +73,13 @@ jobs:
               core.info(
                 `${name}: status=${latest.status} conclusion=${latest.conclusion} id=${latest.id}`
               );
-              runIds[name] = latest.id;
               if (latest.status !== "completed") {
                 allDone = false;
               }
             }
 
             core.setOutput("all_done", allDone ? "true" : "false");
             core.setOutput("sha", sha);
-            core.setOutput(
-              "frontend_ci_run_id",
-              runIds["Frontend CI"] || ""
-            );
-            core.setOutput(
-              "frontend_e2e_run_id",
-              runIds["Frontend E2E Integration"] || ""
-            );
-
-      # ────────────────────────────────────────────────────────────────
-      # Download per-suite lcov artifacts from each producing workflow.
-      #
-      # Each download is guarded by the producing workflow's run id (empty
-      # string when that workflow was path-filtered for this SHA), and
-      # `continue-on-error: true` tolerates a completed run that did not
-      # publish the artifact (for example, when the suite failed before
-      # the upload step ran).
-      # ────────────────────────────────────────────────────────────────
-      - name: Download unit lcov artifact
-        if: steps.check.outputs.all_done == 'true' && steps.check.outputs.frontend_ci_run_id != ''
-        continue-on-error: true
-        uses: actions/download-artifact@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          run-id: ${{ steps.check.outputs.frontend_ci_run_id }}
-          name: frontend-unit-lcov
-          path: coverage/unit
-
-      - name: Download component lcov artifact
-        if: steps.check.outputs.all_done == 'true' && steps.check.outputs.frontend_ci_run_id != ''
-        continue-on-error: true
-        uses: actions/download-artifact@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          run-id: ${{ steps.check.outputs.frontend_ci_run_id }}
-          name: frontend-ct-lcov
-          path: coverage/ct
-
-      - name: Download e2e lcov artifact
-        if: steps.check.outputs.all_done == 'true' && steps.check.outputs.frontend_e2e_run_id != ''
-        continue-on-error: true
-        uses: actions/download-artifact@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          run-id: ${{ steps.check.outputs.frontend_e2e_run_id }}
-          name: frontend-e2e-lcov
-          path: coverage/e2e
-
-      - name: Check for downloaded lcov files
-        id: lcov
-        if: steps.check.outputs.all_done == 'true'
-        run: |
-          shopt -s nullglob
-          files=(coverage/*/lcov.info)
-          if [ ${#files[@]} -eq 0 ]; then
-            echo "No lcov artifacts retrieved; skipping merged frontend upload."
-            echo "has_lcov=false" >> "$GITHUB_OUTPUT"
-          else
-            echo "Found ${#files[@]} lcov file(s):"
-            printf '  - %s\n' "${files[@]}"
-            echo "has_lcov=true" >> "$GITHUB_OUTPUT"
-          fi
-
-      - name: Setup Node.js
-        if: steps.lcov.outputs.has_lcov == 'true'
-        uses: actions/setup-node@v6
-        with:
-          node-version: "20"
-
-      - name: Merge frontend lcov reports
-        if: steps.lcov.outputs.has_lcov == 'true'
-        run: |
-          mkdir -p coverage/merged
-          npx --yes lcov-result-merger@5 'coverage/*/lcov.info' coverage/merged/lcov.info
-          echo "Merged lcov source-file count:"
-          grep -c "^SF:" coverage/merged/lcov.info || true
-
-      - name: Upload merged frontend coverage to Codecov
-        if: steps.lcov.outputs.has_lcov == 'true'
-        uses: codecov/codecov-action@v6
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: coverage/merged/lcov.info
-          flags: frontend
-          name: frontend-merged-coverage
-          fail_ci_if_error: false
-          disable_search: true
-          override_commit: ${{ steps.check.outputs.sha }}
 
       - name: Send notifications to Codecov
         if: steps.check.outputs.all_done == 'true'
diff --git a/.github/workflows/frontend-e2e.yml b/.github/workflows/frontend-e2e.yml
@@ -208,29 +208,20 @@ jobs:
           path: frontend/playwright-report-e2e/
           if-no-files-found: ignore
 
+      # The `frontend` flag rides along so the same upload feeds both the
+      # per-suite drill-in and the merged Frontend coverage total that the
+      # README badge reads. See `frontend.yml` for the companion uploads.
       - name: Upload frontend E2E coverage to Codecov
         if: success() || failure()
         uses: codecov/codecov-action@v6
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: frontend/coverage/e2e/lcov.info
-          flags: frontend-e2e
+          flags: frontend-e2e,frontend
           name: frontend-e2e-coverage
           fail_ci_if_error: false
           disable_search: true
 
-      # Publish the raw lcov so the cross-workflow merge job in
-      # `codecov-notify.yml` can pull it via `actions/download-artifact` and
-      # combine it with the unit + component lcovs into a single `frontend` flag.
-      - name: Upload frontend E2E lcov artifact
-        if: success() || failure()
-        uses: actions/upload-artifact@v7
-        with:
-          name: frontend-e2e-lcov
-          path: frontend/coverage/e2e/lcov.info
-          if-no-files-found: warn
-          retention-days: 7
-
       - name: Upload backend E2E coverage to Codecov
         if: success() || failure()
         uses: codecov/codecov-action@v6
diff --git a/.github/workflows/frontend.yml b/.github/workflows/frontend.yml
@@ -79,27 +79,22 @@ jobs:
           yarn run test:ct --reporter=list tests/*Metadata*.ct.tsx
         continue-on-error: true
 
+      # The `frontend` flag is intentionally listed alongside
+      # `frontend-component` so the same upload feeds both the per-suite
+      # drill-in and the merged Frontend coverage total. Codecov aggregates
+      # all uploads sharing a flag server-side, so the README `flag=frontend`
+      # badge reflects the union of unit + component + e2e without any
+      # cross-workflow lcov merging on our side.
       - name: Upload CT Coverage to Codecov
         if: success() || failure()
         uses: codecov/codecov-action@v6
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: frontend/coverage/ct/lcov.info
-          flags: frontend-component
+          flags: frontend-component,frontend
           name: frontend-ct-coverage
           fail_ci_if_error: false
-
-      # Publish the raw lcov so the cross-workflow merge job in
-      # `codecov-notify.yml` can pull it via `actions/download-artifact` and
-      # combine it with the unit + e2e lcovs into a single `frontend` flag.
-      - name: Upload CT lcov artifact
-        if: success() || failure()
-        uses: actions/upload-artifact@v7
-        with:
-          name: frontend-ct-lcov
-          path: frontend/coverage/ct/lcov.info
-          if-no-files-found: warn
-          retention-days: 7
+          disable_search: true
 
   build:
     name: Build
@@ -144,27 +139,17 @@ jobs:
         run: yarn install --frozen-lockfile
       - name: Run Unit Tests with Coverage
         run: yarn run test:coverage:unit
+      # See the CT upload above for why the `frontend` flag is listed here too.
       - name: Upload Unit Coverage to Codecov
         if: success() || failure()
         uses: codecov/codecov-action@v6
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: frontend/coverage/unit/lcov.info
-          flags: frontend-unit
+          flags: frontend-unit,frontend
           name: frontend-unit-coverage
           fail_ci_if_error: false
-
-      # Publish the raw lcov so the cross-workflow merge job in
-      # `codecov-notify.yml` can pull it via `actions/download-artifact` and
-      # combine it with the component + e2e lcovs into a single `frontend` flag.
-      - name: Upload Unit lcov artifact
-        if: success() || failure()
-        uses: actions/upload-artifact@v7
-        with:
-          name: frontend-unit-lcov
-          path: frontend/coverage/unit/lcov.info
-          if-no-files-found: warn
-          retention-days: 7
+          disable_search: true
 
   docker-build:
     name: Build Docker Image
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- **Frontend coverage badge stuck on "unknown"** (`README.md:12`, `.github/workflows/codecov-notify.yml`, `.github/workflows/frontend.yml`, `.github/workflows/frontend-e2e.yml`, `frontend/package.json`, `frontend/yarn.lock`): PR #1322 pointed the README badge at a new merged `frontend` flag fed by a cross-workflow `lcov-result-merger@5` step inside `codecov-notify.yml`. Every `frontend-merged-coverage` upload since has landed at Codecov with `state: error` / `totals: null`, so the badge rendered "unknown" even though `frontend-unit` (31%), `frontend-component` (61%), and `frontend-e2e` (24%) were all processing correctly. Two defects in the merged lcov confirmed by local repro of the CI merge step: (1) `lcov-result-merger@5` emits a stripped lcov containing only `SF:`, `DA:`, `BRDA:`, `end_of_record` — it drops `TN:`, `FN`, `FNDA`, `FNF`, `FNH`, `LF`, `LH`, `BRF`, `BRH`, so line-summary fields required by Codecov's parser are absent; (2) Vitest v8 emits `src/...` (relative to `frontend/`) while `vite-plugin-istanbul` + `nyc report` emit `/home/runner/work/OpenContracts/OpenContracts/frontend/src/...` (absolute), and the merger keys on the literal path string so the same file appears as two records with conflicting hit counts. `codecov-notify.yml` also ran without `actions/checkout`, which Codecov's action docs explicitly recommend against. Fix: stop merging client-side and let Codecov aggregate server-side, since that is what flags are for. Each per-suite upload now declares two flags — `frontend-unit,frontend`, `frontend-component,frontend`, `frontend-e2e,frontend` — so the `frontend` flag total is the union of the three uploads computed by Codecov. `codecov-notify.yml` is reduced to its original gate-and-notify role (no artifact downloads, no `lcov-result-merger`, no merged upload). Deleted the `frontend-{unit,ct,e2e}-lcov` artifact publishes in `frontend.yml` / `frontend-e2e.yml`, removed the `lcov-result-merger@^5.0.1` devDep and the `coverage:merge` script from `frontend/package.json`, and pruned the orphaned entries from `frontend/yarn.lock`. README badge URL unchanged (`flag=frontend`).
+
 ### Changed
 
 - **PR #1297 follow-up — tighten component tests and unit-test coverage** (Issue #1321):
diff --git a/frontend/package.json b/frontend/package.json
@@ -101,7 +101,6 @@
     "test:e2e:coverage": "COVERAGE=true playwright test; E2E_EXIT=$?; mkdir -p coverage/e2e/.nyc_output && nyc report --all --reporter=lcov --reporter=text --report-dir=coverage/e2e --temp-dir=coverage/e2e/.nyc_output || echo 'No coverage data to report'; exit $E2E_EXIT",
     "test:coverage:unit": "vitest run --coverage --watch=false",
     "test:coverage:ct": "COVERAGE=true playwright test -c playwright-ct.config.ts --reporter=list && mkdir -p coverage/ct/.nyc_output && nyc report --all --reporter=lcov --reporter=text --report-dir=coverage/ct --temp-dir=coverage/ct/.nyc_output",
-    "coverage:merge": "mkdir -p coverage/merged && lcov-result-merger 'coverage/*/lcov.info' coverage/merged/lcov.info",
     "lint": "prettier . --check --ignore-unknown",
     "fix-styles": "prettier . --check --write --ignore-unknown",
     "prepare": "cd .. && husky install frontend/.husky",
@@ -156,7 +155,6 @@
     "fake-indexeddb": "^6.2.2",
     "husky": "^8.0.1",
     "jsdom": "^26.1.0",
-    "lcov-result-merger": "^5.0.1",
     "nyc": "^18.0.0",
     "prettier": "^2.7.1",
     "vite-plugin-istanbul": "^8.0.0",
diff --git a/frontend/yarn.lock b/frontend/yarn.lock
@@ -3479,15 +3479,6 @@ cliui@^6.0.0:
     strip-ansi "^6.0.0"
     wrap-ansi "^6.2.0"
 
-cliui@^7.0.2:
-  version "7.0.4"
-  resolved "https://registry.yarnpkg.com/cliui/-/cliui-7.0.4.tgz#a0265ee655476fc807aea9df3df8df7783808b4f"
-  integrity sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==
-  dependencies:
-    string-width "^4.2.0"
-    strip-ansi "^6.0.0"
-    wrap-ansi "^7.0.0"
-
 cliui@^8.0.1:
   version "8.0.1"
   resolved "https://registry.yarnpkg.com/cliui/-/cliui-8.0.1.tgz#0c04b075db02cbfe60dc8e6cf2f5486b1a3608aa"
@@ -4390,7 +4381,7 @@ fast-deep-equal@^3.1.3:
   resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525"
   integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==
 
-fast-glob@^3.2.11, fast-glob@^3.2.9:
+fast-glob@^3.2.9:
   version "3.3.3"
   resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.3.tgz#d06d585ce8dba90a16b0505c543c3ccfb3aeb818"
   integrity sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==
@@ -5512,14 +5503,6 @@ jsonpointer@^5.0.1:
   resolved "https://registry.yarnpkg.com/jsonpointer/-/jsonpointer-5.0.1.tgz#2110e0af0900fd37467b5907ecd13a7884a1b559"
   integrity sha512-p/nXbhSEcu3pZRdkW1OfJhpsVtW1gd4Wa1fnQc9YLiTfAjn0312eMKimbdIQzuZl9aa9xUGaRlP9T/CJE/ditQ==
 
-lcov-result-merger@^5.0.1:
-  version "5.0.1"
-  resolved "https://registry.yarnpkg.com/lcov-result-merger/-/lcov-result-merger-5.0.1.tgz#39e3cfef3f84dc1a73736c139e735b58fbb2eeed"
-  integrity sha512-i53RjTYfqbHgerqGtuJjDfARDU340zNxXrJudQZU3o8ak9rrx8FDQUKf38Cjm6MtbqonqiDFmoKuUe++uZbvOg==
-  dependencies:
-    fast-glob "^3.2.11"
-    yargs "^16.2.0"
-
 lines-and-columns@^1.1.6:
   version "1.2.4"
   resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632"
@@ -8663,11 +8646,6 @@ yargs-parser@^18.1.2:
     camelcase "^5.0.0"
     decamelize "^1.2.0"
 
-yargs-parser@^20.2.2:
-  version "20.2.9"
-  resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.9.tgz#2eb7dc3b0289718fc295f362753845c41a0c94ee"
-  integrity sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==
-
 yargs-parser@^21.1.1:
   version "21.1.1"
   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.1.1.tgz#9096bceebf990d21bb31fa9516e0ede294a77d35"
@@ -8690,19 +8668,6 @@ yargs@^15.0.2:
     y18n "^4.0.0"
     yargs-parser "^18.1.2"
 
-yargs@^16.2.0:
-  version "16.2.0"
-  resolved "https://registry.yarnpkg.com/yargs/-/yargs-16.2.0.tgz#1c82bf0f6b6a66eafce7ef30e376f49a12477f66"
-  integrity sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==
-  dependencies:
-    cliui "^7.0.2"
-    escalade "^3.1.1"
-    get-caller-file "^2.0.5"
-    require-directory "^2.1.1"
-    string-width "^4.2.0"
-    y18n "^5.0.5"
-    yargs-parser "^20.2.2"
-
 yargs@^17.0.0:
   version "17.7.2"
   resolved "https://registry.yarnpkg.com/yargs/-/yargs-17.7.2.tgz#991df39aca675a192b816e1e0363f9d75d2aa269"
