Update Workspaces tab URLs to just workspaces to clearly differentiate them from Account-related URLs

contributingGuides/NAVIGATION.md

@@ -503,7 +503,7 @@ In Expensify, we use an extended implementation of this function because:
 
 Here are examples how the state is generated based on route:
 
--   `settings/workspaces/1/overview`
+-   `workspaces/1/overview`
 
 ```json
 {
@@ -536,7 +536,7 @@ Here are examples how the state is generated based on route:
                         "params": {
                             "policyID": "1"
                         },
-                        "path": "/settings/workspaces/1/overview",
+                        "path": "workspaces/1/overview",
                         "key": "Workspace_Overview-key"
                     }
                 ]

contributingGuides/NAVIGATION_TESTS.md

@@ -33,11 +33,11 @@
 
 1. Open any workspace settings (Settings → Workspaces → Select any workspace)
 2. Click the Settings button on the bottom tab.
-3. Verify that the Workspace list is displayed (`/settings/workspaces`)
+3. Verify that the Workspace list is displayed (`/workspaces`)
 4. Select any workspace again.
 5. Reload the page.
 6. Click the Settings button on the bottom tab.
-7. Verify that the Workspace list is displayed (`/settings/workspaces`)
+7. Verify that the Workspace list is displayed (`/workspaces/`)
 
 
 #### The last visited screen in the settings tab is saved when switching between tabs 
@@ -52,7 +52,7 @@
 
 #### Going up to the workspace list page after refreshing on the workspace settings and pressing the up button
 
-1. Open the workspace settings from the deep link (use a link in format: `/settings/workspaces/:policyID:/profile`)
+1. Open the workspace settings from the deep link (use a link in format: `/workspaces/:policyID:/profile`)
 2. Click the app’s back button.
 3. Verify if the workspace list is displayed.
 
@@ -241,4 +241,4 @@ Linked issue: https://github.com/Expensify/App/issues/50177
 11. Go back.
 12. Verify you are navigated back to the employee size step.
 13. Go back.
-14. Verify you are navigated back to the Purpose step.
+14. Verify you are navigated back to the Purpose step.

contributingGuides/STYLE.md

@@ -535,13 +535,13 @@ We need to change the `getRoute()` `policyID` argument type to allow `undefined`
 
 ```diff
 WORKSPACE_PROFILE_ADDRESS: {
-    route: 'settings/workspaces/:policyID/profile/address',
--   getRoute: (policyID: string, backTo?: string) => getUrlWithBackToParam(`settings/workspaces/${policyID}/profile/address` as const, backTo),
+    route: 'workspaces/:policyID/profile/address',
+-   getRoute: (policyID: string, backTo?: string) => getUrlWithBackToParam(`workspaces/${policyID}/profile/address` as const, backTo),
 +   getRoute: (policyID: string | undefined, backTo?: string) => {
 +       if (!policyID) {
 +           Log.warn("Invalid policyID is used to build the WORKSPACE_PROFILE_ADDRESS route")
 +       }
-+       return getUrlWithBackToParam(`settings/workspaces/${policyID}/profile/address` as const, backTo);
++       return getUrlWithBackToParam(`workspaces/${policyID}/profile/address` as const, backTo);
 +   },
 },
 ```

src/libs/Navigation/helpers/getAdaptedStateFromPath.ts

@@ -12,12 +12,13 @@
 import ONYXKEYS from '@src/ONYXKEYS';
 import SCREENS from '@src/SCREENS';
 import type {Report} from '@src/types/onyx';
+import getMatchingNewRoute from './getMatchingNewRoute';
 import getParamsFromRoute from './getParamsFromRoute';
 import {isFullScreenName} from './isNavigatorName';
 import replacePathInNestedState from './replacePathInNestedState';
 
 let allReports: OnyxCollection<Report>;
 Onyx.connect({
     key: ONYXKEYS.COLLECTION.REPORT,
     waitForCollectionCallback: true,
     callback: (value) => {
@@ -226,6 +227,8 @@
 const getAdaptedStateFromPath: GetAdaptedStateFromPath = (path, options, shouldReplacePathInNestedState = true) => {
     let normalizedPath = !path.startsWith('/') ? `/${path}` : path;
 
+    normalizedPath = getMatchingNewRoute(normalizedPath) ?? normalizedPath;
+
     // Bing search results still link to /signin when searching for “Expensify”, but the /signin route no longer exists in our repo, so we redirect it to the home page to avoid showing a Not Found page.
     if (normalizedPath === CONST.SIGNIN_ROUTE) {
         normalizedPath = '/';

src/libs/Navigation/helpers/getMatchingNewRoute.ts

@@ -0,0 +1,33 @@
+import oldRoutes from '@navigation/linkingConfig/OldRoutes';
+
+/**
+ * Maps an old route path to its corresponding new route based on the `oldRoutes` map.
+ * It finds the best matching pattern (with wildcard `*` support) and replaces the matched
+ * part of the path with the new route value.
+ *
+ * @param path - The input URL path to match and transform.
+ * @returns The new route path if a match is found, otherwise `undefined`.
+ *
+ * Related issue: https://github.com/Expensify/App/issues/64968
+ */
+function getMatchingNewRoute(path: string) {
+    let bestMatch;
+    let maxLength = -1;
+
+    for (const pattern of Object.keys(oldRoutes)) {
+        const regexStr = `^${pattern.replace('*', '.*')}`;
+        const regex = new RegExp(regexStr);
+
+        if (regex.test(path) && pattern.length > maxLength) {
+            bestMatch = pattern;
+            maxLength = pattern.length;
+        }
+    }
+    if (!bestMatch) {
+        return bestMatch;
+    }
+
+    const finalRegexp = bestMatch?.replace('*', '') ?? '';
+    return path.replace(finalRegexp, oldRoutes[bestMatch]);
+}
+export default getMatchingNewRoute;

src/libs/Navigation/helpers/getStateFromPath.ts

@@ -2,16 +2,18 @@ import type {NavigationState, PartialState} from '@react-navigation/native';
 import {getStateFromPath as RNGetStateFromPath} from '@react-navigation/native';
 import {linkingConfig} from '@libs/Navigation/linkingConfig';
 import type {Route} from '@src/ROUTES';
+import getMatchingNewRoute from './getMatchingNewRoute';
 
 /**
  * @param path - The path to parse
  * @returns - It's possible that there is no navigation action for the given path
  */
 function getStateFromPath(path: Route): PartialState<NavigationState> {
     const normalizedPath = !path.startsWith('/') ? `/${path}` : path;
+    const normalizedPathAfterRedirection = getMatchingNewRoute(normalizedPath) ?? normalizedPath;
 
     // This function is used in the linkTo function where we want to use default getStateFromPath function.
-    const state = RNGetStateFromPath(normalizedPath, linkingConfig.config);
+    const state = RNGetStateFromPath(normalizedPathAfterRedirection, linkingConfig.config);
 
     if (!state) {
         throw new Error('Failed to parse the path to a navigation state.');

src/libs/Navigation/helpers/linkTo/index.ts

@@ -6,6 +6,7 @@ import getStateFromPath from '@libs/Navigation/helpers/getStateFromPath';
 import normalizePath from '@libs/Navigation/helpers/normalizePath';
 import {linkingConfig} from '@libs/Navigation/linkingConfig';
 import {shallowCompare} from '@libs/ObjectUtils';
+import getMatchingNewRoute from '@navigation/helpers/getMatchingNewRoute';
 import type {NavigationPartialRoute, ReportsSplitNavigatorParamList, RootNavigatorParamList, StackNavigationAction} from '@navigation/types';
 import CONST from '@src/CONST';
 import NAVIGATORS from '@src/NAVIGATORS';
@@ -56,11 +57,12 @@ export default function linkTo(navigation: NavigationContainerRef<RootNavigatorP
     const {forceReplace} = {...defaultLinkToOptions, ...options} as Required<LinkToOptions>;
 
     const normalizedPath = normalizePath(path) as Route;
+    const normalizedPathAfterRedirection = (getMatchingNewRoute(normalizedPath) ?? normalizedPath) as Route;
 
     // This is the state generated with the default getStateFromPath function.
     // It won't include the whole state that will be generated for this path but the focused route will be correct.
     // It is necessary because getActionFromState will generate RESET action for whole state generated with our custom getStateFromPath function.
-    const stateFromPath = getStateFromPath(normalizedPath) as PartialState<NavigationState<RootNavigatorParamList>>;
+    const stateFromPath = getStateFromPath(normalizedPathAfterRedirection) as PartialState<NavigationState<RootNavigatorParamList>>;
     const currentState = navigation.getRootState() as NavigationState<RootNavigatorParamList>;
 
     const focusedRouteFromPath = findFocusedRoute(stateFromPath);

src/libs/Navigation/linkingConfig/OldRoutes.ts

@@ -0,0 +1,8 @@
+const oldRoutes: Record<string, string> = {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    '/settings/workspaces/*': '/workspaces/',
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    '/settings/workspaces': '/workspaces',
+};
+
+export default oldRoutes;

tests/navigation/getMatchingNewRouteTest.ts

@@ -0,0 +1,25 @@
+import getMatchingNewRoute from '@navigation/helpers/getMatchingNewRoute';
+
+describe('getBestMatchingPath', () => {
+    it('returns mapped base path when input matches the exact pattern', () => {
+        expect(getMatchingNewRoute('/settings/workspaces/')).toBe('/workspaces/');
+    });
+
+    it('returns mapped base path when input matches the exact pattern', () => {
+        expect(getMatchingNewRoute('/settings/workspaces')).toBe('/workspaces');
+    });
+
+    it('returns mapped path when input matches the pattern and have more content', () => {
+        expect(getMatchingNewRoute('/settings/workspaces/anything/more')).toBe('/workspaces/anything/more');
+    });
+
+    it('returns undefined when input does not match any pattern - similar prefix but different ending', () => {
+        expect(getMatchingNewRoute('/settings/anything/')).toBe(undefined);
+    });
+
+    it('returns undefined when input is unrelated to any pattern', () => {
+        expect(getMatchingNewRoute('/anything/workspaces/')).toBe(undefined);
+        expect(getMatchingNewRoute('/anything/anything/')).toBe(undefined);
+        expect(getMatchingNewRoute('/anything/anything/anything')).toBe(undefined);
+    });
+});