7928869480

Committed 16 Feb 2024 09:55AM UTC coverage: 92.031% (-1.2%) from 93.192%

Build # 7928869480

Build Type

Pull #1151

github

Committed by

hectorgomezv

Commit Message

Remove TODOs that are not relevant anymore

Pull Request Pull Request #1151: Add SafeBalancesApi

Run Details

1567 of 1916 branches covered (81.78%)

Branch coverage included in aggregate %.

56 of 57 new or added lines in 4 files covered. (98.25%)

70 existing lines in 1 file now uncovered.

5893 of 6190 relevant lines covered (95.2%)

176.67 hits per line

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

96.55

/src/datasources/balances-api/safe-balances-api.service.ts

import { IConfigurationService } from '@/config/configuration.service.interface';
import { CacheFirstDataSource } from '@/datasources/cache/cache.first.data.source';
import { CacheRouter } from '@/datasources/cache/cache.router';
import { ICacheService } from '@/datasources/cache/cache.service.interface';
import { HttpErrorFactory } from '@/datasources/errors/http-error-factory';
import { Balance } from '@/domain/balances/entities/balance.entity';
import { Collectible } from '@/domain/collectibles/entities/collectible.entity';
import { Page } from '@/domain/entities/page.entity';
import { IBalancesApi } from '@/domain/interfaces/balances-api.interface';
import { Injectable } from '@nestjs/common';

@Injectable()
export class SafeBalancesApi implements IBalancesApi {
  private readonly defaultExpirationTimeInSeconds: number;
  private readonly defaultNotFoundExpirationTimeSeconds: number;

  constructor(
    private readonly chainId: string,
    private readonly baseUrl: string,
    private readonly dataSource: CacheFirstDataSource,
    private readonly cacheService: ICacheService,
    private readonly configurationService: IConfigurationService,
    private readonly httpErrorFactory: HttpErrorFactory,
  ) {
    this.defaultExpirationTimeInSeconds =
      this.configurationService.getOrThrow<number>(
        'expirationTimeInSeconds.default',
      );
    this.defaultNotFoundExpirationTimeSeconds =
      this.configurationService.getOrThrow<number>(
        'expirationTimeInSeconds.notFound.default',
      );
  }

  async getBalances(args: {
    safeAddress: string;
    trusted?: boolean;
    excludeSpam?: boolean;
  }): Promise<Balance[]> {
    try {
      const cacheDir = CacheRouter.getBalancesCacheDir({
        chainId: this.chainId,
        ...args,
      });
      const url = `${this.baseUrl}/api/v1/safes/${args.safeAddress}/balances/`;
      return await this.dataSource.get({
        cacheDir,
        url,
        notFoundExpireTimeSeconds: this.defaultNotFoundExpirationTimeSeconds,
        networkRequest: {
          params: {
            trusted: args.trusted,
            exclude_spam: args.excludeSpam,
          },
        },
        expireTimeSeconds: this.defaultExpirationTimeInSeconds,
      });
    } catch (error) {
      throw this.httpErrorFactory.from(error);
    }
  }

  async clearBalances(args: { safeAddress: string }): Promise<void> {
    const key = CacheRouter.getBalancesCacheKey({
      chainId: this.chainId,
      safeAddress: args.safeAddress,
    });
    await this.cacheService.deleteByKey(key);
  }

  async getCollectibles(args: {
    safeAddress: string;
    limit?: number;
    offset?: number;
    trusted?: boolean;
    excludeSpam?: boolean;
  }): Promise<Page<Collectible>> {
    try {
      const cacheDir = CacheRouter.getCollectiblesCacheDir({
        chainId: this.chainId,
        ...args,
      });
      const url = `${this.baseUrl}/api/v2/safes/${args.safeAddress}/collectibles/`;
      return await this.dataSource.get({
        cacheDir,
        url,
        notFoundExpireTimeSeconds: this.defaultNotFoundExpirationTimeSeconds,
        networkRequest: {
          params: {
            limit: args.limit,
            offset: args.offset,
            trusted: args.trusted,
            exclude_spam: args.excludeSpam,
          },
        },
        expireTimeSeconds: this.defaultExpirationTimeInSeconds,
      });
    } catch (error) {
      throw this.httpErrorFactory.from(error);
    }
  }

  async clearCollectibles(args: { safeAddress: string }): Promise<void> {
    const key = CacheRouter.getCollectiblesKey({
      chainId: this.chainId,
      safeAddress: args.safeAddress,
    });
    await this.cacheService.deleteByKey(key);
  }

  /**
   * No fiat prices are available from this provider.
   */
  getFiatCodes(): string[] {
    return [];
  }
}

1	import { IConfigurationService } from '@/config/configuration.service.interface';	88✔
2	import { CacheFirstDataSource } from '@/datasources/cache/cache.first.data.source';	88✔
3	import { CacheRouter } from '@/datasources/cache/cache.router';	88✔
4	import { ICacheService } from '@/datasources/cache/cache.service.interface';
5	import { HttpErrorFactory } from '@/datasources/errors/http-error-factory';	88✔
6	import { Balance } from '@/domain/balances/entities/balance.entity';
7	import { Collectible } from '@/domain/collectibles/entities/collectible.entity';
8	import { Page } from '@/domain/entities/page.entity';
9	import { IBalancesApi } from '@/domain/interfaces/balances-api.interface';
10	import { Injectable } from '@nestjs/common';	88✔
11
12	@Injectable()
13	export class SafeBalancesApi implements IBalancesApi {	88✔
14	private readonly defaultExpirationTimeInSeconds: number;
15	private readonly defaultNotFoundExpirationTimeSeconds: number;
16
17	constructor(
18	private readonly chainId: string,	102✔
19	private readonly baseUrl: string,	102✔
20	private readonly dataSource: CacheFirstDataSource,	102✔
21	private readonly cacheService: ICacheService,	102✔
22	private readonly configurationService: IConfigurationService,	102✔
23	private readonly httpErrorFactory: HttpErrorFactory,	102✔
24	) {
25	this.defaultExpirationTimeInSeconds =	102✔
26	this.configurationService.getOrThrow<number>(
27	'expirationTimeInSeconds.default',
28	);
29	this.defaultNotFoundExpirationTimeSeconds =	102✔
30	this.configurationService.getOrThrow<number>(
31	'expirationTimeInSeconds.notFound.default',
32	);
33	}
34
35	async getBalances(args: {
36	safeAddress: string;
37	trusted?: boolean;
38	excludeSpam?: boolean;
39	}): Promise<Balance[]> {
40	try {	20✔
41	const cacheDir = CacheRouter.getBalancesCacheDir({	20✔
42	chainId: this.chainId,
43	...args,
44	});
45	const url = `${this.baseUrl}/api/v1/safes/${args.safeAddress}/balances/`;	20✔
46	return await this.dataSource.get({	20✔
47	cacheDir,
48	url,
49	notFoundExpireTimeSeconds: this.defaultNotFoundExpirationTimeSeconds,
50	networkRequest: {
51	params: {
52	trusted: args.trusted,
53	exclude_spam: args.excludeSpam,
54	},
55	},
56	expireTimeSeconds: this.defaultExpirationTimeInSeconds,
57	});
58	} catch (error) {
59	throw this.httpErrorFactory.from(error);	2✔
60	}
61	}
62
63	async clearBalances(args: { safeAddress: string }): Promise<void> {
64	const key = CacheRouter.getBalancesCacheKey({	36✔
65	chainId: this.chainId,
66	safeAddress: args.safeAddress,
67	});
68	await this.cacheService.deleteByKey(key);	36✔
69	}
70
71	async getCollectibles(args: {
72	safeAddress: string;
73	limit?: number;
74	offset?: number;
75	trusted?: boolean;
76	excludeSpam?: boolean;
77	}): Promise<Page<Collectible>> {
78	try {	10✔
79	const cacheDir = CacheRouter.getCollectiblesCacheDir({	10✔
80	chainId: this.chainId,
81	...args,
82	});
83	const url = `${this.baseUrl}/api/v2/safes/${args.safeAddress}/collectibles/`;	10✔
84	return await this.dataSource.get({	10✔
85	cacheDir,
86	url,
87	notFoundExpireTimeSeconds: this.defaultNotFoundExpirationTimeSeconds,
88	networkRequest: {
89	params: {
90	limit: args.limit,
91	offset: args.offset,
92	trusted: args.trusted,
93	exclude_spam: args.excludeSpam,
94	},
95	},
96	expireTimeSeconds: this.defaultExpirationTimeInSeconds,
97	});
98	} catch (error) {
99	throw this.httpErrorFactory.from(error);	4✔
100	}
101	}
102
103	async clearCollectibles(args: { safeAddress: string }): Promise<void> {
104	const key = CacheRouter.getCollectiblesKey({	36✔
105	chainId: this.chainId,
106	safeAddress: args.safeAddress,
107	});
108	await this.cacheService.deleteByKey(key);	36✔
109	}
110
111	/**
112	* No fiat prices are available from this provider.
113	*/
114	getFiatCodes(): string[] {
NEW 115	return [];	×
116	}
117	}

safe-global / safe-client-gateway / 7928869480

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