From 462c2d7bd34bc75fc0d9ec1c659531e64e22dfd8 Mon Sep 17 00:00:00 2001
From: Antoine Clausse <antoine.clausse@overleaf.com>
Date: Mon, 24 Feb 2025 11:07:22 +0100
Subject: [PATCH] [web] Show DS Navigation for all SAAS users regardless of
 feature flag (with fix!) (#23821)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Reapply "[web] Show DS Navigation for all SAAS users regardless of feature fla…"

This reverts commit 8d4096a7e4b6a7894b1bef14290548225deebd57.

* Fix: `hasDsNav` should check `isOverleaf` !!!

* Change `hasDsNav` from a boolean to a function call for dynamic evaluation

GitOrigin-RevId: 17463ac113a4278ed344622552d83da93b208b4d
---
 .../components/project-list-events.ts         | 10 ++-----
 .../components/project-list-root.tsx          |  8 +++---
 .../components/sidebar/sidebar-filters.tsx    |  5 ++--
 .../components/sidebar/tags-list.tsx          | 11 ++++----
 .../components/survey-widget-ds-nav.tsx       |  8 ++++++
 .../project-list/components/use-is-ds-nav.tsx |  5 +++-
 .../components/sidebar/tags-list.test.tsx     |  3 ++-
 .../components/survey-widget.test.tsx         | 26 ++++++++++++++-----
 .../project-tools-rename.test.tsx             |  4 ++-
 9 files changed, 49 insertions(+), 31 deletions(-)

diff --git a/services/web/frontend/js/features/project-list/components/project-list-events.ts b/services/web/frontend/js/features/project-list/components/project-list-events.ts
index eda62016ed..03e426bc7e 100644
--- a/services/web/frontend/js/features/project-list/components/project-list-events.ts
+++ b/services/web/frontend/js/features/project-list/components/project-list-events.ts
@@ -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),
+    []
   )
 }
diff --git a/services/web/frontend/js/features/project-list/components/project-list-root.tsx b/services/web/frontend/js/features/project-list/components/project-list-root.tsx
index 420b2454ab..5de7d9372e 100644
--- a/services/web/frontend/js/features/project-list/components/project-list-root.tsx
+++ b/services/web/frontend/js/features/project-list/components/project-list-root.tsx
@@ -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,14 +82,12 @@ function ProjectListPageContent() {
 
   const { t } = useTranslation()
 
-  const hasDsNav = useIsDsNav()
-
   if (isLoading) {
     const loadingComponent = (
       <LoadingBranded loadProgress={loadProgress} label={t('loading')} />
     )
 
-    if (hasDsNav) {
+    if (hasDsNav()) {
       return loadingComponent
     } else {
       return (
@@ -106,7 +104,7 @@ function ProjectListPageContent() {
         <WelcomePageContent />
       </DefaultPageContentWrapper>
     )
-  } else if (hasDsNav) {
+  } else if (hasDsNav()) {
     return (
       <DsNavStyleProvider>
         <ProjectListDsNav />
diff --git a/services/web/frontend/js/features/project-list/components/sidebar/sidebar-filters.tsx b/services/web/frontend/js/features/project-list/components/sidebar/sidebar-filters.tsx
index 799ccbd6f3..ad908238ca 100644
--- a/services/web/frontend/js/features/project-list/components/sidebar/sidebar-filters.tsx
+++ b/services/web/frontend/js/features/project-list/components/sidebar/sidebar-filters.tsx
@@ -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">
@@ -39,7 +38,7 @@ export default function SidebarFilters() {
       <SidebarFilter filter="shared" text={t('shared_with_you')} />
       <SidebarFilter filter="archived" text={t('archived_projects')} />
       <SidebarFilter filter="trashed" text={t('trashed_projects')} />
-      {hasDsNav && (
+      {hasDsNav() && (
         <li role="none">
           <hr />
         </li>
diff --git a/services/web/frontend/js/features/project-list/components/sidebar/tags-list.tsx b/services/web/frontend/js/features/project-list/components/sidebar/tags-list.tsx
index b149a6b44c..6b1c0db706 100644
--- a/services/web/frontend/js/features/project-list/components/sidebar/tags-list.tsx
+++ b/services/web/frontend/js/features/project-list/components/sidebar/tags-list.tsx
@@ -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
diff --git a/services/web/frontend/js/features/project-list/components/survey-widget-ds-nav.tsx b/services/web/frontend/js/features/project-list/components/survey-widget-ds-nav.tsx
index cac5e10bc8..41e76cf797 100644
--- a/services/web/frontend/js/features/project-list/components/survey-widget-ds-nav.tsx
+++ b/services/web/frontend/js/features/project-list/components/survey-widget-ds-nav.tsx
@@ -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">
diff --git a/services/web/frontend/js/features/project-list/components/use-is-ds-nav.tsx b/services/web/frontend/js/features/project-list/components/use-is-ds-nav.tsx
index 9687f906c3..91ba19ab22 100644
--- a/services/web/frontend/js/features/project-list/components/use-is-ds-nav.tsx
+++ b/services/web/frontend/js/features/project-list/components/use-is-ds-nav.tsx
@@ -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').isOverleaf
 
 /**
  * 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'
 }
diff --git a/services/web/test/frontend/features/project-list/components/sidebar/tags-list.test.tsx b/services/web/test/frontend/features/project-list/components/sidebar/tags-list.test.tsx
index a15d44538a..1543e2e90d 100644
--- a/services/web/test/frontend/features/project-list/components/sidebar/tags-list.test.tsx
+++ b/services/web/test/frontend/features/project-list/components/sidebar/tags-list.test.tsx
@@ -20,6 +20,7 @@ describe('<TagsList />', function () {
         project_ids: [projectsData[0].id, projectsData[1].id],
       },
     ])
+    window.metaAttributesCache.set('ol-ExposedSettings', { isOverleaf: true })
 
     fetchMock.post('/tag', {
       _id: 'eee888eee888',
@@ -42,7 +43,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',
diff --git a/services/web/test/frontend/features/project-list/components/survey-widget.test.tsx b/services/web/test/frontend/features/project-list/components/survey-widget.test.tsx
index 91cc020d4e..798703d0af 100644
--- a/services/web/test/frontend/features/project-list/components/survey-widget.test.tsx
+++ b/services/web/test/frontend/features/project-list/components/survey-widget.test.tsx
@@ -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 () {
diff --git a/services/web/test/frontend/features/project-list/components/table/project-tools/project-tools-rename.test.tsx b/services/web/test/frontend/features/project-list/components/table/project-tools/project-tools-rename.test.tsx
index 5a301a3200..8903fc3089 100644
--- a/services/web/test/frontend/features/project-list/components/table/project-tools/project-tools-rename.test.tsx
+++ b/services/web/test/frontend/features/project-list/components/table/project-tools/project-tools-rename.test.tsx
@@ -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', [])
   })