Merge branch 'master' into improve_caching_behavoir

Author: rickstaa

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,5 +1,5 @@
 name: Bug report
-description: Create a report to help us improve
+description: Create a report to help us improve.
 labels:
   - "bug"
 body:

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,12 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Question
+    url: https://github.com/anuraghazra/github-readme-stats/discussions
+    about: Please ask and answer questions here.
+  - name: Error
+    url: https://github.com/anuraghazra/github-readme-stats/issues/1772
+    about:
+      Before opening a bug report, please check the 'Common Error Codes' issue.
+  - name: FAQ
+    url: https://github.com/anuraghazra/github-readme-stats/discussions/1770
+    about: Please first check the FAQ before asking a question.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,5 +1,5 @@
 name: Feature request
-description: Suggest an idea for this project
+description: Suggest an idea for this project.
 labels:
   - "enhancement"
 body:

.github/workflows/stale-theme-pr-closer.yaml

@@ -26,5 +26,5 @@ jobs:
 
       - run: npm run close-stale-theme-prs
         env:
-          STALE_DAYS: 15
+          STALE_DAYS: 20
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

api/index.js

@@ -94,6 +94,7 @@ export default async (req, res) => {
       }),
     );
   } catch (err) {
+    res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses.
     return res.send(renderError(err.message, err.secondaryMessage));
   }
 };

api/pin.js

@@ -80,6 +80,7 @@ export default async (req, res) => {
       }),
     );
   } catch (err) {
+    res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses.
     return res.send(renderError(err.message, err.secondaryMessage));
   }
 };

api/top-langs.js

@@ -81,6 +81,7 @@ export default async (req, res) => {
       }),
     );
   } catch (err) {
+    res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses.
     return res.send(renderError(err.message, err.secondaryMessage));
   }
 };

api/wakatime.js

@@ -83,6 +83,7 @@ export default async (req, res) => {
       }),
     );
   } catch (err) {
+    res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses.
     return res.send(renderError(err.message, err.secondaryMessage));
   }
 };

package.json

@@ -1,9 +1,23 @@
 {
   "name": "github-readme-stats",
   "version": "1.0.0",
-  "description": "Dynamically generate stats for your github readmes",
-  "main": "index.js",
+  "description": "Dynamically generate stats for your GitHub readme",
+  "keywords": [
+    "github-readme-stats",
+    "readme-stats",
+    "cards",
+    "card-generator"
+  ],
+  "main": "src/index.js",
   "type": "module",
+  "homepage": "https://github.com/anuraghazra/github-readme-stats",
+  "bugs": {
+    "url": "https://github.com/anuraghazra/github-readme-stats/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anuraghazra/github-readme-stats.git"
+  },
   "scripts": {
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
     "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",

readme.md

@@ -92,6 +92,7 @@ Visit <https://indiafightscorona.giveindia.org> and make a small donation to hel
     -   [Language Card Exclusive Options](#language-card-exclusive-options)
     -   [Wakatime Card Exclusive Option](#wakatime-card-exclusive-options)
 -   [Deploy Yourself](#deploy-on-your-own-vercel-instance)
+    - [Keep your fork up to date](#keep-your-fork-up-to-date)   
 
 # GitHub Stats Card
 
@@ -440,6 +441,10 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
 
 </details>
 
+### Keep your fork up to date
+
+You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHubs' [Sync Fork button](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork). You can also use the [pull](https://github.com/wei/pull) package created by [@wei](https://github.com/wei) to automate this process.
+
 ## :sparkling_heart: Support the project
 
 I open-source almost everything I can and try to reply to everyone needing help using these projects. Obviously,

scripts/close-stale-theme-prs.js

@@ -9,19 +9,28 @@ import github from "@actions/github";
 import { RequestError } from "@octokit/request-error";
 import { getGithubToken, getRepoInfo } from "./helpers.js";
 
-// Script parameters
 const CLOSING_COMMENT = `
 	\rThis PR has been automatically closed due to inactivity. Please feel free to reopen it if you need to continue working on it.\
 	\rThank you for your contributions.
 `;
+const REVIEWER = "github-actions[bot]";
+
+/**
+ * Retrieve the review user.
+ * @returns {string} review user.
+ */
+const getReviewer = () => {
+  return process.env.REVIEWER ? process.env.REVIEWER : REVIEWER;
+};
 
 /**
  * Fetch open PRs from a given repository.
  * @param user The user name of the repository owner.
  * @param repo The name of the repository.
+ * @param reviewer The reviewer to filter by.
  * @returns The open PRs.
  */
-export const fetchOpenPRs = async (octokit, user, repo) => {
+export const fetchOpenPRs = async (octokit, user, repo, reviewer) => {
   const openPRs = [];
   let hasNextPage = true;
   let endCursor;
@@ -49,9 +58,9 @@ export const fetchOpenPRs = async (octokit, user, repo) => {
 												name
                       }
                     }
-                    reviews(first: 1, states: CHANGES_REQUESTED, author: "github-actions[bot]") {
+                    reviews(first: 100, states: CHANGES_REQUESTED, author: "${reviewer}") {
 											nodes {
-												updatedAt
+                        submittedAt
 											}
                     }
                   }
@@ -99,11 +108,13 @@ const isStale = (pullRequest, staleDays) => {
     pullRequest.commits.nodes[0].commit.pushedDate,
   );
   if (pullRequest.reviews.nodes[0]) {
-    const lastReviewDate = new Date(pullRequest.reviews.nodes[0].updatedAt);
+    const lastReviewDate = new Date(
+      pullRequest.reviews.nodes.sort((a, b) => (a < b ? 1 : -1))[0].submittedAt,
+    );
     const lastUpdateDate =
       lastCommitDate >= lastReviewDate ? lastCommitDate : lastReviewDate;
     const now = new Date();
-    return now - lastUpdateDate > 1000 * 60 * 60 * 24 * staleDays;
+    return (now - lastUpdateDate) / (1000 * 60 * 60 * 24) >= staleDays;
   } else {
     return false;
   }
@@ -116,14 +127,15 @@ const run = async () => {
   try {
     // Create octokit client.
     const dryRun = process.env.DRY_RUN === "true" || false;
-    const staleDays = process.env.STALE_DAYS || 15;
+    const staleDays = process.env.STALE_DAYS || 20;
     debug("Creating octokit client...");
     const octokit = github.getOctokit(getGithubToken());
     const { owner, repo } = getRepoInfo(github.context);
+    const reviewer = getReviewer();
 
     // Retrieve all theme pull requests.
     debug("Retrieving all theme pull requests...");
-    const prs = await fetchOpenPRs(octokit, owner, repo);
+    const prs = await fetchOpenPRs(octokit, owner, repo, reviewer);
     const themePRs = pullsWithLabel(prs, "themes");
     const invalidThemePRs = pullsWithLabel(themePRs, "invalid");
     debug("Retrieving stale theme PRs...");

scripts/helpers.js

@@ -4,7 +4,6 @@
 
 import { getInput } from "@actions/core";
 
-// Script variables.
 const OWNER = "anuraghazra";
 const REPO = "github-readme-stats";
 

scripts/preview-theme.js

@@ -16,7 +16,6 @@ import { isValidHexColor } from "../src/common/utils.js";
 import { themes } from "../themes/index.js";
 import { getGithubToken, getRepoInfo } from "./helpers.js";
 
-// Script variables.
 const COMMENTER = "github-actions[bot]";
 
 const COMMENT_TITLE = "Automated Theme Preview";
@@ -25,7 +24,7 @@ const THEME_PR_SUCCESS_TEXT =
   ":heavy_check_mark: Theme PR does adhere to our guidelines.";
 const FAIL_TEXT = `
   \rUnfortunately, your theme PR contains an error or does not adhere to our [theme guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution). Please fix the issues below, and we will review your\
-  \r PR again. This pull request will **automatically close in 15 days** if no changes are made. After this time, you must re-open the PR for it to be reviewed.
+  \r PR again. This pull request will **automatically close in 20 days** if no changes are made. After this time, you must re-open the PR for it to be reviewed.
 `;
 const THEME_CONTRIB_GUIDELINESS = `
   \rHi, thanks for the theme contribution. Please read our theme [contribution guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution).

src/cards/index.js

@@ -0,0 +1,4 @@
+export { renderRepoCard } from "./repo-card.js";
+export { renderStatsCard } from "./stats-card.js";
+export { renderTopLanguages } from "./top-languages-card.js";
+export { renderWakatimeCard } from "./wakatime-card.js";

src/cards/stats-card.js

@@ -170,6 +170,7 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
     "pl",
     "de",
     "nl",
+    "zh-tw",
   ];
   const isLongLocale = longLocales.includes(locale) === true;
 

src/common/index.js

@@ -0,0 +1,30 @@
+export { blacklist } from "./blacklist.js";
+export { Card } from "./Card.js";
+export { createProgressNode } from "./createProgressNode.js";
+export { I18n } from "./I18n.js";
+export { icons } from "./icons.js";
+export { retryer } from "./retryer.js";
+export {
+  ERROR_CARD_LENGTH,
+  renderError,
+  encodeHTML,
+  kFormatter,
+  isValidHexColor,
+  parseBoolean,
+  parseArray,
+  clampValue,
+  isValidGradient,
+  fallbackColor,
+  request,
+  flexLayout,
+  getCardColors,
+  wrapTextMultiline,
+  logger,
+  CONSTANTS,
+  CustomError,
+  MissingParamError,
+  measureText,
+  lowercaseTrim,
+  chunkArray,
+  parseEmojis,
+} from "./utils.js";

src/common/utils.js

@@ -414,25 +414,26 @@ function parseEmojis(str) {
 }
 
 export {
+  ERROR_CARD_LENGTH,
   renderError,
-  kFormatter,
   encodeHTML,
+  kFormatter,
   isValidHexColor,
-  request,
-  parseArray,
   parseBoolean,
+  parseArray,
+  clampValue,
+  isValidGradient,
   fallbackColor,
+  request,
   flexLayout,
   getCardColors,
-  clampValue,
   wrapTextMultiline,
-  measureText,
   logger,
   CONSTANTS,
   CustomError,
   MissingParamError,
+  measureText,
   lowercaseTrim,
   chunkArray,
   parseEmojis,
-  ERROR_CARD_LENGTH,
 };

src/index.js

@@ -0,0 +1,3 @@
+export * from "./common/index.js";
+export * from "./cards/index.js";
+export { getStyles, getAnimations } from "./getStyles.js";

tests/api.test.js

@@ -184,6 +184,16 @@ describe("Test /api/", () => {
     ]);
   });
 
+  it("should not store cache when error", async () => {
+    const { req, res } = faker({}, error);
+    await api(req, res);
+
+    expect(res.setHeader.mock.calls).toEqual([
+      ["Content-Type", "image/svg+xml"],
+      ["Cache-Control", `no-cache, no-store, must-revalidate`],
+    ]);
+  });
+
   it("should set proper cache with clamped values", async () => {
     {
       let { req, res } = faker({ cache_seconds: 200000 }, data);

tests/e2e/e2e.test.js

@@ -11,7 +11,6 @@ import { renderStatsCard } from "../../src/cards/stats-card.js";
 import { renderTopLanguages } from "../../src/cards/top-languages-card.js";
 import { renderWakatimeCard } from "../../src/cards/wakatime-card.js";
 
-// Script variables
 const REPO = "dummy-cra";
 const USER = "grsdummy";
 const STATS_DATA = {
@@ -26,6 +25,7 @@ const STATS_DATA = {
     score: 51.01013099671447,
   },
 };
+
 const LANGS_DATA = {
   TypeScript: {
     color: "#3178c6",
@@ -48,6 +48,7 @@ const LANGS_DATA = {
     size: 671,
   },
 };
+
 const WAKATIME_DATA = {
   human_readable_range: "last week",
   is_already_updating: false,
@@ -64,6 +65,7 @@ const WAKATIME_DATA = {
   username: "grsdummy",
   writes_only: false,
 };
+
 const REPOSITORY_DATA = {
   name: "dummy-cra",
   nameWithOwner: "grsdummy/dummy-cra",
@@ -82,6 +84,7 @@ const REPOSITORY_DATA = {
   forkCount: 0,
   starCount: 1,
 };
+
 const CACHE_BURST_STRING = `v=${new Date().getTime()}`;
 
 describe("Fetch Cards", () => {
@@ -110,7 +113,7 @@ describe("Fetch Cards", () => {
 
     // Check if stats card from deployment matches the stats card from local.
     expect(serverStatsSvg.data).toEqual(localStatsCardSVG);
-  });
+  }, 7000);
 
   test("retrieve language card", async () => {
     expect(VERCEL_PREVIEW_URL).toBeDefined();

tests/fetchRepo.test.js

@@ -23,6 +23,7 @@ const data_user = {
     organization: null,
   },
 };
+
 const data_org = {
   data: {
     user: null,

tests/renderStatsCard.test.js

@@ -10,17 +10,17 @@ import "@testing-library/jest-dom";
 
 import { themes } from "../themes/index.js";
 
-describe("Test renderStatsCard", () => {
-  const stats = {
-    name: "Anurag Hazra",
-    totalStars: 100,
-    totalCommits: 200,
-    totalIssues: 300,
-    totalPRs: 400,
-    contributedTo: 500,
-    rank: { level: "A+", score: 40 },
-  };
+const stats = {
+  name: "Anurag Hazra",
+  totalStars: 100,
+  totalCommits: 200,
+  totalIssues: 300,
+  totalPRs: 400,
+  contributedTo: 500,
+  rank: { level: "A+", score: 40 },
+};
 
+describe("Test renderStatsCard", () => {
   it("should render correctly", () => {
     document.body.innerHTML = renderStatsCard(stats);