9910307137

Committed 12 Jul 2024 03:25PM UTC coverage: 48.198% (-0.02%) from 48.222%

Build # 9910307137

Build Type

push

github

Committed by

hectorgomezv

Commit Message

Add accounts and active data types caching

Run Details

415 of 2593 branches covered (16.0%)

Branch coverage included in aggregate %.

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

1 existing line in 1 file now uncovered.

4266 of 7119 relevant lines covered (59.92%)

13.04 hits per line

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

11.76

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

import { CacheRouter } from '@/datasources/cache/cache.router';
import {
  CacheService,
  ICacheService,
} from '@/datasources/cache/cache.service.interface';
import { MAX_TTL } from '@/datasources/cache/constants';
import { CacheDir } from '@/datasources/cache/entities/cache-dir.entity';
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,
  UnprocessableEntityException,
} from '@nestjs/common';
import postgres from 'postgres';

@Injectable()
export class AccountsDatasource implements IAccountsDatasource {
  constructor(
    @Inject(CacheService) private readonly cacheService: ICacheService,
    @Inject('DB_INSTANCE') private readonly sql: postgres.Sql,
    @Inject(LoggingService) private readonly loggingService: ILoggingService,
  ) {}

  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}`,
        );
        return [];
      },
    );

    if (!account) {
      throw new UnprocessableEntityException('Error creating account.');
    }

    return account;
  }

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

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

    return account;
  }

  async deleteAccount(address: `0x${string}`): Promise<void> {
    const { count } = await this
      .sql`DELETE FROM accounts WHERE address = ${address}`;

    const { key } = CacheRouter.getAccountCacheDir(address);
    await this.cacheService.deleteByKey(key);

    if (count === 0) {
      this.loggingService.debug(`Error deleting account ${address}: not found`);
    }
  }

  getActiveDataTypes(): Promise<AccountDataType[]> {
    // TODO: clear on OnModuleInit
    const cacheDir = CacheRouter.getActiveAccountDataTypesCacheDir();
    return this.getFromCacheOrExecuteAndCache<AccountDataType[]>(
      cacheDir,
      this.sql<
        AccountDataType[]
      >`SELECT * FROM account_data_types WHERE is_active IS TRUE`,
      MAX_TTL,
    );
  }

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

  async getAccountDataSettings(
    address: `0x${string}`,
  ): Promise<AccountDataSetting[]> {
    const account = await this.getAccount(address);
    return 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;
    `;
  }

  /**
   * 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);
    return 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.id}, ${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}`;
    });
  }

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

  private async getFromCacheOrExecuteAndCache<T extends postgres.MaybeRow[]>(
    cacheDir: CacheDir,
    query: postgres.PendingQuery<T>,
    ttl: number,
  ): Promise<T> {
    const { key, field } = cacheDir;
    const cached = await this.cacheService.get(cacheDir);
    if (cached != null) {
      this.loggingService.debug({ type: 'cache_hit', key, field });
      return JSON.parse(cached);
    }

    this.loggingService.debug({ type: 'cache_miss', key, field });
    const result = await query;
    if (result.count > 0) {
      await this.cacheService.set(cacheDir, JSON.stringify(result), ttl);
    }
    return result;
  }
}

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

safe-global / safe-client-gateway / 9910307137

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