Merge pull request #36242 from github/repo-sync

Repo sync

Author: docs-bot

src/events/components/events.ts

@@ -116,7 +116,10 @@ export function sendEvent<T extends EventType>({
       os_preference: Cookies.get('osPreferred'),
       code_display_preference: Cookies.get('annotate-mode'),
 
-      experiment_variation: getExperimentVariationForContext(getMetaContent('path-language')),
+      experiment_variation: getExperimentVariationForContext(
+        getMetaContent('path-language'),
+        getMetaContent('path-version'),
+      ),
 
       // Event grouping
       event_group_key: eventGroupKey,

src/events/components/experiments/README.md

@@ -68,19 +68,14 @@ In the code that displays the search bar, you can use the `shouldShowExperiment`
 Example:
 
 ```typescript
-import { useRouter } from 'next/router'
 import { useShouldShowExperiment } from '@/events/components/experiments/useShouldShowExperiment'
 import { EXPERIMENTS } from '@/events/components/experiments/experiments'
 import { ClassicSearchBar } from "@/search/components/ClassicSearchBar.tsx"
 import { NewSearchBar } from "@/search/components/NewSearchBar.tsx"
 
 export function SearchBar() {
-  const router = useRouter()
   // Users who were randomly placed in the `treatment` group will be shown the experiment
-  const { shouldShow: shouldShowNewSearch } = useShouldShowExperiment(
-    EXPERIMENTS.ai_search_experiment,
-    router.locale
-  )
+  const { shouldShow: shouldShowNewSearch } = useShouldShowExperiment(EXPERIMENTS.ai_search_experiment)
 
   if (shouldShowNewSearch) {
     return (

src/events/components/experiments/experiment.ts

@@ -1,6 +1,7 @@
 import murmur from 'imurmurhash'
 import {
   CONTROL_VARIATION,
+  EXPERIMENTS,
   ExperimentNames,
   TREATMENT_VARIATION,
   getActiveExperiments,
@@ -12,6 +13,7 @@ let experimentsInitialized = false
 export function shouldShowExperiment(
   experimentKey: ExperimentNames | { key: ExperimentNames },
   locale: string,
+  version: string,
   isStaff: boolean,
 ) {
   // Accept either EXPERIMENTS.<experiment_key> or EXPERIMENTS.<experiment_key>.key
@@ -40,8 +42,10 @@ export function shouldShowExperiment(
         return controlGroup === TREATMENT_VARIATION
         // Otherwise use the regular logic to determine if the user is in the treatment group
       } else if (
-        experiment.limitToLanguages?.length &&
-        experiment.limitToLanguages.includes(locale)
+        (experiment.limitToLanguages?.length
+          ? experiment.limitToLanguages.includes(locale)
+          : true) &&
+        (experiment.limitToVersions?.length ? experiment.limitToVersions.includes(version) : true)
       ) {
         return (
           getExperimentControlGroupFromSession(
@@ -98,8 +102,8 @@ export function getExperimentControlGroupFromSession(
   return modHash < percentToGetExperiment ? TREATMENT_VARIATION : CONTROL_VARIATION
 }
 
-export function getExperimentVariationForContext(locale: string): string {
-  const experiments = getActiveExperiments(locale)
+export function getExperimentVariationForContext(locale: string, version: string): string {
+  const experiments = getActiveExperiments(locale, version)
   for (const experiment of experiments) {
     if (experiment.includeVariationInContext) {
       return getExperimentControlGroupFromSession(
@@ -113,11 +117,38 @@ export function getExperimentVariationForContext(locale: string): string {
   return ''
 }
 
-export function initializeExperiments(locale: string) {
+export function initializeExperiments(
+  locale: string,
+  currentVersion: string,
+  allVersions: { [key: string]: { version: string } },
+) {
   if (experimentsInitialized) return
   experimentsInitialized = true
 
-  const experiments = getActiveExperiments(locale)
+  // Replace any occurrence of 'enterprise-server@latest' with the actual latest version
+  for (const [experimentKey, experiment] of Object.entries(EXPERIMENTS)) {
+    if (experiment.limitToVersions?.includes('enterprise-server@latest')) {
+      // Sort the versions in descending order so that the latest enterprise-server version is first
+      const latestEnterpriseServerVersion = Object.keys(allVersions)
+        .filter((version) => version.startsWith('enterprise-server@'))
+        .sort((a, b) => {
+          const aVersion = a.split('@')[1]
+          const bVersion = b.split('@')[1]
+          return Number(bVersion) - Number(aVersion)
+        })[0]
+      if (latestEnterpriseServerVersion) {
+        EXPERIMENTS[experimentKey as ExperimentNames].limitToVersions =
+          experiment.limitToVersions.map((version) =>
+            version.replace(
+              'enterprise-server@latest',
+              allVersions[latestEnterpriseServerVersion].version,
+            ),
+          )
+      }
+    }
+  }
+
+  const experiments = getActiveExperiments(locale, currentVersion)
 
   if (experiments.length && process.env.NODE_ENV === 'development') {
     console.log(

src/events/components/experiments/experiments.ts

@@ -9,6 +9,7 @@ type Experiment = {
   // Only one experiment's control group (variation) can be included in the context at a time
   includeVariationInContext?: boolean
   limitToLanguages?: string[]
+  limitToVersions?: string[]
   alwaysShowForStaff: boolean
 }
 
@@ -22,6 +23,11 @@ export const EXPERIMENTS = {
     percentOfUsersToGetExperiment: 0, // 10% of users will get the experiment
     includeVariationInContext: true, // All events will include the `experiment_variation` of the `ai_search_experiment`
     limitToLanguages: ['en'], // Only users with the `en` language will be included in the experiment
+    limitToVersions: [
+      'free-pro-team@latest',
+      'enterprise-cloud@latest',
+      'enterprise-server@latest',
+    ], // Only enable for versions
     alwaysShowForStaff: false, // When set to true, staff will always see the experiment (determined by the `staffonly` cookie)
   },
   /*  Add new experiments here, example:
@@ -31,17 +37,37 @@ export const EXPERIMENTS = {
       percentOfUsersToGetExperiment: 10, // 10% of users will randomly get the experiment
       includeVariationInContext: true, // All events will include the `experiment_variation` of the `example_experiment`
       limitToLanguages: ['en'], // Only users with the `en` language will be included in the experiment
+      limitToVersions: [
+        'free-pro-team@latest',
+        'enterprise-cloud@latest',
+        'enterprise-server@latest',
+      ], // Only enable for the latest versions
       alwaysShowForStaff: true, // When set to true, staff will always see the experiment (determined by the `staffonly` cookie)
     }
   */
 } as Record<ExperimentNames, Experiment>
 
-export function getActiveExperiments(locale: string): Experiment[] {
+export function getActiveExperiments(locale: string, version?: string): Experiment[] {
   return Object.values(EXPERIMENTS).filter((experiment) => {
-    return (
-      experiment.isActive &&
-      (locale === 'all' ||
-        (experiment.limitToLanguages?.length ? experiment.limitToLanguages.includes(locale) : true))
-    )
+    if (locale === 'all') {
+      return true
+    }
+
+    let include = true
+    if (!experiment.isActive) {
+      include = false
+    }
+
+    // Only include experiment if it's supported for the current language
+    if (experiment.limitToLanguages?.length && !experiment.limitToLanguages.includes(locale)) {
+      include = false
+    }
+
+    // Only include experiment if it's supported for the current version
+    if (experiment.limitToVersions?.length && !experiment.limitToVersions.includes(version || '')) {
+      include = false
+    }
+
+    return include
   })
 }

src/events/components/experiments/useShouldShowExperiment.ts

@@ -1,22 +1,30 @@
 import { useEffect, useState } from 'react'
+import { useRouter } from 'next/router'
 import { shouldShowExperiment } from './experiment'
 import { ExperimentNames } from './experiments'
 import { getIsStaff } from '../dotcom-cookies'
+import { useMainContext } from '@/frame/components/context/MainContext'
 
-export function useShouldShowExperiment(
-  experimentKey: ExperimentNames | { key: ExperimentNames },
-  locale: string,
-) {
+export function useShouldShowExperiment(experimentKey: ExperimentNames | { key: ExperimentNames }) {
   if (typeof experimentKey === 'object') {
     experimentKey = experimentKey.key
   }
 
   const [showExperiment, setShowExperiment] = useState(false)
+  const router = useRouter()
+  const mainContext = useMainContext()
 
   useEffect(() => {
     const updateShouldShow = async () => {
       const isStaff = await getIsStaff()
-      setShowExperiment(shouldShowExperiment(experimentKey, locale, isStaff))
+      setShowExperiment(
+        shouldShowExperiment(
+          experimentKey,
+          router.locale || '',
+          mainContext.currentVersion || '',
+          isStaff,
+        ),
+      )
     }
 
     updateShouldShow()
@@ -27,7 +35,7 @@ export function useShouldShowExperiment(
     return () => {
       window.removeEventListener('controlGroupOverrideChanged', updateShouldShow)
     }
-  }, [experimentKey])
+  }, [experimentKey, router.locale, mainContext.currentVersion])
 
   return showExperiment
 }

src/frame/components/page-header/Header.tsx

@@ -51,10 +51,7 @@ export const Header = () => {
   const { width } = useInnerWindowWidth()
   const returnFocusRef = useRef(null)
 
-  const showNewSearch = useShouldShowExperiment(
-    EXPERIMENTS.ai_search_experiment,
-    router.locale as string,
-  )
+  const showNewSearch = useShouldShowExperiment(EXPERIMENTS.ai_search_experiment)
 
   useEffect(() => {
     function onScroll() {

src/frame/pages/app.tsx

@@ -25,7 +25,11 @@ const MyApp = ({ Component, pageProps, languagesContext }: MyAppProps) => {
 
   useEffect(() => {
     initializeEvents()
-    initializeExperiments(router.locale as string)
+    initializeExperiments(
+      router.locale as string,
+      pageProps.mainContext.currentVersion,
+      pageProps.mainContext.allVersions,
+    )
   }, [])
 
   useEffect(() => {

src/search/components/helpers/ai-search-links-json.ts

@@ -53,7 +53,16 @@ function extractMarkdownLinks(markdownResponse: string) {
     urls.push(match[2])
   }
 
-  return urls
+  // Filter out any invalid URLs
+  return urls.filter((url) => {
+    try {
+      new URL(url)
+      return true
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    } catch (e) {
+      return false
+    }
+  })
 }
 
 // Given a Docs URL, extract the product name