10005486281

Committed 19 Jul 2024 09:03AM UTC coverage: 48.163% (-0.07%) from 48.233%

Build # 10005486281

Build Type

Pull #1773

github

Committed by

web-flow

Commit Message

Merge 7888b8b28 into 03923f685

Pull Request Pull Request #1773: Add Counterfactual Safes Datasource

Run Details

417 of 2612 branches covered (15.96%)

Branch coverage included in aggregate %.

6 of 25 new or added lines in 3 files covered. (24.0%)

64 existing lines in 7 files now uncovered.

4288 of 7157 relevant lines covered (59.91%)

13.01 hits per line

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

16.13

/src/datasources/accounts/accounts.datasource.ts

import { IConfigurationService } from '@/config/configuration.service.interface';
import { CacheRouter } from '@/datasources/cache/cache.router';
import {
  CacheService,
  ICacheService,
} from '@/datasources/cache/cache.service.interface';
import { MAX_TTL } from '@/datasources/cache/constants';
import { getFromCacheOrExecuteAndCache } from '@/datasources/db/utils';
import { AccountDataSetting } from '@/domain/accounts/entities/account-data-setting.entity';
import { AccountDataType } from '@/domain/accounts/entities/account-data-type.entity';
import { Account } from '@/domain/accounts/entities/account.entity';
import { UpsertAccountDataSettingsDto } from '@/domain/accounts/entities/upsert-account-data-settings.dto.entity';
import { IAccountsDatasource } from '@/domain/interfaces/accounts.datasource.interface';
import { ILoggingService, LoggingService } from '@/logging/logging.interface';
import { asError } from '@/logging/utils';
import {
  Inject,
  Injectable,
  NotFoundException,
  OnModuleInit,
  UnprocessableEntityException,
} from '@nestjs/common';
import postgres from 'postgres';

@Injectable()
export class AccountsDatasource implements IAccountsDatasource, OnModuleInit {
  private readonly defaultExpirationTimeInSeconds: number;

  constructor(
    @Inject(CacheService) private readonly cacheService: ICacheService,
    @Inject('DB_INSTANCE') private readonly sql: postgres.Sql,
    @Inject(LoggingService) private readonly loggingService: ILoggingService,
    @Inject(IConfigurationService)
    private readonly configurationService: IConfigurationService,
  ) {
    this.defaultExpirationTimeInSeconds =
      this.configurationService.getOrThrow<number>(
        'expirationTimeInSeconds.default',
      );
  }

  /**
   * Function executed when the module is initialized.
   * It deletes the cache for persistent keys.
   */
  async onModuleInit(): Promise<void> {
    await this.cacheService.deleteByKey(
      CacheRouter.getAccountDataTypesCacheDir().key,
    );
  }

  async createAccount(address: `0x${string}`): Promise<Account> {
    const [account] = await this.sql<[Account]>`
      INSERT INTO accounts (address) VALUES (${address}) RETURNING *`.catch(
      (e) => {
        this.loggingService.warn(
          `Error creating account: ${asError(e).message}`,
        );
        throw new UnprocessableEntityException('Error creating account.');
      },
    );
    const cacheDir = CacheRouter.getAccountCacheDir(address);
    await this.cacheService.set(
      cacheDir,
      JSON.stringify([account]),
      this.defaultExpirationTimeInSeconds,
    );
    return account;
  }

  async getAccount(address: `0x${string}`): Promise<Account> {
    const cacheDir = CacheRouter.getAccountCacheDir(address);
    const [account] = await getFromCacheOrExecuteAndCache<Account[]>(
      this.loggingService,
      this.cacheService,
      cacheDir,
      this.sql<Account[]>`SELECT * FROM accounts WHERE address = ${address}`,
      this.defaultExpirationTimeInSeconds,
    );

    if (!account) {
      throw new NotFoundException('Error getting account.');
    }

    return account;
  }

  async deleteAccount(address: `0x${string}`): Promise<void> {
    try {
      const { count } = await this
        .sql`DELETE FROM accounts WHERE address = ${address}`;
      if (count === 0) {
        this.loggingService.debug(
          `Error deleting account ${address}: not found`,
        );
      }
    } finally {
      const keys = [
        CacheRouter.getAccountCacheDir(address).key,
        CacheRouter.getAccountDataSettingsCacheDir(address).key,
        CacheRouter.getCounterfactualSafesCacheDir(address).key,
      ];
      await Promise.all(keys.map((key) => this.cacheService.deleteByKey(key)));
    }
  }

  async getDataTypes(): Promise<AccountDataType[]> {
    const cacheDir = CacheRouter.getAccountDataTypesCacheDir();
    return getFromCacheOrExecuteAndCache<AccountDataType[]>(
      this.loggingService,
      this.cacheService,
      cacheDir,
      this.sql<AccountDataType[]>`SELECT * FROM account_data_types`,
      MAX_TTL,
    );
  }

  async getAccountDataSettings(
    address: `0x${string}`,
  ): Promise<AccountDataSetting[]> {
    const account = await this.getAccount(address);
    const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(address);
    return getFromCacheOrExecuteAndCache<AccountDataSetting[]>(
      this.loggingService,
      this.cacheService,
      cacheDir,
      this.sql<AccountDataSetting[]>`
        SELECT ads.* FROM account_data_settings ads INNER JOIN account_data_types adt
          ON ads.account_data_type_id = adt.id
        WHERE ads.account_id = ${account.id} AND adt.is_active IS TRUE;`,
      this.defaultExpirationTimeInSeconds,
    );
  }

  /**
   * Adds or updates the existing account data settings for a given address/account.
   * Requirements:
   * - The account must exist.
   * - The data type must exist.
   * - The data type must be active.
   *
   * @param address - account address.
   * @param upsertAccountDataSettings {@link UpsertAccountDataSettingsDto} object.
   * @returns {Array<AccountDataSetting>} inserted account data settings.
   */
  async upsertAccountDataSettings(
    address: `0x${string}`,
    upsertAccountDataSettings: UpsertAccountDataSettingsDto,
  ): Promise<AccountDataSetting[]> {
    const { accountDataSettings } = upsertAccountDataSettings;
    await this.checkDataTypes(accountDataSettings);
    const account = await this.getAccount(address);

    const result = await this.sql.begin(async (sql) => {
      await Promise.all(
        accountDataSettings.map(async (accountDataSetting) => {
          return sql`
            INSERT INTO account_data_settings (account_id, account_data_type_id, enabled)
            VALUES (${account.id}, ${accountDataSetting.dataTypeId}, ${accountDataSetting.enabled})
            ON CONFLICT (account_id, account_data_type_id) DO UPDATE SET enabled = EXCLUDED.enabled
          `.catch((e) => {
            throw new UnprocessableEntityException(
              `Error updating data settings: ${asError(e).message}`,
            );
          });
        }),
      );
      return sql<[AccountDataSetting]>`
        SELECT * FROM account_data_settings WHERE account_id = ${account.id}`;
    });

    const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(address);
    await this.cacheService.set(
      cacheDir,
      JSON.stringify(result),
      this.defaultExpirationTimeInSeconds,
    );
    return result;
  }

  private async checkDataTypes(
    accountDataSettings: UpsertAccountDataSettingsDto['accountDataSettings'],
  ): Promise<void> {
    const dataTypes = await this.getDataTypes();
    const activeDataTypeIds = dataTypes
      .filter((dt) => dt.is_active)
      .map((ads) => ads.id);
    if (
      !accountDataSettings.every((ads) =>
        activeDataTypeIds.includes(Number(ads.dataTypeId)),
      )
    ) {
      throw new UnprocessableEntityException(
        `Data types not found or not active.`,
      );
    }
  }
}

1	import { IConfigurationService } from '@/config/configuration.service.interface';	16✔
2	import { CacheRouter } from '@/datasources/cache/cache.router';	16✔
3	import {	16✔
4	CacheService,
5	ICacheService,
6	} from '@/datasources/cache/cache.service.interface';
7	import { MAX_TTL } from '@/datasources/cache/constants';	16✔
8	import { getFromCacheOrExecuteAndCache } from '@/datasources/db/utils';	16✔
9	import { AccountDataSetting } from '@/domain/accounts/entities/account-data-setting.entity';
10	import { AccountDataType } from '@/domain/accounts/entities/account-data-type.entity';
11	import { Account } from '@/domain/accounts/entities/account.entity';
12	import { UpsertAccountDataSettingsDto } from '@/domain/accounts/entities/upsert-account-data-settings.dto.entity';
13	import { IAccountsDatasource } from '@/domain/interfaces/accounts.datasource.interface';
14	import { ILoggingService, LoggingService } from '@/logging/logging.interface';	16✔
15	import { asError } from '@/logging/utils';	16✔
16	import {	16✔
17	Inject,
18	Injectable,
19	NotFoundException,
20	OnModuleInit,
21	UnprocessableEntityException,
22	} from '@nestjs/common';
23	import postgres from 'postgres';	16✔
24
25	@Injectable()
26	export class AccountsDatasource implements IAccountsDatasource, OnModuleInit {	16✔
27	private readonly defaultExpirationTimeInSeconds: number;
28
29	constructor(
30	@Inject(CacheService) private readonly cacheService: ICacheService,	×
31	@Inject('DB_INSTANCE') private readonly sql: postgres.Sql,	×
32	@Inject(LoggingService) private readonly loggingService: ILoggingService,	×
33	@Inject(IConfigurationService)
34	private readonly configurationService: IConfigurationService,	×
35	) {
36	this.defaultExpirationTimeInSeconds =	×
37	this.configurationService.getOrThrow<number>(
38	'expirationTimeInSeconds.default',
39	);
40	}
41
42	/**
43	* Function executed when the module is initialized.
44	* It deletes the cache for persistent keys.
45	*/
46	async onModuleInit(): Promise<void> {
47	await this.cacheService.deleteByKey(	×
48	CacheRouter.getAccountDataTypesCacheDir().key,
49	);
50	}
51
52	async createAccount(address: `0x${string}`): Promise<Account> {
53	const [account] = await this.sql<[Account]>`	×
54	INSERT INTO accounts (address) VALUES (${address}) RETURNING *`.catch(
55	(e) => {
56	this.loggingService.warn(	×
57	`Error creating account: ${asError(e).message}`,
58	);
59	throw new UnprocessableEntityException('Error creating account.');	×
60	},
61	);
62	const cacheDir = CacheRouter.getAccountCacheDir(address);	×
63	await this.cacheService.set(	×
64	cacheDir,
65	JSON.stringify([account]),
66	this.defaultExpirationTimeInSeconds,
67	);
68	return account;	×
69	}
70
71	async getAccount(address: `0x${string}`): Promise<Account> {
72	const cacheDir = CacheRouter.getAccountCacheDir(address);	×
NEW 73	const [account] = await getFromCacheOrExecuteAndCache<Account[]>(	×
74	this.loggingService,
75	this.cacheService,
76	cacheDir,
77	this.sql<Account[]>`SELECT * FROM accounts WHERE address = ${address}`,
78	this.defaultExpirationTimeInSeconds,
79	);
80
81	if (!account) {	×
82	throw new NotFoundException('Error getting account.');	×
83	}
84
85	return account;	×
86	}
87
88	async deleteAccount(address: `0x${string}`): Promise<void> {
89	try {	×
90	const { count } = await this	×
91	.sql`DELETE FROM accounts WHERE address = ${address}`;
92	if (count === 0) {	×
93	this.loggingService.debug(	×
94	`Error deleting account ${address}: not found`,
95	);
96	}
97	} finally {
NEW 98	const keys = [	×
99	CacheRouter.getAccountCacheDir(address).key,
100	CacheRouter.getAccountDataSettingsCacheDir(address).key,
101	CacheRouter.getCounterfactualSafesCacheDir(address).key,
102	];
NEW 103	await Promise.all(keys.map((key) => this.cacheService.deleteByKey(key)));	×
104	}
105	}
106
107	async getDataTypes(): Promise<AccountDataType[]> {
108	const cacheDir = CacheRouter.getAccountDataTypesCacheDir();	×
NEW 109	return getFromCacheOrExecuteAndCache<AccountDataType[]>(	×
110	this.loggingService,
111	this.cacheService,
112	cacheDir,
113	this.sql<AccountDataType[]>`SELECT * FROM account_data_types`,
114	MAX_TTL,
115	);
116	}
117
118	async getAccountDataSettings(
119	address: `0x${string}`,
120	): Promise<AccountDataSetting[]> {
121	const account = await this.getAccount(address);	×
122	const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(address);	×
NEW 123	return getFromCacheOrExecuteAndCache<AccountDataSetting[]>(	×
124	this.loggingService,
125	this.cacheService,
126	cacheDir,
127	this.sql<AccountDataSetting[]>`
128	SELECT ads.* FROM account_data_settings ads INNER JOIN account_data_types adt
129	ON ads.account_data_type_id = adt.id
130	WHERE ads.account_id = ${account.id} AND adt.is_active IS TRUE;`,
131	this.defaultExpirationTimeInSeconds,
132	);
133	}
134
135	/**
136	* Adds or updates the existing account data settings for a given address/account.
137	* Requirements:
138	* - The account must exist.
139	* - The data type must exist.
140	* - The data type must be active.
141	*
142	* @param address - account address.
143	* @param upsertAccountDataSettings {@link UpsertAccountDataSettingsDto} object.
144	* @returns {Array<AccountDataSetting>} inserted account data settings.
145	*/
146	async upsertAccountDataSettings(
147	address: `0x${string}`,
148	upsertAccountDataSettings: UpsertAccountDataSettingsDto,
149	): Promise<AccountDataSetting[]> {
150	const { accountDataSettings } = upsertAccountDataSettings;	×
151	await this.checkDataTypes(accountDataSettings);	×
152	const account = await this.getAccount(address);	×
153
154	const result = await this.sql.begin(async (sql) => {	×
155	await Promise.all(	×
156	accountDataSettings.map(async (accountDataSetting) => {
157	return sql`	×
158	INSERT INTO account_data_settings (account_id, account_data_type_id, enabled)
159	VALUES (${account.id}, ${accountDataSetting.dataTypeId}, ${accountDataSetting.enabled})
160	ON CONFLICT (account_id, account_data_type_id) DO UPDATE SET enabled = EXCLUDED.enabled
161	`.catch((e) => {
162	throw new UnprocessableEntityException(	×
163	`Error updating data settings: ${asError(e).message}`,
164	);
165	});
166	}),
167	);
168	return sql<[AccountDataSetting]>`	×
169	SELECT * FROM account_data_settings WHERE account_id = ${account.id}`;
170	});
171
172	const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(address);	×
173	await this.cacheService.set(	×
174	cacheDir,
175	JSON.stringify(result),
176	this.defaultExpirationTimeInSeconds,
177	);
178	return result;	×
179	}
180
181	private async checkDataTypes(
182	accountDataSettings: UpsertAccountDataSettingsDto['accountDataSettings'],
183	): Promise<void> {
184	const dataTypes = await this.getDataTypes();	×
185	const activeDataTypeIds = dataTypes	×
186	.filter((dt) => dt.is_active)	×
187	.map((ads) => ads.id);	×
188	if (	×
189	!accountDataSettings.every((ads) =>
190	activeDataTypeIds.includes(Number(ads.dataTypeId)),	×
191	)
192	) {
193	throw new UnprocessableEntityException(	×
194	`Data types not found or not active.`,
195	);
196	}
197	}
198	}

safe-global / safe-client-gateway / 10005486281

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