batches: remove rollout windows config from jscontext and DropdownBut…

…ton (sourcegraph#51752)

Co-authored-by: Kelli Rockwell <kelli@sourcegraph.com>

client/web/dev/utils/create-js-context.ts

@@ -75,7 +75,6 @@ export const createJsContext = ({ sourcegraphBaseUrl }: { sourcegraphBaseUrl: st
         },
         embeddingsEnabled: false,
         primaryLoginProvidersCount: 5,
-        batchChangesRolloutWindows: null,
         // Site-config overrides default JS context
         ...siteConfig,
     }

client/web/src/enterprise/batches/DropdownButton.story.tsx

@@ -1,8 +1,13 @@
 import { DecoratorFn, Meta, Story } from '@storybook/react'
 
+import { getDocumentNode } from '@sourcegraph/http-client'
+import { MockedTestProvider } from '@sourcegraph/shared/src/testing/apollo'
+
 import { WebStory } from '../../components/WebStory'
 
+import { BATCH_CHANGES_SITE_CONFIGURATION } from './backend'
 import { Action, DropdownButton } from './DropdownButton'
+import { rolloutWindowConfigMockResult, noRolloutWindowMockResult } from './mocks'
 
 // eslint-disable-next-line @typescript-eslint/require-await
 const onTrigger = async (onDone: () => void) => onDone()
@@ -33,6 +38,15 @@ const experimentalAction: Action = {
     experimental: true,
 }
 
+const publishAction: Action = {
+    type: 'publish',
+    buttonLabel: 'Publish Changeset',
+    dropdownTitle: 'Publish Changeset',
+    dropdownDescription: 'Attempt to publish all changesets to the code hosts.',
+    onTrigger,
+    experimental: false,
+}
+
 const decorator: DecoratorFn = story => <div className="p-3 container">{story()}</div>
 
 const config: Meta = {
@@ -64,15 +78,64 @@ export const SingleAction: Story = args => <WebStory>{() => <DropdownButton acti
 SingleAction.storyName = 'Single action'
 
 export const MultipleActionsWithoutDefault: Story = args => (
-    <WebStory>{() => <DropdownButton actions={[action, disabledAction, experimentalAction]} {...args} />}</WebStory>
+    <WebStory>
+        {() => (
+            <MockedTestProvider
+                mocks={[
+                    {
+                        request: {
+                            query: getDocumentNode(BATCH_CHANGES_SITE_CONFIGURATION),
+                        },
+                        result: noRolloutWindowMockResult,
+                    },
+                ]}
+            >
+                <DropdownButton actions={[action, disabledAction, experimentalAction, publishAction]} {...args} />
+            </MockedTestProvider>
+        )}
+    </WebStory>
 )
 
 MultipleActionsWithoutDefault.storyName = 'Multiple actions without default'
 
 export const MultipleActionsWithDefault: Story = args => (
     <WebStory>
-        {() => <DropdownButton actions={[action, disabledAction, experimentalAction]} defaultAction={0} {...args} />}
+        {() => (
+            <MockedTestProvider
+                mocks={[
+                    {
+                        request: {
+                            query: getDocumentNode(BATCH_CHANGES_SITE_CONFIGURATION),
+                        },
+                        result: noRolloutWindowMockResult,
+                    },
+                ]}
+            >
+                <DropdownButton actions={[action, disabledAction, experimentalAction]} defaultAction={0} {...args} />
+            </MockedTestProvider>
+        )}
     </WebStory>
 )
 
 MultipleActionsWithDefault.storyName = 'Multiple actions with default'
+
+export const PublishActionWithRolloutWindowConfigured: Story = args => (
+    <WebStory>
+        {() => (
+            <MockedTestProvider
+                mocks={[
+                    {
+                        request: {
+                            query: getDocumentNode(BATCH_CHANGES_SITE_CONFIGURATION),
+                        },
+                        result: rolloutWindowConfigMockResult,
+                    },
+                ]}
+            >
+                <DropdownButton actions={[action, publishAction]} defaultAction={0} {...args} />
+            </MockedTestProvider>
+        )}
+    </WebStory>
+)
+
+PublishActionWithRolloutWindowConfigured.storyName = 'Publish Action with rollout window configured'

client/web/src/enterprise/batches/DropdownButton.tsx

@@ -18,6 +18,8 @@ import {
     Icon,
 } from '@sourcegraph/wildcard'
 
+import { useBatchChangesRolloutWindowConfig } from './backend'
+
 import styles from './DropdownButton.module.scss'
 
 export interface Action {
@@ -169,11 +171,11 @@ const DropdownItem: React.FunctionComponent<React.PropsWithChildren<DropdownItem
     action,
     setSelectedType,
 }) => {
+    const { rolloutWindowConfig, loading } = useBatchChangesRolloutWindowConfig()
     const onSelect = useCallback(() => {
         setSelectedType(action.type)
     }, [setSelectedType, action.type])
-
-    const { batchChangesRolloutWindows } = window.context
+    const shouldDisplayRolloutInfo = action.type === 'publish' && rolloutWindowConfig && rolloutWindowConfig.length > 0
 
     return (
         <MenuItem className={styles.menuListItem} onSelect={onSelect} disabled={action.disabled}>
@@ -187,17 +189,18 @@ const DropdownItem: React.FunctionComponent<React.PropsWithChildren<DropdownItem
                 )}
             </H4>
             <Text className="text-wrap text-muted mb-0">
-                {action.type === 'publish' && batchChangesRolloutWindows && batchChangesRolloutWindows.length > 0 ? (
-                    <small>
-                        {action.dropdownDescription} <br />
-                        <b>
-                            Note: Rollout windows have been set up by the admin. This means that some of the selected
-                            changesets won't be processed until a time in the future.
-                        </b>{' '}
-                    </small>
-                ) : (
-                    <small>{action.dropdownDescription}</small>
-                )}
+                <small>
+                    {action.dropdownDescription}
+                    {!loading && shouldDisplayRolloutInfo && (
+                        <>
+                            <br />
+                            <strong>
+                                Note: Rollout windows have been set up by the admin. This means that some of the
+                                selected changesets won't be processed until a time in the future.
+                            </strong>
+                        </>
+                    )}
+                </small>
             </Text>
         </MenuItem>
     )

client/web/src/enterprise/batches/backend.ts

@@ -1,8 +1,12 @@
-import { QueryResult } from '@apollo/client'
+import { useMemo } from 'react'
+
+import { ApolloError } from '@apollo/client'
+import * as jsonc from 'jsonc-parser'
 import { Observable } from 'rxjs'
 import { map } from 'rxjs/operators'
 
 import { dataOrThrowErrors, gql, useQuery } from '@sourcegraph/http-client'
+import { BatchChangeRolloutWindow, SiteConfiguration } from '@sourcegraph/shared/src/schema/site.schema'
 
 import { requestGraphQL } from '../../backend/graphql'
 import {
@@ -212,10 +216,27 @@ export const BATCH_CHANGES_SITE_CONFIGURATION = gql`
     }
 `
 
-export const useGetBatchChangesSiteConfiguration = (): QueryResult<
-    BatchChangesSiteConfigurationResult,
-    BatchChangesSiteConfigurationVariables
-> =>
-    useQuery(BATCH_CHANGES_SITE_CONFIGURATION, {
+interface useGetBatchChangesSiteConfigurationResult {
+    loading: boolean
+    error: ApolloError | undefined
+    rolloutWindowConfig: BatchChangeRolloutWindow[]
+}
+
+export const useBatchChangesRolloutWindowConfig = (): useGetBatchChangesSiteConfigurationResult => {
+    const { loading, error, data } = useQuery<
+        BatchChangesSiteConfigurationResult,
+        BatchChangesSiteConfigurationVariables
+    >(BATCH_CHANGES_SITE_CONFIGURATION, {
         fetchPolicy: 'cache-first',
     })
+
+    const rolloutWindowConfig: BatchChangeRolloutWindow[] = useMemo(() => {
+        if (!data) {
+            return []
+        }
+        const siteConfig = jsonc.parse(data.site.configuration.effectiveContents) as SiteConfiguration
+        return siteConfig['batchChanges.rolloutWindows'] || []
+    }, [data])
+
+    return { loading, error, rolloutWindowConfig }
+}

client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.story.tsx

@@ -11,10 +11,10 @@ import {
     UserBatchChangesCodeHostsResult,
 } from '../../../graphql-operations'
 import { BATCH_CHANGES_SITE_CONFIGURATION } from '../backend'
+import { noRolloutWindowMockResult, rolloutWindowConfigMockResult } from '../mocks'
 
 import { USER_CODE_HOSTS } from './backend'
 import { BatchChangesSettingsArea } from './BatchChangesSettingsArea'
-import { noRolloutWindowMockResult, rolloutWindowConfigMockResult } from './mocks'
 
 const decorator: DecoratorFn = story => <div className="p-3 container">{story()}</div>
 

client/web/src/enterprise/batches/settings/RolloutWindowsConfiguration.story.tsx

@@ -5,8 +5,8 @@ import { MockedTestProvider } from '@sourcegraph/shared/src/testing/apollo'
 
 import { WebStory } from '../../../components/WebStory'
 import { BATCH_CHANGES_SITE_CONFIGURATION } from '../backend'
+import { noRolloutWindowMockResult, rolloutWindowConfigMockResult } from '../mocks'
 
-import { noRolloutWindowMockResult, rolloutWindowConfigMockResult } from './mocks'
 import { RolloutWindowsConfiguration } from './RolloutWindowsConfiguration'
 
 const decorator: DecoratorFn = story => <div className="p-3 container">{story()}</div>

client/web/src/enterprise/batches/settings/RolloutWindowsConfiguration.tsx

@@ -1,35 +1,26 @@
-import React, { useEffect, useState } from 'react'
+import React from 'react'
 
 import { mdiPulse } from '@mdi/js'
-import * as jsonc from 'jsonc-parser'
 
-import { BatchChangeRolloutWindow } from '@sourcegraph/shared/src/schema/site.schema'
 import { Text, H3, Container, Icon, LoadingSpinner, ErrorAlert, Link } from '@sourcegraph/wildcard'
 
-import { useGetBatchChangesSiteConfiguration } from '../backend'
+import { useBatchChangesRolloutWindowConfig } from '../backend'
 
 import { formatRate, formatDays } from './format'
 
 import styles from './RolloutWindowsConfiguration.module.scss'
 
 // Displays the rollout window configuration.
 export const RolloutWindowsConfiguration: React.FunctionComponent = () => {
-    const [rolloutWindows, setRolloutWindows] = useState<BatchChangeRolloutWindow[]>([])
-    const { loading, error, data } = useGetBatchChangesSiteConfiguration()
-    useEffect(() => {
-        if (data) {
-            const siteConfig = jsonc.parse(data.site.configuration.effectiveContents)
-            setRolloutWindows(siteConfig['batchChanges.rolloutWindows'] || [])
-        }
-    }, [data])
+    const { loading, error, rolloutWindowConfig } = useBatchChangesRolloutWindowConfig()
     return (
         <Container className="mb-3">
             <H3>Rollout Windows</H3>
             {loading && <LoadingSpinner />}
             {error && <ErrorAlert error={error} />}
             {!loading &&
-                data &&
-                (rolloutWindows.length === 0 ? (
+                rolloutWindowConfig &&
+                (rolloutWindowConfig.length === 0 ? (
                     <Text className="mb-0">
                         No rollout windows configured for changesets. Learn how to configure them in{' '}
                         <Link to="/help/admin/config/batch_changes#rollout-windows" target="_blank">
@@ -48,7 +39,7 @@ export const RolloutWindowsConfiguration: React.FunctionComponent = () => {
                             </Link>
                         </Text>
                         <ul className={styles.rolloutWindowList}>
-                            {rolloutWindows.map((rolloutWindow, index) => (
+                            {rolloutWindowConfig.map((rolloutWindow, index) => (
                                 <li key={index} className={styles.rolloutWindowListItem}>
                                     <Text className={styles.rolloutWindowListItemFrequency}>
                                         <Icon

client/web/src/integration/jscontext.ts

@@ -57,5 +57,4 @@ export const createJsContext = ({ sourcegraphBaseUrl }: { sourcegraphBaseUrl: st
     runningOnMacOS: true,
     srcServeGitUrl: 'http://127.0.0.1:3434',
     primaryLoginProvidersCount: 5,
-    batchChangesRolloutWindows: null,
 })

client/web/src/jscontext.ts

@@ -1,5 +1,5 @@
 import { AuthenticatedUser } from '@sourcegraph/shared/src/auth'
-import { SiteConfiguration, BatchChangeRolloutWindow } from '@sourcegraph/shared/src/schema/site.schema'
+import { SiteConfiguration } from '@sourcegraph/shared/src/schema/site.schema'
 
 import { TemporarySettingsResult } from './graphql-operations'
 
@@ -174,8 +174,6 @@ export interface SourcegraphContext extends Pick<Required<SiteConfiguration>, 'e
 
     batchChangesWebhookLogsEnabled: boolean
 
-    batchChangesRolloutWindows: BatchChangeRolloutWindow[] | null
-
     /** Whether cody is enabled for the user. */
     codyEnabled: boolean
 

cmd/frontend/internal/app/jscontext/jscontext.go

@@ -176,10 +176,9 @@ type JSContext struct {
 	//   the request is an admin and thus can access batch changes
 	// It does NOT reflect whether or not the site license has batch changes available.
 	// Use LicenseInfo for that.
-	BatchChangesEnabled                bool                                `json:"batchChangesEnabled"`
-	BatchChangesDisableWebhooksWarning bool                                `json:"batchChangesDisableWebhooksWarning"`
-	BatchChangesWebhookLogsEnabled     bool                                `json:"batchChangesWebhookLogsEnabled"`
-	BatchChangesRolloutWindows         *[]*schema.BatchChangeRolloutWindow `json:"batchChangesRolloutWindows"`
+	BatchChangesEnabled                bool `json:"batchChangesEnabled"`
+	BatchChangesDisableWebhooksWarning bool `json:"batchChangesDisableWebhooksWarning"`
+	BatchChangesWebhookLogsEnabled     bool `json:"batchChangesWebhookLogsEnabled"`
 
 	CodyEnabled bool `json:"codyEnabled"`
 
@@ -360,7 +359,6 @@ func NewJSContextFromRequest(req *http.Request, db database.DB) JSContext {
 		BatchChangesEnabled:                enterprise.BatchChangesEnabledForUser(ctx, db) == nil,
 		BatchChangesDisableWebhooksWarning: conf.Get().BatchChangesDisableWebhooksWarning,
 		BatchChangesWebhookLogsEnabled:     webhooks.LoggingEnabled(conf.Get()),
-		BatchChangesRolloutWindows:         conf.Get().BatchChangesRolloutWindows,
 
 		CodyEnabled: cody.IsCodyEnabled(ctx),