Skip to content

fix(seo): define a bounded canonical URL strategy for NPM Stats #1152

Closed

Description

@KevinVandy

Problem

The clean /stats/npm URL currently redirects to a URL that serializes the complete default chart state. In a live audit, the resulting canonical URL was 2,355 characters long.

The route validates defaults for packageGroups, range, chart type, transforms, playback controls, legend state, dimensions, and other UI settings, then staticData.includeSearchInCanonical causes all of those values to become canonical. Each user interaction can therefore create another indexable URL.

Relevant route: src/routes/stats/npm/index.tsx

Google warns that parameter-driven faceted navigation can generate effectively infinite crawl spaces and slow discovery of useful pages: https://developers.google.com/crawling/docs/faceted-navigation

Goals

  • Keep NPM Stats URLs shareable.
  • Index only clean, stable pages with meaningful search intent.
  • Prevent display and playback controls from creating indexable canonical variants.

Proposed direction

  • Make /stats/npm a stable 200 URL with a clean self-canonical, or normalize to another intentionally short canonical URL.
  • Omit default values from serialized search parameters.
  • Separate semantic state from presentation state.
  • Treat parameters such as range, transform, bin type, view mode, chart type, sorting, dimensions, playback, legend visibility, and similar controls as non-indexable UI state.
  • Define a bounded format for package or package-comparison pages that should be indexable, potentially using stable path-based package identifiers rather than encoded JSON.
  • Canonicalize or noindex non-semantic variants according to the chosen model.
  • Ensure scoped package paths resolve correctly and have one canonical encoding.
  • Make WebApplication JSON-LD url and any BreadcrumbList URLs match the selected canonical.
  • Review FAQPage JSON-LD. Google does not normally show FAQ rich results for non-government and non-health sites, so retain it only if another consumer justifies the maintenance.

Acceptance criteria

  • Loading /stats/npm does not redirect to a URL containing the full default chart configuration.
  • The default canonical is short, stable, and self-referencing.
  • Default values are omitted from generated links.
  • Presentation-only variants do not self-canonicalize as independently indexable pages.
  • Any intentionally indexable comparison page has unique SSR title, description, H1, canonical, and structured data based on the compared packages.
  • Nonsensical or empty package combinations return an appropriate 404 or noindex response rather than another indexable state.
  • Tests cover default state, one package, scoped packages, multi-package comparison, UI-only controls, and invalid combinations.
  • Internal links and sitemap entries expose only the bounded set of indexable URLs.

Activity

  1. tannerlinsley commented on Oct 26, 2026

    @tannerlinsley
    Member

    Thanks for spelling this out, Kevin. This is now fixed in #1434, #1435 and #1436. The chart stays shareable, with /stats/npm as its single indexable canonical.

    AI review notes:
    Production HTTP checks confirmed that /stats/npm returns 200 without redirecting or serializing the full default configuration. Display-only query variants keep the same clean canonical.
    Single-package, multi-package and scoped-package comparison paths now return a server-side 307 to the chart, followed by 200. Package names and non-default display settings are preserved. These paths are redirect entrypoints, not independently indexable comparison pages.
    Invalid combinations, an empty comparison member and a 215-character package name return 404 directly. WebApplication metadata uses the clean chart URL, and the obsolete FAQPage metadata is removed while the visible FAQ remains. Internal links and sitemap handling were reviewed for this single-page indexing model.
    Regression tests and full pnpm test passed before commits, and all eight PR checks passed before merging. Committed comparison tests exercise the guard directly; actual application HTTP checks separately verified route wiring, including these production checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions