3421001094

Committed 08 Nov 2022 03:54PM UTC coverage: 41.764% (-0.07%) from 41.836%

Build Type

github

Committed by GitHub

Commit Message

Merge 571d08d74 into 2a2da7063

Pull Request Pull Request #4114: fix: Add export data button to settings page

Run Details

1787 of 5272 branches covered (33.9%)

Branch coverage included in aggregate %.

0 of 12 new or added lines in 2 files covered. (0.0%)

40 existing lines in 3 files now uncovered.

4777 of 10445 relevant lines covered (45.73%)

38.86 hits per line

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

95.56

/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 { DEMO_SAFE_MAINNET, 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 independent 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'
export const SAFE_APP_LANDING_PAGE_ROUTE = '/share/safe-app'

// [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`,
  SETTINGS_SAFE_APPS_PERMISSIONS: `${ADDRESSED_ROUTE}/settings/safe-apps-permissions`,
}

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 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}`
}

export const demoSafeRoute = generateSafeRoute(SAFE_ROUTES.APPS, {
  shortName: 'eth',
  safeAddress: DEMO_SAFE_MAINNET,
})

export const getShareSafeAppUrl = (appUrl: string, chainId: string): string => {
  const baseUrl = `${window.location.origin}${PUBLIC_URL}`

  return `${baseUrl}${SAFE_APP_LANDING_PAGE_ROUTE}?appUrl=${encodeURI(appUrl)}&chainId=${chainId}`
}

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

safe-global / safe-react / 3421001094

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