fix: disable preview url indexing

fern-api · Dec 6, 2024 · 987784a · 987784a
1 parent 836e563
commit 987784a
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 10 deletions.
diff --git a/packages/ui/app/src/search/SearchV2.tsx b/packages/ui/app/src/search/SearchV2.tsx
@@ -17,7 +17,6 @@ import {
     useFacetFilters,
     useIsMobile,
 } from "@fern-ui/fern-docs-search-ui";
-import { HEADER_X_ALGOLIA_API_KEY } from "@fern-ui/fern-docs-utils";
 import { useEventCallback } from "@fern-ui/react-commons";
 import { useAtomValue } from "jotai";
 import { useRouter } from "next/router";
@@ -73,12 +72,10 @@ export function SearchV2(): ReactElement | false {
                 return {};
             }
             const searchParams = new URLSearchParams();
+            searchParams.append("apiKey", data.apiKey);
             filters.forEach((filter) => searchParams.append("filters", filter));
             const search = String(searchParams);
-            const res = await fetch(`${facetApiEndpoint}${search ? `?${search}` : ""}`, {
-                method: "GET",
-                headers: { [HEADER_X_ALGOLIA_API_KEY]: data.apiKey },
-            });
+            const res = await fetch(`${facetApiEndpoint}?${search}`, { method: "GET" });
             return res.json();
         },
         [data, facetApiEndpoint],

diff --git a/packages/ui/docs-bundle/src/pages/api/fern-docs/search/v2/facet.ts b/packages/ui/docs-bundle/src/pages/api/fern-docs/search/v2/facet.ts
@@ -2,7 +2,6 @@ import { algoliaAppId } from "@/server/env-variables";
 import { selectFirst } from "@/server/utils/selectFirst";
 import { toArray } from "@/server/utils/toArray";
 import { fetchFacetValues } from "@fern-ui/fern-docs-search-server/algolia";
-import { HEADER_X_ALGOLIA_API_KEY } from "@fern-ui/fern-docs-utils";
 import { algoliasearch } from "algoliasearch";
 import { NextApiRequest, NextApiResponse } from "next/types";
 
@@ -15,10 +14,10 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
     }
 
     const filters = toArray(req.query.filters);
-    const apiKey = selectFirst(req.headers[HEADER_X_ALGOLIA_API_KEY]);
+    const apiKey = selectFirst(req.query.apiKey);
 
     if (!apiKey) {
-        return res.status(400).send(`${HEADER_X_ALGOLIA_API_KEY} is required`);
+        return res.status(400).send("apiKey is required");
     }
 
     return res.json(await fetchFacetValues({ filters, client: algoliasearch(algoliaAppId(), apiKey) }));

diff --git a/packages/ui/docs-bundle/src/pages/api/fern-docs/search/v2/key.ts b/packages/ui/docs-bundle/src/pages/api/fern-docs/search/v2/key.ts
@@ -1,3 +1,4 @@
+import { getOrgMetadataForDomain } from "@/server/auth/metadata-for-url";
 import { algoliaAppId, algoliaSearchApikey } from "@/server/env-variables";
 import { selectFirst } from "@/server/utils/selectFirst";
 import { getDocsDomainNode } from "@/server/xfernhost/node";
@@ -18,6 +19,16 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
     }
 
     const domain = getDocsDomainNode(req);
+
+    const orgMetadata = await getOrgMetadataForDomain(withoutStaging(domain));
+    if (orgMetadata == null) {
+        return res.status(404).send("Not found");
+    }
+
+    if (orgMetadata.isPreviewUrl) {
+        return res.status(400).send("Search is not supported for preview URLs");
+    }
+
     const userToken = getXUserToken(req);
 
     const apiKey = getSearchApiKey({

diff --git a/packages/ui/docs-bundle/src/pages/api/fern-docs/search/v2/reindex.ts b/packages/ui/docs-bundle/src/pages/api/fern-docs/search/v2/reindex.ts
@@ -1,4 +1,5 @@
 import { track } from "@/server/analytics/posthog";
+import { getOrgMetadataForDomain } from "@/server/auth/metadata-for-url";
 import { algoliaAppId, algoliaWriteApiKey, fdrEnvironment, fernToken } from "@/server/env-variables";
 import { Gate, withBasicTokenAnonymous } from "@/server/withRbac";
 import { getDocsDomainNode } from "@/server/xfernhost/node";
@@ -14,6 +15,20 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
     const domain = getDocsDomainNode(req);
 
     try {
+        const orgMetadata = await getOrgMetadataForDomain(withoutStaging(domain));
+        if (orgMetadata == null) {
+            return res.status(404).send("Not found");
+        }
+
+        // If the domain is a preview URL, we don't want to reindex
+        if (orgMetadata.isPreviewUrl) {
+            return res.status(200).json({
+                added: 0,
+                updated: 0,
+                deleted: 0,
+            });
+        }
+
         const start = Date.now();
         const [authEdgeConfig, featureFlags] = await Promise.all([getAuthEdgeConfig(domain), getFeatureFlags(domain)]);
 
@@ -51,7 +66,11 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
             deleted: response.deletedObjectIDs.length,
         });
 
-        return res.status(200).json(response);
+        return res.status(200).json({
+            added: response.addedObjectIDs.length,
+            updated: response.updatedObjectIDs.length,
+            deleted: response.deletedObjectIDs.length,
+        });
     } catch (error) {
         // eslint-disable-next-line no-console
         console.error(error);

diff --git a/packages/ui/fern-docs-utils/src/constants.ts b/packages/ui/fern-docs-utils/src/constants.ts
@@ -7,7 +7,7 @@ export const COOKIE_REFRESH_TOKEN = "refresh_token" as const; // for api key inj
 export const COOKIE_EMAIL = "email" as const; // for api key injection
 export const HEADER_X_FERN_HOST = "x-fern-host" as const;
 export const HEADER_X_MATCHED_PATH = "x-matched-path" as const;
-export const HEADER_X_ALGOLIA_API_KEY = "x-algolia-api-key" as const;
+
 /**
  * The role that is used to represent everyone (including unauthenticated users)
  */