Add buildGetStaticProps utility function to be more DRY (#564)

* Add `buildGetStaticProps` utility function to be more DRY (WIP) * extract getStaticPropsForSupportedNetworks polish * Update dependencies --------- Co-authored-by: Dimitri POSTOLOV <dmytropostolov@gmail.com>
graphprotocol · Dec 21, 2023 · 386283e · 386283e
1 parent 24d1f7c
commit 386283e
Show file tree

Hide file tree

Showing 36 changed files with 1,455 additions and 1,942 deletions.
diff --git a/package.json b/package.json
@@ -22,7 +22,7 @@
   },
   "devDependencies": {
     "@edgeandnode/eslint-config": "^2.0.3",
-    "eslint": "^8.55.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-mdx": "^2.2.0",
     "husky": "^8.0.3",
     "lint-staged": "^15.2.0",

diff --git a/packages/nextra-theme/package.json b/packages/nextra-theme/package.json
@@ -25,8 +25,8 @@
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
-    "@edgeandnode/gds": "3.0.0-global-header-1701913779061-6ea902d",
-    "@edgeandnode/go": "4.0.0-global-header-1701913779061-6ea902d",
+    "@edgeandnode/gds": "3.0.0-global-header-1703167287784-4d7f05b34403f749b2baf2c11af2882b2acb4b11",
+    "@edgeandnode/go": "4.0.0-global-header-1703167287784-4d7f05b34403f749b2baf2c11af2882b2acb4b11",
     "@emotion/react": "^11.11",
     "next": "^13",
     "next-seo": "^6",
@@ -43,12 +43,12 @@
     "react-use": "^17.4.2"
   },
   "devDependencies": {
-    "@edgeandnode/gds": "3.0.0-global-header-1701913779061-6ea902d",
-    "@edgeandnode/go": "4.0.0-global-header-1701913779061-6ea902d",
+    "@edgeandnode/gds": "3.0.0-global-header-1703167287784-4d7f05b34403f749b2baf2c11af2882b2acb4b11",
+    "@edgeandnode/go": "4.0.0-global-header-1703167287784-4d7f05b34403f749b2baf2c11af2882b2acb4b11",
     "@emotion/react": "^11.11.1",
     "@types/lodash": "^4.14.202",
-    "@types/react": "^18.2.44",
-    "@types/react-dom": "^18.2.17",
+    "@types/react": "^18.2.45",
+    "@types/react-dom": "^18.2.18",
     "next": "^14.0.4",
     "next-seo": "^6.4.0",
     "nextra": "^2.13.2",

diff --git a/packages/og-image/package.json b/packages/og-image/package.json
@@ -16,12 +16,12 @@
     "yoga-wasm-web": "0.3.3"
   },
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20231121.0",
-    "@types/react": "^18.2.44",
+    "@cloudflare/workers-types": "^4.20231218.0",
+    "@types/react": "^18.2.45",
     "jest-image-snapshot": "^6.4.0",
-    "tsx": "^4.6.2",
+    "tsx": "^4.7.0",
     "typescript": "^5.3.3",
     "vitest": "^0.34.6",
-    "wrangler": "^3.20.0"
+    "wrangler": "^3.22.1"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/website/next.config.js b/website/next.config.js
@@ -1,7 +1,6 @@
 import nextra from 'nextra'
 
-// If you need to make a commit just to force a redeploy when creating a new release, increase this
-const _forceRedeploy = 1
+import { defaultLocale, extractLocaleFromPath } from '@edgeandnode/gds'
 
 const env = {
   ENVIRONMENT: process.env.ENVIRONMENT,
@@ -23,16 +22,21 @@ const withNextra = nextra({
   codeHighlight: false,
   defaultShowCopyCode: false,
   transform(result, { route }) {
-    if (route && !result.includes('getStaticProps')) {
-      const banner = `
-import { getPageMap } from '@/src/getPageMap'
+    if (!route) return result
 
-export const getStaticProps = async context => ({
-  props: {
-    __nextra_pageMap: await getPageMap('${route.split('/')[1]}')
-  }
-})`
-      result += banner
+    const { locale } = extractLocaleFromPath(route)
+
+    result = `
+      globalThis.__graph_docs_locale = '${locale ?? defaultLocale}'
+      ${result}
+    `
+
+    if (!result.includes('getStaticProps')) {
+      result = `
+        import { buildGetStaticProps } from '@/src/buildGetStaticProps'
+        ${result}
+        export const getStaticProps = buildGetStaticProps()
+      `
     }
 
     return result

diff --git a/website/package.json b/website/package.json
@@ -13,9 +13,9 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@edgeandnode/common": "^5.28.1",
-    "@edgeandnode/gds": "3.0.0-global-header-1701913779061-6ea902d",
-    "@edgeandnode/go": "4.0.0-global-header-1701913779061-6ea902d",
+    "@edgeandnode/common": "^5.29.1",
+    "@edgeandnode/gds": "3.0.0-global-header-1703167287784-4d7f05b34403f749b2baf2c11af2882b2acb4b11",
+    "@edgeandnode/go": "4.0.0-global-header-1703167287784-4d7f05b34403f749b2baf2c11af2882b2acb4b11",
     "@emotion/react": "^11.11.1",
     "@graphprotocol/nextra-theme": "workspace:*",
     "mixpanel-browser": "^2.48.1",
@@ -32,11 +32,11 @@
     "@graphprotocol/client-cli": "^3.0.0",
     "@types/mdast": "^4.0.3",
     "@types/mixpanel-browser": "^2.47.5",
-    "@types/react": "^18.2.44",
-    "@types/react-dom": "^18.2.17",
+    "@types/react": "^18.2.45",
+    "@types/react-dom": "^18.2.18",
     "fast-xml-parser": "^4.3.2",
     "graphql": "^16.8.1",
-    "tsx": "^4.6.2",
+    "tsx": "^4.7.0",
     "unified": "^11.0.4"
   },
   "nextBundleAnalysis": {

diff --git a/website/pages/[locale]/index.mdx b/website/pages/[locale]/index.mdx
@@ -17,6 +17,8 @@ export const getStaticPaths = () => {
   }
 }
 
+{/* Only in dynamic route we can't use `buildGetStaticProps` function, because route is based on filename of mdx page */}
+
 export const getStaticProps = async ({ params: { locale } }) => {
   const t = key => translate(translations, locale, key)
   const rawMdx = `---

diff --git a/website/pages/ar/developing/supported-networks.mdx b/website/pages/ar/developing/supported-networks.mdx
@@ -2,21 +2,10 @@
 title: الشبكات المدعومة
 ---
 
-import { getPageMap } from '@/src/getPageMap'
-import { getSupportedNetworks, SupportedNetworksTable } from '@/src/supportedNetworks'
-
-export const getStaticProps = async () => {
-  return {
-    props: {
-      __nextra_pageMap: await getPageMap('ar'),
-      ssg: {
-        networks: await getSupportedNetworks(),
-      },
-    },
-  }
-}
-
-<SupportedNetworksTable />
+export { getStaticPropsForSupportedNetworks as getStaticProps } from '@/src/buildGetStaticProps'
+import { SupportedNetworksTable } from '@/src/supportedNetworks'
+
+<SupportedNetworksTable networks={props.networks} />
 
 The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.
 

diff --git a/website/pages/cs/developing/supported-networks.mdx b/website/pages/cs/developing/supported-networks.mdx
@@ -2,21 +2,10 @@
 title: Supported Networks
 ---
 
-import { getPageMap } from '@/src/getPageMap'
-import { getSupportedNetworks, SupportedNetworksTable } from '@/src/supportedNetworks'
-
-export const getStaticProps = async () => {
-  return {
-    props: {
-      __nextra_pageMap: await getPageMap('cs'),
-      ssg: {
-        networks: await getSupportedNetworks(),
-      },
-    },
-  }
-}
-
-<SupportedNetworksTable />
+export { getStaticPropsForSupportedNetworks as getStaticProps } from '@/src/buildGetStaticProps'
+import { SupportedNetworksTable } from '@/src/supportedNetworks'
+
+<SupportedNetworksTable networks={props.networks} />
 
 The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.
 

diff --git a/website/pages/de/developing/supported-networks.mdx b/website/pages/de/developing/supported-networks.mdx
@@ -2,21 +2,10 @@
 title: Supported Networks
 ---
 
-import { getPageMap } from '@/src/getPageMap'
-import { getSupportedNetworks, SupportedNetworksTable } from '@/src/supportedNetworks'
-
-export const getStaticProps = async () => {
-  return {
-    props: {
-      __nextra_pageMap: await getPageMap('de'),
-      ssg: {
-        networks: await getSupportedNetworks(),
-      },
-    },
-  }
-}
-
-<SupportedNetworksTable />
+export { getStaticPropsForSupportedNetworks as getStaticProps } from '@/src/buildGetStaticProps'
+import { SupportedNetworksTable } from '@/src/supportedNetworks'
+
+<SupportedNetworksTable networks={props.networks} />
 
 The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.
 

diff --git a/website/pages/en/developing/graph-ts/[[...slug]].mdx b/website/pages/en/developing/graph-ts/[[...slug]].mdx
@@ -15,6 +15,8 @@ export const getStaticPaths = () => ({
   })),
 })
 
+{/* Only in dynamic route we can't use `buildGetStaticProps` function, because route is based on filename of mdx page */}
+
 export async function getStaticProps({ params }) {
   const { filePaths, user, repo, branch, docsPath } = json
   const paths = params?.slug?.join('/')

diff --git a/website/pages/en/developing/supported-networks.mdx b/website/pages/en/developing/supported-networks.mdx
@@ -2,21 +2,10 @@
 title: Supported Networks
 ---
 
-import { getPageMap } from '@/src/getPageMap'
-import { getSupportedNetworks, SupportedNetworksTable } from '@/src/supportedNetworks'
-
-export const getStaticProps = async () => {
-  return {
-    props: {
-      __nextra_pageMap: await getPageMap('en'),
-      ssg: {
-        networks: await getSupportedNetworks(),
-      },
-    },
-  }
-}
-
-<SupportedNetworksTable />
+export { getStaticPropsForSupportedNetworks as getStaticProps } from '@/src/buildGetStaticProps'
+import { SupportedNetworksTable } from '@/src/supportedNetworks'
+
+<SupportedNetworksTable networks={props.networks} />
 
 The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.
 

diff --git a/website/pages/en/querying/graph-client/[[...slug]].mdx b/website/pages/en/querying/graph-client/[[...slug]].mdx
@@ -15,6 +15,8 @@ export const getStaticPaths = () => ({
   })),
 })
 
+{/* Only in dynamic route we can't use `buildGetStaticProps` function, because route is based on filename of mdx page */}
+
 export async function getStaticProps({ params }) {
   const { filePaths, user, repo, branch, docsPath } = json
   const paths = params?.slug?.join('/')

diff --git a/website/pages/es/developing/supported-networks.mdx b/website/pages/es/developing/supported-networks.mdx
@@ -2,21 +2,10 @@
 title: Redes admitidas
 ---
 
-import { getPageMap } from '@/src/getPageMap'
-import { getSupportedNetworks, SupportedNetworksTable } from '@/src/supportedNetworks'
-
-export const getStaticProps = async () => {
-  return {
-    props: {
-      __nextra_pageMap: await getPageMap('es'),
-      ssg: {
-        networks: await getSupportedNetworks(),
-      },
-    },
-  }
-}
-
-<SupportedNetworksTable />
+export { getStaticPropsForSupportedNetworks as getStaticProps } from '@/src/buildGetStaticProps'
+import { SupportedNetworksTable } from '@/src/supportedNetworks'
+
+<SupportedNetworksTable networks={props.networks} />
 
 The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.
 

diff --git a/website/pages/fr/developing/supported-networks.mdx b/website/pages/fr/developing/supported-networks.mdx
@@ -2,21 +2,10 @@
 title: Réseaux pris en charge
 ---
 
-import { getPageMap } from '@/src/getPageMap'
-import { getSupportedNetworks, SupportedNetworksTable } from '@/src/supportedNetworks'
-
-export const getStaticProps = async () => {
-  return {
-    props: {
-      __nextra_pageMap: await getPageMap('fr'),
-      ssg: {
-        networks: await getSupportedNetworks(),
-      },
-    },
-  }
-}
-
-<SupportedNetworksTable />
+export { getStaticPropsForSupportedNetworks as getStaticProps } from '@/src/buildGetStaticProps'
+import { SupportedNetworksTable } from '@/src/supportedNetworks'
+
+<SupportedNetworksTable networks={props.networks} />
 
 The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.
 

diff --git a/website/pages/ha/developing/supported-networks.mdx b/website/pages/ha/developing/supported-networks.mdx
@@ -2,21 +2,10 @@
 title: Supported Networks
 ---
 
-import { getPageMap } from '@/src/getPageMap'
-import { getSupportedNetworks, SupportedNetworksTable } from '@/src/supportedNetworks'
-
-export const getStaticProps = async () => {
-  return {
-    props: {
-      __nextra_pageMap: await getPageMap('ha'),
-      ssg: {
-        networks: await getSupportedNetworks(),
-      },
-    },
-  }
-}
-
-<SupportedNetworksTable />
+export { getStaticPropsForSupportedNetworks as getStaticProps } from '@/src/buildGetStaticProps'
+import { SupportedNetworksTable } from '@/src/supportedNetworks'
+
+<SupportedNetworksTable networks={props.networks} />
 
 The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.
 

diff --git a/website/pages/hi/developing/supported-networks.mdx b/website/pages/hi/developing/supported-networks.mdx
@@ -2,21 +2,10 @@
 title: समर्थित नेटवर्क्स
 ---
 
-import { getPageMap } from '@/src/getPageMap'
-import { getSupportedNetworks, SupportedNetworksTable } from '@/src/supportedNetworks'
-
-export const getStaticProps = async () => {
-  return {
-    props: {
-      __nextra_pageMap: await getPageMap('hi'),
-      ssg: {
-        networks: await getSupportedNetworks(),
-      },
-    },
-  }
-}
-
-<SupportedNetworksTable />
+export { getStaticPropsForSupportedNetworks as getStaticProps } from '@/src/buildGetStaticProps'
+import { SupportedNetworksTable } from '@/src/supportedNetworks'
+
+<SupportedNetworksTable networks={props.networks} />
 
 The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.
 

diff --git a/website/pages/it/developing/supported-networks.mdx b/website/pages/it/developing/supported-networks.mdx
@@ -2,21 +2,10 @@
 title: Supported Networks
 ---
 
-import { getPageMap } from '@/src/getPageMap'
-import { getSupportedNetworks, SupportedNetworksTable } from '@/src/supportedNetworks'
-
-export const getStaticProps = async () => {
-  return {
-    props: {
-      __nextra_pageMap: await getPageMap('it'),
-      ssg: {
-        networks: await getSupportedNetworks(),
-      },
-    },
-  }
-}
-
-<SupportedNetworksTable />
+export { getStaticPropsForSupportedNetworks as getStaticProps } from '@/src/buildGetStaticProps'
+import { SupportedNetworksTable } from '@/src/supportedNetworks'
+
+<SupportedNetworksTable networks={props.networks} />
 
 The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.