fix: (regression) parseDocsConfiguration accidentally calls loadAllPa…

…ges with absolutePathToDocsConfig (#4026) * fix: (regression) parseDocsConfiguration accidentally calls loadAllPages with absolutePathToDocsConfig * update tests
fern-api · Jul 9, 2024 · b9db493 · b9db493
1 parent 84c482a
commit b9db493
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 16 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/packages/cli/configuration/src/docs-yml/getAllPages.ts b/packages/cli/configuration/src/docs-yml/getAllPages.ts
@@ -10,10 +10,15 @@ import {
 
 const BATCH_SIZE = 100; // Define a reasonable batch size
 
-async function loadBatch(
-    files: AbsoluteFilePath[],
-    absolutePathToFernFolder: AbsoluteFilePath
-): Promise<Record<RelativeFilePath, string>> {
+interface LoadPagesOptions {
+    files: AbsoluteFilePath[];
+    absolutePathToFernFolder: AbsoluteFilePath;
+}
+
+async function loadBatch({
+    files,
+    absolutePathToFernFolder
+}: LoadPagesOptions): Promise<Record<RelativeFilePath, string>> {
     const pairs = await Promise.all(
         files.map(async (file) => {
             const content = await readFile(file, "utf-8");
@@ -23,16 +28,21 @@ async function loadBatch(
     return Object.fromEntries(pairs);
 }
 
-export async function loadAllPages(
-    filesPromise: Promise<AbsoluteFilePath[]>,
-    absolutePathToFernFolder: AbsoluteFilePath
-): Promise<Record<RelativeFilePath, string>> {
-    const files = await filesPromise;
+export async function loadAllPages({
+    files,
+    absolutePathToFernFolder
+}: {
+    files: AbsoluteFilePath[];
+    absolutePathToFernFolder: AbsoluteFilePath;
+}): Promise<Record<RelativeFilePath, string>> {
     const result: Record<RelativeFilePath, string> = {};
 
     for (let i = 0; i < files.length; i += BATCH_SIZE) {
         const batch = files.slice(i, i + BATCH_SIZE);
-        const batchResult = await loadBatch(batch, absolutePathToFernFolder);
+        const batchResult = await loadBatch({
+            files: batch,
+            absolutePathToFernFolder
+        });
         Object.assign(result, batchResult);
     }
 

diff --git a/packages/cli/configuration/src/docs-yml/parseDocsConfiguration.ts b/packages/cli/configuration/src/docs-yml/parseDocsConfiguration.ts
@@ -80,11 +80,11 @@ export async function parseDocsConfiguration({
         context
     });
 
-    const pagesPromise = loadAllPages(
-        convertedNavigationPromise.then((convertedNavigation) =>
-            getAllPages({ navigation: convertedNavigation, landingPage })
-        ),
-        absoluteFilepathToDocsConfig
+    const pagesPromise = convertedNavigationPromise.then((convertedNavigation) =>
+        loadAllPages({
+            files: getAllPages({ navigation: convertedNavigation, landingPage }),
+            absolutePathToFernFolder
+        })
     );
 
     const logo = convertLogoReference(rawLogo, absoluteFilepathToDocsConfig);

diff --git a/packages/cli/ete-tests/package.json b/packages/cli/ete-tests/package.json
@@ -28,6 +28,7 @@
   },
   "dependencies": {
     "@fern-api/configuration": "workspace:*",
+    "@fern-api/fdr-sdk": "0.98.10-04e9d1412",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/logging-execa": "workspace:*",
     "@fern-typescript/fetcher": "workspace:*",

diff --git a/packages/cli/ete-tests/src/tests/docs-dev/docsDev.test.ts b/packages/cli/ete-tests/src/tests/docs-dev/docsDev.test.ts
@@ -1,3 +1,4 @@
+import { DocsV2Read, FernNavigation } from "@fern-api/fdr-sdk";
 import { AbsoluteFilePath, join, RelativeFilePath } from "@fern-api/fs-utils";
 import fetch from "node-fetch";
 import { runFernCli } from "../../utils/runFernCli";
@@ -26,10 +27,27 @@ describe("fern docs dev", () => {
         const responseText = await response.text();
         expect(responseText.includes("[object Promise]")).toBeFalsy();
 
-        const responseBody = JSON.parse(responseText);
+        const responseBody = JSON.parse(responseText) as DocsV2Read.LoadDocsForUrlResponse;
         expect(typeof responseBody === "object").toEqual(true);
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         expect(Object.keys(responseBody as any)).toEqual(["baseUrl", "definition", "lightModeEnabled"]);
+
+        const root = FernNavigation.utils.convertLoadDocsForUrlResponse(responseBody);
+        const pageIds = new Set(Object.keys(responseBody.definition.pages));
+        const pageIdsVisited = new Set<string>();
+
+        FernNavigation.utils.traverseNavigation(root, (node) => {
+            if (FernNavigation.hasMarkdown(node)) {
+                const pageId = FernNavigation.utils.getPageId(node);
+                if (pageId != null) {
+                    pageIdsVisited.add(pageId);
+                }
+            }
+        });
+        expect(pageIdsVisited.size).toBeGreaterThan(0);
+
+        const overlap = new Set([...pageIds].filter((x) => pageIdsVisited.has(x)));
+        expect(overlap.size).toEqual(pageIdsVisited.size);
     }, 30_000);
 });
 

diff --git a/yarn.lock b/yarn.lock
@@ -3684,6 +3684,7 @@ __metadata:
   resolution: "@fern-api/ete-tests@workspace:packages/cli/ete-tests"
   dependencies:
     "@fern-api/configuration": "workspace:*"
+    "@fern-api/fdr-sdk": 0.98.10-04e9d1412
     "@fern-api/fs-utils": "workspace:*"
     "@fern-api/logging-execa": "workspace:*"
     "@fern-typescript/fetcher": "workspace:*"