6955329916

Committed 22 Nov 2023 09:27AM UTC coverage: 91.219% (+0.8%) from 90.43%

Build # 6955329916

Build Type

push

github

Committed by

web-flow

Commit Message

Add email registration route (#862)

Routes:

- Adds an email registration route, allowing owners of a Safe to register an email address (which will be tied to that owner).
- Moves related email guards to `src/routes/email/guards`
- The `EmailController` is set to be excluded from the Swagger interface – it can be shown whenever the feature is considered to be stable.

The new route is available under:

```
POST /v1/chains/:chainId/safes/:safeAddress/emails

{
  "emailAddress": <string>,
  "account": <string>,
  "timestamp": <number>,
  "signature": <string>
}
```

Domain:

- Removes the owner check from the domain layer as this is already covered by the `OnlySafeOwnerGuard`.

Data:

- Adds a `TestEmailDatasourceModule` – this module should be used whenever the real database instance doesn't need to be considered in the tests. This module uses a mocked instance of `IEmailDataSource`.

Run Details

1418 of 1695 branches covered (0.0%)

Branch coverage included in aggregate %.

37 of 38 new or added lines in 7 files covered. (97.37%)

1 existing line in 1 file now uncovered.

5262 of 5628 relevant lines covered (93.5%)

162.08 hits per line

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

80.0

/src/routes/transactions/entities/__tests__/human-description.builder.ts

import { Builder, IBuilder } from '@/__tests__/builder';
import {
  RichAddressFragment,
  RichTokenValueFragment,
  RichTextFragment,
  RichDecodedInfoFragment,
  RichFragmentType,
} from '@/routes/transactions/entities/human-description.entity';
import { faker } from '@faker-js/faker';

function richTokenValueFragmentBuilder(): IBuilder<RichTokenValueFragment> {
  return Builder.new<RichTokenValueFragment>()
    .with('type', RichFragmentType.TokenValue)
    .with('value', faker.string.numeric())
    .with('symbol', faker.finance.currencySymbol())
    .with('logoUri', faker.internet.avatar());
}

function richTextFragmentBuilder(): IBuilder<RichTextFragment> {
  return Builder.new<RichTextFragment>()
    .with('type', RichFragmentType.Text)
    .with('value', faker.word.words());
}

function richAddressFragmentBuilder(): IBuilder<RichAddressFragment> {
  return Builder.new<RichAddressFragment>()
    .with('type', RichFragmentType.Address)
    .with('value', faker.finance.ethereumAddress());
}

const humanDescriptionBuilders: Array<() => IBuilder<RichDecodedInfoFragment>> =
  [
    richTokenValueFragmentBuilder,
    richTextFragmentBuilder,
    richAddressFragmentBuilder,
  ];

export function buildHumanDescription(): RichDecodedInfoFragment[] {
  return Array.from({ length: faker.number.int({ min: 0, max: 6 }) }, () =>
    faker.helpers.arrayElement(humanDescriptionBuilders)().build(),
  );
}

1	import { Builder, IBuilder } from '@/__tests__/builder';	2✔
2	import {	2✔
3	RichAddressFragment,
4	RichTokenValueFragment,
5	RichTextFragment,
6	RichDecodedInfoFragment,
7	RichFragmentType,
8	} from '@/routes/transactions/entities/human-description.entity';
9	import { faker } from '@faker-js/faker';	2✔
10
11	function richTokenValueFragmentBuilder(): IBuilder<RichTokenValueFragment> {
UNCOV 12	return Builder.new<RichTokenValueFragment>()	×
13	.with('type', RichFragmentType.TokenValue)
14	.with('value', faker.string.numeric())
15	.with('symbol', faker.finance.currencySymbol())
16	.with('logoUri', faker.internet.avatar());
17	}
18
19	function richTextFragmentBuilder(): IBuilder<RichTextFragment> {
20	return Builder.new<RichTextFragment>()	×
21	.with('type', RichFragmentType.Text)
22	.with('value', faker.word.words());
23	}
24
25	function richAddressFragmentBuilder(): IBuilder<RichAddressFragment> {
26	return Builder.new<RichAddressFragment>()	2✔
27	.with('type', RichFragmentType.Address)
28	.with('value', faker.finance.ethereumAddress());
29	}
30
31	const humanDescriptionBuilders: Array<() => IBuilder<RichDecodedInfoFragment>> =
32	[	2✔
33	richTokenValueFragmentBuilder,
34	richTextFragmentBuilder,
35	richAddressFragmentBuilder,
36	];
37
38	export function buildHumanDescription(): RichDecodedInfoFragment[] {	2✔
39	return Array.from({ length: faker.number.int({ min: 0, max: 6 }) }, () =>	2✔
40	faker.helpers.arrayElement(humanDescriptionBuilders)().build(),	2✔
41	);
42	}

safe-global / safe-client-gateway / 6955329916

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