Update enabled apps to use openapi version (#32327)

Co-authored-by: Rachael Sewell <[email protected]>

Author: gracepark

lib/rest/index.js

@@ -65,13 +65,6 @@ export default async function getRest(version, category, subCategory) {
   }
 }
 
-function getDocsVersion(openApiVersion) {
-  const version = Object.values(allVersions).find(
-    (version) => version.openApiVersionName === openApiVersion
-  ).version
-  return version
-}
-
 function getOpenApiVersion(version) {
   if (!(version in allVersions)) {
     throw new Error(`Unrecognized version '${version}'. Not found in ${Object.keys(allVersions)}`)
@@ -104,14 +97,16 @@ export async function getRestMiniTocItems(
   return restOperationData.get(language).get(version).get(category).get(subCategory)
 }
 
-export async function getEnabledForApps() {
-  // The `readCompressedJsonFileFallback()` function
-  // will check for both a .br and .json extension.
-  const appsData = readCompressedJsonFileFallback(ENABLED_APPS_FILENAME)
-  for (const version in appsData) {
-    const docsVersion = getDocsVersion(version)
-    appsData[docsVersion] = appsData[version]
-    delete appsData[version]
+const enabledForApps = {}
+export async function getEnabledForApps(docsVersion) {
+  if (Object.keys(enabledForApps).length === 0) {
+    // The `readCompressedJsonFileFallback()` function
+    // will check for both a .br and .json extension.
+    Object.assign(enabledForApps, readCompressedJsonFileFallback(ENABLED_APPS_FILENAME))
+
+    // One off edge case where secret-scanning should be removed from FPT. Docs Content #6637
+    delete enabledForApps['api.github.com']['secret-scanning']
   }
-  return appsData
+  const openApiVersion = getOpenApiVersion(docsVersion)
+  return enabledForApps[openApiVersion]
 }

pages/[versionId]/rest/overview/endpoints-available-for-github-apps.tsx

@@ -23,12 +23,6 @@ type EnabledAppCategoryT = {
   [category: string]: OperationT[]
 }
 
-type AppDataT = {
-  [version: string]: EnabledAppCategoryT
-}
-
-let enabledForApps: AppDataT | null = null
-
 type Props = {
   mainContext: MainContextT
   currentVersion: string
@@ -91,25 +85,17 @@ export default function Category({
 export const getServerSideProps: GetServerSideProps<Props> = async (context) => {
   const req = context.req as object
   const res = context.res as object
-  const currentVersion = context.query.versionId as string
   const mainContext = await getMainContext(req, res)
   const automatedPageContext = getAutomatedPageContextFromRequest(req)
+  const currentVersion = context.query.versionId as string
 
-  if (!enabledForApps) {
-    enabledForApps = (await getEnabledForApps()) as AppDataT
-  }
-
-  // One off edge case where secret-scanning should be removed from FPT. Docs Content #6637
-  const noSecretScanning = { ...enabledForApps[currentVersion] }
-  delete noSecretScanning['secret-scanning']
-  const overrideEnabledForApps =
-    currentVersion === 'free-pro-team@latest' ? noSecretScanning : enabledForApps[currentVersion]
+  const enabledForApps = await getEnabledForApps(currentVersion)
 
   return {
     props: {
       mainContext,
       currentVersion,
-      enabledForApps: overrideEnabledForApps,
+      enabledForApps,
       automatedPageContext,
       categoriesWithoutSubcategories,
     },

tests/rendering/rest.js

@@ -28,18 +28,12 @@ describe('REST references docs', () => {
   // and ensures that all sections in the openapi schema
   // are present in the page.
   test('loads operations enabled for GitHub Apps', async () => {
-    const enabledForApps = await getEnabledForApps()
-
     for (const version in allVersions) {
+      const enabledForApps = await getEnabledForApps(version)
       const schemaSlugs = []
-      // One off edge case where secret-scanning should be removed from FPT. Docs Content #6637
-      const noSecretScanning = { ...enabledForApps[version] }
-      delete noSecretScanning['secret-scanning']
-      const overrideEnabledForApps =
-        version === 'free-pro-team@latest' ? noSecretScanning : enabledForApps[version]
 
       // using the static file, generate the expected slug for each operation
-      for (const [key, value] of Object.entries(overrideEnabledForApps)) {
+      for (const [key, value] of Object.entries(enabledForApps)) {
         schemaSlugs.push(
           ...value.map(
             (item) =>