[web] Show DS Navigation for all SAAS users regardless of feature flag (#23801)

* Remove `sidebar-navigation-ui-update` as true from analytics events

* Hide "ds-nav" survey for users who have the feature flag

* Replace `useIsDsNav()` by `isOverleaf`

* Rename former `hideDsSurvey` to `hideDsSurvey`, and set `hasDsNav = isOverleaf` variable

so the intent is clearer.

* Update frontend tests

GitOrigin-RevId: 2be9f88a10da430c0429de15d777d98104327f9f
This commit is contained in:
Antoine Clausse
2025-02-21 15:42:35 +01:00
committed by Copybot
parent 9bb220506a
commit 0adc30738f
9 changed files with 45 additions and 28 deletions

View File

@@ -1,5 +1,4 @@
import { useCallback } from 'react'
import { useSplitTestContext } from '@/shared/context/split-test-context'
import { sendMB } from '@/infrastructure/event-tracking'
export type ExtraSegmentations = {
@@ -39,16 +38,11 @@ export type ExtraSegmentations = {
}
export const useSendProjectListMB = () => {
const { splitTestVariants } = useSplitTestContext()
const hasDsNav = splitTestVariants['sidebar-navigation-ui-update'] as
| 'default'
| 'active'
return useCallback(
<T extends keyof ExtraSegmentations>(
event: T,
payload: ExtraSegmentations[T]
) =>
sendMB(event, { ...payload, 'sidebar-navigation-ui-update': hasDsNav }),
[hasDsNav]
) => sendMB(event, payload),
[]
)
}

View File

@@ -20,7 +20,7 @@ import ProjectListDefault from '@/features/project-list/components/project-list-
import { ProjectListDsNav } from '@/features/project-list/components/project-list-ds-nav'
import {
DsNavStyleProvider,
useIsDsNav,
hasDsNav,
} from '@/features/project-list/components/use-is-ds-nav'
function ProjectListRoot() {
@@ -82,8 +82,6 @@ function ProjectListPageContent() {
const { t } = useTranslation()
const hasDsNav = useIsDsNav()
if (isLoading) {
const loadingComponent = (
<LoadingBranded loadProgress={loadProgress} label={t('loading')} />

View File

@@ -5,7 +5,7 @@ import {
} from '../../context/project-list-context'
import TagsList from './tags-list'
import ProjectsFilterMenu from '../projects-filter-menu'
import { useIsDsNav } from '@/features/project-list/components/use-is-ds-nav'
import { hasDsNav } from '@/features/project-list/components/use-is-ds-nav'
type SidebarFilterProps = {
filter: Filter
@@ -30,7 +30,6 @@ export function SidebarFilter({ filter, text }: SidebarFilterProps) {
export default function SidebarFilters() {
const { t } = useTranslation()
const hasDsNav = useIsDsNav()
return (
<ul className="list-unstyled project-list-filters">

View File

@@ -14,7 +14,7 @@ import {
DropdownMenu,
DropdownToggle,
} from '@/features/ui/components/bootstrap-5/dropdown-menu'
import { useIsDsNav } from '@/features/project-list/components/use-is-ds-nav'
import { hasDsNav } from '@/features/project-list/components/use-is-ds-nav'
export default function TagsList() {
const { t } = useTranslation()
@@ -35,7 +35,6 @@ export default function TagsList() {
DeleteTagModal,
} = useTag()
const isDsNav = useIsDsNav()
return (
<>
<li
@@ -43,11 +42,11 @@ export default function TagsList() {
aria-hidden="true"
data-testid="organize-projects"
>
{isDsNav ? t('organize_tags') : t('organize_projects')}
{hasDsNav ? t('organize_tags') : t('organize_projects')}
</li>
<li className="tag">
<button type="button" className="tag-name" onClick={openCreateTagModal}>
{isDsNav ? (
{hasDsNav ? (
<Plus weight="bold" />
) : (
<MaterialIcon type="add" className="tag-list-icon" />
@@ -74,7 +73,7 @@ export default function TagsList() {
color: getTagColor(tag),
}}
>
{isDsNav ? (
{hasDsNav ? (
<TagSimple weight="fill" className="tag-list-icon" />
) : (
<MaterialIcon type="label" className="tag-list-icon" />
@@ -94,7 +93,7 @@ export default function TagsList() {
id={`${tag._id}-dropdown-toggle`}
data-testid="tag-dropdown-toggle"
>
{isDsNav && <DotsThreeVertical weight="bold" />}
{hasDsNav && <DotsThreeVertical weight="bold" />}
</DropdownToggle>
<DropdownMenu className="dropdown-menu-sm-width">
<DropdownItem

View File

@@ -5,6 +5,7 @@ import classnames from 'classnames'
import OLButton from '@/features/ui/components/ol/ol-button'
import { useTranslation } from 'react-i18next'
import { X } from '@phosphor-icons/react'
import { useHideDsSurvey } from '@/features/project-list/components/use-is-ds-nav'
export function SurveyWidgetDsNav() {
const { t } = useTranslation()
@@ -13,6 +14,7 @@ export function SurveyWidgetDsNav() {
`dismissed-${survey?.name}`,
false
)
const hideDsSurvey = useHideDsSurvey()
const dismissSurvey = useCallback(() => {
setDismissedSurvey(true)
@@ -22,6 +24,12 @@ export function SurveyWidgetDsNav() {
return null
}
// Hide the survey for users who have sidebar-navigation-ui-update:
// They've had it for months. We don't need their feedback anymore
if (hideDsSurvey && survey?.name === 'ds-nav') {
return null
}
return (
<div className={classnames('user-notifications', `survey-${survey.name}`)}>
<div className="notification-entry">

View File

@@ -1,10 +1,13 @@
import { createContext, type FC, type ReactNode, useContext } from 'react'
import { useSplitTestContext } from '@/shared/context/split-test-context'
import getMeta from '@/utils/meta'
export const hasDsNav = getMeta('ol-ExposedSettings')
/**
* This hook returns whether the user has the split-test assignment 'sidebar-navigation-ui-update'
*/
export const useIsDsNav = () => {
export const useHideDsSurvey = () => {
const { splitTestVariants } = useSplitTestContext()
return splitTestVariants['sidebar-navigation-ui-update'] === 'active'
}

View File

@@ -42,7 +42,7 @@ describe('<TagsList />', function () {
it('displays the tags list', function () {
const header = screen.getByTestId('organize-projects')
expect(header.textContent).to.equal('Organize Projects')
expect(header.textContent).to.equal('Organize Tags')
screen.getByRole('button', {
name: 'New Tag',

View File

@@ -1,8 +1,9 @@
import { expect } from 'chai'
import { fireEvent, render, screen } from '@testing-library/react'
import SurveyWidget from '../../../../../frontend/js/features/project-list/components/survey-widget'
import { SurveyWidgetDsNav } from '../../../../../frontend/js/features/project-list/components/survey-widget-ds-nav'
import { SplitTestProvider } from '@/shared/context/split-test-context'
describe('<SurveyWidget />', function () {
describe('<SurveyWidgetDsNav />', function () {
beforeEach(function () {
this.name = 'my-survey'
this.preText = 'To help shape the future of Overleaf'
@@ -21,7 +22,11 @@ describe('<SurveyWidget />', function () {
url: this.url,
})
render(<SurveyWidget />)
render(
<SplitTestProvider>
<SurveyWidgetDsNav />
</SplitTestProvider>
)
})
it('shows text and link', function () {
@@ -29,9 +34,10 @@ describe('<SurveyWidget />', function () {
expect(dismissed).to.equal(null)
screen.getByText(this.preText)
screen.getByText(this.linkText)
const link = screen.getByRole('link', {
name: this.linkText,
name: 'Take survey',
}) as HTMLAnchorElement
expect(link.href).to.equal(this.url)
})
@@ -63,7 +69,11 @@ describe('<SurveyWidget />', function () {
})
localStorage.setItem('dismissed-my-survey', 'true')
render(<SurveyWidget />)
render(
<SplitTestProvider>
<SurveyWidgetDsNav />
</SplitTestProvider>
)
})
it('nothing is displayed', function () {
@@ -77,7 +87,11 @@ describe('<SurveyWidget />', function () {
describe('survey widget is not shown when no survey is configured', function () {
beforeEach(function () {
render(<SurveyWidget />)
render(
<SplitTestProvider>
<SurveyWidgetDsNav />
</SplitTestProvider>
)
})
it('nothing is displayed', function () {

View File

@@ -63,12 +63,14 @@ describe('<ProjectTools />', function () {
projects,
totalSize: 100,
})
window.metaAttributesCache.set('ol-footer', {
showThinFooter: false,
translatedLanguages: { en: 'English' },
subdomainLang: { en: { lngCode: 'en', url: 'overleaf.com' } },
})
window.metaAttributesCache.set('ol-navbar', {
items: [],
})
fetchMock.get('/system/messages', [])
})