Synchronise address book and name controller #21084

matthewwalsh0 · 2023-09-27T21:36:29Z

Description

Add a migration to copy all existing address book entries in the AddressBookController to the NameController.

Add listeners to both controllers to synchronise all new, updated, or deleted entries going forward.

Manual Testing Steps

Synchronisation

Go to test dApp.
Click Connect.
Click Sign Typed Data V4 > Sign.
Click first address.
Copy address.
Save petname.
Paste address in Send form of test dApp.
Click Submit.
Verify same name is visible in address book in top right of transaction modal.
Permutate the above to verify create, update, and delete is synchronised in both directions.
Address book entries can be deleted via Settings > Contacts > [Click Entry] > Delete.

Migration

Install build of develop.
Create address book entries for test dApp signature addresses.
Build this branch.
Reload extension without removing.
Verify identical petnames are visible in V3 and V4 signature request.

Related Issues

Fixes #1367

Pre-merge Author Checklist

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.

Create associated unit tests.

Update proposed names from name details component. Truncate in name component. Truncate in name details component. Sort proposed names by source label.

Normalize values in hook.

Add unit tests.

…sync

github-actions · 2023-09-27T21:36:41Z

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.

…sync

Move name detail metric logic into separate file.

codecov · 2023-09-29T19:58:48Z

Codecov Report

Attention: 12 lines in your changes are missing coverage. Please review.

Comparison is base (0482ab6) 68.57% compared to head (d6ab9d0) 68.65%.
Report is 3 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #21084      +/-   ##
===========================================
+ Coverage    68.57%   68.65%   +0.08%     
===========================================
  Files         1013     1015       +2     
  Lines        40615    40753     +138     
  Branches     10854    10875      +21     
===========================================
+ Hits         27848    27976     +128     
- Misses       12767    12777      +10

Files	Coverage Δ
app/scripts/migrations/100.ts	`100.00% <100.00%> (ø)`
app/scripts/migrations/index.js	`100.00% <ø> (ø)`
app/scripts/metamask-controller.js	`53.95% <66.67%> (+0.25%)`	⬆️
app/scripts/lib/AddressBookPetnamesBridge.ts	`90.00% <90.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

metamaskbot · 2023-09-29T20:08:14Z

Builds ready [b96d99c]

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
- common: 0, 1, 2, 3, 4, 5, 6
- content-script: 0
- contentscript: contentscript
- disable-console: disable-console
- inpage: inpage
- policy-load: policy-load
- sentry-install: sentry-install
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1234 ± 397 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	88	175	116	27	13
		domContentLoaded	73	186	112	30	15
		load	84	2242	1234	828	397
		domInteractive	73	186	112	30	15

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

background: 1.89 KiB (0.05%)
ui: -16.16 KiB (-0.20%)
common: 54.85 KiB (1.17%)

…sync

metamaskbot · 2023-09-30T14:26:53Z

Builds ready [1bdbece]

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
- common: 0, 1, 2, 3, 4, 5, 6
- content-script: 0
- contentscript: contentscript
- disable-console: disable-console
- inpage: inpage
- policy-load: policy-load
- sentry-install: sentry-install
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (641 ± 329 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	79	97	85	4	2
		domContentLoaded	64	85	75	7	3
		load	74	1534	641	686	329
		domInteractive	64	85	75	7	3

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

background: 1.89 KiB (0.05%)
ui: -16.16 KiB (-0.20%)
common: 54.85 KiB (1.17%)

sleepytanya · 2023-10-02T04:03:20Z

Synchronization works as expected.

Same petname is displayed in the address book and in top right of transaction modal after creating:

No petname is shown after deleting the account from Address Book:

Same petname is shown after updating the account in the Address Book:

sleepytanya · 2023-10-02T04:28:39Z

Migration works as expected.

Petnames in Address Book on develop branch build:

Petnames in Address Book after migration to feat/address-book-petnames-sync branch build:

Petname is displayed in V3 signature request after migration:

Petname are displayed in V4 signature request after migration:

app/scripts/lib/AddressBookPetnamesBridge.ts

The base branch was changed.

metamaskbot · 2023-10-02T11:37:34Z

Builds ready [ab443a3]

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
- common: 0, 1, 2, 3, 4, 5, 6, 7
- content-script: 0
- contentscript: contentscript
- disable-console: disable-console
- inpage: inpage
- policy-load: policy-load
- sentry-install: sentry-install
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (880 ± 377 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	87	132	101	12	6
		domContentLoaded	69	126	93	15	7
		load	80	1752	880	785	377
		domInteractive	69	126	93	15	7

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

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

metamaskbot · 2023-10-03T15:55:28Z

Builds ready [d6ab9d0]

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
- common: 0, 1, 2, 3, 4, 5, 6, 7
- content-script: 0
- contentscript: contentscript
- disable-console: disable-console
- inpage: inpage
- policy-load: policy-load
- sentry-install: sentry-install
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1354 ± 349 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	91	184	113	23	11
		domContentLoaded	78	180	104	26	12
		load	94	2107	1354	727	349
		domInteractive	78	180	104	26	12

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

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

matthewwalsh0 added 21 commits September 20, 2023 20:17

Add petnames metrics

f41e25f

Update metrics

d8d2bd3

Create associated unit tests.

Add user trait

75b3827

Fix linting

be83db9

Merge branch 'develop' into feat/petnames-metrics

1c4d20f

Merge branch 'develop' into feat/petnames-metrics

97761f7

Remove proposed name from name component

3b8d34b

Update proposed names from name details component. Truncate in name component. Truncate in name details component. Sort proposed names by source label.

Fix name clearing

cece879

Update name controller

c834ed3

Update name controller

233be51

Update yarn lock

eed4d40

Merge branch 'develop' into feat/petnames-metrics

897d278

Display checksum addresses

4db917e

Normalize values in hook.

Add migration

95e22bc

Add unit tests.

Update name controller

ff40abb

Add bridge

5d5306f

Update name controller

f1e5778

Merge branch 'feat/petnames-metrics' into feat/address-book-petnames-…

94f1090

…sync

Add unit tests

70413e5

Fix linting

3b332f6

Merge branch 'feat/petnames-metrics' into feat/address-book-petnames-…

331f9fd

…sync

matthewwalsh0 requested a review from a team as a code owner September 27, 2023 21:36

matthewwalsh0 added 7 commits September 27, 2023 22:39

Fix unit tests

7062cc8

Merge branch 'feat/petnames-metrics' into feat/address-book-petnames-…

55813b0

…sync

Fix deletion

80820a8

Update name controller

0609838

Merge branch 'feat/petnames-metrics' into feat/address-book-petnames-…

110c136

…sync

Merge branch 'develop' into feat/petnames-metrics

eeb00a2

Send open metric after proposed names are loaded

0504df9

Move name detail metric logic into separate file.

Add error handling

b96d99c

matthewwalsh0 added 3 commits September 29, 2023 22:25

Refactor E2E tests

35cd3ac

Merge branch 'develop' into feat/petnames-metrics

b596e4e

Merge branch 'feat/petnames-metrics' into feat/address-book-petnames-…

1bdbece

…sync

OGPoyraz reviewed Oct 2, 2023

View reviewed changes

app/scripts/lib/AddressBookPetnamesBridge.ts Show resolved Hide resolved

OGPoyraz previously approved these changes Oct 2, 2023

View reviewed changes

Base automatically changed from feat/petnames-metrics to develop October 2, 2023 09:21

matthewwalsh0 requested review from a team as code owners October 2, 2023 09:21

Merge branch 'develop' into feat/address-book-petnames-sync

ab443a3

matthewwalsh0 added the team-confirmations-system DEPRECATED: please use "team-confirmations" label instead label Oct 2, 2023

matthewwalsh0 added 2 commits October 3, 2023 10:58

Merge branch 'develop' into feat/address-book-petnames-sync

4aa826b

Merge branch 'develop' into feat/address-book-petnames-sync

d6ab9d0

vinistevam approved these changes Oct 3, 2023

View reviewed changes

OGPoyraz approved these changes Oct 4, 2023

View reviewed changes

matthewwalsh0 merged commit 9f394b4 into develop Oct 4, 2023
9 checks passed

matthewwalsh0 deleted the feat/address-book-petnames-sync branch October 4, 2023 08:33

github-actions bot locked and limited conversation to collaborators Oct 4, 2023

metamaskbot added the release-11.4.0 Issue or pull request that will be included in release 11.4.0 label Oct 4, 2023

danjm added release-blocker This bug is blocking the next release release-11.3.0 Issue or pull request that will be included in release 11.3.0 and removed release-11.4.0 Issue or pull request that will be included in release 11.4.0 labels Oct 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Synchronise address book and name controller #21084

Synchronise address book and name controller #21084

matthewwalsh0 commented Sep 27, 2023 •

edited

Loading

github-actions bot commented Sep 27, 2023

codecov bot commented Sep 29, 2023 •

edited

Loading

metamaskbot commented Sep 29, 2023

metamaskbot commented Sep 30, 2023

sleepytanya commented Oct 2, 2023 •

edited

Loading

sleepytanya commented Oct 2, 2023

metamaskbot commented Oct 2, 2023

metamaskbot commented Oct 3, 2023

Synchronise address book and name controller #21084

Synchronise address book and name controller #21084

Conversation

matthewwalsh0 commented Sep 27, 2023 • edited Loading

Description

Manual Testing Steps

Synchronisation

Migration

Related Issues

Pre-merge Author Checklist

Pre-merge Reviewer Checklist

github-actions bot commented Sep 27, 2023

codecov bot commented Sep 29, 2023 • edited Loading

Codecov Report

metamaskbot commented Sep 29, 2023

metamaskbot commented Sep 30, 2023

sleepytanya commented Oct 2, 2023 • edited Loading

sleepytanya commented Oct 2, 2023

metamaskbot commented Oct 2, 2023

metamaskbot commented Oct 3, 2023

matthewwalsh0 commented Sep 27, 2023 •

edited

Loading

codecov bot commented Sep 29, 2023 •

edited

Loading

sleepytanya commented Oct 2, 2023 •

edited

Loading