feat: New <Feature> component to gate docs content by feature flag (#…

…1959)
fern-api · Jan 8, 2025 · 07631d9 · 07631d9
1 parent d573935
commit 07631d9
Show file tree

Hide file tree

Showing 69 changed files with 637 additions and 468 deletions.
diff --git a/packages/fern-docs/bundle/src/app/[[...slug]]/llms-full.txt.ts b/packages/fern-docs/bundle/src/app/[[...slug]]/llms-full.txt.ts
@@ -5,7 +5,7 @@ import { getDocsDomainEdge, getHostEdge } from "@/server/xfernhost/edge";
 import { FernNavigation } from "@fern-api/fdr-sdk";
 import { CONTINUE, SKIP } from "@fern-api/fdr-sdk/traversers";
 import { isNonNullish } from "@fern-api/ui-core-utils";
-import { getFeatureFlags } from "@fern-docs/edge-config";
+import { getEdgeFlags } from "@fern-docs/edge-config";
 import { addLeadingSlash, COOKIE_FERN_TOKEN } from "@fern-docs/utils";
 import { uniqBy } from "es-toolkit/array";
 import { cookies } from "next/headers";
@@ -20,9 +20,9 @@ export async function handleLLMSFullTxt(
   const domain = getDocsDomainEdge(req);
   const host = getHostEdge(req);
   const fern_token = cookies().get(COOKIE_FERN_TOKEN)?.value;
-  const featureFlags = await getFeatureFlags(domain);
-  const loader = DocsLoader.for(domain, host, fern_token).withFeatureFlags(
-    featureFlags
+  const edgeFlags = await getEdgeFlags(domain);
+  const loader = DocsLoader.for(domain, host, fern_token).withEdgeFlags(
+    edgeFlags
   );
 
   const root = getSectionRoot(await loader.root(), path);
@@ -53,7 +53,7 @@ export async function handleLLMSFullTxt(
         nodes,
         (a) => FernNavigation.getPageId(a) ?? a.canonicalSlug ?? a.slug
       ).map(async (node) => {
-        const markdown = await getMarkdownForPath(node, loader, featureFlags);
+        const markdown = await getMarkdownForPath(node, loader, edgeFlags);
         if (markdown == null) {
           return undefined;
         }

diff --git a/packages/fern-docs/bundle/src/app/[[...slug]]/llms.txt.ts b/packages/fern-docs/bundle/src/app/[[...slug]]/llms.txt.ts
@@ -6,7 +6,7 @@ import { getDocsDomainEdge, getHostEdge } from "@/server/xfernhost/edge";
 import * as FernNavigation from "@fern-api/fdr-sdk/navigation";
 import { CONTINUE, SKIP } from "@fern-api/fdr-sdk/traversers";
 import { isNonNullish, withDefaultProtocol } from "@fern-api/ui-core-utils";
-import { getFeatureFlags } from "@fern-docs/edge-config";
+import { getEdgeFlags } from "@fern-docs/edge-config";
 import { COOKIE_FERN_TOKEN, addLeadingSlash } from "@fern-docs/utils";
 import { cookies } from "next/headers";
 import { NextRequest, NextResponse } from "next/server";
@@ -40,9 +40,9 @@ export async function handleLLMSTxt(
   const domain = getDocsDomainEdge(req);
   const host = getHostEdge(req);
   const fern_token = cookies().get(COOKIE_FERN_TOKEN)?.value;
-  const featureFlags = await getFeatureFlags(domain);
-  const loader = DocsLoader.for(domain, host, fern_token).withFeatureFlags(
-    featureFlags
+  const edgeFlags = await getEdgeFlags(domain);
+  const loader = DocsLoader.for(domain, host, fern_token).withEdgeFlags(
+    edgeFlags
   );
 
   const root = getSectionRoot(await loader.root(), path);
@@ -71,7 +71,7 @@ export async function handleLLMSTxt(
   const landingPage = getLandingPage(root);
   const markdown =
     landingPage != null
-      ? await getMarkdownForPath(landingPage, loader, featureFlags)
+      ? await getMarkdownForPath(landingPage, loader, edgeFlags)
       : undefined;
 
   // traverse the tree in a depth-first manner to collect all the nodes that have markdown content

diff --git a/packages/fern-docs/bundle/src/app/[[...slug]]/markdown.ts b/packages/fern-docs/bundle/src/app/[[...slug]]/markdown.ts
@@ -4,7 +4,7 @@ import {
   getPageNodeForPath,
 } from "@/server/getMarkdownForPath";
 import { getDocsDomainEdge, getHostEdge } from "@/server/xfernhost/edge";
-import { getFeatureFlags } from "@fern-docs/edge-config";
+import { getEdgeFlags } from "@fern-docs/edge-config";
 import { addLeadingSlash, COOKIE_FERN_TOKEN } from "@fern-docs/utils";
 import { cookies } from "next/headers";
 import { notFound } from "next/navigation";
@@ -23,9 +23,9 @@ export async function handleMarkdown(
   const domain = getDocsDomainEdge(req);
   const host = getHostEdge(req);
   const fern_token = cookies().get(COOKIE_FERN_TOKEN)?.value;
-  const featureFlags = await getFeatureFlags(domain);
-  const loader = DocsLoader.for(domain, host, fern_token).withFeatureFlags(
-    featureFlags
+  const edgeFlags = await getEdgeFlags(domain);
+  const loader = DocsLoader.for(domain, host, fern_token).withEdgeFlags(
+    edgeFlags
   );
 
   const node = getPageNodeForPath(await loader.root(), path);
@@ -39,7 +39,7 @@ export async function handleMarkdown(
     return new NextResponse(null, { status: 403 });
   }
 
-  const markdown = await getMarkdownForPath(node, loader, featureFlags);
+  const markdown = await getMarkdownForPath(node, loader, edgeFlags);
   if (markdown == null) {
     notFound();
   }

diff --git a/.../fern-docs/bundle/src/app/api/fern-docs/api-definition/[api]/endpoint/[endpoint]/route.ts b/.../fern-docs/bundle/src/app/api/fern-docs/api-definition/[api]/endpoint/[endpoint]/route.ts
@@ -1,7 +1,7 @@
 import { getAuthStateEdge } from "@/server/auth/getAuthStateEdge";
 import * as ApiDefinition from "@fern-api/fdr-sdk/api-definition";
 import { ApiDefinitionLoader } from "@fern-docs/cache";
-import { getFeatureFlags } from "@fern-docs/edge-config";
+import { getEdgeFlags } from "@fern-docs/edge-config";
 import { getMdxBundler } from "@fern-docs/ui/bundlers";
 import { NextRequest, NextResponse } from "next/server";
 
@@ -20,15 +20,15 @@ export async function GET(
     );
   }
 
-  const flags = await getFeatureFlags(authState.domain);
+  const flags = await getEdgeFlags(authState.domain);
   const engine = flags.useMdxBundler ? "mdx-bundler" : "next-mdx-remote";
   const serializeMdx = await getMdxBundler(engine);
 
   const apiDefinition = await ApiDefinitionLoader.create(
     authState.domain,
     ApiDefinition.ApiDefinitionId(api)
   )
-    .withFlags(flags)
+    .withEdgeFlags(flags)
     .withMdxBundler(serializeMdx, engine)
     .withPrune({
       type: "endpoint",

diff --git a/...es/fern-docs/bundle/src/app/api/fern-docs/api-definition/[api]/webhook/[webhook]/route.ts b/...es/fern-docs/bundle/src/app/api/fern-docs/api-definition/[api]/webhook/[webhook]/route.ts
@@ -1,7 +1,7 @@
 import { getAuthStateEdge } from "@/server/auth/getAuthStateEdge";
 import * as ApiDefinition from "@fern-api/fdr-sdk/api-definition";
 import { ApiDefinitionLoader } from "@fern-docs/cache";
-import { getFeatureFlags } from "@fern-docs/edge-config";
+import { getEdgeFlags } from "@fern-docs/edge-config";
 import { getMdxBundler } from "@fern-docs/ui/bundlers";
 import { NextRequest, NextResponse } from "next/server";
 
@@ -20,15 +20,15 @@ export async function GET(
     );
   }
 
-  const flags = await getFeatureFlags(authState.domain);
+  const flags = await getEdgeFlags(authState.domain);
   const engine = flags.useMdxBundler ? "mdx-bundler" : "next-mdx-remote";
   const serializeMdx = await getMdxBundler(engine);
 
   const apiDefinition = await ApiDefinitionLoader.create(
     authState.domain,
     ApiDefinition.ApiDefinitionId(api)
   )
-    .withFlags(flags)
+    .withEdgeFlags(flags)
     .withMdxBundler(serializeMdx, engine)
     .withPrune({
       type: "webhook",

diff --git a/...ern-docs/bundle/src/app/api/fern-docs/api-definition/[api]/websocket/[websocket]/route.ts b/...ern-docs/bundle/src/app/api/fern-docs/api-definition/[api]/websocket/[websocket]/route.ts
@@ -1,7 +1,7 @@
 import { getAuthStateEdge } from "@/server/auth/getAuthStateEdge";
 import * as ApiDefinition from "@fern-api/fdr-sdk/api-definition";
 import { ApiDefinitionLoader } from "@fern-docs/cache";
-import { getFeatureFlags } from "@fern-docs/edge-config";
+import { getEdgeFlags } from "@fern-docs/edge-config";
 import { getMdxBundler } from "@fern-docs/ui/bundlers";
 import { NextRequest, NextResponse } from "next/server";
 
@@ -20,15 +20,15 @@ export async function GET(
     );
   }
 
-  const flags = await getFeatureFlags(authState.domain);
+  const flags = await getEdgeFlags(authState.domain);
   const engine = flags.useMdxBundler ? "mdx-bundler" : "next-mdx-remote";
   const serializeMdx = await getMdxBundler(engine);
 
   const apiDefinition = await ApiDefinitionLoader.create(
     authState.domain,
     ApiDefinition.ApiDefinitionId(api)
   )
-    .withFlags(flags)
+    .withEdgeFlags(flags)
     .withMdxBundler(serializeMdx, engine)
     .withPrune({
       type: "webSocket",

diff --git a/...pi/fern-docs/integrations/launchdarkly.ts → ...n-docs/integrations/launchdarkly/route.ts b/...pi/fern-docs/integrations/launchdarkly.ts → ...n-docs/integrations/launchdarkly/route.ts
@@ -11,8 +11,7 @@ import { NextRequest, NextResponse, userAgent } from "next/server";
 
 export const runtime = "edge";
 
-interface LaunchDarklyInfo {
-  clientSideId: string;
+interface LaunchDarklyContext {
   kind: "multi";
   user:
     | { anonymous: true }
@@ -29,7 +28,7 @@ interface LaunchDarklyInfo {
 
 export async function GET(
   req: NextRequest
-): Promise<NextResponse<LaunchDarklyInfo | undefined>> {
+): Promise<NextResponse<LaunchDarklyContext | undefined>> {
   const domain = getDocsDomainEdge(req);
 
   const config = await safeGetLaunchDarklySettings(domain);
@@ -40,7 +39,6 @@ export async function GET(
   }
 
   return NextResponse.json({
-    clientSideId,
     kind: "multi" as const,
     user: await getUserContext(req),
     device: await getDeviceContext(req),
@@ -72,7 +70,7 @@ async function hashString(
 
 async function getUserContext(
   req: NextRequest
-): Promise<LaunchDarklyInfo["user"]> {
+): Promise<LaunchDarklyContext["user"]> {
   const jar = cookies();
 
   const fernToken = jar.get(COOKIE_FERN_TOKEN)?.value;
@@ -102,7 +100,7 @@ async function getUserContext(
 
 async function getDeviceContext(
   req: NextRequest
-): Promise<LaunchDarklyInfo["device"]> {
+): Promise<LaunchDarklyContext["device"]> {
   const agent = userAgent(req);
 
   const hash = (await hashString(agent.ua)) ?? crypto.randomUUID();

diff --git a/packages/fern-docs/bundle/src/app/api/fern-docs/search/v2/chat/route.ts b/packages/fern-docs/bundle/src/app/api/fern-docs/search/v2/chat/route.ts
@@ -10,7 +10,7 @@ import { getDocsDomainEdge } from "@/server/xfernhost/edge";
 import { createAnthropic } from "@ai-sdk/anthropic";
 // import { createAmazonBedrock } from "@ai-sdk/amazon-bedrock";
 import { createOpenAI } from "@ai-sdk/openai";
-import { getAuthEdgeConfig, getFeatureFlags } from "@fern-docs/edge-config";
+import { getAuthEdgeConfig, getEdgeFlags } from "@fern-docs/edge-config";
 import { createDefaultSystemPrompt } from "@fern-docs/search-server";
 import {
   queryTurbopuffer,
@@ -48,12 +48,12 @@ export async function POST(req: NextRequest) {
   }
 
   const start = Date.now();
-  const [authEdgeConfig, featureFlags] = await Promise.all([
+  const [authEdgeConfig, edgeFlags] = await Promise.all([
     getAuthEdgeConfig(domain),
-    getFeatureFlags(domain),
+    getEdgeFlags(domain),
   ]);
 
-  if (!featureFlags.isAskAiEnabled) {
+  if (!edgeFlags.isAskAiEnabled) {
     throw new Error(`Ask AI is not enabled for ${domain}`);
   }
 

diff --git a/packages/fern-docs/bundle/src/app/api/fern-docs/search/v2/reindex/algolia/route.ts b/packages/fern-docs/bundle/src/app/api/fern-docs/search/v2/reindex/algolia/route.ts
@@ -8,7 +8,7 @@ import {
 } from "@/server/env-variables";
 import { Gate, withBasicTokenAnonymous } from "@/server/withRbac";
 import { getDocsDomainEdge } from "@/server/xfernhost/edge";
-import { getAuthEdgeConfig, getFeatureFlags } from "@fern-docs/edge-config";
+import { getAuthEdgeConfig, getEdgeFlags } from "@fern-docs/edge-config";
 import {
   SEARCH_INDEX,
   algoliaIndexSettingsTask,
@@ -40,9 +40,9 @@ export async function GET(req: NextRequest): Promise<NextResponse> {
     }
 
     const start = Date.now();
-    const [authEdgeConfig, featureFlags] = await Promise.all([
+    const [authEdgeConfig, edgeFlags] = await Promise.all([
       getAuthEdgeConfig(domain),
-      getFeatureFlags(domain),
+      getEdgeFlags(domain),
     ]);
 
     await algoliaIndexSettingsTask({
@@ -70,7 +70,7 @@ export async function GET(req: NextRequest): Promise<NextResponse> {
           ) === Gate.DENY
         );
       },
-      ...featureFlags,
+      ...edgeFlags,
     });
 
     const end = Date.now();

diff --git a/packages/fern-docs/bundle/src/app/api/fern-docs/search/v2/reindex/turbopuffer/route.ts b/packages/fern-docs/bundle/src/app/api/fern-docs/search/v2/reindex/turbopuffer/route.ts
@@ -1,5 +1,5 @@
 import { createOpenAI } from "@ai-sdk/openai";
-import { getAuthEdgeConfig, getFeatureFlags } from "@fern-docs/edge-config";
+import { getAuthEdgeConfig, getEdgeFlags } from "@fern-docs/edge-config";
 import { turbopufferUpsertTask } from "@fern-docs/search-server/turbopuffer";
 import { addLeadingSlash, withoutStaging } from "@fern-docs/utils";
 import { embedMany } from "ai";
@@ -48,12 +48,12 @@ export async function GET(req: NextRequest): Promise<NextResponse> {
     }
 
     const start = Date.now();
-    const [authEdgeConfig, featureFlags] = await Promise.all([
+    const [authEdgeConfig, edgeFlags] = await Promise.all([
       getAuthEdgeConfig(domain),
-      getFeatureFlags(domain),
+      getEdgeFlags(domain),
     ]);
 
-    if (!featureFlags.isAskAiEnabled) {
+    if (!edgeFlags.isAskAiEnabled) {
       throw new Error(`AI Chat is not enabled for ${domain}`);
     }
 
@@ -64,7 +64,7 @@ export async function GET(req: NextRequest): Promise<NextResponse> {
         environment: fdrEnvironment(),
         fernToken: fernToken(),
         domain: withoutStaging(domain),
-        ...featureFlags,
+        ...edgeFlags,
       },
       vectorizer: async (chunks) => {
         const embeddings = await embedMany({

diff --git a/packages/fern-docs/bundle/src/app/api/fern-docs/search/v2/suggest/route.ts b/packages/fern-docs/bundle/src/app/api/fern-docs/search/v2/suggest/route.ts
@@ -3,7 +3,7 @@ import { algoliaAppId, anthropicApiKey } from "@/server/env-variables";
 import { getDocsDomainEdge } from "@/server/xfernhost/edge";
 import { createAnthropic } from "@ai-sdk/anthropic";
 import { searchClient } from "@algolia/client-search";
-import { getFeatureFlags } from "@fern-docs/edge-config";
+import { getEdgeFlags } from "@fern-docs/edge-config";
 import { SuggestionsSchema } from "@fern-docs/search-server";
 import {
   SEARCH_INDEX,
@@ -32,10 +32,10 @@ export async function POST(req: NextRequest): Promise<Response> {
 
   const start = Date.now();
   const domain = getDocsDomainEdge(req);
-  const featureFlags = await getFeatureFlags(domain);
+  const edgeFlags = await getEdgeFlags(domain);
   const cookieJar = cookies();
 
-  if (!featureFlags.isAskAiEnabled) {
+  if (!edgeFlags.isAskAiEnabled) {
     throw new Error(`Ask AI is not enabled for ${domain}`);
   }
 

diff --git a/packages/fern-docs/bundle/src/pages/api/fern-docs/revalidate-all/v3.ts b/packages/fern-docs/bundle/src/pages/api/fern-docs/revalidate-all/v3.ts
@@ -8,7 +8,7 @@ import {
 import { Revalidator } from "@/server/revalidator";
 import { getDocsDomainNode, getHostNode } from "@/server/xfernhost/node";
 import { NodeCollector } from "@fern-api/fdr-sdk/navigation";
-import { getFeatureFlags } from "@fern-docs/edge-config";
+import { getEdgeFlags } from "@fern-docs/edge-config";
 import { withoutStaging } from "@fern-docs/utils";
 import type { FernDocs } from "@fern-fern/fern-docs-sdk";
 import { NextApiHandler, NextApiRequest, NextApiResponse } from "next";
@@ -50,8 +50,8 @@ const handler: NextApiHandler = async (
   // never provide a token here because revalidation should only be done on public routes (for now)
   const loader = DocsLoader.for(domain, host);
 
-  const flags = await getFeatureFlags(domain);
-  const root = await loader.withFeatureFlags(flags).root();
+  const flags = await getEdgeFlags(domain);
+  const root = await loader.withEdgeFlags(flags).root();
 
   if (!root) {
     /**

diff --git a/packages/fern-docs/bundle/src/pages/api/fern-docs/revalidate-all/v4.ts b/packages/fern-docs/bundle/src/pages/api/fern-docs/revalidate-all/v4.ts
@@ -8,7 +8,7 @@ import {
 import { Revalidator } from "@/server/revalidator";
 import { getDocsDomainNode, getHostNode } from "@/server/xfernhost/node";
 import { NodeCollector } from "@fern-api/fdr-sdk/navigation";
-import { getFeatureFlags } from "@fern-docs/edge-config";
+import { getEdgeFlags } from "@fern-docs/edge-config";
 import { withoutStaging } from "@fern-docs/utils";
 import type { FernDocs } from "@fern-fern/fern-docs-sdk";
 import { NextApiHandler, NextApiRequest, NextApiResponse } from "next";
@@ -53,8 +53,8 @@ const handler: NextApiHandler = async (
 
   // never provide a token here because revalidation should only be done on public routes (for now)
   const loader = DocsLoader.for(domain, host);
-  const flags = await getFeatureFlags(domain);
-  const root = await loader.withFeatureFlags(flags).root();
+  const flags = await getEdgeFlags(domain);
+  const root = await loader.withEdgeFlags(flags).root();
 
   if (!root) {
     /**