Skip to content

[No QA] Remove unsafe type assertions from getStateForDynamicRouteTests.ts tests #96783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
youssef-lr merged 4 commits into from
Jul 27, 2026
Merged

[No QA] Remove unsafe type assertions from getStateForDynamicRouteTests.ts tests #96783

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7036cd
fix: remove unsafe assertions from dynamic route tests
KJ21-ENG Jul 22, 2026
58406ef
fix: require dynamic route nodes before absence assertions
KJ21-ENG Jul 23, 2026
fe3115f
chore: rerun CI
KJ21-ENG Jul 23, 2026
4799bad
fix: use production dynamic route paths
KJ21-ENG Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
173 changes: 82 additions & 91 deletions tests/navigation/getStateForDynamicRouteTests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,33 @@
import getStateForDynamicRoute from '@libs/Navigation/helpers/dynamicRoutesUtils/getStateForDynamicRoute';

import type {DYNAMIC_ROUTES} from '@src/ROUTES';

jest.mock('@libs/Navigation/linkingConfig/config', () => ({
normalizedConfigs: {
TestNavigator: {
path: 'test-path',
routeNames: ['Wrapper', 'TargetScreen'],
},
SingleNavigator: {
path: 'single-path',
routeNames: ['Root'],
},
},
}));

jest.mock('@src/ROUTES', () => ({
DYNAMIC_ROUTES: {
TEST_ROUTE: {
path: 'test-path',
},
SINGLE_ROUTE: {
path: 'single-path',
},
UNKNOWN_ROUTE: {
path: 'unknown-path',
import type * as Routes from '@src/ROUTES';
import {DYNAMIC_ROUTES} from '@src/ROUTES';

jest.mock('@libs/Navigation/linkingConfig/config', () => {
const {DYNAMIC_ROUTES: actualDynamicRoutes} = jest.requireActual<typeof Routes>('@src/ROUTES');
return {
normalizedConfigs: {
TestNavigator: {
path: actualDynamicRoutes.VERIFY_ACCOUNT.path,
routeNames: ['Wrapper', 'TargetScreen'],
},
SingleNavigator: {
path: actualDynamicRoutes.TWO_FACTOR_AUTH_ROOT.path,
routeNames: ['Root'],
},
},
},
}));

type LeafRoute = {
name: string;
path: string;
params?: Record<string, unknown>;
};

type NestedRoute = {
name: string;
state: {
routes: [RouteNode];
index: 0;
};
};

type RouteNode = LeafRoute | NestedRoute;
});

const KEY_TEST = 'TEST_ROUTE';
const KEY_SINGLE = 'SINGLE_ROUTE';
const KEY_UNKNOWN = 'UNKNOWN_ROUTE';
const KEY_TEST = 'VERIFY_ACCOUNT';
const KEY_SINGLE = 'TWO_FACTOR_AUTH_ROOT';
const KEY_UNKNOWN = 'TWO_FACTOR_AUTH_VERIFY';

describe('getStateForDynamicRoute', () => {
it('should build correctly nested state for multi-level route', () => {
const path = '/some/path/test-path';
const path = `/some/path/${DYNAMIC_ROUTES.VERIFY_ACCOUNT.path}`;

const result = getStateForDynamicRoute(path, KEY_TEST as unknown as keyof typeof DYNAMIC_ROUTES);
const result = getStateForDynamicRoute(path, KEY_TEST);

expect(result).toEqual({
routes: [
Expand All @@ -74,8 +48,8 @@ describe('getStateForDynamicRoute', () => {
});

it('should build flat state for single-level route', () => {
const path = '/some/path/single-path';
const result = getStateForDynamicRoute(path, KEY_SINGLE as unknown as keyof typeof DYNAMIC_ROUTES);
const path = `/some/path/${DYNAMIC_ROUTES.TWO_FACTOR_AUTH_ROOT.path}`;
const result = getStateForDynamicRoute(path, KEY_SINGLE);

expect(result).toEqual({
routes: [
Expand All @@ -88,91 +62,108 @@ describe('getStateForDynamicRoute', () => {
});

it('should throw error when route configuration is not found', () => {
const path = '/some/path/unknown';
const path = `/some/path/${DYNAMIC_ROUTES.TWO_FACTOR_AUTH_VERIFY.path}`;

expect(() => getStateForDynamicRoute(path, KEY_UNKNOWN as unknown as keyof typeof DYNAMIC_ROUTES)).toThrow("No route configuration found for dynamic route 'UNKNOWN_ROUTE'");
expect(() => getStateForDynamicRoute(path, KEY_UNKNOWN)).toThrow("No route configuration found for dynamic route 'TWO_FACTOR_AUTH_VERIFY'");
});

it('should handle different path format but same structure', () => {
const path = '/another/different/path/test-path';
const result = getStateForDynamicRoute(path, KEY_TEST as unknown as keyof typeof DYNAMIC_ROUTES);
const path = `/another/different/path/${DYNAMIC_ROUTES.VERIFY_ACCOUNT.path}`;
const result = getStateForDynamicRoute(path, KEY_TEST);

const rootRoute = result.routes.at(0) as NestedRoute | undefined;
const leafRoute = rootRoute?.state.routes.at(0) as LeafRoute | undefined;
expect(leafRoute?.path).toBe(path);
const rootRoute = result.routes.at(0);
const leafRoute = rootRoute && 'state' in rootRoute && rootRoute.state ? rootRoute.state.routes.at(0) : undefined;
expect(leafRoute && 'path' in leafRoute ? leafRoute.path : undefined).toBe(path);
});

it('should correctly structure state property in parent nodes', () => {
const path = '/test-path';
const result = getStateForDynamicRoute(path, KEY_TEST as unknown as keyof typeof DYNAMIC_ROUTES);
const path = `/${DYNAMIC_ROUTES.VERIFY_ACCOUNT.path}`;
const result = getStateForDynamicRoute(path, KEY_TEST);

const parentNode = result.routes.at(0);
expect(parentNode).toHaveProperty('state');

const state = (parentNode as NestedRoute).state;
const state = parentNode && 'state' in parentNode ? parentNode.state : undefined;
expect(state?.index).toBe(0);
expect(Array.isArray(state?.routes)).toBe(true);
});

it('should inherit parent route params on the leaf node', () => {
const path = '/r/12345/settings/test-path';
const path = `/r/12345/settings/${DYNAMIC_ROUTES.VERIFY_ACCOUNT.path}`;
const parentParams = {reportID: '12345'};
const result = getStateForDynamicRoute(path, KEY_TEST as unknown as keyof typeof DYNAMIC_ROUTES, parentParams);
const result = getStateForDynamicRoute(path, KEY_TEST, parentParams);

const rootRoute = result.routes.at(0) as NestedRoute | undefined;
const leafRoute = rootRoute?.state.routes.at(0) as LeafRoute | undefined;
expect(leafRoute?.params).toEqual(parentParams);
const rootRoute = result.routes.at(0);
const leafRoute = rootRoute && 'state' in rootRoute && rootRoute.state ? rootRoute.state.routes.at(0) : undefined;
expect(leafRoute && 'params' in leafRoute ? leafRoute.params : undefined).toEqual(parentParams);
});

it('should not include params on the leaf node when neither parentRouteParams nor query params are provided', () => {
const path = '/some/path/test-path';
const result = getStateForDynamicRoute(path, KEY_TEST as unknown as keyof typeof DYNAMIC_ROUTES);
const path = `/some/path/${DYNAMIC_ROUTES.VERIFY_ACCOUNT.path}`;
const result = getStateForDynamicRoute(path, KEY_TEST);

const rootRoute = result.routes.at(0);
if (!rootRoute || rootRoute.name !== 'Wrapper' || !('state' in rootRoute) || !rootRoute.state) {
throw new Error('Expected the dynamic route to contain the Wrapper state');
}

const rootRoute = result.routes.at(0) as NestedRoute | undefined;
const leafRoute = rootRoute?.state.routes.at(0) as LeafRoute | undefined;
expect(leafRoute?.params).toBeUndefined();
const leafRoute = rootRoute.state.routes.at(0);
if (!leafRoute || !('path' in leafRoute) || leafRoute.name !== 'TargetScreen' || leafRoute.path !== path) {
throw new Error('Expected the dynamic route to contain the TargetScreen leaf');
}

expect(leafRoute).not.toHaveProperty('params');
});

it('should merge parent route params with query params', () => {
const path = '/r/12345/settings/test-path?country=US';
const path = `/r/12345/settings/${DYNAMIC_ROUTES.VERIFY_ACCOUNT.path}?country=US`;
const parentParams = {reportID: '12345'};
const result = getStateForDynamicRoute(path, KEY_TEST as unknown as keyof typeof DYNAMIC_ROUTES, parentParams);
const result = getStateForDynamicRoute(path, KEY_TEST, parentParams);

const rootRoute = result.routes.at(0) as NestedRoute | undefined;
const leafRoute = rootRoute?.state.routes.at(0) as LeafRoute | undefined;
expect(leafRoute?.params).toEqual({reportID: '12345', country: 'US'});
const rootRoute = result.routes.at(0);
const leafRoute = rootRoute && 'state' in rootRoute && rootRoute.state ? rootRoute.state.routes.at(0) : undefined;
expect(leafRoute && 'params' in leafRoute ? leafRoute.params : undefined).toEqual({reportID: '12345', country: 'US'});
});

describe('undefined params are filtered out (optional path params absent)', () => {
it('does not include the key when an optional path param is undefined', () => {
const path = '/r/12345/test-path';
const path = `/r/12345/${DYNAMIC_ROUTES.VERIFY_ACCOUNT.path}`;
const parentParams = {reportID: '12345', accountID: undefined};
const result = getStateForDynamicRoute(path, KEY_TEST as unknown as keyof typeof DYNAMIC_ROUTES, parentParams);
const result = getStateForDynamicRoute(path, KEY_TEST, parentParams);

const rootRoute = result.routes.at(0) as NestedRoute | undefined;
const leafRoute = rootRoute?.state.routes.at(0) as LeafRoute | undefined;
expect(leafRoute?.params).toEqual({reportID: '12345'});
expect(leafRoute?.params).not.toHaveProperty('accountID');
const rootRoute = result.routes.at(0);
const leafRoute = rootRoute && 'state' in rootRoute && rootRoute.state ? rootRoute.state.routes.at(0) : undefined;
const leafParams = leafRoute && 'params' in leafRoute ? leafRoute.params : undefined;
expect(leafParams).toEqual({reportID: '12345'});
expect(leafParams).not.toHaveProperty('accountID');
});

it('returns no params when all parent params are undefined and there are no query params', () => {
const path = '/r/12345/test-path';
const parentParams = {accountID: undefined as unknown as string};
const result = getStateForDynamicRoute(path, KEY_TEST as unknown as keyof typeof DYNAMIC_ROUTES, parentParams);
const path = `/r/12345/${DYNAMIC_ROUTES.VERIFY_ACCOUNT.path}`;
const parentParams = {accountID: undefined};
const result = getStateForDynamicRoute(path, KEY_TEST, parentParams);

const rootRoute = result.routes.at(0);
if (!rootRoute || rootRoute.name !== 'Wrapper' || !('state' in rootRoute) || !rootRoute.state) {
throw new Error('Expected the dynamic route to contain the Wrapper state');
}

const leafRoute = rootRoute.state.routes.at(0);
if (!leafRoute || !('path' in leafRoute) || leafRoute.name !== 'TargetScreen' || leafRoute.path !== path) {
throw new Error('Expected the dynamic route to contain the TargetScreen leaf');
}

const rootRoute = result.routes.at(0) as NestedRoute | undefined;
const leafRoute = rootRoute?.state.routes.at(0) as LeafRoute | undefined;
expect(leafRoute?.params).toBeUndefined();
expect(leafRoute).not.toHaveProperty('params');
});

it('keeps defined params and drops undefined ones in mixed scenario', () => {
const path = '/r/12345/test-path?country=US';
const path = `/r/12345/${DYNAMIC_ROUTES.VERIFY_ACCOUNT.path}?country=US`;
const parentParams = {reportID: '12345', extraneous: undefined};
const result = getStateForDynamicRoute(path, KEY_TEST as unknown as keyof typeof DYNAMIC_ROUTES, parentParams);
const result = getStateForDynamicRoute(path, KEY_TEST, parentParams);

const rootRoute = result.routes.at(0) as NestedRoute | undefined;
const leafRoute = rootRoute?.state.routes.at(0) as LeafRoute | undefined;
expect(leafRoute?.params).toEqual({reportID: '12345', country: 'US'});
const rootRoute = result.routes.at(0);
const leafRoute = rootRoute && 'state' in rootRoute && rootRoute.state ? rootRoute.state.routes.at(0) : undefined;
expect(leafRoute && 'params' in leafRoute ? leafRoute.params : undefined).toEqual({reportID: '12345', country: 'US'});
});
});
});
Loading