fix: separate logic for markdown vs app page

wackerow · wackerow · commit 8a6cc655fd1d · 2025-05-19T12:40:10.000-07:00
refactor to more precise naming. Create getAppPageLastCommitDate for react page history fetches. Throw error at build if contributor information not available.
diff --git a/app/[locale]/bug-bounty/page.tsx b/app/[locale]/bug-bounty/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang, Params } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
@@ -27,7 +27,7 @@ export default async function Page({ params }: { params: Promise<Params> }) {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo(
+    await getAppPageContributorInfo(
       "bug-bounty",
       locale as Lang,
       commitHistoryCache
diff --git a/app/[locale]/dapps/page.tsx b/app/[locale]/dapps/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang, Params } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
@@ -25,7 +25,7 @@ export default async function Page({ params }: { params: Promise<Params> }) {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo("dapps", locale as Lang, commitHistoryCache)
+    await getAppPageContributorInfo("dapps", locale as Lang, commitHistoryCache)
 
   return (
     <I18nProvider locale={locale} messages={pickedMessages}>
diff --git a/app/[locale]/eth/page.tsx b/app/[locale]/eth/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
@@ -31,7 +31,7 @@ export default async function Page({
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo("eth", locale as Lang, commitHistoryCache)
+    await getAppPageContributorInfo("eth", locale as Lang, commitHistoryCache)
 
   return (
     <I18nProvider locale={locale} messages={pickedMessages}>
diff --git a/app/[locale]/gas/page.tsx b/app/[locale]/gas/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
@@ -27,7 +27,7 @@ const Page = async ({ params }: { params: Promise<{ locale: Lang }> }) => {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo("gas", locale as Lang, commitHistoryCache)
+    await getAppPageContributorInfo("gas", locale as Lang, commitHistoryCache)
 
   return (
     <I18nProvider locale={locale} messages={messages}>
diff --git a/app/[locale]/get-eth/page.tsx b/app/[locale]/get-eth/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getLastModifiedDateByPath } from "@/lib/utils/gh"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
@@ -38,7 +38,11 @@ export default async function Page({
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo("get-eth", locale as Lang, commitHistoryCache)
+    await getAppPageContributorInfo(
+      "get-eth",
+      locale as Lang,
+      commitHistoryCache
+    )
 
   return (
     <I18nProvider locale={locale} messages={pickedMessages}>
diff --git a/app/[locale]/layer-2/learn/page.tsx b/app/[locale]/layer-2/learn/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
@@ -27,7 +27,7 @@ const Page = async ({ params }: { params: Promise<{ locale: Lang }> }) => {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo(
+    await getAppPageContributorInfo(
       "layer-2/learn",
       locale as Lang,
       commitHistoryCache
diff --git a/app/[locale]/learn/page.tsx b/app/[locale]/learn/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang, Params } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
@@ -27,7 +27,7 @@ export default async function Page({ params }: { params: Promise<Params> }) {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo("learn", locale as Lang, commitHistoryCache)
+    await getAppPageContributorInfo("learn", locale as Lang, commitHistoryCache)
 
   return (
     <I18nProvider locale={locale} messages={messages}>
diff --git a/app/[locale]/roadmap/vision/page.tsx b/app/[locale]/roadmap/vision/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
@@ -27,7 +27,7 @@ const Page = async ({ params }: { params: Promise<{ locale: Lang }> }) => {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo(
+    await getAppPageContributorInfo(
       "roadmap/vision",
       locale as Lang,
       commitHistoryCache
diff --git a/app/[locale]/run-a-node/page.tsx b/app/[locale]/run-a-node/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
@@ -27,7 +27,7 @@ const Page = async ({ params }: { params: Promise<{ locale: Lang }> }) => {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo(
+    await getAppPageContributorInfo(
       "run-a-node",
       locale as Lang,
       commitHistoryCache
diff --git a/app/[locale]/staking/page.tsx b/app/[locale]/staking/page.tsx
@@ -15,7 +15,7 @@ import {
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { dataLoader } from "@/lib/utils/data/dataLoader"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
@@ -75,7 +75,11 @@ const Page = async ({ params }: { params: Promise<{ locale: Lang }> }) => {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo("staking", locale as Lang, commitHistoryCache)
+    await getAppPageContributorInfo(
+      "staking",
+      locale as Lang,
+      commitHistoryCache
+    )
 
   return (
     <I18nProvider locale={locale} messages={messages}>
diff --git a/app/[locale]/wallets/page.tsx b/app/[locale]/wallets/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
@@ -27,7 +27,11 @@ const Page = async ({ params }: { params: Promise<{ locale: Lang }> }) => {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo("wallets", locale as Lang, commitHistoryCache)
+    await getAppPageContributorInfo(
+      "wallets",
+      locale as Lang,
+      commitHistoryCache
+    )
 
   return (
     <I18nProvider locale={locale} messages={messages}>
diff --git a/app/[locale]/what-is-ethereum/page.tsx b/app/[locale]/what-is-ethereum/page.tsx
@@ -9,7 +9,7 @@ import type { CommitHistory, Lang } from "@/lib/types"
 
 import I18nProvider from "@/components/I18nProvider"
 
-import { getPageContributorInfo } from "@/lib/utils/contributors"
+import { getAppPageContributorInfo } from "@/lib/utils/contributors"
 import { dataLoader } from "@/lib/utils/data/dataLoader"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
@@ -32,7 +32,7 @@ const Page = async ({ params }: { params: Promise<{ locale: Lang }> }) => {
 
   const commitHistoryCache: CommitHistory = {}
   const { contributors, lastEditLocaleTimestamp } =
-    await getPageContributorInfo(
+    await getAppPageContributorInfo(
       "what-is-ethereum",
       locale as Lang,
       commitHistoryCache
diff --git a/src/lib/api/fetchGitHistory.ts b/src/lib/api/fetchGitHistory.ts
@@ -46,7 +46,7 @@ async function fetchWithRateLimit(filepath: string): Promise<Commit[]> {
 }
 
 // Fetch commit history and save it to a JSON file
-export const fetchAndCacheGitContributors = async (
+export const fetchAndCacheGitHubContributors = async (
   filepath: string,
   cache: CommitHistory
 ) => {
diff --git a/src/lib/md/data.ts b/src/lib/md/data.ts
@@ -9,7 +9,7 @@ import {
   ToCItem,
 } from "@/lib/types"
 
-import { getFileContributorInfo } from "@/lib/utils/contributors"
+import { getMarkdownFileContributorInfo } from "@/lib/utils/contributors"
 import { getLocaleTimestamp } from "@/lib/utils/time"
 
 import { compile } from "./compile"
@@ -59,12 +59,13 @@ export async function getPageData({
       : tocNodeItems
 
   // Get contributor information
-  const { contributors, lastUpdatedDate } = await getFileContributorInfo(
-    slug,
-    locale,
-    frontmatter.lang as string,
-    commitHistoryCache
-  )
+  const { contributors, lastUpdatedDate } =
+    await getMarkdownFileContributorInfo(
+      slug,
+      locale,
+      frontmatter.lang as string,
+      commitHistoryCache
+    )
 
   // Format timestamp
   const lastEditLocaleTimestamp = getLocaleTimestamp(
diff --git a/src/lib/utils/contributors.ts b/src/lib/utils/contributors.ts
@@ -8,12 +8,12 @@ import {
   convertToFileContributorFromCrowdin,
   getCrowdinContributors,
 } from "./crowdin"
-import { getLastModifiedDate } from "./gh"
+import { getAppPageLastCommitDate, getMarkdownLastCommitDate } from "./gh"
 import { getLocaleTimestamp } from "./time"
 
-import { fetchAndCacheGitContributors } from "@/lib/api/fetchGitHistory"
+import { fetchAndCacheGitHubContributors } from "@/lib/api/fetchGitHistory"
 
-export const getFileContributorInfo = async (
+export const getMarkdownFileContributorInfo = async (
   slug: string,
   locale: string,
   fileLang: string,
@@ -22,25 +22,25 @@ export const getFileContributorInfo = async (
   const mdPath = join(CONTENT_PATH, slug)
   const mdDir = join(CONTENT_DIR, slug)
 
-  const gitContributors = await fetchAndCacheGitContributors(
+  const gitHubContributors = await fetchAndCacheGitHubContributors(
     join("/", mdDir, "index.md"),
     cache
   )
 
-  const latestCommitDate = getLastModifiedDate(slug, locale!, true)
-  const gitHubLastEdit = gitContributors[0]?.date
+  const latestCommitDate = getMarkdownLastCommitDate(slug, locale!)
+  const gitHubLastEdit = gitHubContributors[0]?.date
   const lastUpdatedDate = gitHubLastEdit || latestCommitDate
 
   const crowdinContributors = convertToFileContributorFromCrowdin(
     getCrowdinContributors(mdPath, locale as Lang)
   )
 
-  const useGitHubContributors: boolean =
+  const englishOnly: boolean =
     fileLang === DEFAULT_LOCALE || crowdinContributors.length === 0
 
-  const contributors: FileContributor[] = useGitHubContributors
-    ? gitContributors
-    : [...crowdinContributors, ...gitContributors]
+  const contributors: FileContributor[] = englishOnly
+    ? gitHubContributors
+    : [...crowdinContributors, ...gitHubContributors]
 
   return { contributors, lastUpdatedDate }
 }
@@ -69,33 +69,34 @@ const getAllHistoricalPaths = (pagePath: string): string[] => [
   join("app/[locale]", pagePath, "_components", `${pagePath}.tsx`),
 ]
 
-export const getPageContributorInfo = async (
+export const getAppPageContributorInfo = async (
   pagePath: string,
   locale: Lang,
   cache: CommitHistory
 ) => {
-  const gitContributors = await getAllHistoricalPaths(pagePath).reduce(
+  // TODO: Incorporate Crowdin contributor information
+
+  const gitHubContributors = await getAllHistoricalPaths(pagePath).reduce(
     async (acc, path) => {
-      const contributors = await fetchAndCacheGitContributors(path, cache)
+      const contributors = await fetchAndCacheGitHubContributors(path, cache)
       return [...(await acc), ...contributors]
     },
     Promise.resolve([] as FileContributor[])
   )
 
-  const uniqueGitContributors = gitContributors.filter(
+  const uniqueGitHubContributors = gitHubContributors.filter(
     (contributor, index, self) =>
       index === self.findIndex((t) => t.login === contributor.login)
   )
 
-  const latestCommitDate = getLastModifiedDate(pagePath, locale!)
-  const gitHubLastEdit = uniqueGitContributors[0]?.date
+  const latestCommitDate = getAppPageLastCommitDate(pagePath)
+  const lastEditLocaleTimestamp = getLocaleTimestamp(locale, latestCommitDate)
 
-  let lastEditLocaleTimestamp = ""
-  if (latestCommitDate) {
-    lastEditLocaleTimestamp = getLocaleTimestamp(locale, latestCommitDate)
-  } else if (gitHubLastEdit) {
-    lastEditLocaleTimestamp = getLocaleTimestamp(locale, gitHubLastEdit)
+  if (!uniqueGitHubContributors.length || !lastEditLocaleTimestamp) {
+    throw new Error(
+      `No contributors found, path: ${pagePath}, locale: ${locale}`
+    )
   }
 
-  return { contributors: uniqueGitContributors, lastEditLocaleTimestamp }
+  return { contributors: uniqueGitHubContributors, lastEditLocaleTimestamp }
 }
diff --git a/src/lib/utils/gh.ts b/src/lib/utils/gh.ts
