fix: contact names should not allow duplication #28249

Matt561 · 2024-11-01T21:42:50Z

Description

This fix prevents users from having duplicate names in their contact list. A warning banner is now displayed in the contact list when duplicates are found. All duplicate contacts will also have a warning icon next to them to help users better identify duplicates.

What is considered a duplicate contact?

A duplicate is a contact with a different address but same name as another contact or account.

Related issues

Fixes:

Manual testing steps

Adding a duplicate contact

Go to Settings > Contacts page
Attempt to add a new contact using an existing contact or account name
An error message will appear underneath the username input and the submit button will be disabled.

Viewing duplicate contact warning banner

In your local environment, go to file ui/components/app/contact-list/contact-list.component.js
On line 138 ({hasDuplicateContacts ? this.renderDuplicateContactWarning() : null} change hasDuplicateContacts to true to display the banner.

Screenshots/Recordings

Before

duplicate-contact-fix-before-demo.mov

After

duplicate-contact-fix-after-demo.mov

Pre-merge author checklist

I've followed MetaMask Contributor Docs and MetaMask Extension Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

github-actions · 2024-11-01T21:43:04Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

…duplication

Matt561 · 2024-11-01T21:44:37Z

I have read the CLA Document and I hereby sign the CLA

…duplication

metamaskbot · 2024-11-04T18:27:43Z

Builds ready [66945ee]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1904 ± 39 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	293	2056	1745	488	234
		domContentLoaded	1733	2043	1873	78	38
		load	1748	2058	1904	81	39
		domInteractive	19	81	44	19	9
		backgroundConnect	7	79	29	23	11
		firstReactRender	52	293	116	62	30
		getState	5	71	19	20	10
		initialActions	0	0	0	0	0
		loadScripts	1196	1537	1354	80	39
		setupStore	10	68	22	18	9
		uiStartup	1961	2586	2152	146	70

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: 2.19 KiB (0.03%)
common: 116 Bytes (0.00%)

mirceanis

I have some questions before I can approve. can you please clarify?

test/data/mock-data.js

ui/components/app/contact-list/contact-list.component.js

ui/pages/settings/contact-list-tab/add-contact/add-contact.component.js

…names-should-not-allow-duplication

…ernalAccounts prop

metamaskbot · 2024-11-06T23:22:18Z

Builds ready [f1351c6]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1925 ± 115 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	317	2279	1750	481	231
		domContentLoaded	1569	2552	1891	239	115
		load	1573	2563	1925	239	115
		domInteractive	25	176	54	33	16
		backgroundConnect	9	68	34	19	9
		firstReactRender	47	129	90	21	10
		getState	4	52	15	15	7
		initialActions	0	1	0	0	0
		loadScripts	1104	1800	1379	181	87
		setupStore	11	68	27	20	10
		uiStartup	1784	2810	2119	253	122

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: 3.17 KiB (0.04%)
common: 116 Bytes (0.00%)

matthewwalsh0

Reviewed minor confirmations ownership changes .

mirceanis

Looks good!

Matt561 · 2024-11-15T21:09:00Z

👋 Hey all, the design team requested that I add a warning icon next to the duplicate contacts for better clarity. Could I get another review when you get a moment please? 😄

Here are the latest screenshots

…duplication

metamaskbot · 2024-11-15T21:46:30Z

Builds ready [e8b47de]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (2077 ± 99 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	579	2579	2020	396	190
		domContentLoaded	1696	2517	2038	200	96
		load	1719	2527	2077	206	99
		domInteractive	15	56	38	9	4
		backgroundConnect	8	104	44	34	16
		firstReactRender	52	294	99	66	32
		getState	52	273	102	47	22
		initialActions	0	1	0	0	0
		loadScripts	1187	1969	1528	173	83
		setupStore	6	48	11	9	4
		uiStartup	1940	3231	2408	307	148

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: 4.56 KiB (0.06%)
common: 215 Bytes (0.00%)

mirceanis

looks good!

…duplication

metamaskbot · 2024-11-20T17:29:35Z

Builds ready [5d7fcc6]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (2282 ± 96 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	299	2780	1992	698	335
		domContentLoaded	2007	2633	2238	176	84
		load	2020	2787	2282	201	96
		domInteractive	32	97	52	20	10
		backgroundConnect	9	154	43	37	18
		firstReactRender	74	395	185	125	60
		getState	92	275	138	56	27
		initialActions	0	0	0	0	0
		loadScripts	1487	2082	1688	158	76
		setupStore	7	82	15	18	9
		uiStartup	2337	3706	2794	330	159

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: 4.56 KiB (0.06%)
common: 215 Bytes (0.00%)

Matt561 added 6 commits October 31, 2024 17:36

fix: prevent duplicate names when adding a contact

d690771

fix: prevent duplicate names when editing an existing contact

48658be

fix: perform name validation on ENS input when adding contact

95f69b2

feat: added placeholder to username input when adding new contact

bdfd821

chore: added tests for duplicate username input

2958a91

feat: added duplicate contact warning banner to contact list

289042c

Matt561 added the team-identity label Nov 1, 2024

Matt561 requested review from a team as code owners November 1, 2024 21:42

Merge branch 'develop' into fix/26621-contact-names-should-not-allow-…

05c9725

…duplication

Matt561 and others added 5 commits November 4, 2024 08:32

Merge branch 'develop' into fix/26621-contact-names-should-not-allow-…

a01ed8a

…duplication

fix: fixed breaking edit-contact.test.js

f4e5925

Merge branch 'develop' into fix/26621-contact-names-should-not-allow-…

ebabefa

…duplication

fix: mock lookupDomainName in add-contact.test.js

e632185

fix: remove unit from zero integer in duplicate-contact-banner style

16e2f38

Matt561 force-pushed the fix/26621-contact-names-should-not-allow-duplication branch from efd4d8f to 16e2f38 Compare November 4, 2024 17:51

Merge branch 'develop' into fix/26621-contact-names-should-not-allow-…

66945ee

…duplication

Matt561 requested a review from mirceanis November 4, 2024 17:56

mirceanis reviewed Nov 5, 2024

View reviewed changes

Matt561 added 4 commits November 6, 2024 16:23

fix: improvements based on PR review comments

ef8cd1b

Merge remote-tracking branch 'origin/develop' into fix/26621-contact-…

c0a6baf

…names-should-not-allow-duplication

fix: replaced type anys in contact-list utils

3ac63bc

fix: fixed contact-list-tab story that was failing due to missing int…

f1351c6

…ernalAccounts prop

Matt561 requested a review from mirceanis November 7, 2024 15:35

matthewwalsh0 previously approved these changes Nov 7, 2024

View reviewed changes

Matt561 removed this pull request from the merge queue due to a manual request Nov 7, 2024

mirceanis previously approved these changes Nov 8, 2024

View reviewed changes

Matt561 dismissed stale reviews from mirceanis, vinnyhoward, and matthewwalsh0 via 60d7635 November 15, 2024 21:01

feat: added duplicate contact warning icon in contact list

b73e844

Matt561 force-pushed the fix/26621-contact-names-should-not-allow-duplication branch from 109530a to b73e844 Compare November 15, 2024 21:10

Merge branch 'develop' into fix/26621-contact-names-should-not-allow-…

e8b47de

…duplication

Matt561 requested review from vinnyhoward, matthewwalsh0 and mirceanis November 15, 2024 21:47

vinnyhoward approved these changes Nov 16, 2024

View reviewed changes

matthewwalsh0 approved these changes Nov 19, 2024

View reviewed changes

mirceanis approved these changes Nov 20, 2024

View reviewed changes

Matt561 added this pull request to the merge queue Nov 20, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 20, 2024

Matt561 added this pull request to the merge queue Nov 20, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 20, 2024

Merge branch 'develop' into fix/26621-contact-names-should-not-allow-…

5d7fcc6

…duplication

Matt561 added this pull request to the merge queue Nov 20, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 20, 2024

Matt561 added this pull request to the merge queue Nov 20, 2024

Merged via the queue into develop with commit f3cec69 Nov 20, 2024
75 checks passed

Matt561 deleted the fix/26621-contact-names-should-not-allow-duplication branch November 20, 2024 18:50

github-actions bot locked and limited conversation to collaborators Nov 20, 2024

metamaskbot added the release-12.9.0 Issue or pull request that will be included in release 12.9.0 label Nov 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: contact names should not allow duplication #28249

fix: contact names should not allow duplication #28249

Matt561 commented Nov 1, 2024 •

edited

Loading

github-actions bot commented Nov 1, 2024 •

edited

Loading

Matt561 commented Nov 1, 2024

metamaskbot commented Nov 4, 2024

mirceanis left a comment

metamaskbot commented Nov 6, 2024

matthewwalsh0 left a comment

mirceanis left a comment

Matt561 commented Nov 15, 2024

metamaskbot commented Nov 15, 2024

mirceanis left a comment

metamaskbot commented Nov 20, 2024

fix: contact names should not allow duplication #28249

fix: contact names should not allow duplication #28249

Conversation

Matt561 commented Nov 1, 2024 • edited Loading

Description

What is considered a duplicate contact?

Related issues

Manual testing steps

Adding a duplicate contact

Viewing duplicate contact warning banner

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Nov 1, 2024 • edited Loading

Matt561 commented Nov 1, 2024

metamaskbot commented Nov 4, 2024

mirceanis left a comment

Choose a reason for hiding this comment

metamaskbot commented Nov 6, 2024

matthewwalsh0 left a comment

Choose a reason for hiding this comment

mirceanis left a comment

Choose a reason for hiding this comment

Matt561 commented Nov 15, 2024

metamaskbot commented Nov 15, 2024

mirceanis left a comment

Choose a reason for hiding this comment

metamaskbot commented Nov 20, 2024

Matt561 commented Nov 1, 2024 •

edited

Loading

github-actions bot commented Nov 1, 2024 •

edited

Loading