feature: add server-side feature flags (#2023)

Co-authored-by: Andrew Jiang <[email protected]>
fern-api · Jan 15, 2025 · 785f1e7 · 785f1e7
1 parent cddd818
commit 785f1e7
Show file tree

Hide file tree

Showing 59 changed files with 814 additions and 432 deletions.
diff --git a/fern/apis/fdr/definition/navigation/latest/__package__.yml b/fern/apis/fdr/definition/navigation/latest/__package__.yml
@@ -327,6 +327,7 @@ types:
     extends:
       - WithNodeId
       - WithPermissions
+      - WithFeatureFlags
     properties:
       title:
         type: string
@@ -373,6 +374,16 @@ types:
     properties:
       pointsTo: optional<Slug>
 
+  WithFeatureFlags:
+    properties:
+      featureFlags: optional<list<FeatureFlagOptions>>
+
+  FeatureFlagOptions:
+    properties:
+      flag: string
+      default: optional<unknown>
+      match: optional<unknown>
+
   BreadcrumbItem:
     properties:
       title: string

diff --git a/packages/fdr-sdk/src/__test__/__snapshots__/hume.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/hume.test.ts.snap
@@ -130,6 +130,7 @@ exports[`hume > gets navigation root for /support 1`] = `
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": false,
   "icon": undefined,
   "id": "root.uv.docs.docs.introduction.support",

diff --git a/packages/fdr-sdk/src/__test__/__snapshots__/no-version-no-tabs.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/no-version-no-tabs.test.ts.snap
@@ -23,6 +23,7 @@ exports[`no-version-no-tabs > gets navigation root for /docs/api/page-6 1`] = `
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root.uv.section-3.page-6",
@@ -51,6 +52,7 @@ exports[`no-version-no-tabs > gets navigation root for /docs/api/section-2 1`] =
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root.uv.section-2.page-3",

diff --git a/packages/fdr-sdk/src/__test__/__snapshots__/no-version-yes-tabs.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/no-version-yes-tabs.test.ts.snap
@@ -25,6 +25,7 @@ exports[`no-version-yes-tabs > gets navigation root for /docs/api/page-2 1`] = `
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root.uv.tab-1.tab-1.section-1.page-2",
@@ -54,6 +55,7 @@ exports[`no-version-yes-tabs > gets navigation root for /docs/api/tab-1 1`] = `
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root.uv.tab-1.tab-1.section-3.page-6",
@@ -75,6 +77,7 @@ exports[`no-version-yes-tabs > gets navigation root for /docs/api/tab-2 1`] = `
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root.uv.tab-2.tab-2.section-5.page-10",

diff --git a/packages/fdr-sdk/src/__test__/__snapshots__/polytomic.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/polytomic.test.ts.snap
@@ -897,6 +897,7 @@ exports[`polytomic > gets navigation root for /2024-02-08/guides/introduction 1`
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": false,
   "icon": undefined,
   "id": "root..2024-02-08.uv.guides.guides.getting-started.introduction",

diff --git a/packages/fdr-sdk/src/__test__/__snapshots__/primer.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/primer.test.ts.snap
@@ -161,6 +161,7 @@ exports[`primer > gets navigation root for /docs/api/v2.1/api-reference/client-s
   "availability": undefined,
   "canonicalSlug": "docs/api/v2.3/api-reference/client-session-api/retrieve-client-side-token",
   "endpointId": "subpackage_clientSessionApi.retrieveClientSideToken",
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root..v2.1.uv.api-reference.subpackage_clientSessionApi.subpackage_clientSessionApi.retrieveClientSideToken",

diff --git a/packages/fdr-sdk/src/__test__/__snapshots__/uploadcare.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/uploadcare.test.ts.snap
@@ -88,6 +88,7 @@ exports[`uploadcare > gets navigation root for /docs/file-management/overview 1`
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root.uv.docs.docs.file-management.overview",
@@ -123,6 +124,7 @@ exports[`uploadcare > gets navigation root for /docs/introduction/intro 1`] = `
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root.uv.docs.docs.introduction.intro",

diff --git a/packages/fdr-sdk/src/__test__/__snapshots__/yes-version-no-tabs.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/yes-version-no-tabs.test.ts.snap
@@ -69,6 +69,7 @@ exports[`yes-version-no-tabs > gets navigation root for /docs/api/version-1/page
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root..version-1.uv.section-3.page-5",
@@ -97,6 +98,7 @@ exports[`yes-version-no-tabs > gets navigation root for /docs/api/version-1/vers
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root..version-1.uv.section-3.page-6",
@@ -125,6 +127,7 @@ exports[`yes-version-no-tabs > gets navigation root for /docs/api/version-2/vers
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root..version-2.uv.section-5.page-9",

diff --git a/packages/fdr-sdk/src/__test__/__snapshots__/yes-version-yes-tabs.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/yes-version-yes-tabs.test.ts.snap
@@ -72,6 +72,7 @@ exports[`yes-version-yes-tabs > gets navigation root for /docs/api/version-1/sec
 {
   "authed": undefined,
   "canonicalSlug": undefined,
+  "featureFlags": undefined,
   "hidden": undefined,
   "icon": undefined,
   "id": "root..version-1.uv.tab-1.tab-1.section-2.page-3",

diff --git a/...rc/client/generated/api/resources/navigation/resources/latest/types/FeatureFlagOptions.ts b/...rc/client/generated/api/resources/navigation/resources/latest/types/FeatureFlagOptions.ts
diff --git a/.../src/client/generated/api/resources/navigation/resources/latest/types/WithFeatureFlags.ts b/.../src/client/generated/api/resources/navigation/resources/latest/types/WithFeatureFlags.ts
diff --git a/.../src/client/generated/api/resources/navigation/resources/latest/types/WithNodeMetadata.ts b/.../src/client/generated/api/resources/navigation/resources/latest/types/WithNodeMetadata.ts
diff --git a/...ges/fdr-sdk/src/client/generated/api/resources/navigation/resources/latest/types/index.ts b/...ges/fdr-sdk/src/client/generated/api/resources/navigation/resources/latest/types/index.ts
diff --git a/packages/fdr-sdk/src/navigation/migrators/v1ToV2.ts b/packages/fdr-sdk/src/navigation/migrators/v1ToV2.ts
@@ -36,6 +36,7 @@ export class FernNavigationV1ToLatest {
       viewers: node.viewers,
       orphaned: node.orphaned,
       roles: node.roles,
+      featureFlags: undefined,
     };
 
     return latest;
@@ -61,11 +62,11 @@ export class FernNavigationV1ToLatest {
     /**
      * the default version should be the preferred canonical slug
      */
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const defaultVersion = this.version(node.children[defaultVersionIdx]!, [
-      ...parents,
-      node,
-    ]);
+    const defaultVersionV1 = node.children[defaultVersionIdx];
+    if (!defaultVersionV1) {
+      throw new Error("default version is undefined");
+    }
+    const defaultVersion = this.version(defaultVersionV1, [...parents, node]);
 
     /**
      * visit the rest of the children, but splice the default version in its original position
@@ -118,6 +119,7 @@ export class FernNavigationV1ToLatest {
       pointsTo: node.pointsTo ? FernNavigation.Slug(node.pointsTo) : undefined,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -144,6 +146,7 @@ export class FernNavigationV1ToLatest {
       noindex: node.noindex,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -183,13 +186,14 @@ export class FernNavigationV1ToLatest {
       pointsTo: node.pointsTo ? FernNavigation.Slug(node.pointsTo) : undefined,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
 
   public link = (
     node: FernNavigation.V1.LinkNode,
-    parents: FernNavigation.V1.NavigationNode[]
+    _parents: FernNavigation.V1.NavigationNode[]
   ): FernNavigation.LinkNode => {
     const latest: FernNavigation.LinkNode = {
       type: "link",
@@ -247,11 +251,11 @@ export class FernNavigationV1ToLatest {
     /**
      * the default product should be the preferred canonical slug
      */
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const defaultProduct = this.product(node.children[defaultProductIdx]!, [
-      ...parents,
-      node,
-    ]);
+    const defaultProductV1 = node.children[defaultProductIdx];
+    if (!defaultProductV1) {
+      throw new Error("default product is undefined");
+    }
+    const defaultProduct = this.product(defaultProductV1, [...parents, node]);
 
     /**
      * visit the rest of the children, but splice the default product in its original position
@@ -300,6 +304,7 @@ export class FernNavigationV1ToLatest {
       subtitle: node.subtitle,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -358,6 +363,7 @@ export class FernNavigationV1ToLatest {
       noindex: node.noindex,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -395,6 +401,7 @@ export class FernNavigationV1ToLatest {
       noindex: node.noindex,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -440,6 +447,7 @@ export class FernNavigationV1ToLatest {
       pointsTo: node.pointsTo ? FernNavigation.Slug(node.pointsTo) : undefined,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -472,6 +480,7 @@ export class FernNavigationV1ToLatest {
       noindex: node.noindex,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -495,6 +504,7 @@ export class FernNavigationV1ToLatest {
       year: node.year,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -518,13 +528,14 @@ export class FernNavigationV1ToLatest {
       month: node.month,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
 
   public changelogEntry = (
     node: FernNavigation.V1.ChangelogEntryNode,
-    parents: FernNavigation.V1.NavigationNode[]
+    _parents: FernNavigation.V1.NavigationNode[]
   ): FernNavigation.ChangelogEntryNode => {
     const slug = FernNavigation.Slug(node.slug);
     // NOTE: do NOT use title disambiguation key here, since the title may not always be unique
@@ -543,6 +554,7 @@ export class FernNavigationV1ToLatest {
       noindex: node.noindex,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -582,6 +594,7 @@ export class FernNavigationV1ToLatest {
       availability: this.#availability(node.availability),
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -615,6 +628,7 @@ export class FernNavigationV1ToLatest {
       isResponseStream: node.isResponseStream,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -659,6 +673,7 @@ export class FernNavigationV1ToLatest {
       webSocketId: node.webSocketId,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };
@@ -690,6 +705,7 @@ export class FernNavigationV1ToLatest {
       webhookId: node.webhookId,
       viewers: node.viewers,
       orphaned: node.orphaned,
+      featureFlags: undefined,
     };
     return latest;
   };

diff --git a/packages/fdr-sdk/src/navigation/utils/__test__/followRedirects.test.ts b/packages/fdr-sdk/src/navigation/utils/__test__/followRedirects.test.ts
@@ -20,6 +20,7 @@ function sectionNode(
     overviewPageId: undefined,
     noindex: undefined,
     pointsTo: undefined,
+    featureFlags: undefined,
     ...section,
   };
 }
@@ -39,6 +40,7 @@ function pageNode(
     viewers: undefined,
     orphaned: undefined,
     noindex: undefined,
+    featureFlags: undefined,
     ...page,
   };
 }