Path-filtered totals (components, `paths:` statuses) read the wrong chunks: ReadOnlyReport maps files to chunks by dict position, which jsonb commits.report reorders

Ouverte
#997 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
1-2 jours
Accessibilité débutants
42/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
postgresql, python, rust, sqlite

Piste de recherche

The bug is in ReadOnlyReport.from_chunks in libs/shared/shared/reports/readonly.py, where filename_mapping uses dict position instead of files[name][0]. Start with the self-contained reproduction in the issue, which should fail on main, then check Report.init in libs/shared/shared/reports/resources.py to confirm how chunks_index is read. Done means the reproduction passes and the existing report tests still pass, with a note on whether stored timeseries need correcting.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Describe the bug

On self-hosted Codecov, any total computed through ReadOnlyReport.filter(paths=...) can read the wrong file's line data. That covers component statuses, the component table in PR comments, component timeseries, project statuses scoped with paths:, and the API's component views. It happens on commits whose report gained files its parent didn't have, which is most PRs that add source files. Unfiltered totals and flag-only filters are correct, so the overall project % looks fine while the component numbers are wildly off.

Real example, with a few dozen path-based components:

  • a component with 0 of 89 lines hit (at both base and head) was reported at 57.45%
  • another was reported at 65.14% when its stored line data gives 26.35%
  • others swung by ±20–55% while the overall project changed by −0.89% and no individual module moved by more than 5%

Root cause

ReadOnlyReport.from_chunks in libs/shared/shared/reports/readonly.py (on main at de0a8097, lines 57-59) tells the Rust analyzer which chunk each file lives in by dict position:

filename_mapping = {
    filename: idx for idx, filename in enumerate(inner_report._files.keys())
}

Each file's real chunk index is stored in its summary, files[name][0]. The Python Report.__init__ (libs/shared/shared/reports/resources.py, chunks_index = summary[0]) already uses it, but the Rust mapping ignores it.

Position and chunk index only agree if the files dict comes back in the order it was serialized. It doesn't when the report is stored in the Postgres jsonb commits.report column, because jsonb doesn't keep key insertion order: it sorts object keys by length, then bytewise. When a merge appends new files, their chunks go at the end, but after the jsonb round-trip those files sort somewhere in the middle. Every file after them then maps to another file's chunk.

On the affected commit, 4,537 of 4,572 files had dict position ≠ files[name][0]. Its parent, which added no files, had 0 mismatches, and its component numbers were correct.

Recomputing every path-based component from the stored report (commits.report plus chunks.txt):

  • reading chunk = dict position reproduced Codecov's reported values for 58 of 58 components, exactly to 2 decimals
  • reading chunk = files[name][0] gave the correct values

The bug seems to come from the change that hard-enabled RustReport (#582) together with the Report._files/_chunks merge (#553).

Environment

  • Self-hosted, codecov/self-hosted-api and codecov/self-hosted-worker latest-stable (26.5.18), report stored inline in commits.report (jsonb)
  • The same code is unchanged on codecov/umbrella main as of 2026-11
  • Codecov SaaS may never see this if it doesn't keep reports in jsonb

To Reproduce

Self-contained; the files order differs from chunk order, which is exactly what a jsonb round-trip produces:

from shared.reports.readonly import ReadOnlyReport

# a.py lives in chunk 0 (fully covered), b.py in chunk 1 (uncovered), but b.py is listed first.
files = {
    "b.py": [1, [0, 1, 0, 1, 0, "0"]],
    "a.py": [0, [0, 1, 1, 0, 0, "100"]],
}
chunks = "\n".join(
    [
        "{}",
        "[1, null, [[0, 1]]]",
        "<<<<< end_of_chunk >>>>>",
        "{}",
        "[0, null, [[0, 0]]]",
    ]
)
sessions = {0: {"t": None, "f": None}}

report = ReadOnlyReport.from_chunks(files=files, sessions=sessions, totals=None, chunks=chunks)

for path, want_hits in (("a.py", 1), ("b.py", 0)):
    got = report.filter(paths=[path]).totals
    assert (got.lines, got.hits) == (1, want_hits), (
        f"filter(paths=[{path!r}]) -> lines={got.lines} hits={got.hits}, want lines=1 hits={want_hits}"
    )

On main this fails: filter(paths=["a.py"]) returns b.py's lines, and vice versa. With the patch below it passes.

Expected behavior

Path-filtered totals read each file's own chunk, so component and paths: statuses match the stored line data.

Fix

files is the raw dict passed to from_chunks. create_from_report passes freshly serialized files, where position == index, so it keeps working.

diff --git a/libs/shared/shared/reports/readonly.py b/libs/shared/shared/reports/readonly.py
--- a/libs/shared/shared/reports/readonly.py
+++ b/libs/shared/shared/reports/readonly.py
@@ -54,8 +54,10 @@ class ReadOnlyReport:
             files=files, sessions=sessions, totals=totals, chunks=chunks
         )
         totals = inner_report._totals
+        # Map each file to the chunk index stored in its summary, not to its
+        # position in `files`: commits.report is jsonb, which reorders keys.
         filename_mapping = {
-            filename: idx for idx, filename in enumerate(inner_report._files.keys())
+            filename: summary[0] for filename, summary in (files or {}).items()
         }
         session_mapping = {
             sid: (session.flags or []) for sid, session in inner_report.sessions.items()

I applied this patch to the 26.5.18 self-hosted api and worker images and re-ran the affected commit's stored report through them. Every component came out correct, and the overall total was unchanged.

Additional context

Component values already written to the timeseries tables were computed with the bad mapping. The fix corrects new measurements but not existing points.

Langage dominant
Aucune donnée de langage
Étoiles
52
Forks
25
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de codecov/feedback

Toutes les issues de codecov/feedback

Issues similaires

Plus d'issues Backend & API Design

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.