feat: enable configuring custom environments for launchdarkly

fern-api · Jan 15, 2025 · 658789b · 658789b
1 parent 5c43336
commit 658789b
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 3 deletions.
diff --git a/packages/fern-docs/bundle/src/server/ld-adapter.ts b/packages/fern-docs/bundle/src/server/ld-adapter.ts
@@ -48,6 +48,13 @@ interface LaunchDarklyInfo {
   contextEndpoint: string;
   context: ld.LDContext | undefined;
   defaultFlags: Record<string, unknown> | undefined;
+  options:
+    | {
+        baseUrl?: string;
+        streamUrl?: string;
+        eventsUrl?: string;
+      }
+    | undefined;
 }
 
 export async function withLaunchDarkly(
@@ -69,15 +76,21 @@ export async function withLaunchDarkly(
       node,
       rawCookie
     );
+    const options = {
+      baseUrl: launchDarklyConfig.options?.["base-url"],
+      streamUrl: launchDarklyConfig.options?.["stream-url"],
+      eventsUrl: launchDarklyConfig.options?.["events-url"],
+    };
     const defaultFlags = launchDarklyConfig["sdk-key"]
-      ? await fetchInitialFlags(launchDarklyConfig["sdk-key"], context)
+      ? await fetchInitialFlags(launchDarklyConfig["sdk-key"], context, options)
       : undefined;
     return [
       {
         clientSideId: launchDarklyConfig["client-side-id"],
         contextEndpoint: launchDarklyConfig["context-endpoint"],
         context,
         defaultFlags,
+        options,
       },
       // Note: if sdk-key is set, then middleware will automatically switch to 100% getServerSideProps
       // because getServerSideProps must determine whether any given page should be rendered or not.
@@ -122,10 +135,19 @@ export const createLdPredicate = async ({
 
 function fetchInitialFlags(
   sdkKey: string,
-  context: ld.LDContext
+  context: ld.LDContext,
+  options?: {
+    baseUrl?: string;
+    streamUrl?: string;
+    eventsUrl?: string;
+  }
 ): Promise<Record<string, unknown>> | undefined {
   try {
-    const ldClient = ld.init(sdkKey);
+    const ldClient = ld.init(sdkKey, {
+      baseUri: options?.baseUrl,
+      streamUri: options?.streamUrl,
+      eventsUri: options?.eventsUrl,
+    });
     return ldClient.allFlagsState(context).then((flags) => flags.allValues());
   } catch (error) {
     console.error(error);

diff --git a/packages/fern-docs/edge-config/src/getLaunchDarklySettings.ts b/packages/fern-docs/edge-config/src/getLaunchDarklySettings.ts
@@ -11,6 +11,14 @@ const LaunchDarklyEdgeConfigSchema = z.object({
   // we should add a check to make sure the target domain is trusted. Trust should always be granted manually by a fern engineer,
   // so it should be managed in edge config, or FGA.
   "context-endpoint": z.string(),
+
+  options: z
+    .object({
+      "base-url": z.string().optional(),
+      "stream-url": z.string().optional(),
+      "events-url": z.string().optional(),
+    })
+    .optional(),
 });
 
 export type LaunchDarklyEdgeConfig = z.infer<

diff --git a/packages/fern-docs/ui/src/atoms/types.ts b/packages/fern-docs/ui/src/atoms/types.ts
@@ -57,6 +57,13 @@ export interface LaunchDarklyInfo {
   contextEndpoint: string;
   context: LDContext | undefined;
   defaultFlags: Record<string, unknown> | undefined;
+  options:
+    | {
+        baseUrl: string | undefined;
+        streamUrl: string | undefined;
+        eventsUrl: string | undefined;
+      }
+    | undefined;
 }
 
 export interface FeatureFlagsConfig {

diff --git a/packages/fern-docs/ui/src/feature-flags/FeatureFlagProvider.tsx b/packages/fern-docs/ui/src/feature-flags/FeatureFlagProvider.tsx
@@ -29,6 +29,7 @@ export const FeatureFlagProvider: FC<FeatureFlagProviderProps> = ({
       contextEndpoint={launchDarklyInfo.contextEndpoint}
       defaultContext={launchDarklyInfo.context}
       defaultFlags={launchDarklyInfo.defaultFlags}
+      options={launchDarklyInfo.options}
     >
       {children}
     </LDFeatureFlagProvider>

diff --git a/packages/fern-docs/ui/src/feature-flags/LDFeatureFlagProvider.tsx b/packages/fern-docs/ui/src/feature-flags/LDFeatureFlagProvider.tsx
@@ -23,20 +23,28 @@ interface Props extends PropsWithChildren {
   defaultContext?: LDContext;
 
   defaultFlags?: Record<string, unknown>;
+
+  options?: {
+    baseUrl?: string;
+    streamUrl?: string;
+    eventsUrl?: string;
+  };
 }
 
 export const LDFeatureFlagProvider: FC<Props> = ({
   clientSideId,
   contextEndpoint,
   defaultContext,
   defaultFlags,
+  options,
   children,
 }) => {
   return (
     <LDProvider
       clientSideID={clientSideId}
       context={defaultContext}
       flags={defaultFlags}
+      options={options}
     >
       <IdentifyWrapper
         contextEndpoint={contextEndpoint}