fix(plg): add links to the user nav dropdown

client/web/BUILD.bazel

@@ -238,7 +238,7 @@ ts_project(
         "src/cody/management/UseCodyInEditorSection.tsx",
         "src/cody/management/api/client.ts",
         "src/cody/management/api/components/CodyProApiClient.ts",
-        "src/cody/management/api/react-query/QueryClientProvider.tsx",
+        "src/cody/management/api/react-query/CodyProApiProvider.tsx",
         "src/cody/management/api/react-query/callCodyProApi.ts",
         "src/cody/management/api/react-query/invites.ts",
         "src/cody/management/api/react-query/queryKeys.ts",
@@ -281,6 +281,7 @@ ts_project(
         "src/cody/upsell/vs-code.tsx",
         "src/cody/useCodyChat.tsx",
         "src/cody/useCodyIgnore.tsx",
+        "src/cody/useCodyProNavLinks.ts",
         "src/cody/util.ts",
         "src/cody/widgets/CodyRecipesWidget.tsx",
         "src/cody/widgets/components/Recipe.tsx",
@@ -1897,6 +1898,7 @@ ts_project(
         "src/codeintel/ReferencesPanel.test.tsx",
         "src/cody/team/TeamMemberList.test.ts",
         "src/cody/useCodyIgnore.test.ts",
+        "src/cody/useCodyProNavLinks.test.tsx",
         "src/components/ErrorBoundary.test.tsx",
         "src/components/FilteredConnection/FilteredConnection.test.tsx",
         "src/components/FilteredConnection/hooks/usePageSwitcherPagination.test.tsx",

client/web/src/LegacySourcegraphWebApp.tsx

@@ -41,6 +41,7 @@ import { WildcardThemeContext, type WildcardTheme } from '@sourcegraph/wildcard'
 import { authenticatedUser as authenticatedUserSubject, type AuthenticatedUser, authenticatedUserValue } from './auth'
 import { getWebGraphQLClient } from './backend/graphql'
 import { isBatchChangesExecutionEnabled } from './batches'
+import { CodyProApiProvider } from './cody/management/api/react-query/CodyProApiProvider'
 import { ComponentsComposer } from './components/ComponentsComposer'
 import { ErrorBoundary } from './components/ErrorBoundary'
 import { FeatureFlagsLocalOverrideAgent } from './featureFlags/FeatureFlagsProvider'
@@ -260,6 +261,7 @@ export class LegacySourcegraphWebApp extends React.Component<StaticAppConfig, Le
                     <SearchResultsCacheProvider />,
                     <SearchQueryStateStoreProvider useSearchQueryState={useNavbarQueryState} />,
                     <LegacyRouteContextProvider context={legacyContext} />,
+                    <CodyProApiProvider isSourcegraphDotCom={window.context.sourcegraphDotComMode} />,
                     /* eslint-enable react/no-children-prop, react/jsx-key */
                 ]}
             >

client/web/src/SourcegraphWebApp.tsx

@@ -29,6 +29,7 @@ import type { TelemetryV2Props } from '@sourcegraph/shared/src/telemetry'
 import { WildcardThemeContext, type WildcardTheme } from '@sourcegraph/wildcard'
 
 import { authenticatedUser as authenticatedUserSubject, type AuthenticatedUser, authenticatedUserValue } from './auth'
+import { CodyProApiProvider } from './cody/management/api/react-query/CodyProApiProvider'
 import { ComponentsComposer } from './components/ComponentsComposer'
 import { ErrorBoundary, RouteError } from './components/ErrorBoundary'
 import { FeatureFlagsLocalOverrideAgent } from './featureFlags/FeatureFlagsProvider'
@@ -283,6 +284,7 @@ export const SourcegraphWebApp: FC<SourcegraphWebAppProps> = props => {
                         ...props,
                     }}
                 />,
+                <CodyProApiProvider isSourcegraphDotCom={props.isSourcegraphDotCom} />,
                 /* eslint-enable react/no-children-prop, react/jsx-key */
             ]}
         >

client/web/src/cody/codyProRoutes.tsx

@@ -4,7 +4,6 @@ import { lazyComponent } from '@sourcegraph/shared/src/util/lazyComponent'
 
 import { type LegacyLayoutRouteContext, LegacyRoute } from '../LegacyRouteContext'
 
-import { QueryClientProvider } from './management/api/react-query/QueryClientProvider'
 import { isEmbeddedCodyProUIEnabled } from './util'
 
 export enum CodyProRoutes {
@@ -78,9 +77,5 @@ interface CodyProPageProps extends Pick<LegacyLayoutRouteContext, 'authenticated
  */
 const CodyProPage: React.FC<CodyProPageProps> = props => {
     const Component = routeComponents[props.path]
-    return (
-        <QueryClientProvider>
-            <Component authenticatedUser={props.authenticatedUser} telemetryRecorder={props.telemetryRecorder} />
-        </QueryClientProvider>
-    )
+    return <Component authenticatedUser={props.authenticatedUser} telemetryRecorder={props.telemetryRecorder} />
 }

client/web/src/cody/management/api/react-query/CodyProApiProvider.tsx

@@ -0,0 +1,32 @@
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
+
+// Tweak the default queries and mutations behavior.
+// See defaults here: https://tanstack.com/query/latest/docs/framework/react/guides/important-defaults
+const queryClient = new QueryClient({
+    defaultOptions: {
+        queries: {
+            // If query failed, it's not likely that refetching it will succeed, so don't retry.
+            retry: false,
+        },
+        mutations: {
+            // If query failed, it's not likely that refetching it will succeed, so don't retry.
+            retry: false,
+        },
+    },
+})
+
+/**
+ * CodyProApiProvider wraps its children with the react-query QueryClientProvider.
+ * It is used to access the Cody Pro API and is only utilized on dotcom.
+ * In enterprise mode, it simply passes through the children.
+ */
+export const CodyProApiProvider: React.FC<React.PropsWithChildren<{ isSourcegraphDotCom: boolean }>> = ({
+    isSourcegraphDotCom,
+    children,
+}) => {
+    if (!isSourcegraphDotCom) {
+        return <>{children}</>
+    }
+
+    return <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
+}

client/web/src/cody/management/subscription/manage/CodySubscriptionManagePage.tsx

@@ -20,7 +20,7 @@ import type { LegacyLayoutRouteContext } from '../../../../LegacyRouteContext'
 import { CodyProRoutes } from '../../../codyProRoutes'
 import { PageHeaderIcon } from '../../../components/PageHeaderIcon'
 import { USER_CODY_PLAN } from '../../../subscription/queries'
-import { useCurrentSubscription } from '../../api/react-query/subscriptions'
+import { useCurrentSubscription, useSubscriptionSummary } from '../../api/react-query/subscriptions'
 
 import { InvoiceHistory } from './InvoiceHistory'
 import { PaymentDetails } from './PaymentDetails'
@@ -38,6 +38,7 @@ const AuthenticatedCodySubscriptionManagePage: React.FC<Props> = ({ telemetryRec
         error: useCodyPlanError,
         data: userCodyPlanData,
     } = useQuery<UserCodyPlanResult, UserCodyPlanVariables>(USER_CODY_PLAN, {})
+    const subscriptionSummaryQuery = useSubscriptionSummary()
 
     useEffect(
         function recordViewEvent() {
@@ -46,7 +47,7 @@ const AuthenticatedCodySubscriptionManagePage: React.FC<Props> = ({ telemetryRec
         [telemetryRecorder]
     )
 
-    if (userCodyPlanLoading) {
+    if (userCodyPlanLoading || subscriptionSummaryQuery.isLoading) {
         return <LoadingSpinner />
     }
 
@@ -55,18 +56,32 @@ const AuthenticatedCodySubscriptionManagePage: React.FC<Props> = ({ telemetryRec
         return null
     }
 
+    if (subscriptionSummaryQuery.isError) {
+        logger.error('Failed to fetch Cody subscription summary', subscriptionSummaryQuery.error)
+        return null
+    }
+
     const subscriptionData = userCodyPlanData?.currentUser?.codySubscription
     if (!subscriptionData) {
         logger.error('Cody subscription data is not available.')
         return null
     }
 
+    if (!subscriptionSummaryQuery.data) {
+        logger.error('Cody subscription summary is not available.')
+        return null
+    }
+
     // This page only applies to users who have a Cody Pro subscription to manage.
     // Otherwise, direct them to the ./new page to sign up.
     if (subscriptionData.plan !== CodySubscriptionPlan.PRO) {
         return <Navigate to={CodyProRoutes.NewProSubscription} replace={true} />
     }
 
+    if (subscriptionSummaryQuery.data.userRole !== 'admin') {
+        return <Navigate to={CodyProRoutes.Manage} replace={true} />
+    }
+
     return (
         <Page className="d-flex flex-column">
             <PageTitle title="Manage subscription" />

client/web/src/cody/useCodyProNavLinks.test.tsx

@@ -0,0 +1,85 @@
+import { renderHook } from '@testing-library/react'
+import { vi, describe, afterEach, test, expect, beforeEach } from 'vitest'
+
+import { CodyProRoutes } from './codyProRoutes'
+import * as subscriptionQueries from './management/api/react-query/subscriptions'
+import type { SubscriptionSummary } from './management/api/teamSubscriptions'
+import { useCodyProNavLinks } from './useCodyProNavLinks'
+
+describe('useCodyProNavLinks', () => {
+    const useSubscriptionSummaryMock = vi.spyOn(subscriptionQueries, 'useSubscriptionSummary')
+
+    afterEach(() => {
+        useSubscriptionSummaryMock.mockReset()
+    })
+
+    const mockSubscriptionSummary = (summary?: SubscriptionSummary): void => {
+        useSubscriptionSummaryMock.mockReturnValue({ data: summary } as ReturnType<
+            typeof subscriptionQueries.useSubscriptionSummary
+        >)
+    }
+
+    test('returns empty array if subscription summary is undefined', () => {
+        mockSubscriptionSummary()
+        const { result } = renderHook(() => useCodyProNavLinks())
+        expect(result.current).toHaveLength(0)
+    })
+
+    test('returns empty array user is not admin', () => {
+        const summary: SubscriptionSummary = {
+            teamId: '018ff1b3-118c-7789-82e4-ab9106eed204',
+            userRole: 'member',
+            teamCurrentMembers: 2,
+            teamMaxMembers: 6,
+            subscriptionStatus: 'active',
+            cancelAtPeriodEnd: false,
+        }
+        mockSubscriptionSummary(summary)
+        const { result } = renderHook(() => useCodyProNavLinks())
+        expect(result.current).toHaveLength(0)
+    })
+
+    describe('user is admin', () => {
+        const summary: SubscriptionSummary = {
+            teamId: '018ff1b3-118c-7789-82e4-ab9106eed204',
+            userRole: 'admin',
+            teamCurrentMembers: 2,
+            teamMaxMembers: 6,
+            subscriptionStatus: 'active',
+            cancelAtPeriodEnd: false,
+        }
+
+        const setUseEmbeddedUI = (useEmbeddedUI: boolean) => {
+            vi.stubGlobal('context', {
+                frontendCodyProConfig: {
+                    stripePublishableKey: 'pk_test_123',
+                    sscBaseUrl: '',
+                    useEmbeddedUI,
+                },
+            })
+        }
+
+        beforeEach(() => {
+            vi.stubGlobal('context', {})
+            mockSubscriptionSummary(summary)
+        })
+
+        test.skip('returns links to subscription and team management pages if embedded UI is enabled', () => {
+            setUseEmbeddedUI(true)
+            const { result } = renderHook(() => useCodyProNavLinks())
+            expect(result.current).toHaveLength(2)
+            expect(result.current[0].label).toBe('Manage subscription')
+            expect(result.current[0].to).toBe(CodyProRoutes.SubscriptionManage)
+            expect(result.current[1].label).toBe('Manage team')
+            expect(result.current[1].to).toBe(CodyProRoutes.ManageTeam)
+        })
+
+        test('returns link to subscription management page if embedded UI is disabled', () => {
+            setUseEmbeddedUI(false)
+            const { result } = renderHook(() => useCodyProNavLinks())
+            expect(result.current).toHaveLength(1)
+            expect(result.current[0].label).toBe('Manage subscription')
+            expect(result.current[0].to).toBe('https://accounts.sourcegraph.com/cody/subscription')
+        })
+    })
+})

client/web/src/cody/useCodyProNavLinks.ts

@@ -0,0 +1,23 @@
+import { useMemo } from 'react'
+
+import { CodyProRoutes } from './codyProRoutes'
+import { useSubscriptionSummary } from './management/api/react-query/subscriptions'
+import { getManageSubscriptionPageURL, isEmbeddedCodyProUIEnabled } from './util'
+
+export const useCodyProNavLinks = (): { to: string; label: string }[] => {
+    const { data } = useSubscriptionSummary()
+
+    return useMemo(() => {
+        if (!data || data.userRole !== 'admin') {
+            return []
+        }
+
+        const items = [{ to: getManageSubscriptionPageURL(), label: 'Manage subscription' }]
+
+        if (isEmbeddedCodyProUIEnabled()) {
+            items.push({ to: CodyProRoutes.ManageTeam, label: 'Manage team' })
+        }
+
+        return items
+    }, [data])
+}

client/web/src/nav/UserNavItem.test.tsx

@@ -2,13 +2,15 @@ import { render, screen } from '@testing-library/react'
 import userEvent from '@testing-library/user-event'
 import { MemoryRouter } from 'react-router-dom'
 import sinon from 'sinon'
-import { afterAll, beforeAll, describe, expect, test, vi } from 'vitest'
+import { afterAll, beforeAll, afterEach, describe, expect, test, vi, beforeEach } from 'vitest'
 
 import { NOOP_TELEMETRY_SERVICE } from '@sourcegraph/shared/src/telemetry/telemetryService'
 import { MockedTestProvider } from '@sourcegraph/shared/src/testing/apollo'
 import { AnchorLink, RouterLink, setLinkComponent } from '@sourcegraph/wildcard'
 import { renderWithBrandedContext } from '@sourcegraph/wildcard/src/testing'
 
+import * as codyProHooks from '../cody/useCodyProNavLinks'
+
 import { UserNavItem, type UserNavItemProps } from './UserNavItem'
 
 vi.mock('../util/license', () => ({
@@ -26,6 +28,14 @@ describe('UserNavItem', () => {
         setLinkComponent(AnchorLink)
     })
 
+    const useCodyProNavLinksMock = vi.spyOn(codyProHooks, 'useCodyProNavLinks')
+    beforeEach(() => {
+        useCodyProNavLinksMock.mockReturnValue([])
+    })
+    afterEach(() => {
+        useCodyProNavLinksMock.mockReset()
+    })
+
     const USER: UserNavItemProps['authenticatedUser'] = {
         username: 'alice',
         displayName: 'alice doe',
@@ -96,4 +106,54 @@ describe('UserNavItem', () => {
         expect(result.locationRef.entries.length).toBe(1)
         expect(result.locationRef.entries.find(({ pathname }) => pathname.includes('sign-out'))).toBe(undefined)
     })
+
+    describe('Cody Pro section', () => {
+        const setup = (isSourcegraphDotCom: boolean) => {
+            renderWithBrandedContext(
+                <MockedTestProvider>
+                    <UserNavItem
+                        showKeyboardShortcutsHelp={() => undefined}
+                        authenticatedUser={USER}
+                        isSourcegraphDotCom={isSourcegraphDotCom}
+                        showFeedbackModal={() => undefined}
+                        telemetryService={NOOP_TELEMETRY_SERVICE}
+                    />
+                </MockedTestProvider>
+            )
+            userEvent.click(screen.getByRole('button'))
+        }
+
+        describe('dotcom', () => {
+            test('renders provided links', () => {
+                const links = [
+                    { to: '/foo', label: 'Foo' },
+                    { to: '/bar', label: 'Bar' },
+                ]
+                useCodyProNavLinksMock.mockReturnValue(links)
+                setup(true)
+
+                for (const link of links) {
+                    const el = screen.getByText(link.label)
+                    expect(el).toHaveAttribute('href', link.to)
+                }
+            })
+
+            test('is not rendered if no links provided', () => {
+                useCodyProNavLinksMock.mockReturnValue([])
+                setup(true)
+
+                expect(useCodyProNavLinksMock).toHaveBeenCalled()
+                expect(screen.queryByText('Cody Pro')).not.toBeInTheDocument()
+            })
+        })
+
+        describe('enterprise', () => {
+            test('is not rendered', () => {
+                setup(false)
+
+                // Cody Pro section is not rendered thus useCodyProNavLinks hook is not called
+                expect(useCodyProNavLinksMock).not.toHaveBeenCalled()
+            })
+        })
+    })
 })