@stats-organization/github-readme-stats-core 2.1.3 → 2.1.5

package/src/common/retryer.ts

@@ -0,0 +1,125 @@
+import type { AxiosResponse } from "axios";
+
+import { getConfig } from "./config.js";
+import { CustomError } from "./error.js";
+import { logger } from "./log.js";
+
+/**
+ * Error-detection fields the retryer inspects to detect rate-limiting and credential failures.
+ * Every fetcher's payload is intersected with
+ * this, so the retryer can read `errors`/`message` regardless of the payload's own shape.
+ */
+interface ResponseErrors {
+  errors?: Array<{ type?: string; message?: string }>;
+  message?: string;
+}
+
+/**
+ * Returns a random integer from 0 (inclusive) to `max` (exclusive).
+ *
+ * The value is generated using `Math.random()` and uniformly distributed
+ * across the range.
+ *
+ * @param max The upper bound (exclusive). Must be a positive number.
+ *
+ * @returns A random integer `n` such that `0 <= n < max`.
+ */
+function getRandomInt(max: number): number {
+  return Math.floor(Math.random() * max);
+}
+
+/**
+ * A fetcher's Axios response. `TData` is the shape of `response.data`,
+ * which is intersected with {@link ResponseErrors} so the retryer can inspect
+ * `errors`/`message`.
+ * Defaults to `unknown` (error fields only) for callers that don't care about the payload.
+ */
+type FetcherResponse<TData = unknown> = AxiosResponse<TData & ResponseErrors>;
+
+type FetcherFunction<TData = unknown> = (
+  variables: Record<string, unknown>,
+  token: string,
+  retriesForTests?: number,
+) => Promise<FetcherResponse<TData>>;
+
+/**
+ * Try to execute the fetcher function until it succeeds or the max number of retries is reached.
+ *
+ * @template TData Shape of `response.data` returned by the fetcher.
+ * @param fetcher The fetcher function.
+ * @param variables Object with arguments to pass to the fetcher function.
+ * @param pat Optional PAT override.
+ * @returns The response from the fetcher function.
+ */
+const retryer = async <TData = unknown>(
+  fetcher: FetcherFunction<TData>,
+  variables: Record<string, unknown>,
+  pat: string | null = null,
+): Promise<FetcherResponse<TData>> => {
+  const PATs = pat
+    ? [{ name: "user PAT from database", value: pat }]
+    : getConfig().pats;
+
+  if (!PATs.length) {
+    throw new CustomError("No GitHub API tokens found", CustomError.NO_TOKENS);
+  }
+  const startPAT = getRandomInt(PATs.length);
+
+  for (let retries = 0; retries < PATs.length; retries++) {
+    const currentPAT = PATs[(startPAT + retries) % PATs.length];
+    if (!currentPAT) {
+      continue;
+    }
+
+    try {
+      const response = await fetcher(
+        variables,
+        currentPAT.value,
+        // used in tests for faking rate limit
+        retries,
+      );
+
+      // react on both type and message-based rate-limit signals.
+      // https://github.com/anuraghazra/github-readme-stats/issues/4425
+      const errors = response.data.errors;
+      const errorType = errors?.[0]?.type;
+      const errorMsg = errors?.[0]?.message ?? "";
+      const isRateLimited =
+        (!!errors && errorType === "RATE_LIMITED") ||
+        /rate limit/i.test(errorMsg);
+
+      if (isRateLimited) {
+        logger.log(`${currentPAT.name} Failed due to rate limiting`);
+      } else {
+        return response;
+      }
+    } catch (err) {
+      const e = err as { response?: FetcherResponse<TData> };
+
+      // network/unexpected error → let caller treat as failure
+      if (!e.response) {
+        throw err;
+      }
+
+      // also checking for bad credentials if any tokens gets invalidated
+      const message = e.response.data.message;
+      const isBadCredential = message === "Bad credentials";
+      const isAccountSuspended =
+        message === "Sorry. Your account was suspended.";
+
+      if (isBadCredential || isAccountSuspended) {
+        logger.log(`${currentPAT.name} Failed due to bad credentials`);
+      } else {
+        // HTTP error with a response → return it for caller-side handling
+        return e.response;
+      }
+    }
+  }
+
+  throw new CustomError(
+    "Downtime due to GitHub API rate limiting",
+    CustomError.MAX_RETRY,
+  );
+};
+
+export { retryer };

package/src/fetchers/gist.ts

@@ -0,0 +1,136 @@
+import type { AxiosResponse } from "axios";
+
+import { MissingParamError } from "../common/error.js";
+import { request } from "../common/http.js";
+import { retryer } from "../common/retryer.js";
+
+import type { GistData } from "./types.js";
+
+const QUERY = `
+query gistInfo($gistName: String!) {
+    viewer {
+        gist(name: $gistName) {
+            description
+            owner {
+                login
+            }
+            stargazerCount
+            forks {
+                totalCount
+            }
+            files {
+                name
+                language {
+                    name
+                }
+                size
+            }
+        }
+    }
+}
+`;
+
+/**
+ * Gist data fetcher.
+ *
+ * @param variables Fetcher variables.
+ * @param token GitHub token.
+ * @returns The response.
+ */
+const fetcher = (
+  variables: Record<string, unknown>,
+  token: string,
+): Promise<AxiosResponse> => {
+  return request(
+    { query: QUERY, variables },
+    { Authorization: `token ${token}` },
+  );
+};
+
+/** A single file within a gist. */
+interface GistFile {
+  name: string;
+  language: { name: string } | null;
+  size: number;
+}
+
+/** Shape of `response.data` returned by the gist GraphQL query. */
+interface GistQueryResponse {
+  data: {
+    viewer: {
+      gist: {
+        description: string | null;
+        owner: { login: string };
+        stargazerCount: number;
+        forks: { totalCount: number };
+        files: Array<GistFile>;
+      } | null;
+    };
+  };
+}
+
+/**
+ * This function calculates the primary language of a gist by files size.
+ *
+ * @param files Files.
+ * @returns Primary language, or `null` when no file has a language.
+ */
+const calculatePrimaryLanguage = (files: Array<GistFile>): string | null => {
+  const languages: Record<string, number> = {};
+
+  for (const file of files) {
+    if (file.language) {
+      languages[file.language.name] =
+        (languages[file.language.name] ?? 0) + file.size;
+    }
+  }
+
+  let primaryLanguage: string | null = null;
+  let maxSize = -1;
+  for (const [language, size] of Object.entries(languages)) {
+    if (size > maxSize) {
+      maxSize = size;
+      primaryLanguage = language;
+    }
+  }
+
+  return primaryLanguage;
+};
+
+/**
+ * Fetch GitHub gist information by given username and ID.
+ *
+ * @param id GitHub gist ID.
+ * @param pat Optional PAT override.
+ * @returns Gist data.
+ */
+const fetchGist = async (
+  id: string,
+  pat: string | null = null,
+): Promise<GistData> => {
+  if (!id) {
+    throw new MissingParamError(["id"], "/api/gist?id=GIST_ID");
+  }
+  const res = await retryer<GistQueryResponse>(fetcher, { gistName: id }, pat);
+  if (res.data.errors) {
+    throw new Error(res.data.errors[0]?.message);
+  }
+  const gist = res.data.data.viewer.gist;
+  if (!gist) {
+    throw new Error("Gist not found");
+  }
+  const firstFile = gist.files[0];
+  if (!firstFile) {
+    throw new Error("Gist has no files");
+  }
+  return {
+    name: firstFile.name,
+    nameWithOwner: `${gist.owner.login}/${firstFile.name}`,
+    description: gist.description,
+    language: calculatePrimaryLanguage(gist.files),
+    starsCount: gist.stargazerCount,
+    forksCount: gist.forks.totalCount,
+  };
+};
+
+export { fetchGist };

package/src/fetchers/repo.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { MissingParamError } from "../common/error.js";
 import { request } from "../common/http.js";
 import { retryer } from "../common/retryer.js";
@@ -23,9 +21,7 @@ const fetcher = (variables, token) => {
         isPrivate
         isArchived
         isTemplate
-        stargazers {
-          totalCount
-        }
+        stargazerCount
         description
         primaryLanguage {
           color
@@ -55,7 +51,7 @@ const fetcher = (variables, token) => {
   );
 };
 
-const urlExample = "/api/pin?username=USERNAME&repo=REPO_NAME";
+const urlExample = "/api/pin?username=USERNAME&repo=REPO_NAME";
 
 /**
  * @typedef {import("./types").RepositoryData} RepositoryData Repository data.
@@ -130,7 +126,7 @@ const fetchRepo = async (
     return {
       ...repoUserStats,
       ...data.user.repository,
-      starCount: data.user.repository.stargazers.totalCount,
+      starCount: data.user.repository.stargazerCount,
     };
   }
 
@@ -155,7 +151,7 @@ const fetchRepo = async (
     return {
       ...repoUserStats,
       ...data.organization.repository,
-      starCount: data.organization.repository.stargazers.totalCount,
+      starCount: data.organization.repository.stargazerCount,
     };
   }
 

package/src/fetchers/stats.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import axios from "axios";
 import githubUsernameRegex from "github-username-regex";
 
@@ -18,9 +16,7 @@ const GRAPHQL_REPOS_FIELD = `
     totalCount
     nodes {
       name
-      stargazers {
-        totalCount
-      }
+      stargazerCount
     }
     pageInfo {
       hasNextPage
@@ -156,10 +152,9 @@ const statsFetcher = async ({
       stats = res;
     }
 
-    // Disable multi page fetching on public Vercel instance due to rate limits.
     fetchedPages++;
     const repoNodesWithStars = repoNodes.filter(
-      (node) => node.stargazers.totalCount !== 0,
+      (node) => node.stargazerCount !== 0,
     );
 
     hasNextPage =
@@ -458,7 +453,7 @@ const fetchStats = async (
       return !repoToHide.has(data.name);
     })
     .reduce((prev, curr) => {
-      return prev + curr.stargazers.totalCount;
+      return prev + curr.stargazerCount;
     }, 0);
 
   stats.rank = calculateRank({

package/src/fetchers/top-languages.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { getConfig } from "../common/config.js";
 import { CustomError, MissingParamError } from "../common/error.js";
 import { wrapTextMultiline } from "../common/fmt.js";

package/src/fetchers/{types.d.ts → types.ts}

@@ -13,7 +13,7 @@ export interface RepositoryData {
   isPrivate: boolean;
   isArchived: boolean;
   isTemplate: boolean;
-  stargazers: { totalCount: number };
+  stargazerCount: number;
   description: string;
   primaryLanguage: {
     color: string;

package/src/fetchers/wakatime.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import axios from "axios";
 
 import { CustomError, MissingParamError } from "../common/error.js";

package/src/{translations.js → translations.ts}

@@ -1,18 +1,22 @@
-// @ts-check
-
 import { encodeHTML } from "./common/html.js";
 
 /**
  * Retrieves stat card labels in the available locales.
  *
- * @param {object} props Function arguments.
- * @param {string} props.name The name of the locale.
- * @param {string} props.apostrophe Whether to use apostrophe or not.
- * @returns {object} The locales object.
+ * @param props Function arguments.
+ * @param props.name The name of the locale.
+ * @param props.apostrophe Whether to use apostrophe or not.
+ * @returns The locales object.
  *
  * @see https://www.andiamo.co.uk/resources/iso-language-codes/ for language codes.
  */
-const statCardLocales = ({ name, apostrophe }) => {
+const statCardLocales = ({
+  name,
+  apostrophe,
+}: {
+  name: string;
+  apostrophe: string;
+}) => {
   const encodedName = encodeHTML(name);
   return {
     "statcard.title": {
@@ -1140,10 +1144,10 @@ const availableLocales = Object.keys(repoCardLocales["repocard.archived"]);
 /**
  * Checks whether the locale is available or not.
  *
- * @param {string} locale The locale to check.
- * @returns {boolean} Boolean specifying whether the locale is available or not.
+ * @param locale The locale to check.
+ * @returns Boolean specifying whether the locale is available or not.
  */
-const isLocaleAvailable = (locale) => {
+const isLocaleAvailable = (locale: string): boolean => {
   return availableLocales.includes(locale.toLowerCase());
 };
 

package/src/common/Card.js

@@ -1,275 +0,0 @@
-// @ts-check
-
-import { encodeHTML } from "./html.js";
-import { flexLayout } from "./render.js";
-
-class Card {
-  /**
-   * Creates a new card instance.
-   *
-   * @param {object} args Card arguments.
-   * @param {number=} args.width Card width.
-   * @param {number=} args.height Card height.
-   * @param {number=} args.border_radius Card border radius.
-   * @param {string=} args.customTitle Card custom title.
-   * @param {string=} args.defaultTitle Card default title.
-   * @param {string=} args.titlePrefixIcon Card title prefix icon.
-   * @param {object} [args.colors={}] Card colors arguments.
-   * @param {string=} args.colors.titleColor Card title color.
-   * @param {string=} args.colors.textColor Card text color.
-   * @param {string=} args.colors.iconColor Card icon color.
-   * @param {string|string[]=} args.colors.bgColor Card background color.
-   * @param {string=} args.colors.borderColor Card border color.
-   */
-  constructor({
-    width = 100,
-    height = 100,
-    border_radius = 4.5,
-    colors = {},
-    customTitle,
-    defaultTitle = "",
-    titlePrefixIcon,
-  }) {
-    this.width = width;
-    this.height = height;
-
-    this.hideBorder = false;
-    this.hideTitle = false;
-
-    this.border_radius = border_radius;
-
-    // returns theme based colors with proper overrides and defaults
-    this.colors = colors;
-    this.title =
-      customTitle === undefined
-        ? encodeHTML(defaultTitle)
-        : encodeHTML(customTitle);
-
-    this.css = "";
-
-    this.paddingX = 25;
-    this.paddingY = 35;
-    this.titlePrefixIcon = titlePrefixIcon;
-    this.animations = true;
-    this.a11yTitle = "";
-    this.a11yDesc = "";
-  }
-
-  /**
-   * @returns {void}
-   */
-  disableAnimations() {
-    this.animations = false;
-  }
-
-  /**
-   * @param {Object} props The props object.
-   * @param {string} props.title Accessibility title.
-   * @param {string} props.desc Accessibility description.
-   * @returns {void}
-   */
-  setAccessibilityLabel({ title, desc }) {
-    this.a11yTitle = title;
-    this.a11yDesc = desc;
-  }
-
-  /**
-   * @param {string} value The CSS to add to the card.
-   * @returns {void}
-   */
-  setCSS(value) {
-    this.css = value;
-  }
-
-  /**
-   * @param {boolean} value Whether to hide the border or not.
-   * @returns {void}
-   */
-  setHideBorder(value) {
-    this.hideBorder = value;
-  }
-
-  /**
-   * @param {boolean} value Whether to hide the title or not.
-   * @returns {void}
-   */
-  setHideTitle(value) {
-    this.hideTitle = value;
-    if (value) {
-      this.height -= 30;
-    }
-  }
-
-  /**
-   * @param {string} text The title to set.
-   * @returns {void}
-   */
-  setTitle(text) {
-    this.title = text;
-  }
-
-  /**
-   * @returns {string} The rendered card title.
-   */
-  renderTitle() {
-    const titleText = `
-      <text
-        x="0"
-        y="0"
-        class="header"
-        data-testid="header"
-      >${this.title}</text>
-    `;
-
-    const prefixIcon = `
-      <svg
-        class="icon"
-        x="0"
-        y="-13"
-        viewBox="0 0 16 16"
-        version="1.1"
-        width="16"
-        height="16"
-      >
-        ${this.titlePrefixIcon}
-      </svg>
-    `;
-    return `
-      <g
-        data-testid="card-title"
-        transform="translate(${this.paddingX}, ${this.paddingY})"
-      >
-        ${flexLayout({
-          items: [this.titlePrefixIcon ? prefixIcon : "", titleText],
-          gap: 25,
-        }).join("")}
-      </g>
-    `;
-  }
-
-  /**
-   * @returns {string} The rendered card gradient.
-   */
-  renderGradient() {
-    if (typeof this.colors.bgColor !== "object") {
-      return "";
-    }
-
-    const gradients = this.colors.bgColor.slice(1);
-    return typeof this.colors.bgColor === "object"
-      ? `
-        <defs>
-          <linearGradient
-            id="gradient"
-            gradientTransform="rotate(${this.colors.bgColor[0]})"
-            gradientUnits="userSpaceOnUse"
-          >
-            ${gradients.map((grad, index) => {
-              let offset = (index * 100) / (gradients.length - 1);
-              return `<stop offset="${offset}%" stop-color="#${grad}" />`;
-            })}
-          </linearGradient>
-        </defs>
-        `
-      : "";
-  }
-
-  /**
-   * Retrieves css animations for a card.
-   *
-   * @returns {string} Animation css.
-   */
-  getAnimations = () => {
-    return `
-      /* Animations */
-      @keyframes scaleInAnimation {
-        from {
-          transform: translate(-5px, 5px) scale(0);
-        }
-        to {
-          transform: translate(-5px, 5px) scale(1);
-        }
-      }
-      @keyframes fadeInAnimation {
-        from {
-          opacity: 0;
-        }
-        to {
-          opacity: 1;
-        }
-      }
-    `;
-  };
-
-  /**
-   * @param {string} body The inner body of the card.
-   * @returns {string} The rendered card.
-   */
-  render(body) {
-    return `
-      <svg
-        width="${this.width}"
-        height="${this.height}"
-        viewBox="0 0 ${this.width} ${this.height}"
-        fill="none"
-        xmlns="http://www.w3.org/2000/svg"
-        role="img"
-        aria-labelledby="descId"
-      >
-        <title id="titleId">${this.a11yTitle}</title>
-        <desc id="descId">${this.a11yDesc}</desc>
-        <style>
-          .header {
-            font: 600 18px 'Segoe UI', Ubuntu, Sans-Serif;
-            fill: ${this.colors.titleColor};
-            animation: fadeInAnimation 0.8s ease-in-out forwards;
-          }
-          @supports(-moz-appearance: auto) {
-            /* Selector detects Firefox */
-            .header { font-size: 15.5px; }
-          }
-          ${this.css}
-
-          ${this.getAnimations()}
-          ${
-            this.animations === false
-              ? `* { animation-duration: 0s !important; animation-delay: 0s !important; }`
-              : ""
-          }
-        </style>
-
-        ${this.renderGradient()}
-
-        <rect
-          data-testid="card-bg"
-          x="0.5"
-          y="0.5"
-          rx="${this.border_radius}"
-          height="99%"
-          stroke="${this.colors.borderColor}"
-          width="${this.width - 1}"
-          fill="${
-            typeof this.colors.bgColor === "object"
-              ? "url(#gradient)"
-              : this.colors.bgColor
-          }"
-          stroke-opacity="${this.hideBorder ? 0 : 1}"
-        />
-
-        ${this.hideTitle ? "" : this.renderTitle()}
-
-        <g
-          data-testid="main-card-body"
-          transform="translate(0, ${
-            this.hideTitle ? this.paddingX : this.paddingY + 20
-          })"
-        >
-          ${body}
-        </g>
-      </svg>
-    `;
-  }
-}
-
-export { Card };
-export default Card;