-
Notifications
You must be signed in to change notification settings - Fork 1.5k
feat(pages): show live npm downloads in highlights stats #794
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
ff4feba
feat(pages): show live npm downloads in highlights stats
lizhengfeng101 b8e0830
docs(pages): translate highlights npm-downloads comments to English
lizhengfeng101 72cd50d
fix(pages): give stat3 a distinct caption and refactor npm-downloads …
lizhengfeng101 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // Copyright 2026 alibaba/open-code-review Contributors | ||
|
|
||
| import { useEffect, useState } from 'react'; | ||
|
|
||
| type Period = 'last-day' | 'last-week' | 'last-month' | 'last-year'; | ||
|
|
||
| interface NpmDownloadsState { | ||
| downloads: number | null; | ||
| loading: boolean; | ||
| error: boolean; | ||
| } | ||
|
|
||
| /** | ||
| * Fetch the live download count for an npm package. | ||
| * The data source is the official npm stats API (CORS-enabled, callable directly from a purely static page). | ||
| * When the request fails, `error` is true so callers can degrade gracefully. | ||
| * | ||
| * Currently used by the "NPM community downloads" stat in HighlightsSection: while the | ||
| * request is in flight or has failed, the component falls back to the static i18n value. | ||
| */ | ||
| export function useNpmDownloads(pkg: string, period: Period = 'last-month'): NpmDownloadsState { | ||
| const [state, setState] = useState<NpmDownloadsState>({ | ||
| downloads: null, | ||
| loading: true, | ||
| error: false, | ||
| }); | ||
|
|
||
| useEffect(() => { | ||
| let cancelled = false; | ||
| setState({ downloads: null, loading: true, error: false }); | ||
|
|
||
| // On a slow network or an unresponsive API, abort the request after a timeout and degrade, | ||
| // so the UI does not stay stuck in the loading state indefinitely | ||
| const controller = new AbortController(); | ||
| const timeout = setTimeout(() => controller.abort(), 8000); | ||
|
|
||
| (async () => { | ||
| try { | ||
| // pkg may be a scoped package name (containing `/`), so encode it before interpolation to keep the URL path valid | ||
| const r = await fetch(`https://api.npmjs.org/downloads/point/${period}/${encodeURIComponent(pkg)}`, { | ||
| signal: controller.signal, | ||
| }); | ||
| if (!r.ok) throw new Error(`npm downloads API responded ${r.status}`); | ||
| const data: { downloads?: number } = await r.json(); | ||
| if (cancelled) return; | ||
| if (typeof data.downloads !== 'number') throw new Error('unexpected payload'); | ||
| setState({ downloads: data.downloads, loading: false, error: false }); | ||
| } catch { | ||
| if (cancelled) return; | ||
| setState({ downloads: null, loading: false, error: true }); | ||
| } finally { | ||
| // Clear the timeout as soon as the request settles, so it doesn't linger and abort a finished request | ||
| clearTimeout(timeout); | ||
| } | ||
| })(); | ||
|
|
||
| return () => { | ||
| cancelled = true; | ||
| clearTimeout(timeout); | ||
| controller.abort(); | ||
| }; | ||
| }, [pkg, period]); | ||
|
|
||
| return state; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[bug · medium]
Resource leak:
setTimeoutnot cleared on fetch completion. The 8-second timeout is only cleared in the effect cleanup function. If the fetch resolves or rejects well before the timeout, the timer keeps running and will callcontroller.abort()on an already-finished request. While functionally harmless, it's a minor resource leak. Clear the timeout in both success and error paths (or in afinallyblock).