10270314343

Committed 06 Aug 2024 04:24PM UTC coverage: 48.03% (-0.03%) from 48.055%

Build # 10270314343

Build Type

Pull #1800

github

Committed by

hectorgomezv

Commit Message

PR comment

Pull Request Pull Request #1800: Implement Accounts creation rate limit

Run Details

450 of 2714 branches covered (16.58%)

Branch coverage included in aggregate %.

5 of 17 new or added lines in 3 files covered. (29.41%)

2 existing lines in 2 files now uncovered.

4427 of 7440 relevant lines covered (59.5%)

12.88 hits per line

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

17.07

/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 { CachedQueryResolver } from '@/datasources/db/cached-query-resolver';
import { ICachedQueryResolver } from '@/datasources/db/cached-query-resolver.interface';
import { LimitReachedError } from '@/datasources/network/entities/errors/limit-reached.error';
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 { IpSchema } from '@/validation/entities/schemas/ip.schema';
import {
  Inject,
  Injectable,
  NotFoundException,
  OnModuleInit,
  UnprocessableEntityException,
} from '@nestjs/common';
import postgres from 'postgres';

@Injectable()
export class AccountsDatasource implements IAccountsDatasource, OnModuleInit {
  private static readonly ACCOUNT_CREATION_CACHE_PREFIX = 'account_creation';
  private readonly defaultExpirationTimeInSeconds: number;
  // Number of seconds for each rate-limit cycle
  private readonly accountCreationRateLimitPeriodSeconds: number;
  // Number of allowed calls on each rate-limit cycle
  private readonly accountCreationRateLimitCalls: number;

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

  /**
   * 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(args: {
    address: `0x${string}`;
    clientIp: string;
  }): Promise<Account> {
    await this.checkCreationRateLimit(args.clientIp);
    const [account] = await this.sql<[Account]>`
      INSERT INTO accounts (address) VALUES (${args.address}) RETURNING *`.catch(
      (e) => {
        this.loggingService.warn(
          `Error creating account: ${asError(e).message}`,
        );
        throw new UnprocessableEntityException('Error creating account.');
      },
    );
    const cacheDir = CacheRouter.getAccountCacheDir(args.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.cachedQueryResolver.get<Account[]>({
      cacheDir,
      query: this.sql`SELECT * FROM accounts WHERE address = ${address}`,
      ttl: 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 this.cachedQueryResolver.get<AccountDataType[]>({
      cacheDir,
      query: this.sql`SELECT * FROM account_data_types`,
      ttl: MAX_TTL,
    });
  }

  async getAccountDataSettings(
    address: `0x${string}`,
  ): Promise<AccountDataSetting[]> {
    const account = await this.getAccount(address);
    const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(address);
    return this.cachedQueryResolver.get<AccountDataSetting[]>({
      cacheDir,
      query: this.sql`
        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;`,
      ttl: 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(args: {
    address: `0x${string}`;
    upsertAccountDataSettingsDto: UpsertAccountDataSettingsDto;
  }): Promise<AccountDataSetting[]> {
    const { accountDataSettings } = args.upsertAccountDataSettingsDto;
    await this.checkDataTypes(accountDataSettings);
    const account = await this.getAccount(args.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(args.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.`,
      );
    }
  }

  /**
   * Checks if the client IP address has reached the account creation rate limit.
   *
   * NOTE: the rate limit is implemented in the datasource layer for this use case
   * because we need to restrict the actual creation of accounts, not merely
   * the attempts to create them.
   *
   * If the client IP address is invalid, a warning is logged.
   * If the client IP address is valid and rate limit is reached, a {@link LimitReachedError} is thrown.
   *
   * @param clientIp - client IP address.
   */
  private async checkCreationRateLimit(clientIp: string): Promise<void> {
    const { success: isValidIp } = IpSchema.safeParse(clientIp);
    if (!clientIp || !isValidIp) {
      this.loggingService.warn(
        `Invalid client IP while creating account: ${clientIp}`,
      );
    } else {
      const current = await this.cacheService.increment(
        CacheRouter.getRateLimitCacheKey(
          `${AccountsDatasource.ACCOUNT_CREATION_CACHE_PREFIX}_${clientIp}`,
        ),
        this.accountCreationRateLimitPeriodSeconds,
      );
      if (current > this.accountCreationRateLimitCalls) {
        this.loggingService.warn(
          `Limit of ${this.accountCreationRateLimitCalls} reached for IP ${clientIp}`,
        );
        throw new LimitReachedError();
      }
    }
  }
}

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 { CachedQueryResolver } from '@/datasources/db/cached-query-resolver';	16✔
9	import { ICachedQueryResolver } from '@/datasources/db/cached-query-resolver.interface';	16✔
10	import { LimitReachedError } from '@/datasources/network/entities/errors/limit-reached.error';	16✔
11	import { AccountDataSetting } from '@/domain/accounts/entities/account-data-setting.entity';
12	import { AccountDataType } from '@/domain/accounts/entities/account-data-type.entity';
13	import { Account } from '@/domain/accounts/entities/account.entity';
14	import { UpsertAccountDataSettingsDto } from '@/domain/accounts/entities/upsert-account-data-settings.dto.entity';
15	import { IAccountsDatasource } from '@/domain/interfaces/accounts.datasource.interface';
16	import { ILoggingService, LoggingService } from '@/logging/logging.interface';	16✔
17	import { asError } from '@/logging/utils';	16✔
18	import { IpSchema } from '@/validation/entities/schemas/ip.schema';	16✔
19	import {	16✔
20	Inject,
21	Injectable,
22	NotFoundException,
23	OnModuleInit,
24	UnprocessableEntityException,
25	} from '@nestjs/common';
26	import postgres from 'postgres';	16✔
27
28	@Injectable()
29	export class AccountsDatasource implements IAccountsDatasource, OnModuleInit {	16✔
30	private static readonly ACCOUNT_CREATION_CACHE_PREFIX = 'account_creation';	16✔
31	private readonly defaultExpirationTimeInSeconds: number;
32	// Number of seconds for each rate-limit cycle
33	private readonly accountCreationRateLimitPeriodSeconds: number;
34	// Number of allowed calls on each rate-limit cycle
35	private readonly accountCreationRateLimitCalls: number;
36
37	constructor(
38	@Inject(CacheService) private readonly cacheService: ICacheService,	×
39	@Inject('DB_INSTANCE') private readonly sql: postgres.Sql,	×
40	@Inject(ICachedQueryResolver)
41	private readonly cachedQueryResolver: CachedQueryResolver,	×
42	@Inject(LoggingService) private readonly loggingService: ILoggingService,	×
43	@Inject(IConfigurationService)
44	private readonly configurationService: IConfigurationService,	×
45	) {
46	this.defaultExpirationTimeInSeconds =	×
47	this.configurationService.getOrThrow<number>(
48	'expirationTimeInSeconds.default',
49	);
NEW 50	this.accountCreationRateLimitPeriodSeconds =	×
51	configurationService.getOrThrow(
52	'accounts.creationRateLimitPeriodSeconds',
53	);
NEW 54	this.accountCreationRateLimitCalls = configurationService.getOrThrow(	×
55	'accounts.creationRateLimitCalls',
56	);
57	}
58
59	/**
60	* Function executed when the module is initialized.
61	* It deletes the cache for persistent keys.
62	*/
63	async onModuleInit(): Promise<void> {
64	await this.cacheService.deleteByKey(	×
65	CacheRouter.getAccountDataTypesCacheDir().key,
66	);
67	}
68
69	async createAccount(args: {
70	address: `0x${string}`;
71	clientIp: string;
72	}): Promise<Account> {
NEW 73	await this.checkCreationRateLimit(args.clientIp);	×
UNCOV 74	const [account] = await this.sql<[Account]>`	×
75	INSERT INTO accounts (address) VALUES (${args.address}) RETURNING *`.catch(
76	(e) => {
77	this.loggingService.warn(	×
78	`Error creating account: ${asError(e).message}`,
79	);
80	throw new UnprocessableEntityException('Error creating account.');	×
81	},
82	);
NEW 83	const cacheDir = CacheRouter.getAccountCacheDir(args.address);	×
84	await this.cacheService.set(	×
85	cacheDir,
86	JSON.stringify([account]),
87	this.defaultExpirationTimeInSeconds,
88	);
89	return account;	×
90	}
91
92	async getAccount(address: `0x${string}`): Promise<Account> {
93	const cacheDir = CacheRouter.getAccountCacheDir(address);	×
94	const [account] = await this.cachedQueryResolver.get<Account[]>({	×
95	cacheDir,
96	query: this.sql`SELECT * FROM accounts WHERE address = ${address}`,
97	ttl: this.defaultExpirationTimeInSeconds,
98	});
99
100	if (!account) {	×
101	throw new NotFoundException('Error getting account.');	×
102	}
103
104	return account;	×
105	}
106
107	async deleteAccount(address: `0x${string}`): Promise<void> {
108	try {	×
109	const { count } = await this	×
110	.sql`DELETE FROM accounts WHERE address = ${address}`;
111	if (count === 0) {	×
112	this.loggingService.debug(	×
113	`Error deleting account ${address}: not found`,
114	);
115	}
116	} finally {
117	const keys = [	×
118	CacheRouter.getAccountCacheDir(address).key,
119	CacheRouter.getAccountDataSettingsCacheDir(address).key,
120	CacheRouter.getCounterfactualSafesCacheDir(address).key,
121	];
122	await Promise.all(keys.map((key) => this.cacheService.deleteByKey(key)));	×
123	}
124	}
125
126	async getDataTypes(): Promise<AccountDataType[]> {
127	const cacheDir = CacheRouter.getAccountDataTypesCacheDir();	×
128	return this.cachedQueryResolver.get<AccountDataType[]>({	×
129	cacheDir,
130	query: this.sql`SELECT * FROM account_data_types`,
131	ttl: MAX_TTL,
132	});
133	}
134
135	async getAccountDataSettings(
136	address: `0x${string}`,
137	): Promise<AccountDataSetting[]> {
138	const account = await this.getAccount(address);	×
139	const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(address);	×
140	return this.cachedQueryResolver.get<AccountDataSetting[]>({	×
141	cacheDir,
142	query: this.sql`
143	SELECT ads.* FROM account_data_settings ads
144	INNER JOIN account_data_types adt ON ads.account_data_type_id = adt.id
145	WHERE ads.account_id = ${account.id} AND adt.is_active IS TRUE;`,
146	ttl: this.defaultExpirationTimeInSeconds,
147	});
148	}
149
150	/**
151	* Adds or updates the existing account data settings for a given address/account.
152	* Requirements:
153	* - The account must exist.
154	* - The data type must exist.
155	* - The data type must be active.
156	*
157	* @param address - account address.
158	* @param upsertAccountDataSettings {@link UpsertAccountDataSettingsDto} object.
159	* @returns {Array<AccountDataSetting>} inserted account data settings.
160	*/
161	async upsertAccountDataSettings(args: {
162	address: `0x${string}`;
163	upsertAccountDataSettingsDto: UpsertAccountDataSettingsDto;
164	}): Promise<AccountDataSetting[]> {
165	const { accountDataSettings } = args.upsertAccountDataSettingsDto;	×
166	await this.checkDataTypes(accountDataSettings);	×
167	const account = await this.getAccount(args.address);	×
168
169	const result = await this.sql.begin(async (sql) => {	×
170	await Promise.all(	×
171	accountDataSettings.map(async (accountDataSetting) => {
172	return sql`	×
173	INSERT INTO account_data_settings (account_id, account_data_type_id, enabled)
174	VALUES (${account.id}, ${accountDataSetting.dataTypeId}, ${accountDataSetting.enabled})
175	ON CONFLICT (account_id, account_data_type_id) DO UPDATE SET enabled = EXCLUDED.enabled
176	`.catch((e) => {
177	throw new UnprocessableEntityException(	×
178	`Error updating data settings: ${asError(e).message}`,
179	);
180	});
181	}),
182	);
183	return sql<[AccountDataSetting]>`	×
184	SELECT * FROM account_data_settings WHERE account_id = ${account.id}`;
185	});
186
187	const cacheDir = CacheRouter.getAccountDataSettingsCacheDir(args.address);	×
188	await this.cacheService.set(	×
189	cacheDir,
190	JSON.stringify(result),
191	this.defaultExpirationTimeInSeconds,
192	);
193	return result;	×
194	}
195
196	private async checkDataTypes(
197	accountDataSettings: UpsertAccountDataSettingsDto['accountDataSettings'],
198	): Promise<void> {
199	const dataTypes = await this.getDataTypes();	×
200	const activeDataTypeIds = dataTypes	×
201	.filter((dt) => dt.is_active)	×
202	.map((ads) => ads.id);	×
203	if (	×
204	!accountDataSettings.every((ads) =>
205	activeDataTypeIds.includes(Number(ads.dataTypeId)),	×
206	)
207	) {
208	throw new UnprocessableEntityException(	×
209	`Data types not found or not active.`,
210	);
211	}
212	}
213
214	/**
215	* Checks if the client IP address has reached the account creation rate limit.
216	*
217	* NOTE: the rate limit is implemented in the datasource layer for this use case
218	* because we need to restrict the actual creation of accounts, not merely
219	* the attempts to create them.
220	*
221	* If the client IP address is invalid, a warning is logged.
222	* If the client IP address is valid and rate limit is reached, a {@link LimitReachedError} is thrown.
223	*
224	* @param clientIp - client IP address.
225	*/
226	private async checkCreationRateLimit(clientIp: string): Promise<void> {
NEW 227	const { success: isValidIp } = IpSchema.safeParse(clientIp);	×
NEW 228	if (!clientIp \|\| !isValidIp) {	×
NEW 229	this.loggingService.warn(	×
230	`Invalid client IP while creating account: ${clientIp}`,
231	);
232	} else {
NEW 233	const current = await this.cacheService.increment(	×
234	CacheRouter.getRateLimitCacheKey(
235	`${AccountsDatasource.ACCOUNT_CREATION_CACHE_PREFIX}_${clientIp}`,
236	),
237	this.accountCreationRateLimitPeriodSeconds,
238	);
NEW 239	if (current > this.accountCreationRateLimitCalls) {	×
NEW 240	this.loggingService.warn(	×
241	`Limit of ${this.accountCreationRateLimitCalls} reached for IP ${clientIp}`,
242	);
NEW 243	throw new LimitReachedError();	×
244	}
245	}
246	}
247	}

safe-global / safe-client-gateway / 10270314343

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