2454404876

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/safe-global/safe-react/commit/<a class=hub.com/safe-global/safe-react/commit/<a class="double-link" href="https://git"><a class=hub.com/safe-global/safe-react/commit/<a class="double-link" href="https://git"><a class=hub.com/safe-global/safe-react/commit/<a class="double-link" href="https://git"><a class=hub.com/safe-global/safe-react/commit/2a30f065a07247123d43b51a7f849b73b618220c">2a30f065a">&lt;a href=&quot;https://github.com/safe-global/safe-react/commit/</a><a class="double-link" href="https://github.com/safe-global/safe-react/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/safe-global/safe-react/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/safe-global/safe-react/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/safe-global/safe-react/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/safe-global/safe-react/commit/2a30f065a07247123d43b51a7f849b73b618220c">2a30f065a</a><a href="https://github.com/safe-global/safe-react/commit/2a30f065a07247123d43b51a7f849b73b618220c">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/safe-global/safe-react/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/safe-global/safe-react/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/safe-global/safe-react/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/safe-global/safe-react/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/safe-global/safe-react/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/safe-global/safe-react/commit/2a30f065a07247123d43b51a7f849b73b618220c&quot;&gt;2a30f065a&lt;/a&gt;&lt;a href=&quot;https://github.com/safe-global/safe-react/commit/2a30f065a07247123d43b51a7f849b73b618220c&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/safe-global/safe-react/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp... (continued)

Pull Request Pull Request #3870: fix: filter historical transactions

Run Details

1451 of 4871 branches covered (29.79%)

Branch coverage included in aggregate %.

133 of 133 new or added lines in 10 files covered. (100.0%)

4000 of 9777 relevant lines covered (40.91%)

37.78 hits per line

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

7.14

/src/logic/safe/store/actions/transactions/fetchTransactions/loadGatewayTransactions.ts

import {
  getTransactionHistory,
  getTransactionQueue,
  TransactionListPage,
  getIncomingTransfers,
  getMultisigTransactions,
  getModuleTransactions,
} from '@gnosis.pm/safe-react-gateway-sdk'
import { _getChainId } from 'src/config'
import { HistoryGatewayResponse, QueuedGatewayResponse } from 'src/logic/safe/store/models/types/gateway.d'
import { checksumAddress } from 'src/utils/checksumAddress'
import { Errors, CodedException } from 'src/logic/exceptions/CodedException'
import { FilterForm, FilterType, FILTER_TYPE_FIELD_NAME } from 'src/routes/safe/components/Transactions/TxList/Filter'
import {
  getIncomingFilter,
  getMultisigFilter,
  getModuleFilter,
} from 'src/routes/safe/components/Transactions/TxList/Filter/utils'
import { ChainId } from 'src/config/chain.d'
import { operations } from '@gnosis.pm/safe-react-gateway-sdk/dist/types/api'

/*************/
/*  HISTORY  */
/*************/
const historyPointers: {
  [chainId: string]: {
    [safeAddress: string]: {
      next?: string
      previous?: string
      filterType?: FilterType
    }
  }
} = {}

const getHistoryTxListPage = async (
  chainId: ChainId,
  safeAddress: string,
  filter?: FilterForm | Partial<FilterForm>,
): Promise<TransactionListPage> => {
  let txListPage: TransactionListPage = {
    next: undefined,
    previous: undefined,
    results: [],
  }

  const { next, filterType } = historyPointers[chainId]?.[safeAddress] || {}

  let query:
    | operations['incoming_transfers' | 'incoming_transfers' | 'module_transactions']['parameters']['query']
    | undefined

  switch (filterType) {
    case FilterType.INCOMING: {
      query = filter ? getIncomingFilter(filter) : undefined
      txListPage = await getIncomingTransfers(chainId, safeAddress, query, next)
      break
    }
    case FilterType.MULTISIG: {
      query = filter ? getMultisigFilter(filter, true) : undefined
      txListPage = await getMultisigTransactions(chainId, safeAddress, query, next)
      break
    }
    case FilterType.MODULE: {
      query = filter ? getModuleFilter(filter) : undefined
      txListPage = await getModuleTransactions(chainId, safeAddress, query, next)
      break
    }
    default: {
      txListPage = await getTransactionHistory(chainId, safeAddress, next)
    }
  }

  const getPageUrl = (pageUrl?: string): string | undefined => {
    if (!pageUrl || !filterType || !query) {
      return pageUrl
    }

    const url = new URL(pageUrl)

    Object.entries(query).forEach(([key, value]) => {
      url.searchParams.set(key, value)
    })

    console.log(url.toString())

    return url.toString()
  }

  historyPointers[chainId][safeAddress].next = getPageUrl(txListPage?.next)
  historyPointers[chainId][safeAddress].previous = getPageUrl(txListPage?.previous)

  return txListPage
}

/**
 * Fetch next page if there is a next pointer for the safeAddress.
 * If the fetch was success, updates the pointers.
 * @param {string} safeAddress
 */
export const loadPagedHistoryTransactions = async (
  safeAddress: string,
): Promise<{ values: HistoryGatewayResponse['results']; next?: string } | undefined> => {
  const chainId = _getChainId()

  if (!historyPointers[chainId]?.[safeAddress]?.next) {
    throw new CodedException(Errors._608)
  }

  try {
    const { results, next } = await getHistoryTxListPage(chainId, safeAddress)

    return { values: results, next }
  } catch (e) {
    throw new CodedException(Errors._602, e.message)
  }
}

export const loadHistoryTransactions = async (
  safeAddress: string,
  filter?: FilterForm | Partial<FilterForm>,
): Promise<HistoryGatewayResponse['results']> => {
  const chainId = _getChainId()

  if (!historyPointers[chainId]) {
    historyPointers[chainId] = {}
  }

  const isNewFilter = filter?.type !== historyPointers?.[chainId]?.[safeAddress]?.filterType
  if (!historyPointers[chainId][safeAddress] || isNewFilter) {
    historyPointers[chainId][safeAddress] = {
      next: undefined,
      previous: undefined,
      filterType: filter?.[FILTER_TYPE_FIELD_NAME],
    }
  }

  try {
    const { results } = await getHistoryTxListPage(chainId, safeAddress, filter)

    return results
  } catch (e) {
    throw new CodedException(Errors._602, e.message)
  }
}

/************/
/*  QUEUED  */
/************/
const queuedPointers: { [chainId: string]: { [safeAddress: string]: { next?: string; previous?: string } } } = {}

/**
 * Fetch next page if there is a next pointer for the safeAddress.
 * If the fetch was success, updates the pointers.
 * @param {string} safeAddress
 */
export const loadPagedQueuedTransactions = async (
  safeAddress: string,
): Promise<{ values: QueuedGatewayResponse['results']; next?: string } | undefined> => {
  const chainId = _getChainId()
  // if `queuedPointers[safeAddress] is `undefined` it means `loadHistoryTransactions` wasn't called
  // if `queuedPointers[safeAddress].next is `null`, it means it reached the last page in gateway-client
  if (!queuedPointers[safeAddress]?.next) {
    throw new CodedException(Errors._608)
  }

  try {
    const { results, next, previous } = await getTransactionQueue(
      chainId,
      checksumAddress(safeAddress),
      queuedPointers[chainId][safeAddress].next,
    )

    queuedPointers[chainId][safeAddress] = { next, previous }

    return { values: results, next: queuedPointers[chainId][safeAddress].next }
  } catch (e) {
    throw new CodedException(Errors._603, e.message)
  }
}

export const loadQueuedTransactions = async (safeAddress: string): Promise<QueuedGatewayResponse['results']> => {
  const chainId = _getChainId()
  try {
    const { results, next, previous } = await getTransactionQueue(chainId, checksumAddress(safeAddress))

    if (!queuedPointers[chainId]) {
      queuedPointers[chainId] = {}
    }

    if (!queuedPointers[chainId][safeAddress] || queuedPointers[chainId][safeAddress].next === null) {
      queuedPointers[chainId][safeAddress] = { next, previous }
    }

    return results
  } catch (e) {
    throw new CodedException(Errors._603, e.message)
  }
}

1	import {
2	getTransactionHistory,
3	getTransactionQueue,
4	TransactionListPage,
5	getIncomingTransfers,
6	getMultisigTransactions,
7	getModuleTransactions,
8	} from '@gnosis.pm/safe-react-gateway-sdk'
9	import { _getChainId } from 'src/config'
10	import { HistoryGatewayResponse, QueuedGatewayResponse } from 'src/logic/safe/store/models/types/gateway.d'
11	import { checksumAddress } from 'src/utils/checksumAddress'
12	import { Errors, CodedException } from 'src/logic/exceptions/CodedException'
13	import { FilterForm, FilterType, FILTER_TYPE_FIELD_NAME } from 'src/routes/safe/components/Transactions/TxList/Filter'
14	import {
15	getIncomingFilter,
16	getMultisigFilter,
17	getModuleFilter,
18	} from 'src/routes/safe/components/Transactions/TxList/Filter/utils'
19	import { ChainId } from 'src/config/chain.d'
20	import { operations } from '@gnosis.pm/safe-react-gateway-sdk/dist/types/api'
21
22	/*************/
23	/* HISTORY */
24	/*************/
25	const historyPointers: {
26	[chainId: string]: {
27	[safeAddress: string]: {
28	next?: string
29	previous?: string
30	filterType?: FilterType
31	}
32	}
33	} = {}	10✔
34
35	const getHistoryTxListPage = async (	10✔
36	chainId: ChainId,
37	safeAddress: string,
38	filter?: FilterForm \| Partial<FilterForm>,
39	): Promise<TransactionListPage> => {
40	let txListPage: TransactionListPage = {	×
41	next: undefined,
42	previous: undefined,
43	results: [],
44	}
45
46	const { next, filterType } = historyPointers[chainId]?.[safeAddress] \|\| {}	×
47
48	let query:
49	\| operations['incoming_transfers' \| 'incoming_transfers' \| 'module_transactions']['parameters']['query']
50	\| undefined
51
52	switch (filterType) {	×
53	case FilterType.INCOMING: {
54	query = filter ? getIncomingFilter(filter) : undefined	×
55	txListPage = await getIncomingTransfers(chainId, safeAddress, query, next)	×
56	break	×
57	}
58	case FilterType.MULTISIG: {
59	query = filter ? getMultisigFilter(filter, true) : undefined	×
60	txListPage = await getMultisigTransactions(chainId, safeAddress, query, next)	×
61	break	×
62	}
63	case FilterType.MODULE: {
64	query = filter ? getModuleFilter(filter) : undefined	×
65	txListPage = await getModuleTransactions(chainId, safeAddress, query, next)	×
66	break	×
67	}
68	default: {
69	txListPage = await getTransactionHistory(chainId, safeAddress, next)	×
70	}
71	}
72
73	const getPageUrl = (pageUrl?: string): string \| undefined => {	×
74	if (!pageUrl \|\| !filterType \|\| !query) {	×
75	return pageUrl	×
76	}
77
78	const url = new URL(pageUrl)	×
79
80	Object.entries(query).forEach(([key, value]) => {	×
81	url.searchParams.set(key, value)	×
82	})
83
84	console.log(url.toString())	×
85
86	return url.toString()	×
87	}
88
89	historyPointers[chainId][safeAddress].next = getPageUrl(txListPage?.next)	×
90	historyPointers[chainId][safeAddress].previous = getPageUrl(txListPage?.previous)	×
91
92	return txListPage	×
93	}
94
95	/**
96	* Fetch next page if there is a next pointer for the safeAddress.
97	* If the fetch was success, updates the pointers.
98	* @param {string} safeAddress
99	*/
100	export const loadPagedHistoryTransactions = async (	10✔
101	safeAddress: string,
102	): Promise<{ values: HistoryGatewayResponse['results']; next?: string } \| undefined> => {
103	const chainId = _getChainId()	×
104
105	if (!historyPointers[chainId]?.[safeAddress]?.next) {	×
106	throw new CodedException(Errors._608)	×
107	}
108
109	try {	×
110	const { results, next } = await getHistoryTxListPage(chainId, safeAddress)	×
111
112	return { values: results, next }	×
113	} catch (e) {
114	throw new CodedException(Errors._602, e.message)	×
115	}
116	}
117
118	export const loadHistoryTransactions = async (	10✔
119	safeAddress: string,
120	filter?: FilterForm \| Partial<FilterForm>,
121	): Promise<HistoryGatewayResponse['results']> => {
122	const chainId = _getChainId()	×
123
124	if (!historyPointers[chainId]) {	×
125	historyPointers[chainId] = {}	×
126	}
127
128	const isNewFilter = filter?.type !== historyPointers?.[chainId]?.[safeAddress]?.filterType	×
129	if (!historyPointers[chainId][safeAddress] \|\| isNewFilter) {	×
130	historyPointers[chainId][safeAddress] = {	×
131	next: undefined,
132	previous: undefined,
133	filterType: filter?.[FILTER_TYPE_FIELD_NAME],
134	}
135	}
136
137	try {	×
138	const { results } = await getHistoryTxListPage(chainId, safeAddress, filter)	×
139
140	return results	×
141	} catch (e) {
142	throw new CodedException(Errors._602, e.message)	×
143	}
144	}
145
146	/************/
147	/* QUEUED */
148	/************/
149	const queuedPointers: { [chainId: string]: { [safeAddress: string]: { next?: string; previous?: string } } } = {}	10✔
150
151	/**
152	* Fetch next page if there is a next pointer for the safeAddress.
153	* If the fetch was success, updates the pointers.
154	* @param {string} safeAddress
155	*/
156	export const loadPagedQueuedTransactions = async (	10✔
157	safeAddress: string,
158	): Promise<{ values: QueuedGatewayResponse['results']; next?: string } \| undefined> => {
159	const chainId = _getChainId()	×
160	// if `queuedPointers[safeAddress] is `undefined` it means `loadHistoryTransactions` wasn't called
161	// if `queuedPointers[safeAddress].next is `null`, it means it reached the last page in gateway-client
162	if (!queuedPointers[safeAddress]?.next) {	×
163	throw new CodedException(Errors._608)	×
164	}
165
166	try {	×
167	const { results, next, previous } = await getTransactionQueue(	×
168	chainId,
169	checksumAddress(safeAddress),
170	queuedPointers[chainId][safeAddress].next,
171	)
172
173	queuedPointers[chainId][safeAddress] = { next, previous }	×
174
175	return { values: results, next: queuedPointers[chainId][safeAddress].next }	×
176	} catch (e) {
177	throw new CodedException(Errors._603, e.message)	×
178	}
179	}
180
181	export const loadQueuedTransactions = async (safeAddress: string): Promise<QueuedGatewayResponse['results']> => {	10✔
182	const chainId = _getChainId()	×
183	try {	×
184	const { results, next, previous } = await getTransactionQueue(chainId, checksumAddress(safeAddress))	×
185
186	if (!queuedPointers[chainId]) {	×
187	queuedPointers[chainId] = {}	×
188	}
189
190	if (!queuedPointers[chainId][safeAddress] \|\| queuedPointers[chainId][safeAddress].next === null) {	×
191	queuedPointers[chainId][safeAddress] = { next, previous }	×
192	}
193
194	return results	×
195	} catch (e) {
196	throw new CodedException(Errors._603, e.message)	×
197	}
198	}

safe-global / safe-react / 2454404876

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