10074119828

Committed 24 Jul 2024 09:28AM UTC coverage: 48.47% (+0.02%) from 48.454%

Build # 10074119828

Build Type

Pull #1777

github

Committed by

web-flow

Commit Message

Update src/datasources/db/cached-query-resolver.ts

Co-authored-by: Aaron Cook <aaron@safe.global>

Pull Request Pull Request #1777: Extract getFromCacheOrExecuteAndCache utility function

Run Details

437 of 2633 branches covered (16.6%)

Branch coverage included in aggregate %.

10 of 29 new or added lines in 4 files covered. (34.48%)

22 existing lines in 1 file now uncovered.

4332 of 7206 relevant lines covered (60.12%)

13.02 hits per line

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

21.74

/src/datasources/db/cached-query-resolver.ts

import {
  CacheService,
  ICacheService,
} from '@/datasources/cache/cache.service.interface';
import { CacheDir } from '@/datasources/cache/entities/cache-dir.entity';
import { ICachedQueryResolver } from '@/datasources/db/cached-query-resolver.interface';
import { ILoggingService, LoggingService } from '@/logging/logging.interface';
import { asError } from '@/logging/utils';
import {
  Inject,
  Injectable,
  InternalServerErrorException,
} from '@nestjs/common';
import postgres from 'postgres';

@Injectable()
export class CachedQueryResolver implements ICachedQueryResolver {
  constructor(
    @Inject(LoggingService) private readonly loggingService: ILoggingService,
    @Inject(CacheService) private readonly cacheService: ICacheService,
  ) {}

  /**
   * Returns the content from cache or executes the query, caches the result and returns it.
   * 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
   */
  async get<T extends postgres.MaybeRow[]>(args: {
    cacheDir: CacheDir;
    query: postgres.PendingQuery<T>;
    ttl: number;
  }): Promise<T> {
    const { key, field } = args.cacheDir;
    const cached = await this.cacheService.get(args.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 args.query.catch((e) => {
      this.loggingService.error(asError(e).message);
      throw new InternalServerErrorException();
    });

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

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

safe-global / safe-client-gateway / 10074119828

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