Skip to content

Update Charts landing and catalog contracts - #1082

Merged
tannerlinsley merged 2 commits into
mainfrom
taren/charts-release-prep
Jul 30, 2026
Merged

Update Charts landing and catalog contracts#1082
tannerlinsley merged 2 commits into
mainfrom
taren/charts-release-prep

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Jul 30, 2026

Copy link
Copy Markdown
Member

What changed

  • updates the Charts landing page for the post-0.0.0 API, all nine adapters, inferred domains and keys, and current 24.2–24.8 KiB bundle evidence
  • accepts both the published catalog schema v2 and the new schema v4 through separate strict validators
  • renders complete v4 authored-source roles and dataset provenance while excluding harness source and raw dataset rows
  • keeps the current v2 catalog working through its entry-only source fallback

Why

The next Charts release changes definition ownership, domain and key inference, tooltip composition, and catalog artifact structure. The site must understand schema v4 before the Charts repository publishes it, while preserving the live schema-v2 routes during the cutover.

Validation

  • pnpm test (137 tests: 136 passed, 1 skipped; typecheck and lint clean)
  • pnpm run build
  • desktop and mobile browser audit of /charts/latest, /charts/catalog, and a catalog detail route
  • no browser console errors or horizontal overflow

Release order

Deploy this site change before publishing the schema-v4 catalog artifact. Keep schema-v2 compatibility until the production catalog routes are verified.

Summary by CodeRabbit

  • New Features

    • Chart catalog source panels now display authored source files, datasets, file metrics, and optional schema details.
    • Embedded chart views support the same enhanced source experience.
  • Improvements

    • Catalog manifests now support richer source and dataset metadata while maintaining compatibility with existing catalogs.
    • Source display includes expandable files, syntax highlighting, safe external links, and clearer size/count formatting.
    • Landing-page guidance and bundle-size labels have been updated for greater clarity and accuracy.
  • Tests

    • Added comprehensive validation for source integrity, datasets, asset limits, and compatibility.

@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0dec1f24-db40-4b35-af69-7d4cf896bae6

📥 Commits

Reviewing files that changed from the base of the PR and between 5fd484a and c376409.

📒 Files selected for processing (11)
  • src/components/charts/ChartsCatalogPages.tsx
  • src/components/charts/ChartsCatalogSource.tsx
  • src/components/landing/ChartsLanding.tsx
  • src/components/landing/ChartsLandingGraphics.tsx
  • src/routes/charts.catalog_.embed.$caseId.tsx
  • src/utils/charts-catalog.functions.ts
  • src/utils/charts-catalog.server.ts
  • src/utils/charts-catalog.ts
  • tests/charts-catalog-manifest.test.ts
  • tests/charts-catalog-source.test.ts
  • tests/charts-catalog-test-fixture.ts

📝 Walkthrough

Walkthrough

The PR adds schema v4 authored-source catalog support with dataset metadata, source integrity checks, and v2 compatibility. Catalog APIs and UI now render authored source files and comparison data. Landing-page chart guidance and bundle-size presentation are also updated.

Changes

Authored source catalog

Layer / File(s) Summary
Catalog schema and validation contracts
src/utils/charts-catalog.ts, tests/charts-catalog-manifest.test.ts, tests/charts-catalog-test-fixture.ts
Adds versioned v4 manifest schemas, datasets, authored-source closures, canonical preload validation, size constraints, compatibility fixtures, and positive and negative validation tests.
Authored source loading and API payloads
src/utils/charts-catalog.server.ts, src/utils/charts-catalog.functions.ts, tests/charts-catalog-source.test.ts
Loads v2 and v4 source files, computes metrics, excludes harness files, verifies metadata integrity, and returns authored-source payloads from catalog handlers.
Catalog authored-source rendering
src/components/charts/ChartsCatalogSource.tsx, src/components/charts/ChartsCatalogPages.tsx, src/routes/charts.catalog_.embed.$caseId.tsx
Adds source and dataset rendering, safe external links, formatted metrics, and authored-source integration for detail and embed views.
Charts landing presentation
Layer / File(s) Summary
Landing content and bundle metrics
src/components/landing/ChartsLanding.tsx, src/components/landing/ChartsLandingGraphics.tsx
Updates chart-generation guidance, explanatory copy, examples, bundle values, scaling, accessibility labels, and KiB formatting.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant CatalogView
  participant CatalogAPI
  participant AuthoredSourceLoader
  participant SourceFiles
  CatalogView->>CatalogAPI: request catalog case
  CatalogAPI->>AuthoredSourceLoader: load authored source by case and implementation
  AuthoredSourceLoader->>SourceFiles: fetch entry, support, and fixture files
  SourceFiles-->>AuthoredSourceLoader: return source contents
  AuthoredSourceLoader-->>CatalogAPI: return files, datasets, and metrics
  CatalogAPI-->>CatalogView: render authored source panels
Loading

Possibly related PRs

  • TanStack/tanstack.com#1068: Introduced the charts-catalog UI, routes, and server functions that this PR updates to use authored-source payloads.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch taren/charts-release-prep

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

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 30, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
tanstack-com c376409 Commit Preview URL

Branch Preview URL
Jul 30 2026, 10:14 PM

@tannerlinsley
tannerlinsley marked this pull request as ready for review July 30, 2026 22:41
@tannerlinsley
tannerlinsley merged commit c09e354 into main Jul 30, 2026
6 of 7 checks passed
@tannerlinsley
tannerlinsley deleted the taren/charts-release-prep branch July 30, 2026 22:41
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.

1 participant