8987889669

Committed 07 May 2024 03:13PM UTC coverage: 93.013% (+0.02%) from 92.998%

Build # 8987889669

Build Type

push

github

Committed by

web-flow

Commit Message

Authorise email editing relative to JWT authentication (#1470)

Migrates the suboptiomal authentication/authorisation for editing emails to the new JWT/SIWE-based approach:

- Remove `EmailEditGuard` and replace it with `AuthGuard`
- Add `EditEmailDto`
- Checksum incoming `signer` address on deletion request
- Pass `AuthPayload` to domain and assert chain and signer before editing an email address
- Add/update associated test coverage

Run Details

1959 of 2383 branches covered (82.21%)

Branch coverage included in aggregate %.

5 of 5 new or added lines in 2 files covered. (100.0%)

1 existing line in 1 file now uncovered.

7027 of 7278 relevant lines covered (96.55%)

321.38 hits per line

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

87.5

/src/routes/email/email.service.ts

import {
  Inject,
  Injectable,
  UnprocessableEntityException,
} from '@nestjs/common';
import { IAccountRepository } from '@/domain/account/account.repository.interface';
import { Email } from '@/routes/email/entities/email.entity';
import { InvalidAddressError } from 'viem';
import { AuthPayload } from '@/domain/auth/entities/auth-payload.entity';

@Injectable()
export class EmailService {
  constructor(
    @Inject(IAccountRepository) private readonly repository: IAccountRepository,
  ) {}

  private _mapInvalidAddressError(e: unknown): never {
    if (e instanceof InvalidAddressError) {
      throw new UnprocessableEntityException(e.shortMessage);
    }
    throw e;
  }

  async saveEmail(args: {
    chainId: string;
    safeAddress: string;
    emailAddress: string;
    signer: `0x${string}`;
    authPayload: AuthPayload;
  }): Promise<void> {
    return this.repository
      .createAccount(args)
      .catch((e) => this._mapInvalidAddressError(e));
  }

  async resendVerification(args: {
    chainId: string;
    safeAddress: string;
    signer: string;
  }): Promise<void> {
    return this.repository
      .resendEmailVerification(args)
      .catch((e) => this._mapInvalidAddressError(e));
  }

  async verifyEmailAddress(args: {
    chainId: string;
    safeAddress: string;
    signer: string;
    code: string;
  }): Promise<void> {
    return this.repository
      .verifyEmailAddress(args)
      .catch((e) => this._mapInvalidAddressError(e));
  }

  async deleteEmail(args: {
    chainId: string;
    safeAddress: string;
    signer: `0x${string}`;
    authPayload: AuthPayload;
  }): Promise<void> {
    return this.repository
      .deleteAccount(args)
      .catch((e) => this._mapInvalidAddressError(e));
  }

  async editEmail(args: {
    chainId: string;
    safeAddress: string;
    signer: `0x${string}`;
    emailAddress: string;
    authPayload: AuthPayload;
  }): Promise<void> {
    return this.repository
      .editEmail(args)
      .catch((e) => this._mapInvalidAddressError(e));
  }

  async getEmail(args: {
    chainId: string;
    safeAddress: string;
    signer: `0x${string}`;
    authPayload: AuthPayload;
  }): Promise<Email> {
    const account = await this.repository
      .getAccount(args)
      .catch((e) => this._mapInvalidAddressError(e));

    return new Email(account.emailAddress.value, account.isVerified);
  }
}

1	import {	98✔
2	Inject,
3	Injectable,
4	UnprocessableEntityException,
5	} from '@nestjs/common';
6	import { IAccountRepository } from '@/domain/account/account.repository.interface';	98✔
7	import { Email } from '@/routes/email/entities/email.entity';	98✔
8	import { InvalidAddressError } from 'viem';	98✔
9	import { AuthPayload } from '@/domain/auth/entities/auth-payload.entity';
10
11	@Injectable()
12	export class EmailService {	98✔
13	constructor(
14	@Inject(IAccountRepository) private readonly repository: IAccountRepository,	202✔
15	) {}
16
17	private _mapInvalidAddressError(e: unknown): never {
18	if (e instanceof InvalidAddressError) {	54!
UNCOV 19	throw new UnprocessableEntityException(e.shortMessage);	×
20	}
21	throw e;	54✔
22	}
23
24	async saveEmail(args: {
25	chainId: string;
26	safeAddress: string;
27	emailAddress: string;
28	signer: `0x${string}`;
29	authPayload: AuthPayload;
30	}): Promise<void> {
31	return this.repository	8✔
32	.createAccount(args)
33	.catch((e) => this._mapInvalidAddressError(e));	4✔
34	}
35
36	async resendVerification(args: {
37	chainId: string;
38	safeAddress: string;
39	signer: string;
40	}): Promise<void> {
41	return this.repository	10✔
42	.resendEmailVerification(args)
43	.catch((e) => this._mapInvalidAddressError(e));	4✔
44	}
45
46	async verifyEmailAddress(args: {
47	chainId: string;
48	safeAddress: string;
49	signer: string;
50	code: string;
51	}): Promise<void> {
52	return this.repository	8✔
53	.verifyEmailAddress(args)
54	.catch((e) => this._mapInvalidAddressError(e));	6✔
55	}
56
57	async deleteEmail(args: {
58	chainId: string;
59	safeAddress: string;
60	signer: `0x${string}`;
61	authPayload: AuthPayload;
62	}): Promise<void> {
63	return this.repository	18✔
64	.deleteAccount(args)
65	.catch((e) => this._mapInvalidAddressError(e));	12✔
66	}
67
68	async editEmail(args: {
69	chainId: string;
70	safeAddress: string;
71	signer: `0x${string}`;
72	emailAddress: string;
73	authPayload: AuthPayload;
74	}): Promise<void> {
75	return this.repository	20✔
76	.editEmail(args)
77	.catch((e) => this._mapInvalidAddressError(e));	16✔
78	}
79
80	async getEmail(args: {
81	chainId: string;
82	safeAddress: string;
83	signer: `0x${string}`;
84	authPayload: AuthPayload;
85	}): Promise<Email> {
86	const account = await this.repository	16✔
87	.getAccount(args)
88	.catch((e) => this._mapInvalidAddressError(e));	12✔
89
90	return new Email(account.emailAddress.value, account.isVerified);	4✔
91	}
92	}

safe-global / safe-client-gateway / 8987889669

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