2227417858

Committed 26 Apr 2022 02:44PM UTC coverage: 35.39% (-0.03%) from 35.417%

Build Type

github

Committed by GitHub

Commit Message

Merge 088540e91 into 2e6ed72b1

Pull Request Pull Request #3826: fix: use address from store instead of URL

Run Details

1269 of 4532 branches covered (28.0%)

Branch coverage included in aggregate %.

15 of 60 new or added lines in 38 files covered. (25.0%)

153 existing lines in 16 files now uncovered.

3594 of 9209 relevant lines covered (39.03%)

35.29 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.86

/src/routes/routes.ts

import { createBrowserHistory } from 'history'
import { generatePath, matchPath } from 'react-router-dom'

import { getChains } from 'src/config/cache/chains'
import { ChainId, ShortName } from 'src/config/chain.d'
import { checksumAddress } from 'src/utils/checksumAddress'
import { PUBLIC_URL } from 'src/utils/constants'
import { parsePrefixedAddress } from 'src/utils/prefixedAddress'

export const history = createBrowserHistory({
  basename: PUBLIC_URL,
})

// Safe specific routes
const hashRegExp = '0x[0-9A-Fa-f]'

const chainSpecificSafeAddressPathRegExp = `[a-z0-9-]{2,}:${hashRegExp}{40}`

export const SAFE_ADDRESS_SLUG = 'prefixedSafeAddress'
export const ADDRESSED_ROUTE = `/:${SAFE_ADDRESS_SLUG}(${chainSpecificSafeAddressPathRegExp})`

// Safe section routes, i.e. /:prefixedSafeAddress/settings
const SAFE_SECTION_SLUG = 'safeSection'
export const SAFE_SECTION_ROUTE = `${ADDRESSED_ROUTE}/:${SAFE_SECTION_SLUG}`

// Safe subsection routes, i.e. /:prefixedSafeAddress/settings/advanced
export const SAFE_SUBSECTION_SLUG = 'safeSubsection'
export const SAFE_SUBSECTION_ROUTE = `${SAFE_SECTION_ROUTE}/:${SAFE_SUBSECTION_SLUG}`

export const TRANSACTION_ID_SLUG = 'txId'

// URL: gnosis-safe.io/app/:[SAFE_ADDRESS_SLUG]/:[SAFE_SECTION_SLUG]/:[SAFE_SUBSECTION_SLUG]
export type SafeRouteSlugs = {
  [SAFE_ADDRESS_SLUG]?: string
  [SAFE_SECTION_SLUG]?: string
  [SAFE_SUBSECTION_SLUG]?: string
  [TRANSACTION_ID_SLUG]?: string
}

export const LOAD_SPECIFIC_SAFE_ROUTE = `/load/:${SAFE_ADDRESS_SLUG}?` // ? = optional slug

// Routes independant of safe/network
export const ROOT_ROUTE = '/'
export const WELCOME_ROUTE = '/welcome'
export const OPEN_SAFE_ROUTE = '/open'
export const GENERIC_APPS_ROUTE = '/apps'
export const LOAD_SAFE_ROUTE = generatePath(LOAD_SPECIFIC_SAFE_ROUTE) // By providing no slug, we get '/load'

// [SAFE_SECTION_SLUG], [SAFE_SUBSECTION_SLUG] populated safe routes
export const SAFE_ROUTES = {
  DASHBOARD: `${ADDRESSED_ROUTE}/home`,
  ASSETS_BALANCES: `${ADDRESSED_ROUTE}/balances`, // [SAFE_SECTION_SLUG] === 'balances'
  ASSETS_BALANCES_COLLECTIBLES: `${ADDRESSED_ROUTE}/balances/nfts`, // [SAFE_SUBSECTION_SLUG] === 'nfts'
  LEGACY_COLLECTIBLES: `${ADDRESSED_ROUTE}/balances/collectibles`,
  TRANSACTIONS: `${ADDRESSED_ROUTE}/transactions`,
  TRANSACTIONS_HISTORY: `${ADDRESSED_ROUTE}/transactions/history`,
  TRANSACTIONS_QUEUE: `${ADDRESSED_ROUTE}/transactions/queue`,
  TRANSACTIONS_SINGULAR: `${ADDRESSED_ROUTE}/transactions/:${TRANSACTION_ID_SLUG}`,
  ADDRESS_BOOK: `${ADDRESSED_ROUTE}/address-book`,
  APPS: `${ADDRESSED_ROUTE}/apps`,
  SETTINGS: `${ADDRESSED_ROUTE}/settings`,
  SETTINGS_APPEARANCE: `${ADDRESSED_ROUTE}/settings/appearance`,
  SETTINGS_DETAILS: `${ADDRESSED_ROUTE}/settings/details`,
  SETTINGS_OWNERS: `${ADDRESSED_ROUTE}/settings/owners`,
  SETTINGS_POLICIES: `${ADDRESSED_ROUTE}/settings/policies`,
  SETTINGS_SPENDING_LIMIT: `${ADDRESSED_ROUTE}/settings/spending-limit`,
  SETTINGS_ADVANCED: `${ADDRESSED_ROUTE}/settings/advanced`,
}

export const getNetworkRootRoutes = (): Array<{ chainId: ChainId; route: string; shortName: string }> =>
  getChains().map(({ chainId, chainName, shortName }) => ({
    chainId,
    route: `/${chainName.replace(/\s+/g, '-').toLowerCase()}`,
    shortName,
  }))

export type SafeRouteParams = { shortName: ShortName; safeAddress: string }

export const isValidShortChainName = (shortName: ShortName): boolean => {
  return getChains().some((chain) => chain.shortName === shortName)
}

// Due to hoisting issues, these functions should remain here
export const extractPrefixedSafeAddress = (
  path = history.location.pathname,
  route = ADDRESSED_ROUTE,
): SafeRouteParams => {
  const match = matchPath<SafeRouteSlugs>(path, {
    path: route,
  })

  const prefixedSafeAddress = match?.params?.[SAFE_ADDRESS_SLUG]
  const { prefix, address } = parsePrefixedAddress(prefixedSafeAddress || '')

  return {
    shortName: prefix,
    safeAddress: checksumAddress(address),
  }
}

export const extractShortChainName = (): ShortName => extractPrefixedSafeAddress().shortName
export const extractSafeAddress = (): string => extractPrefixedSafeAddress().safeAddress

export const getPrefixedSafeAddressSlug = ({
  safeAddress,
  shortName,
}: {
  safeAddress: string
  shortName: string
}): string => `${shortName}:${safeAddress}`

// Populate `/:[SAFE_ADDRESS_SLUG]` with current 'shortName:safeAddress'
export const generateSafeRoute = (
  path: typeof SAFE_ROUTES[keyof typeof SAFE_ROUTES],
  params: SafeRouteParams,
): string =>
  generatePath(path, {
    [SAFE_ADDRESS_SLUG]: getPrefixedSafeAddressSlug(params),
  })

// Singular tx route is excluded as it has a required safeTxHash slug
// This is to give stricter routing, instead of making the slug optional
const { TRANSACTIONS_SINGULAR: _hasRequiredSlug, ...STANDARD_SAFE_ROUTES } = SAFE_ROUTES
export const generatePrefixedAddressRoutes = (params: SafeRouteParams): typeof STANDARD_SAFE_ROUTES => {
  return Object.entries(STANDARD_SAFE_ROUTES).reduce<typeof STANDARD_SAFE_ROUTES>(
    (routes, [key, route]) => ({ ...routes, [key]: generateSafeRoute(route, params) }),
    {} as typeof STANDARD_SAFE_ROUTES,
  )
}

export const getSafeAppUrl = (appUrl: string, routesSlug: SafeRouteParams): string => {
  return generateSafeRoute(SAFE_ROUTES.APPS, routesSlug) + `?appUrl=${appUrl}`
}

1	import { createBrowserHistory } from 'history'
2	import { generatePath, matchPath } from 'react-router-dom'
3
4	import { getChains } from 'src/config/cache/chains'
5	import { ChainId, ShortName } from 'src/config/chain.d'
6	import { checksumAddress } from 'src/utils/checksumAddress'
7	import { PUBLIC_URL } from 'src/utils/constants'
8	import { parsePrefixedAddress } from 'src/utils/prefixedAddress'
9
10	export const history = createBrowserHistory({	45✔
11	basename: PUBLIC_URL,
12	})
13
14	// Safe specific routes
15	const hashRegExp = '0x[0-9A-Fa-f]'	45✔
16
17	const chainSpecificSafeAddressPathRegExp = `[a-z0-9-]{2,}:${hashRegExp}{40}`	45✔
18
19	export const SAFE_ADDRESS_SLUG = 'prefixedSafeAddress'	45✔
20	export const ADDRESSED_ROUTE = `/:${SAFE_ADDRESS_SLUG}(${chainSpecificSafeAddressPathRegExp})`	45✔
21
22	// Safe section routes, i.e. /:prefixedSafeAddress/settings
23	const SAFE_SECTION_SLUG = 'safeSection'	45✔
24	export const SAFE_SECTION_ROUTE = `${ADDRESSED_ROUTE}/:${SAFE_SECTION_SLUG}`	45✔
25
26	// Safe subsection routes, i.e. /:prefixedSafeAddress/settings/advanced
27	export const SAFE_SUBSECTION_SLUG = 'safeSubsection'	45✔
28	export const SAFE_SUBSECTION_ROUTE = `${SAFE_SECTION_ROUTE}/:${SAFE_SUBSECTION_SLUG}`	45✔
29
30	export const TRANSACTION_ID_SLUG = 'txId'	45✔
31
32	// URL: gnosis-safe.io/app/:[SAFE_ADDRESS_SLUG]/:[SAFE_SECTION_SLUG]/:[SAFE_SUBSECTION_SLUG]
33	export type SafeRouteSlugs = {
34	[SAFE_ADDRESS_SLUG]?: string
35	[SAFE_SECTION_SLUG]?: string
36	[SAFE_SUBSECTION_SLUG]?: string
37	[TRANSACTION_ID_SLUG]?: string
38	}
39
40	export const LOAD_SPECIFIC_SAFE_ROUTE = `/load/:${SAFE_ADDRESS_SLUG}?` // ? = optional slug	45✔
41
42	// Routes independant of safe/network
43	export const ROOT_ROUTE = '/'	45✔
44	export const WELCOME_ROUTE = '/welcome'	45✔
45	export const OPEN_SAFE_ROUTE = '/open'	45✔
46	export const GENERIC_APPS_ROUTE = '/apps'	45✔
47	export const LOAD_SAFE_ROUTE = generatePath(LOAD_SPECIFIC_SAFE_ROUTE) // By providing no slug, we get '/load'	45✔
48
49	// [SAFE_SECTION_SLUG], [SAFE_SUBSECTION_SLUG] populated safe routes
50	export const SAFE_ROUTES = {	45✔
51	DASHBOARD: `${ADDRESSED_ROUTE}/home`,
52	ASSETS_BALANCES: `${ADDRESSED_ROUTE}/balances`, // [SAFE_SECTION_SLUG] === 'balances'
53	ASSETS_BALANCES_COLLECTIBLES: `${ADDRESSED_ROUTE}/balances/nfts`, // [SAFE_SUBSECTION_SLUG] === 'nfts'
54	LEGACY_COLLECTIBLES: `${ADDRESSED_ROUTE}/balances/collectibles`,
55	TRANSACTIONS: `${ADDRESSED_ROUTE}/transactions`,
56	TRANSACTIONS_HISTORY: `${ADDRESSED_ROUTE}/transactions/history`,
57	TRANSACTIONS_QUEUE: `${ADDRESSED_ROUTE}/transactions/queue`,
58	TRANSACTIONS_SINGULAR: `${ADDRESSED_ROUTE}/transactions/:${TRANSACTION_ID_SLUG}`,
59	ADDRESS_BOOK: `${ADDRESSED_ROUTE}/address-book`,
60	APPS: `${ADDRESSED_ROUTE}/apps`,
61	SETTINGS: `${ADDRESSED_ROUTE}/settings`,
62	SETTINGS_APPEARANCE: `${ADDRESSED_ROUTE}/settings/appearance`,
63	SETTINGS_DETAILS: `${ADDRESSED_ROUTE}/settings/details`,
64	SETTINGS_OWNERS: `${ADDRESSED_ROUTE}/settings/owners`,
65	SETTINGS_POLICIES: `${ADDRESSED_ROUTE}/settings/policies`,
66	SETTINGS_SPENDING_LIMIT: `${ADDRESSED_ROUTE}/settings/spending-limit`,
67	SETTINGS_ADVANCED: `${ADDRESSED_ROUTE}/settings/advanced`,
68	}
69
70	export const getNetworkRootRoutes = (): Array<{ chainId: ChainId; route: string; shortName: string }> =>	45✔
71	getChains().map(({ chainId, chainName, shortName }) => ({	×
72	chainId,
73	route: `/${chainName.replace(/\s+/g, '-').toLowerCase()}`,
74	shortName,
75	}))
76
77	export type SafeRouteParams = { shortName: ShortName; safeAddress: string }
78
79	export const isValidShortChainName = (shortName: ShortName): boolean => {	45✔
80	return getChains().some((chain) => chain.shortName === shortName)	×
81	}
82
83	// Due to hoisting issues, these functions should remain here
84	export const extractPrefixedSafeAddress = (	45✔
85	path = history.location.pathname,	212✔
86	route = ADDRESSED_ROUTE,	119✔
87	): SafeRouteParams => {
88	const match = matchPath<SafeRouteSlugs>(path, {	217✔
89	path: route,
90	})
91
92	const prefixedSafeAddress = match?.params?.[SAFE_ADDRESS_SLUG]	217✔
93	const { prefix, address } = parsePrefixedAddress(prefixedSafeAddress \|\| '')	217✔
94
95	return {	217✔
96	shortName: prefix,
97	safeAddress: checksumAddress(address),
98	}
99	}
100
101	export const extractShortChainName = (): ShortName => extractPrefixedSafeAddress().shortName	110✔
102	export const extractSafeAddress = (): string => extractPrefixedSafeAddress().safeAddress	45✔
103
104	export const getPrefixedSafeAddressSlug = ({	45✔
105	safeAddress,
106	shortName,
107	}: {
108	safeAddress: string
109	shortName: string
110	}): string => `${shortName}:${safeAddress}`	108✔
111
112	// Populate `/:[SAFE_ADDRESS_SLUG]` with current 'shortName:safeAddress'
113	export const generateSafeRoute = (	45✔
114	path: typeof SAFE_ROUTES[keyof typeof SAFE_ROUTES],
115	params: SafeRouteParams,
116	): string =>
117	generatePath(path, {	105✔
118	[SAFE_ADDRESS_SLUG]: getPrefixedSafeAddressSlug(params),
119	})
120
121	// Singular tx route is excluded as it has a required safeTxHash slug
122	// This is to give stricter routing, instead of making the slug optional
123	const { TRANSACTIONS_SINGULAR: _hasRequiredSlug, ...STANDARD_SAFE_ROUTES } = SAFE_ROUTES	45✔
124	export const generatePrefixedAddressRoutes = (params: SafeRouteParams): typeof STANDARD_SAFE_ROUTES => {	45✔
125	return Object.entries(STANDARD_SAFE_ROUTES).reduce<typeof STANDARD_SAFE_ROUTES>(	1✔
126	(routes, [key, route]) => ({ ...routes, [key]: generateSafeRoute(route, params) }),	16✔
127	{} as typeof STANDARD_SAFE_ROUTES,
128	)
129	}
130
131	export const getSafeAppUrl = (appUrl: string, routesSlug: SafeRouteParams): string => {	45✔
UNCOV 132	return generateSafeRoute(SAFE_ROUTES.APPS, routesSlug) + `?appUrl=${appUrl}`	×
133	}

safe-global / safe-react / 2227417858

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous