Add disableAnalytics setting to DocsSettingsConfig (#4426)

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Colton Berry <[email protected]>

Author: devin-ai-integration[bot]

fern/apis/fdr/definition/docs/v1/commons/commons.yml

@@ -234,6 +234,7 @@ types:
     properties:
       searchText: optional<string>
       disableSearch: optional<boolean>
+      disableAnalytics: optional<boolean>
       darkModeCode: optional<boolean>
       defaultSearchFilters: optional<boolean>
       httpSnippets: optional<HttpSnippetsConfig>

packages/commons/docs-loader/src/readonly-docs-loader.ts

@@ -600,6 +600,7 @@ const getSettings = (cacheConfig: Required<CacheConfig>) =>
             darkModeCode: settings?.darkModeCode ?? false,
             defaultSearchFilters: settings?.defaultSearchFilters ?? false,
             disableSearch: settings?.disableSearch ?? false,
+            disableAnalytics: settings?.disableAnalytics ?? false,
             hide404Page: settings?.hide404Page ?? false,
             httpSnippets: settings?.httpSnippets ?? true,
             searchText: settings?.searchText ?? "Search",

packages/commons/docs-utils/src/types/settings-config.ts

@@ -29,6 +29,7 @@ export type HttpSnippetsConfig = boolean | HttpSnippetLanguage[];
 export interface FernSettingsConfig {
     searchText: string | undefined;
     disableSearch: boolean | undefined;
+    disableAnalytics: boolean | undefined;
     darkModeCode: boolean | undefined;
     defaultSearchFilters: boolean | undefined;
     httpSnippets: HttpSnippetsConfig | undefined;

packages/fdr-sdk/src/client/generated/api/resources/docs/resources/v1/resources/commons/resources/commons/types/DocsSettingsConfig.ts

@@ -96,7 +96,7 @@ export default async function Layout({
             <RootNodeProvider sidebarRootNodesToChildToParentsMap={sidebarRootNodesToChildToParentsMap}>
                 <Domain value={domain} />
                 <SetBasePath value={basePath || "/"} />
-                {!isSelfHosted() && (
+                {!isSelfHosted() && !settings.disableAnalytics && (
                     <>
                         <Script
                             data-endpoint={`${basePath ?? ""}/_vercel/insights`}
@@ -133,10 +133,12 @@ export default async function Layout({
                 />
                 <FeatureFlagProvider featureFlagsConfig={{ launchDarkly }}>{children}</FeatureFlagProvider>
                 <React.Suspense fallback={null}>
-                    {!isLocalEnvironment && !settings.disableSearch && <SearchV2 domain={domain} />}
+                    {!isLocalEnvironment && !settings.disableSearch && (
+                        <SearchV2 domain={domain} disableAnalytics={settings.disableAnalytics} />
+                    )}
                 </React.Suspense>
                 {jsConfig != null && <JavascriptProvider config={jsConfig} />}
-                {VERCEL_ENV === "production" && (
+                {VERCEL_ENV === "production" && !settings.disableAnalytics && (
                     <CustomerAnalytics
                         config={mergeCustomerAnalytics(deprecated_customerAnalytics, config.analyticsConfig)}
                     />

packages/fern-docs/bundle/src/app/[host]/[domain]/layout.tsx

@@ -66,7 +66,13 @@ export function useQueryId() {
     };
 }
 
-export const SearchV2 = React.memo(function SearchV2({ domain }: { domain: string }) {
+export const SearchV2 = React.memo(function SearchV2({
+    domain,
+    disableAnalytics
+}: {
+    domain: string;
+    disableAnalytics?: boolean;
+}) {
     const currentVersion = useCurrentVersionId();
 
     const isDarkCodeEnabled = useIsDarkCode();
@@ -183,7 +189,7 @@ export const SearchV2 = React.memo(function SearchV2({ domain }: { domain: strin
             fetchFacets={facetFetcher}
             authenticatedUserToken={user?.email}
             initialFilters={shouldApplyVersionFilter ? { "version.title": currentVersion } : undefined}
-            analyticsTags={["search-v2-dialog"]}
+            analyticsTags={disableAnalytics ? [] : ["search-v2-dialog"]}
         >
             <DesktopSearchDialog open={open} onOpenChange={setOpen}>
                 {isAskAiEnabled ? (