Skip to content

docs(privacy): say which servers the CPSR and MultiQC reports contact when opened - #494

Merged
3 commits merged into
GeiserX:mainfrom
geiresx:pgp/ux-docs-report-privacy
Nov 18, 2026
Merged

3 commits merged into
GeiserX:mainfrom
geiresx:pgp/ux-docs-report-privacy

Conversation

@geiresx

@geiresx geiresx commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

The privacy page lists what each HTML report loads from the internet when you open it. A report that loads a file tells that server your IP address. Two reports were left out: the page said "Not checked: the CPSR (step 17) and MultiQC (step 28) reports". A reader could not tell whether opening them contacts any server.

Fix

docs/why-local.md, section "Opening the reports", now has a dated bullet for each of the two reports and no "Not checked" line:

  • CPSR report: loads nothing. Its stylesheets, scripts and images are inside the HTML file. Its external addresses are plain links (ClinVar, PanelApp, PubMed and others).
  • MultiQC report: loads nothing. Its external addresses are plain links to MultiQC, Seqera and the tools' papers.

CHANGELOG.md gets one line. Docs only: no option, output or file name changes.

Decision: the e2e address listing does not see these two reports (the test never builds a real CPSR report, and its MultiQC report is written in another job than the listing), so the PCGR 2.3.2 data bundle and VEP cache were not downloaded to build a CPSR report here. The CPSR evidence is the CPSR project's own example reports of versions 2.3.0 and 2.4.0, plus the report template inside the pinned image. Version 2.3.0 is the CPSR that the pinned PCGR 2.3.2 image runs. The doc says this.

How it was checked

Each report was opened in headless Chromium with every request that is not file:, data: or blob: blocked and logged. The script clicks every tab and scrolls the whole page so lazy content renders.

  • Control: a page with one external stylesheet, one external script and one external image. Logged 3 requests (maxcdn.bootstrapcdn.com, code.jquery.com, assets-cdn.github.com). This shows the logger catches loads.
  • MultiQC 1.35 (quay.io/biocontainers/multiqc:1.35--pyhdfd78af_2, the pinned image), run with the step's options (-f --no-version-check --no-ai, the step's title) on a samtools flagstat file, in a container with no network: 0 requests.
  • CPSR 2.3.0 example report (Zenodo record 20795508), 15 tabs clicked: 0 requests.
  • CPSR 2.4.0 example report (Zenodo record 24107328), 13 tabs clicked: 0 requests.

Static scan of the same files for src or href on script, link, img, iframe, and for @import or url(http...) in CSS:

  • CPSR, both versions: no tag loads an http(s) address and no CSS imports one. Every http(s) address is an <a href> link.
  • MultiQC: one img src="https://assets-cdn.github.com/...octocat.png". It sits inside a JavaScript string (the emoji table of the bundled Markdown converter), not in the page, and the browser run shows it is never requested.
  • The CPSR template in the pinned ghcr.io/sigven/pcgr:2.3.2 image (cpsr R package 2.3.0, templates/cpsr_report.qmd) sets embed-resources: true. Its cpsr.css uses only data: URLs, and no template file has a script, link, img or iframe tag with an http(s) address.

CI on this head runs the doc link check and the docs build.

Beads

K010, K028

Summary by CodeRabbit

  • Documentation
    • Clarified that CPSR and MultiQC reports load their stylesheets, scripts, and images without contacting external addresses; external addresses are links that open when clicked.
    • Recorded browser checks for the specified report versions and noted that the end-to-end test does not cover these reports.
    • Updated the changelog to reflect the revised privacy-page wording.

… when opened

The privacy page left the CPSR (step 17) and MultiQC (step 28) reports as
"not checked", so a reader could not tell whether opening them tells a
server their IP address. Both were opened in a browser that blocked and
logged every request to the internet: neither loads anything. Their
external addresses are plain links.

Bead: K010
Bead: K028
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The report-opening documentation now records browser-check findings and notes that the e2e test does not cover CPSR or MultiQC reports. The changelog records the privacy-page wording about report network contacts and embedded assets.

Changes: Report network-contact documentation

Layer / File(s) Summary
Document report network contacts
docs/why-local.md, CHANGELOG.md
The documentation states that the checked reports load no external resources and that external addresses are links. It records the e2e test coverage limitation and the tested report versions. The changelog describes the privacy-page wording and states that there are no output changes.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: Minimal · up to 8bcdb

This change only updates documentation and the changelog to describe which external resources the CPSR and MultiQC reports load. It has no runtime effect and is safe to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the main change: the privacy/documentation update that states which servers the CPSR and MultiQC reports contact when opened. The changeset (CHANGELOG.md and docs/why-local.md) documen…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the main change: the privacy/documentation update that states which servers the CPSR and MultiQC reports contact when opened. The changeset (CHANGELOG.md and docs/why-local.md) documents that both reports load no external resources and that their external addresses are plain links. The title is specific and accurate, and it is a single, concise sentence in conventional commit format.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
Fix failing CI checks

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 85652cb and 8bcdbab.

Files selected for processing: 2

  • CHANGELOG.md
  • docs/why-local.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

geiresx pushed a commit to geiresx/OwnGenome that referenced this pull request Nov 18, 2026
GeiserX added a commit that referenced this pull request Nov 18, 2026
The rust job took 23 minutes on main (limit 30) and parity 19 (limit 20).
The same trees on the geiresx fork ran past both limits, twice, so a
docs-only PR (#494) could not get a green ci-ok. Raise rust to 45 and
parity to 35: the limit is there to stop a hung job, not a slow one.
@GeiserX GeiserX closed this pull request by merging all changes into GeiserX:main in 93ac84d Nov 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants