9954979883

Committed 16 Jul 2024 10:14AM UTC coverage: 48.233% (-0.1%) from 48.34%

Build # 9954979883

Build Type

Pull #1760

github

Committed by

hectorgomezv

Commit Message

Check the cache contents directly on AccountsDatasource tests

Pull Request Pull Request #1760: Add Accounts Datasource cache layer

Run Details

415 of 2591 branches covered (16.02%)

Branch coverage included in aggregate %.

8 of 51 new or added lines in 2 files covered. (15.69%)

3 existing lines in 1 file now uncovered.

4281 of 7145 relevant lines covered (59.92%)

12.98 hits per line

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

11.69

/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 { 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,
  InternalServerErrorException,
  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 this.getFromCacheOrExecuteAndCache<Account[]>(
      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 { key } = CacheRouter.getAccountCacheDir(address);
      await this.cacheService.deleteByKey(key);
    }
  }

  async getDataTypes(): Promise<AccountDataType[]> {
    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);
    const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(address);
    return this.getFromCacheOrExecuteAndCache<AccountDataSetting[]>(
      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.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}`;
    });

    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.id)),
      )
    ) {
      throw new UnprocessableEntityException(
        `Data types not found or not active.`,
      );
    }
  }

  /**
   * Returns the content from cache or executes the query and caches the result.
   * If the specified {@link CacheDir} is empty, the query is executed and the result is cached.
   * If the specified {@link CacheDir} is not empty, the pointed content is returned.
   *
   * @param cacheDir {@link CacheDir} to use for caching
   * @param query query to execute
   * @param ttl time to live for the cache
   * @returns content from cache or query result
   */
  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 });

    // log & hide database errors
    const result = await query.catch((e) => {
      this.loggingService.error(asError(e).message);
      throw new InternalServerErrorException();
    });

    if (result.count > 0) {
      await this.cacheService.set(cacheDir, JSON.stringify(result), ttl);
    }
    return result;
  }
}

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 { CacheDir } from '@/datasources/cache/entities/cache-dir.entity';
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	InternalServerErrorException,
20	NotFoundException,
21	OnModuleInit,
22	UnprocessableEntityException,
23	} from '@nestjs/common';
24	import postgres from 'postgres';	16✔
25
26	@Injectable()
27	export class AccountsDatasource implements IAccountsDatasource, OnModuleInit {	16✔
28	private readonly defaultExpirationTimeInSeconds: number;
29
30	constructor(
NEW 31	@Inject(CacheService) private readonly cacheService: ICacheService,	×
32	@Inject('DB_INSTANCE') private readonly sql: postgres.Sql,	×
33	@Inject(LoggingService) private readonly loggingService: ILoggingService,	×
34	@Inject(IConfigurationService)
NEW 35	private readonly configurationService: IConfigurationService,	×
36	) {
NEW 37	this.defaultExpirationTimeInSeconds =	×
38	this.configurationService.getOrThrow<number>(
39	'expirationTimeInSeconds.default',
40	);
41	}
42
43	/**
44	* Function executed when the module is initialized.
45	* It deletes the cache for persistent keys.
46	*/
47	async onModuleInit(): Promise<void> {
NEW 48	await this.cacheService.deleteByKey(	×
49	CacheRouter.getAccountDataTypesCacheDir().key,
50	);
51	}
52
53	async createAccount(address: `0x${string}`): Promise<Account> {
NEW 54	const [account] = await this.sql<[Account]>`	×
55	INSERT INTO accounts (address) VALUES (${address}) RETURNING *`.catch(
56	(e) => {
57	this.loggingService.warn(	×
58	`Error creating account: ${asError(e).message}`,
59	);
NEW 60	throw new UnprocessableEntityException('Error creating account.');	×
61	},
62	);
NEW 63	const cacheDir = CacheRouter.getAccountCacheDir(address);	×
NEW 64	await this.cacheService.set(	×
65	cacheDir,
66	JSON.stringify([account]),
67	this.defaultExpirationTimeInSeconds,
68	);
UNCOV 69	return account;	×
70	}
71
72	async getAccount(address: `0x${string}`): Promise<Account> {
NEW 73	const cacheDir = CacheRouter.getAccountCacheDir(address);	×
NEW 74	const [account] = await this.getFromCacheOrExecuteAndCache<Account[]>(	×
75	cacheDir,
76	this.sql<Account[]>`SELECT * FROM accounts WHERE address = ${address}`,
77	this.defaultExpirationTimeInSeconds,
78	);
79
80	if (!account) {	×
81	throw new NotFoundException('Error getting account.');	×
82	}
83
84	return account;	×
85	}
86
87	async deleteAccount(address: `0x${string}`): Promise<void> {
NEW 88	try {	×
NEW 89	const { count } = await this	×
90	.sql`DELETE FROM accounts WHERE address = ${address}`;
NEW 91	if (count === 0) {	×
NEW 92	this.loggingService.debug(	×
93	`Error deleting account ${address}: not found`,
94	);
95	}
96	} finally {
NEW 97	const { key } = CacheRouter.getAccountCacheDir(address);	×
NEW 98	await this.cacheService.deleteByKey(key);	×
99	}
100	}
101
102	async getDataTypes(): Promise<AccountDataType[]> {
NEW 103	const cacheDir = CacheRouter.getAccountDataTypesCacheDir();	×
NEW 104	return this.getFromCacheOrExecuteAndCache<AccountDataType[]>(	×
105	cacheDir,
106	this.sql<AccountDataType[]>`SELECT * FROM account_data_types`,
107	MAX_TTL,
108	);
109	}
110
111	async getAccountDataSettings(
112	address: `0x${string}`,
113	): Promise<AccountDataSetting[]> {
114	const account = await this.getAccount(address);	×
NEW 115	const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(address);	×
NEW 116	return this.getFromCacheOrExecuteAndCache<AccountDataSetting[]>(	×
117	cacheDir,
118	this.sql<AccountDataSetting[]>`
119	SELECT ads.* FROM account_data_settings ads INNER JOIN account_data_types adt
120	ON ads.account_data_type_id = adt.id
121	WHERE ads.account_id = ${account.id} AND adt.is_active IS TRUE;`,
122	this.defaultExpirationTimeInSeconds,
123	);
124	}
125
126	/**
127	* Adds or updates the existing account data settings for a given address/account.
128	* Requirements:
129	* - The account must exist.
130	* - The data type must exist.
131	* - The data type must be active.
132	*
133	* @param address - account address.
134	* @param upsertAccountDataSettings {@link UpsertAccountDataSettingsDto} object.
135	* @returns {Array<AccountDataSetting>} inserted account data settings.
136	*/
137	async upsertAccountDataSettings(
138	address: `0x${string}`,
139	upsertAccountDataSettings: UpsertAccountDataSettingsDto,
140	): Promise<AccountDataSetting[]> {
141	const { accountDataSettings } = upsertAccountDataSettings;	×
142	await this.checkDataTypes(accountDataSettings);	×
143	const account = await this.getAccount(address);	×
144
NEW 145	const result = await this.sql.begin(async (sql) => {	×
UNCOV 146	await Promise.all(	×
147	accountDataSettings.map(async (accountDataSetting) => {
148	return sql`	×
149	INSERT INTO account_data_settings (account_id, account_data_type_id, enabled)
150	VALUES (${account.id}, ${accountDataSetting.id}, ${accountDataSetting.enabled})
151	ON CONFLICT (account_id, account_data_type_id) DO UPDATE SET enabled = EXCLUDED.enabled
152	`.catch((e) => {
153	throw new UnprocessableEntityException(	×
154	`Error updating data settings: ${asError(e).message}`,
155	);
156	});
157	}),
158	);
159	return sql<[AccountDataSetting]>`	×
160	SELECT * FROM account_data_settings WHERE account_id = ${account.id}`;
161	});
162
NEW 163	const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(address);	×
NEW 164	await this.cacheService.set(	×
165	cacheDir,
166	JSON.stringify(result),
167	this.defaultExpirationTimeInSeconds,
168	);
NEW 169	return result;	×
170	}
171
172	private async checkDataTypes(
173	accountDataSettings: UpsertAccountDataSettingsDto['accountDataSettings'],
174	): Promise<void> {
NEW 175	const dataTypes = await this.getDataTypes();	×
NEW 176	const activeDataTypeIds = dataTypes	×
NEW 177	.filter((dt) => dt.is_active)	×
NEW 178	.map((ads) => ads.id);	×
UNCOV 179	if (	×
180	!accountDataSettings.every((ads) =>
181	activeDataTypeIds.includes(Number(ads.id)),	×
182	)
183	) {
184	throw new UnprocessableEntityException(	×
185	`Data types not found or not active.`,
186	);
187	}
188	}
189
190	/**
191	* Returns the content from cache or executes the query and caches the result.
192	* If the specified {@link CacheDir} is empty, the query is executed and the result is cached.
193	* If the specified {@link CacheDir} is not empty, the pointed content is returned.
194	*
195	* @param cacheDir {@link CacheDir} to use for caching
196	* @param query query to execute
197	* @param ttl time to live for the cache
198	* @returns content from cache or query result
199	*/
200	private async getFromCacheOrExecuteAndCache<T extends postgres.MaybeRow[]>(
201	cacheDir: CacheDir,
202	query: postgres.PendingQuery<T>,
203	ttl: number,
204	): Promise<T> {
NEW 205	const { key, field } = cacheDir;	×
NEW 206	const cached = await this.cacheService.get(cacheDir);	×
NEW 207	if (cached != null) {	×
NEW 208	this.loggingService.debug({ type: 'cache_hit', key, field });	×
NEW 209	return JSON.parse(cached);	×
210	}
NEW 211	this.loggingService.debug({ type: 'cache_miss', key, field });	×
212
213	// log & hide database errors
NEW 214	const result = await query.catch((e) => {	×
NEW 215	this.loggingService.error(asError(e).message);	×
NEW 216	throw new InternalServerErrorException();	×
217	});
218
NEW 219	if (result.count > 0) {	×
NEW 220	await this.cacheService.set(cacheDir, JSON.stringify(result), ttl);	×
221	}
NEW 222	return result;	×
223	}
224	}

safe-global / safe-client-gateway / 9954979883

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