Revert "chore: plumb new navigation record generation" (#1774)

fern-api · Nov 4, 2024 · 5d10763 · 5d10763
1 parent 891c83a
commit 5d10763
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 168 deletions.
diff --git a/packages/fdr-sdk/src/converters/index.ts b/packages/fdr-sdk/src/converters/index.ts
@@ -4,4 +4,3 @@ export { SDKSnippetHolder } from "./db/snippets/SDKSnippetHolder";
 export { migrateDocsDbDefinition } from "./db/upgrade/migrateDocsDbDefinition";
 export { convertDbAPIDefinitionToRead, convertDbAPIDefinitionsToRead } from "./read/convertDbAPIDefinitionToRead";
 export { convertDbDocsConfigToRead } from "./read/convertDbDocsConfigToRead";
-export { convertDocsDefinitionToRead } from "./read/convertDocsDefinitionToRead";
diff --git a/packages/fdr-sdk/src/converters/read/convertDocsDefinitionToRead.ts b/packages/fdr-sdk/src/converters/read/convertDocsDefinitionToRead.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/servers/fdr/package.json b/servers/fdr/package.json
@@ -12,7 +12,6 @@
   "dependencies": {
     "@aws-sdk/client-s3": "^3.335.0",
     "@aws-sdk/s3-request-presigner": "^3.574.0",
-    "@fern-ui/fern-docs-search-server": "workspace:*",
     "@fern-api/fdr-sdk": "workspace:*",
     "@fern-api/github": "workspace:*",
     "@fern-api/template-resolver": "workspace:*",

diff --git a/servers/fdr/src/controllers/docs/v1/getDocsReadService.ts b/servers/fdr/src/controllers/docs/v1/getDocsReadService.ts
@@ -6,20 +6,18 @@ import {
     DocsV1Read,
     FdrAPI,
     convertDbAPIDefinitionToRead,
-    convertDocsDefinitionToRead,
+    convertDbDocsConfigToRead,
     migrateDocsDbDefinition,
     visitDbNavigationConfig,
 } from "@fern-api/fdr-sdk";
 import { AuthType, type IndexSegment } from "@prisma/client";
-import { keyBy } from "es-toolkit";
 import { mapValues } from "lodash-es";
 import { DocsV1ReadService } from "../../../api";
 import { UnauthorizedError } from "../../../api/generated/api";
 import { DomainNotRegisteredError } from "../../../api/generated/api/resources/docs/resources/v1/resources/read";
 import type { FdrApplication } from "../../../app";
 import { LoadDocsDefinitionByUrlResponse } from "../../../db";
 import { readBuffer } from "../../../util";
-import { getFilesV2 } from "../../../util/getFilesV2";
 
 export function getDocsReadService(app: FdrApplication): DocsV1ReadService {
     return new DocsV1ReadService({
@@ -129,22 +127,61 @@ export async function getDocsDefinition({
         }),
     ]);
 
-    const bufferedApiDefinitionsById = keyBy(apiDefinitions, (def) => DocsV1Db.ApiDefinitionId(def.apiDefinitionId));
-
     const filesV2 = await getFilesV2(docsDbDefinition, app);
 
-    const apiDefinitionsById = mapValues(bufferedApiDefinitionsById, (def) =>
-        convertDbApiDefinitionToRead(def.definition),
-    );
-
-    return convertDocsDefinitionToRead({
-        docsDbDefinition,
+    return {
         algoliaSearchIndex: docsV2?.algoliaIndex ?? undefined,
+        config: convertDbDocsConfigToRead({ dbShape: docsDbDefinition.config }),
+        apis: Object.fromEntries(
+            apiDefinitions.map((apiDefinition) => {
+                const parsedApiDefinition = convertDbApiDefinitionToRead(apiDefinition.definition);
+                return [apiDefinition.apiDefinitionId, parsedApiDefinition];
+            }),
+        ),
+        files: mapValues(filesV2, (fileV2) => fileV2.url),
+        jsFiles: docsDbDefinition.type === "v3" ? docsDbDefinition.jsFiles : undefined,
         filesV2,
-        apis: apiDefinitionsById,
-        id: docsV2?.docsConfigInstanceId ?? undefined,
+        pages: docsDbDefinition.pages,
         search: searchInfo,
-    });
+        id: docsV2?.docsConfigInstanceId ?? undefined,
+    };
+}
+
+async function getFilesV2(docsDbDefinition: DocsV1Db.DocsDefinitionDb, app: FdrApplication) {
+    let promisedFiles: Promise<[DocsV1Read.FileId, DocsV1Read.File_]>[];
+    if (docsDbDefinition.type === "v3") {
+        promisedFiles = Object.entries(docsDbDefinition.files).map(
+            async ([fileId, fileDbInfo]): Promise<[DocsV1Read.FileId, DocsV1Read.File_]> => {
+                const s3DownloadUrl = await app.services.s3.getPresignedDocsAssetsDownloadUrl({
+                    key: fileDbInfo.s3Key,
+                    isPrivate: true, // for backcompat
+                });
+                const readFile: DocsV1Read.File_ =
+                    fileDbInfo.type === "image"
+                        ? {
+                              type: "image",
+                              url: s3DownloadUrl,
+                              width: fileDbInfo.width,
+                              height: fileDbInfo.height,
+                              blurDataUrl: fileDbInfo.blurDataUrl,
+                              alt: fileDbInfo.alt,
+                          }
+                        : { type: "url", url: s3DownloadUrl };
+                return [DocsV1Read.FileId(fileId), readFile];
+            },
+        );
+    } else {
+        promisedFiles = Object.entries(docsDbDefinition.files).map(
+            async ([fileId, fileDbInfo]): Promise<[DocsV1Read.FileId, DocsV1Read.File_]> => {
+                const s3DownloadUrl = await app.services.s3.getPresignedDocsAssetsDownloadUrl({
+                    key: fileDbInfo.s3Key,
+                    isPrivate: true, // for backcompat
+                });
+                return [DocsV1Read.FileId(fileId), { type: "url", url: s3DownloadUrl }];
+            },
+        );
+    }
+    return Object.fromEntries(await Promise.all(promisedFiles));
 }
 
 export async function loadIndexSegmentsAndGetSearchInfo({
@@ -171,7 +208,7 @@ export async function loadIndexSegmentsAndGetSearchInfo({
     });
 }
 
-export function getSearchInfoFromDocs({
+function getSearchInfoFromDocs({
     algoliaIndex,
     indexSegmentIds,
     activeIndexSegments,

diff --git a/servers/fdr/src/controllers/docs/v2/getDocsWriteV2Service.ts b/servers/fdr/src/controllers/docs/v2/getDocsWriteV2Service.ts
@@ -1,35 +1,21 @@
-import {
-    APIV1Db,
-    convertDbAPIDefinitionToRead,
-    convertDocsDefinitionToDb,
-    convertDocsDefinitionToRead,
-    DocsV1Db,
-    DocsV1Write,
-    FdrAPI,
-    FernNavigation,
-} from "@fern-api/fdr-sdk";
+import { APIV1Db, convertDocsDefinitionToDb, DocsV1Db, DocsV1Write, FdrAPI } from "@fern-api/fdr-sdk";
 import { isNonNullish } from "@fern-api/ui-core-utils";
-import { generateAlgoliaRecords } from "@fern-ui/fern-docs-search-server";
 import { AuthType } from "@prisma/client";
-import { mapValues } from "es-toolkit";
 import urlJoin from "url-join";
 import { v4 as uuidv4 } from "uuid";
 import { DocsV2WriteService } from "../../../api";
-import { FernRegistry } from "../../../api/generated";
 import { DomainBelongsToAnotherOrgError } from "../../../api/generated/api/resources/commons/errors";
 import { DocsRegistrationIdNotFound } from "../../../api/generated/api/resources/docs/resources/v1/resources/write/errors";
-import { LoadDocsForUrlResponse } from "../../../api/generated/api/resources/docs/resources/v2/resources/read";
 import {
     DocsNotFoundError,
     InvalidDomainError,
     ReindexNotAllowedError,
 } from "../../../api/generated/api/resources/docs/resources/v2/resources/write/errors";
 import { type FdrApplication } from "../../../app";
-import { AlgoliaSearchRecord, IndexSegment } from "../../../services/algolia";
+import { IndexSegment } from "../../../services/algolia";
 import { type S3DocsFileInfo } from "../../../services/s3";
 import { WithoutQuestionMarks } from "../../../util";
 import { ParsedBaseUrl } from "../../../util/ParsedBaseUrl";
-import { getSearchInfoFromDocs } from "../v1/getDocsReadService";
 
 export interface DocsRegistrationInfo {
     fernUrl: ParsedBaseUrl;
@@ -269,8 +255,6 @@ export function getDocsWriteV2Service(app: FdrApplication): DocsV2WriteService {
                 ParsedBaseUrl.parse(response.domain),
                 response.docsDefinition,
                 apiDefinitionsById,
-                response.algoliaIndex,
-                response.docsConfigInstanceId,
             );
 
             // step 3. store docs + new algolia segments
@@ -304,7 +288,7 @@ export function getDocsWriteV2Service(app: FdrApplication): DocsV2WriteService {
 async function uploadToAlgoliaForRegistration(
     app: FdrApplication,
     docsRegistrationInfo: DocsRegistrationInfo,
-    dbDocsDefinition: WithoutQuestionMarks<DocsV1Db.DocsDefinitionDb.V3>,
+    dbDocsDefinition: WithoutQuestionMarks<DocsV1Db.DocsDefinitionDb>,
     apiDefinitionsById: Record<string, APIV1Db.DbApiDefinition>,
 ): Promise<IndexSegment[]> {
     // TODO: make sure to store private docs index into user-restricted algolia index
@@ -326,8 +310,6 @@ async function uploadToAlgolia(
     url: ParsedBaseUrl,
     dbDocsDefinition: WithoutQuestionMarks<DocsV1Db.DocsDefinitionDb>,
     apiDefinitionsById: Record<string, APIV1Db.DbApiDefinition>,
-    algoliaIndex?: FernRegistry.AlgoliaSearchIndex,
-    docsConfigInstanceId?: DocsV1Write.DocsConfigId,
 ): Promise<IndexSegment[]> {
     app.logger.debug(`[${url.getFullUrl()}] Generating new index segments`);
     const generateNewIndexSegmentsResult = app.services.algoliaIndexSegmentManager.generateIndexSegmentsForDefinition({
@@ -341,58 +323,12 @@ async function uploadToAlgolia(
     const newIndexSegments = configSegmentTuples.map(([, seg]) => seg);
 
     app.logger.debug(`[${url.getFullUrl()}] Generating search records for all versions`);
-
-    let searchRecords: AlgoliaSearchRecord[] = [];
-    if (dbDocsDefinition.config.root == null) {
-        searchRecords = await app.services.algolia.generateSearchRecords({
-            url: url.getFullUrl(),
-            docsDefinition: dbDocsDefinition,
-            apiDefinitionsById,
-            configSegmentTuples,
-        });
-    } else {
-        const loadDocsForUrlResponse: LoadDocsForUrlResponse = {
-            baseUrl: {
-                domain: url.hostname,
-                basePath: url.path?.trim(),
-            },
-            definition: convertDocsDefinitionToRead({
-                docsDbDefinition: dbDocsDefinition,
-                algoliaSearchIndex: algoliaIndex,
-                // we don't need to use this for generating algolia records
-                filesV2: {},
-                apis: mapValues(apiDefinitionsById, (def) => convertDbAPIDefinitionToRead(def)),
-                id: docsConfigInstanceId ?? DocsV1Write.DocsConfigId(""),
-                search: getSearchInfoFromDocs({
-                    algoliaIndex,
-                    indexSegmentIds: newIndexSegments.map((indexSegment) => indexSegment.id),
-                    activeIndexSegments: newIndexSegments.map((indexSegment) => ({
-                        id: indexSegment.id,
-                        createdAt: new Date(),
-                        version: null,
-                    })),
-                    docsDbDefinition: dbDocsDefinition,
-                    app,
-                }),
-            }),
-            lightModeEnabled: dbDocsDefinition.config.colorsV3?.type !== "dark",
-        };
-        configSegmentTuples.map(([_, indexSegment]) => {
-            const v2Records = generateAlgoliaRecords({
-                indexSegmentId: indexSegment.id,
-                nodes: FernNavigation.utils.toRootNode(loadDocsForUrlResponse),
-                pages: FernNavigation.utils.toPages(loadDocsForUrlResponse),
-                apis: FernNavigation.utils.toApis(loadDocsForUrlResponse),
-                isFieldRecordsEnabled: false,
-            });
-            searchRecords.push(
-                ...v2Records.map((record) => ({
-                    ...record,
-                    objectID: uuidv4(),
-                })),
-            );
-        });
-    }
+    const searchRecords = await app.services.algolia.generateSearchRecords({
+        url: url.getFullUrl(),
+        docsDefinition: dbDocsDefinition,
+        apiDefinitionsById,
+        configSegmentTuples,
+    });
 
     app.logger.debug(`[${url.getFullUrl()}] Uploading search records to Algolia`);
     await app.services.algolia.uploadSearchRecords(searchRecords);

diff --git a/servers/fdr/src/services/algolia/AlgoliaSearchRecordGeneratorV2.ts b/servers/fdr/src/services/algolia/AlgoliaSearchRecordGeneratorV2.ts
@@ -8,10 +8,10 @@ import {
     convertDbAPIDefinitionToRead,
     visitDbNavigationTab,
 } from "@fern-api/fdr-sdk";
+import { EndpointPathPart } from "@fern-api/fdr-sdk/src/client/APIV1Read";
 import { titleCase, visitDiscriminatedUnion } from "@fern-api/ui-core-utils";
 import { kebabCase } from "es-toolkit/string";
 import { v4 as uuid } from "uuid";
-import { EndpointPathPart } from "../../../../../packages/fdr-sdk/src/client/APIV1Read";
 import { BreadcrumbsInfo } from "../../api/generated/api";
 import { LOGGER } from "../../app/FdrApplication";
 import { assertNever, convertMarkdownToText, truncateToBytes } from "../../util";

diff --git a/servers/fdr/src/util/getFilesV2.ts b/servers/fdr/src/util/getFilesV2.ts
diff --git a/servers/fdr/tsconfig.json b/servers/fdr/tsconfig.json
@@ -12,8 +12,7 @@
     // Set `sourceRoot` to  "/" to strip the build path prefix
     // from generated source code references.
     // This improves issue grouping in Sentry.
-    "sourceRoot": "/",
-    "moduleResolution": "bundler"
+    "sourceRoot": "/"
   },
   "include": ["./src/**/*"],
   "references": [