Fix/redoc snooty

extensions/redoc/netlify.toml

@@ -1,9 +1,6 @@
 [build]
-command="pnpm build"
-publish=".ntli/site/static"
-
-[functions]
-directory = "src/endpoints"
+command = "pnpm build"
+publish = ".ntli/site/static"
 
 [dev]
 command = "netlify-extension dev"

extensions/redoc/package.json

@@ -10,7 +10,7 @@
   "dependencies": {
     "@netlify/netlify-plugin-netlify-extension": "^1.0.3",
     "@netlify/sdk": "^2.7.1",
-    "bson": "^6.8.0",
+    "bson": "^4.6.3",
     "mongodb": "^6.8.0",
     "node-fetch": "^3.3.2",
     "typescript": "^5.5.3"

extensions/redoc/src/build-pages.ts → extensions/redoc/src/buildPages.ts

@@ -1,5 +1,5 @@
 import type { NetlifyPluginUtils } from '@netlify/build';
-import type { OASPageMetadata } from '.';
+import type { OASPageMetadata } from './runRedoc';
 import { getAtlasSpecUrl } from './atlas';
 import { db } from './utils/db';
 import { writeFileAsync } from './utils/fs-async';
@@ -36,6 +36,7 @@ interface GetOASpecParams {
   resourceVersions?: string[];
   apiVersion?: string;
   resourceVersion?: string;
+  contentRepoName?: string;
 }
 
 export async function getBuildOasSpecCommand({
@@ -45,17 +46,17 @@ export async function getBuildOasSpecCommand({
   output,
   siteUrl,
   siteTitle,
+  contentRepoName,
   apiVersion,
   resourceVersion,
 }: GetOASpecParams) {
   try {
     let spec = '';
     let isSuccessfulBuild = true;
-
     if (sourceType === 'url') {
       spec = source;
     } else if (sourceType === 'local') {
-      const localFilePath = `source${source}`;
+      const localFilePath = `${contentRepoName ? `${contentRepoName}/` : ''}source${source}`;
       spec = localFilePath;
     } else if (sourceType === 'atlas') {
       const { oasFileURL, successfulGitHash } = await getAtlasSpecUrl({
@@ -176,7 +177,10 @@ export async function buildOpenAPIPages(
   entries: [string, OASPageMetadata][],
   { siteUrl, siteTitle }: PageBuilderOptions,
   run: NetlifyPluginUtils['run'],
+  contentRepoName?: string,
 ) {
+  const output = `${process.cwd()}${contentRepoName ? '' : '/snooty'}/public`;
+
   for (const [pageSlug, data] of entries) {
     const {
       source_type: sourceType,
@@ -186,7 +190,6 @@ export async function buildOpenAPIPages(
     } = data;
 
     let isSuccessfulBuild = true;
-
     if (resourceVersions) {
       const isRunSuccessfulArray = await Promise.all(
         resourceVersions.map(async (resourceVersion) => {
@@ -196,13 +199,14 @@ export async function buildOpenAPIPages(
             const command = await getBuildOasSpecCommand({
               source,
               sourceType,
-              output: `${process.cwd()}/snooty/public`,
+              output,
               pageSlug,
               siteUrl,
               siteTitle,
               apiVersion,
               resourceVersions,
               resourceVersion,
+              contentRepoName,
             });
 
             await run.command(command);
@@ -224,11 +228,12 @@ export async function buildOpenAPIPages(
       const command = await getBuildOasSpecCommand({
         source,
         sourceType,
-        output: `${process.cwd()}/snooty/public`,
+        output,
         pageSlug,
         siteUrl,
         siteTitle,
         apiVersion,
+        contentRepoName,
       });
       await run.command(command);
 

extensions/redoc/src/cloneRedoc.ts

@@ -0,0 +1,46 @@
+import type { NetlifyPluginUtils } from '@netlify/build';
+import { deserialize, type Document } from 'bson';
+import { readFileAsync } from './utils/fs-async';
+const BUNDLE_PATH = `${process.cwd()}/bundle`;
+const REDOC_CLI_VERSION = '1.2.3';
+
+export const hasOpenAPIPages = async (
+  run: NetlifyPluginUtils['run'],
+): Promise<false | Document> => {
+  await run.command('unzip -o -q bundle.zip -d bundle');
+
+  const siteBson = await readFileAsync(`${BUNDLE_PATH}/site.bson`);
+  const buildMetadata = deserialize(siteBson);
+
+  if (!buildMetadata.openapi_pages) {
+    console.log('No OpenAPI pages found');
+    return false;
+  }
+  console.log('OpenAPI pages found');
+  return buildMetadata;
+};
+
+export const cloneRedoc = async (
+  run: NetlifyPluginUtils['run'],
+  cache: NetlifyPluginUtils['cache'],
+) => {
+  const hasRedoc = await cache.has('redoc');
+
+  if (hasRedoc) {
+    console.log('Restoring redoc from cache');
+    cache.restore('redoc');
+    return;
+  }
+
+  console.log('Cloning redoc');
+
+  await run.command(
+    `git clone -b @dop/redoc-cli@${REDOC_CLI_VERSION} --depth 1 https://github.com/mongodb-forks/redoc.git redoc`,
+  );
+
+  await run.command('npm ci --prefix cli/ --omit=dev', {
+    cwd: `${process.cwd()}/redoc`,
+  });
+
+  await cache.save('redoc');
+};

extensions/redoc/src/index.ts

@@ -1,85 +1,18 @@
-import { deserialize } from 'bson';
-import { buildOpenAPIPages } from './build-pages';
-import { readFileAsync } from './utils/fs-async';
 import { envVarToBool, Extension } from 'util/extension';
+import { runRedoc } from './runRedoc';
 
 const extension = new Extension({
   isEnabled: envVarToBool(process.env.REDOC_ENABLED),
 });
-const BUNDLE_PATH = `${process.cwd()}/bundle`;
 
-//TODO: set this in netlify.toml or db env vars
-const REDOC_CLI_VERSION = '1.2.3';
-
-export interface OASPageMetadata {
-  source_type: string;
-  source: string;
-  api_version?: string;
-  resource_versions?: string[];
-}
-
-export type OASPagesMetadata = Record<string, OASPageMetadata>;
-
-// handle installing redoc cli if it's not already installed
+// Handle building of redoc pages if they should exist
 extension.addBuildEventHandler(
-  'onPreBuild',
-  async ({ utils: { run, cache } }) => {
-    console.log('Running redoc prebuild');
-    const hasRedoc = await cache.has('redoc');
-
-    if (hasRedoc) {
-      console.log('Restoring redoc from cache');
-      cache.restore('redoc');
-      return;
-    }
-
-    await run.command(
-      `git clone -b @dop/redoc-cli@${REDOC_CLI_VERSION} --depth 1 https://github.com/mongodb-forks/redoc.git redoc`,
-    );
-
-    await run.command('npm ci --prefix cli/ --omit=dev', {
-      cwd: `${process.cwd()}/redoc`,
-    });
-
-    await cache.save('redoc');
+  'onPostBuild',
+  async ({ utils: { run, cache }, netlifyConfig }) => {
+    const siteName = netlifyConfig?.build?.environment?.SITE_NAME as string;
+    const repoName = netlifyConfig?.build?.environment?.REPO_NAME as string;
+    await runRedoc({ run, cache, siteName, repoName });
   },
 );
 
-// handle building the redoc pages
-extension.addBuildEventHandler('onPostBuild', async ({ utils: { run } }) => {
-  // TODO: remove this conditional
-  if (!process.env.REDOC_ENABLED) return;
-  console.log('=========== Redoc Extension Begin ================');
-  await run.command('unzip -o -q bundle.zip -d bundle');
-
-  const siteBson = await readFileAsync(`${BUNDLE_PATH}/site.bson`);
-
-  const buildMetadata = deserialize(siteBson);
-  const siteTitle: string = buildMetadata.title;
-  const openapiPages: OASPagesMetadata | undefined =
-    buildMetadata.openapi_pages;
-
-  if (!openapiPages) {
-    console.log('No OpenAPI pages found');
-    return;
-  }
-
-  const openapiPagesEntries = Object.entries(openapiPages);
-  //TODO: set this in netlify.toml or db env vars
-  const siteUrl = process.env.DEPLOY_PRIME_URL || '';
-
-  await buildOpenAPIPages(openapiPagesEntries, { siteTitle, siteUrl }, run);
-
-  console.log('=========== Redoc Integration End ================');
-});
-
-// cache redoc
-extension.addBuildEventHandler('onSuccess', async ({ utils: { cache } }) => {
-  const hasRedoc = await cache.has('redoc');
-  if (!hasRedoc) {
-    console.log('saving redoc to cache');
-    await cache.save('redoc');
-  }
-});
-
 export { extension };

extensions/redoc/src/runRedoc.ts

@@ -0,0 +1,68 @@
+import type { NetlifyPluginUtils } from '@netlify/build';
+import { buildOpenAPIPages } from './buildPages';
+import { cloneRedoc, hasOpenAPIPages } from './cloneRedoc';
+
+export interface OASPageMetadata {
+  source_type: string;
+  source: string;
+  api_version?: string;
+  resource_versions?: string[];
+}
+
+type OASPagesMetadata = Record<string, OASPageMetadata>;
+
+const FRONTEND_SITES = [
+  'docs-frontend-stg',
+  'docs-frontend-dotcomstg',
+  'docs-frontend-dotcomprd',
+];
+
+export const runRedoc = async ({
+  run,
+  cache,
+  siteName,
+  repoName,
+}: {
+  run: NetlifyPluginUtils['run'];
+  cache: NetlifyPluginUtils['cache'];
+  siteName: string;
+  repoName: string;
+}) => {
+  console.log('=========== Checking For OpenAPI Pages ================');
+
+  const buildMetadata = await hasOpenAPIPages(run);
+  if (!buildMetadata) {
+    return;
+  }
+  console.log('=========== Redoc Extension Begin ================');
+
+  const siteTitle: string = buildMetadata.title;
+  const openapiPages: OASPagesMetadata = buildMetadata.openapi_pages;
+
+  const openapiPagesEntries = Object.entries(openapiPages);
+  const siteUrl = process.env.DEPLOY_PRIME_URL || '';
+  const isFrontendBuild = FRONTEND_SITES.includes(siteName);
+
+  const contentRepoName = isFrontendBuild ? repoName : undefined;
+
+  await cloneRedoc(run, cache);
+
+  await buildOpenAPIPages(
+    openapiPagesEntries,
+    { siteTitle, siteUrl },
+    run,
+    contentRepoName,
+  );
+
+  await cacheRedoc(cache);
+
+  console.log('=========== Redoc Integration End ================');
+};
+
+const cacheRedoc = async (cache: NetlifyPluginUtils['cache']) => {
+  const hasRedoc = await cache.has('redoc');
+  if (!hasRedoc) {
+    console.log('saving redoc to cache');
+    await cache.save('redoc');
+  }
+};