refactor: use memory for caching

Author: wackerow

.gitignore

@@ -55,5 +55,3 @@ robots.txt
 
 # Crowdin report output
 src/data/crowdin/bucketsAwaitingReviewReport.csv
-
-src/data/git-contributor-cache.json

package.json

@@ -3,10 +3,9 @@
   "version": "8.5.2",
   "private": true,
   "scripts": {
-    "dev": "yarn && next dev",
-    "postinstall": "yarn theme && yarn rm-contributor-cache",
-    "build": "yarn && next build",
-    "rm-contributor-cache": "touch ./src/data/git-contributor-cache.json && rm ./src/data/git-contributor-cache.json",
+    "dev": "next dev",
+    "postinstall": "yarn theme",
+    "build": "next build",
     "postbuild": "next-sitemap",
     "start": "next start",
     "lint": "next lint",

src/lib/api/fetchGitHistory.ts

@@ -1,11 +1,7 @@
-import fs from "fs"
-import { join } from "path"
-
-import type { FileContributor } from "@/lib/types"
+import type { CommitHistory, FileContributor } from "@/lib/types"
 
 import {
   CONTENT_DIR,
-  GIT_CONTRIBUTOR_CACHE_JSON,
   GITHUB_COMMITS_URL,
   OLD_CONTENT_DIR,
 } from "@/lib/constants"
@@ -49,26 +45,12 @@ async function fetchWithRateLimit(
 }
 
 // Fetch commit history and save it to a JSON file
-export const fetchAndCacheGitContributors = async (mdDir: string) => {
-  const filepath = join("/", mdDir, "index.md")
-
-  // Load cache
-  let commitHistory = {}
-  if (fs.existsSync(GIT_CONTRIBUTOR_CACHE_JSON)) {
-    try {
-      commitHistory = JSON.parse(
-        fs.readFileSync(GIT_CONTRIBUTOR_CACHE_JSON, "utf8")
-      )
-    } catch (error) {
-      console.error(
-        `Error reading commit history cache for filepath ${filepath}`,
-        error
-      )
-    }
-  }
-
+export const fetchAndCacheGitContributors = async (
+  filepath: string,
+  cache: CommitHistory
+) => {
   // First, check cache for existing commit history for English version (despite locale)
-  if (commitHistory[filepath]) return commitHistory[filepath]
+  if (cache[filepath]) return cache[filepath]
 
   // Fetch and save commit history for file
   const history = (await fetchWithRateLimit(filepath)) || []
@@ -92,12 +74,8 @@ export const fetchAndCacheGitContributors = async (mdDir: string) => {
       index === self.findIndex((t) => t.login === contributor.login)
   )
 
-  // Amend to commitHistory log and save
-  commitHistory[filepath] = uniqueContributors
-  fs.writeFileSync(
-    GIT_CONTRIBUTOR_CACHE_JSON,
-    JSON.stringify(commitHistory, null, 2)
-  )
+  // Amend to cache
+  cache[filepath] = uniqueContributors
 
   return uniqueContributors
 }

src/lib/constants.ts

@@ -149,5 +149,3 @@ export const DEFAULT_GLOSSARY_NS = "glossary"
 export const HAMBURGER_BUTTON_ID = "mobile-menu-button"
 export const MOBILE_LANGUAGE_BUTTON_NAME = "mobile-language-button"
 export const DESKTOP_LANGUAGE_BUTTON_NAME = "desktop-language-button"
-
-export const GIT_CONTRIBUTOR_CACHE_JSON = "src/data/git-contributor-cache.json"

src/lib/types.ts

@@ -377,6 +377,9 @@ export type FileContributor = {
   date: string
 }
 
+type FilePath = string
+export type CommitHistory = Record<FilePath, FileContributor[]>
+
 /**
  * Table of contents
  */

src/pages/[...slug].tsx

@@ -16,6 +16,7 @@ import readingTime from "reading-time"
 import remarkGfm from "remark-gfm"
 
 import type {
+  CommitHistory,
   Lang,
   Layout,
   LayoutMappingType,
@@ -115,6 +116,8 @@ const gfIssuesDataFetch = runOnlyOnce(async () => {
   return await fetchGFIs()
 })
 
+const commitHistoryCache: CommitHistory = {}
+
 export const getStaticProps = (async (context) => {
   const params = context.params!
   const { locale } = context
@@ -181,7 +184,10 @@ export const getStaticProps = (async (context) => {
 
   const gfissues = await gfIssuesDataFetch()
 
-  const gitContributors = await fetchAndCacheGitContributors(mdDir)
+  const gitContributors = await fetchAndCacheGitContributors(
+    join("/", mdDir, "index.md"),
+    commitHistoryCache
+  )
 
   return {
     props: {