chore: Migrate AsyncStorage to mmkv #10153

kylanhurt · 2024-06-27T21:34:02Z

Description

While debugging a sqlite error related to AsyncStorage (surpassing storage limit on Android) we have decided to migrate from AsyncStorage to mmkv due to it not having said issue and also for performance reasons. This includes an actual migration of any existing items saved in AsyncStorage to mmkv

Related issues

Fixes: https://github.com/orgs/MetaMask/projects/60/views/6?pane=issue&itemId=63268337

Manual testing steps

Start a fresh install
Create new wallet and set password, etc
Reboot app and see if it gives you normal EXISTING_USER flow (since that value is taken from mmkv now)

Screenshots/Recordings

Should be no discernible different in application behavior.

Pre-merge author checklist

I’ve followed MetaMask Contributor Docs and MetaMask Mobile 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-06-27T21:34:13Z

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.

…kv value

…ay from AsyncStorage

app/store/async-storage-wrapper.js

app/store/migrations/049.test.ts

app/store/migrations/049.ts

Co-authored-by: tommasini <[email protected]>

…sk-mobile into kylan/mmkv-final

kylanhurt · 2024-07-02T22:54:21Z

Proof of proper migration via simulator, pardon the data structure difference (array vs object).

AsyncStorage before:

[
  ["@MetaMask:CurrentAppVersion", "7.24.4"],
  ["@MetaMask:LastAppVersion", "7.24.4"],
  ["@MetaMask:UserTermsAcceptedv1.0", "true"],
  ["@MetaMask:existingUser", "true"],
  [
    "TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-context",
    "{\"context\":{\"app\":{\"build\":\"1354\",\"name\":\"MetaMask\",\"namespace\":\"io.metamask\",\"version\":\"7.24.4\"},\"device\":{\"manufacturer\":\"Google\",\"model\":\"sdk_gphone64_arm64\",\"name\":\"emu64a\",\"type\":\"android\"},\"library\":{\"name\":\"@segment/analytics-react-native\",\"version\":\"2.17.0\"},\"locale\":\"en-US\",\"network\":{\"cellular\":false,\"wifi\":true},\"os\":{\"name\":\"Android\",\"version\":\"14\"},\"screen\":{\"width\":1440,\"height\":2476,\"density\":3.5},\"timezone\":\"America/Guayaquil\",\"traits\":{},\"instanceId\":\"4cebbbd0-b6e4-48dc-ad7e-4c46ff43634e\"}}"
  ],
  ["TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-events", "{\"events\":[]}"],
  ["TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-filters", "{}"],
  [
    "TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-settings",
    "{\"settings\":{\"Mixpanel (Actions)\":{\"versionSettings\":{\"componentTypes\":[]}},\"Segment.io\":{\"apiKey\":\"TEB8xv152IJn8FFTpVwm0XFFNpczkpcr\",\"unbundledIntegrations\":[],\"addBundledMetadata\":true,\"maybeBundledConfigIds\":{},\"versionSettings\":{\"version\":\"4.4.7\",\"componentTypes\":[\"browser\"]}}}}"
  ],
  [
    "TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-userInfo",
    "{\"userInfo\":{\"anonymousId\":\"0x0000000000000000\",\"userId\":\"8e54e270-0f87-4031-8413-103a86dcff18\",\"traits\":{\"has_marketing_consent\":true,\"is_metrics_opted_in\":true,\"platform\":\"android\",\"currentBuildNumber\":\"1354\",\"applicationVersion\":\"7.24.4\",\"operatingSystemVersion\":\"34\",\"deviceBrand\":\"google\",\"Enable OpenSea API\":\"ON\",\"NFT Autodetection\":\"ON\",\"Theme\":\"light\",\"token_detection_enable\":\"ON\",\"Batch account balance requests\":\"ON\",\"security_providers\":\"blockaid\",\"Authentication Type\":\"password\"}}}"
  ],
  [
    "wc@2:core:0.3//keychain",
    "{\"client_ed25519_seed\":\"bdc8d01ddc1066bcaa6f3b09d602da6f38ab125e37abce1848d42cfe018b3bc5\"}"
  ]
]

mmkv after:

{
  "@MetaMask:CurrentAppVersion": "7.24.4",
  "@MetaMask:LastAppVersion": "7.24.4",
  "@MetaMask:UserTermsAcceptedv1.0": "true",
  "@MetaMask:WhatsNewAppVersionSeen": "7.24.4",
  "@MetaMask:existingUser": "true",
  "TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-context": "{\"context\":{\"app\":{\"build\":\"1354\",\"name\":\"MetaMask\",\"namespace\":\"io.metamask\",\"version\":\"7.24.4\"},\"device\":{\"manufacturer\":\"Google\",\"model\":\"sdk_gphone64_arm64\",\"name\":\"emu64a\",\"type\":\"android\"},\"library\":{\"name\":\"@segment/analytics-react-native\",\"version\":\"2.17.0\"},\"locale\":\"en-US\",\"network\":{\"cellular\":false,\"wifi\":true},\"os\":{\"name\":\"Android\",\"version\":\"14\"},\"screen\":{\"width\":1440,\"height\":2476,\"density\":3.5},\"timezone\":\"America/Guayaquil\",\"traits\":{},\"instanceId\":\"4cebbbd0-b6e4-48dc-ad7e-4c46ff43634e\"}}",
  "TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-events": "{\"events\":[]}",
  "TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-filters": "{}",
  "TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-settings": "{\"settings\":{\"Mixpanel (Actions)\":{\"versionSettings\":{\"componentTypes\":[]}},\"Segment.io\":{\"apiKey\":\"TEB8xv152IJn8FFTpVwm0XFFNpczkpcr\",\"unbundledIntegrations\":[],\"addBundledMetadata\":true,\"maybeBundledConfigIds\":{},\"versionSettings\":{\"version\":\"4.4.7\",\"componentTypes\":[\"browser\"]}}}}",
  "TEB8xv152IJn8FFTpVwm0XFFNpczkpcr-userInfo": "{\"userInfo\":{\"anonymousId\":\"0x0000000000000000\",\"userId\":\"8e54e270-0f87-4031-8413-103a86dcff18\",\"traits\":{\"has_marketing_consent\":true,\"is_metrics_opted_in\":true,\"platform\":\"android\",\"currentBuildNumber\":\"1354\",\"applicationVersion\":\"7.24.4\",\"operatingSystemVersion\":\"34\",\"deviceBrand\":\"google\",\"Enable OpenSea API\":\"ON\",\"NFT Autodetection\":\"ON\",\"Theme\":\"light\",\"token_detection_enable\":\"ON\",\"Batch account balance requests\":\"ON\",\"security_providers\":\"blockaid\",\"Authentication Type\":\"password\"}}}",
  "wc@2:core:0.3//keychain": "{\"client_ed25519_seed\":\"bdc8d01ddc1066bcaa6f3b09d602da6f38ab125e37abce1848d42cfe018b3bc5\"}"
}

github-actions · 2024-07-03T16:05:41Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 05ce522
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/378b1173-4c58-480d-804d-e4acaa26a914

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

…sk-mobile into kylan/mmkv-final

tommasini

LGTM!

github-actions · 2024-07-03T22:53:09Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 4b0e45a
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/dbcb1549-49cc-4d25-a015-eeef0dd2db4b

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

vinistevam

Great PR!
One small question, Will the renaming of async-storage-wrapper.js be handled in a separate ticket?

tommasini

I'm wondering if we should clear all the async storage, after migrating
https://react-native-async-storage.github.io/async-storage/docs/api#clear

WDYT?

app/store/migrations/049.ts

github-actions · 2024-07-04T14:45:01Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: f002f17
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/bb105bbc-9a60-4c90-be5e-2d118788dbd8

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

sonarcloud · 2024-07-04T14:52:34Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
85.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

kylanhurt added 2 commits June 27, 2024 16:32

AsyncStorage to mmkv migration

b6969e6

Remove unnecessary console logs

ad9283d

kylanhurt added team-mobile-platform Run Smoke E2E Triggers smoke e2e on Bitrise labels Jun 27, 2024

Remove unnecessary awaits for synchronous mmkv

f363877

kylanhurt changed the title ~~Kylan/mmkv final~~ Migrate AsyncStorage to mmkv Jun 28, 2024

kylanhurt added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jun 28, 2024

kylanhurt changed the title ~~Migrate AsyncStorage to mmkv~~ chore: Migrate AsyncStorage to mmkv Jun 28, 2024

kylanhurt added 3 commits June 28, 2024 12:15

Have asyncStorage attempt to provide value (and set to mmkv) if no mm…

356e887

…kv value

Add some relevant comments regarding eventual (complete) migration aw…

6c3b286

…ay from AsyncStorage

Fix asyncStorage vs mmkv null vs undefined values

aa2809e

kylanhurt marked this pull request as ready for review June 28, 2024 18:02

kylanhurt requested a review from a team as a code owner June 28, 2024 18:02

kylanhurt requested a review from vinistevam June 28, 2024 18:03

kylanhurt linked an issue Jun 28, 2024 that may be closed by this pull request

[Sentry] Error: database or disk is full (code 13 SQLITE_FULL) #9670

Open

Adjust storage wrapper to pass e2e tests

6ee0960

kylanhurt added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jul 1, 2024

tommasini reviewed Jul 1, 2024

View reviewed changes

kylanhurt and others added 7 commits July 2, 2024 09:33

Update app/store/async-storage-wrapper.js

00dd7eb

Co-authored-by: tommasini <[email protected]>

Update app/store/async-storage-wrapper.js

53d0e03

Co-authored-by: tommasini <[email protected]>

Update app/store/async-storage-wrapper.js

8310170

Co-authored-by: tommasini <[email protected]>

Some fixes to storage wrapper migration

6947075

Merge branch 'kylan/mmkv-final' of https://github.com/MetaMask/metama…

b7ad9a6

…sk-mobile into kylan/mmkv-final

Minor formatting fix

bb14c0e

More minor fixes to asynt storage wrapper

c428383

Merge branch 'main' into kylan/mmkv-final

05ce522

MetaMask deleted a comment from github-actions bot Jul 3, 2024

kylanhurt added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jul 3, 2024

Merge branch 'main' into kylan/mmkv-final

7180c74

kylanhurt added the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Jul 3, 2024

kylanhurt added 2 commits July 3, 2024 16:23

Remove asyncStorage limit from gradle properties

8bbb23b

Merge branch 'kylan/mmkv-final' of https://github.com/MetaMask/metama…

4b0e45a

…sk-mobile into kylan/mmkv-final

tommasini previously approved these changes Jul 3, 2024

View reviewed changes

kylanhurt added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jul 3, 2024

vinistevam previously approved these changes Jul 4, 2024

View reviewed changes

tommasini reviewed Jul 4, 2024

View reviewed changes

app/store/migrations/049.ts Outdated Show resolved Hide resolved

Remove unnecessary console.error

f002f17

kylanhurt dismissed stale reviews from vinistevam and tommasini via f002f17 July 4, 2024 14:40

kylanhurt added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jul 4, 2024

tommasini approved these changes Jul 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Migrate AsyncStorage to mmkv #10153

chore: Migrate AsyncStorage to mmkv #10153

kylanhurt commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024

kylanhurt commented Jul 2, 2024

github-actions bot commented Jul 3, 2024 •

edited by metamaskbot

Loading

tommasini left a comment

github-actions bot commented Jul 3, 2024 •

edited by metamaskbot

Loading

vinistevam left a comment

tommasini left a comment

github-actions bot commented Jul 4, 2024 •

edited by metamaskbot

Loading

sonarcloud bot commented Jul 4, 2024

chore: Migrate AsyncStorage to mmkv #10153

Are you sure you want to change the base?

chore: Migrate AsyncStorage to mmkv #10153

Conversation

kylanhurt commented Jun 27, 2024 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Jun 27, 2024

kylanhurt commented Jul 2, 2024

github-actions bot commented Jul 3, 2024 • edited by metamaskbot Loading

Bitrise

tommasini left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 3, 2024 • edited by metamaskbot Loading

Bitrise

vinistevam left a comment

Choose a reason for hiding this comment

tommasini left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 4, 2024 • edited by metamaskbot Loading

Bitrise

sonarcloud bot commented Jul 4, 2024

Quality Gate passed

kylanhurt commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jul 3, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Jul 3, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Jul 4, 2024 •

edited by metamaskbot

Loading