anuraghazra/github-readme-stats

Stats and languages results incorrect due to graphql 100 records limit

Open

#1,852 opened on Jul 7, 2022

View on GitHub
 (14 comments) (6 reactions) (1 assignee)JavaScript (33,282 forks)batch import
:star: top bugbughacktoberfesthacktoberfest-acceptedhelp wantedlang-cardstats-card

Repository metrics

Stars
 (79,424 stars)
PR merge metrics
 (Avg merge 21d 13h) (1 merged PR in 30d)

Description

Describe the bug

The current language and stats card results are incorrect for users with more than 100 repositories (see https://docs.github.com/en/graphql/overview/resource-limitations). This is because we are currently only fetching the first 100 repositories of a user account.

https://github.com/anuraghazra/github-readme-stats/blob/a68abbb9b3a47ad73988f37fce274e882e86b7ad/src/fetchers/stats-fetcher.js#L47

https://github.com/anuraghazra/github-readme-stats/blob/a68abbb9b3a47ad73988f37fce274e882e86b7ad/src/fetchers/top-languages-fetcher.js#L17

Because of this not all languages and stars of a user are represented.

Expected behaviour

I think we can use pagination options (i.e. cursor, after, endCursor objects) to loop through all repositories of a user account (see https://stackoverflow.com/a/70039506/8135687). @anuraghazra Let me know what you think.

TODOs

  • Allow fetching of multiple pages for the languages data. #2111.
  • Improve the stats card such that it fetches more pages when a user has more than 100 repositories with stars. #2100
    • Merge #2159 to make this available on private Vercel instances while giving us the control to disable it on the public instance because of rate-limiting problems.

Contributor guide

Research direction
Implement pagination for fetching all repositories via GraphQL to overcome the 100 record limit. Use cursor based pagination with `after` and `endCursor` parameters.
Tech stack
javascriptgraphqlnodejs
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptGraphQLGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60