10041336019

Committed 22 Jul 2024 01:01PM UTC coverage: 48.454% (+0.02%) from 48.432%

Build # 10041336019

Build Type

push

github

Committed by

web-flow

Commit Message

Add Counterfactual Safes Datasource (#1773)

Adds `CounterfactualSafesDatasource`, database migration, and associated tests.

Run Details

437 of 2633 branches covered (16.6%)

Branch coverage included in aggregate %.

6 of 31 new or added lines in 4 files covered. (19.35%)

1 existing line in 1 file now uncovered.

4326 of 7197 relevant lines covered (60.11%)

13.05 hits per line

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

15.79

/src/datasources/db/utils.ts

import { ICacheService } from '@/datasources/cache/cache.service.interface';
import { CacheDir } from '@/datasources/cache/entities/cache-dir.entity';
import { ILoggingService } from '@/logging/logging.interface';
import { asError } from '@/logging/utils';
import { InternalServerErrorException } from '@nestjs/common';
import postgres from 'postgres';

/**
 * 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 loggingService {@link ILoggingService} to use for logging
 * @param cacheService {@link ICacheService} to use for caching
 * @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
 */
// TODO: add tests
export async function getFromCacheOrExecuteAndCache<
  T extends postgres.MaybeRow[],
>(
  loggingService: ILoggingService,
  cacheService: ICacheService,
  cacheDir: CacheDir,
  query: postgres.PendingQuery<T>,
  ttl: number,
): Promise<T> {
  const { key, field } = cacheDir;
  const cached = await cacheService.get(cacheDir);
  if (cached != null) {
    loggingService.debug({ type: 'cache_hit', key, field });
    return JSON.parse(cached);
  }
  loggingService.debug({ type: 'cache_miss', key, field });

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

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

1	import { ICacheService } from '@/datasources/cache/cache.service.interface';
2	import { CacheDir } from '@/datasources/cache/entities/cache-dir.entity';
3	import { ILoggingService } from '@/logging/logging.interface';
4	import { asError } from '@/logging/utils';	16✔
5	import { InternalServerErrorException } from '@nestjs/common';	16✔
6	import postgres from 'postgres';
7
8	/**
9	* Returns the content from cache or executes the query and caches the result.
10	* If the specified {@link CacheDir} is empty, the query is executed and the result is cached.
11	* If the specified {@link CacheDir} is not empty, the pointed content is returned.
12	*
13	* @param loggingService {@link ILoggingService} to use for logging
14	* @param cacheService {@link ICacheService} to use for caching
15	* @param cacheDir {@link CacheDir} to use for caching
16	* @param query query to execute
17	* @param ttl time to live for the cache
18	* @returns content from cache or query result
19	*/
20	// TODO: add tests
21	export async function getFromCacheOrExecuteAndCache<	16✔
22	T extends postgres.MaybeRow[],
23	>(
24	loggingService: ILoggingService,
25	cacheService: ICacheService,
26	cacheDir: CacheDir,
27	query: postgres.PendingQuery<T>,
28	ttl: number,
29	): Promise<T> {
NEW 30	const { key, field } = cacheDir;	×
NEW 31	const cached = await cacheService.get(cacheDir);	×
NEW 32	if (cached != null) {	×
NEW 33	loggingService.debug({ type: 'cache_hit', key, field });	×
NEW 34	return JSON.parse(cached);	×
35	}
NEW 36	loggingService.debug({ type: 'cache_miss', key, field });	×
37
38	// log & hide database errors
NEW 39	const result = await query.catch((e) => {	×
NEW 40	loggingService.error(asError(e).message);	×
NEW 41	throw new InternalServerErrorException();	×
42	});
43
NEW 44	if (result.count > 0) {	×
NEW 45	await cacheService.set(cacheDir, JSON.stringify(result), ttl);	×
46	}
NEW 47	return result;	×
48	}

safe-global / safe-client-gateway / 10041336019

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