General purpose memoization tool

[kacper-mikolajczak]

Details

PR implements POC2 (continuation of #43538) of memoization tool for general purpose use. The main goal is to:

• implement array cache
• add unit tests
• add example in the wild
• implement monitoring for caches
• enable to collect stats globally
• discuss what should be added to the guidelines

Minor to do:

• Fix typings
• Fix eslint
• Discuss whether we should add functionality of copying static methods

Fixed Issues

$ #42200
PROPOSAL: https://expensify.slack.com/archives/C01GTK53T8Q/p1716371827915779

Tests

• Verify that no errors appear in the JS console

1. Scroll through LHN
2. Open report
3. Type an emoji (send message optionally)
4. Go back
5. Press FAB
6. Choose Submit Expense
7. Pick different currency
8. Go back
9. Navigate to Profile screen

Offline tests

N/A

QA Steps

• Verify that no errors appear in the JS console

1. Scroll through LHN
2. Open report
3. Type an emoji (send message optionally)
4. Go back
5. Press FAB
6. Choose Submit Expense
7. Pick different currency
8. Go back
9. Navigate to Profile screen

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (see Reviewing the code)
  • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
  • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • I verified that comments were added to code that is not self explanatory
  • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
  • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• I followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• I verified that if a function's arguments changed that all usages have also been updated correctly
• If any new file was added I verified that:
  • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
• If a new CSS style is added I verified that:
  • A similar style doesn't already exist
  • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
• If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
• If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
• If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
• If the PR modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label so the design team can review the changes.
• If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
• If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android-web.mp4

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

[kacper-mikolajczak]

Current state of the types in the memoize.index.ts is quite difficult to resolve without disabling no-unsafe-return rule.

Here is a TS Playground with minimal reproducible sample for the issue. Also here is a link to SO where the difficulty is discussed, but it is not 100% equivalent.

In general, the memoize method is quite self contained and straightforward so it should not be an issue to disable the rule but let's discuss what would be our next step.

If you know how to resolve the typings issue, please let me know 🙏

[mananjadhav]

Linting error seems to be pointing to non-existent code. @mountiny can we re-run the action? Thanks!

@kacper-mikolajczak Isn't it this code here that's throwing the lint error?

[mountiny]

@kacper-mikolajczak Please merge main to resolve or it must be coming from this PR.

Yeah I think we can proceed with this PR even if there are the issues you have mentioned remaining, but we need to address them in a follow up

[kacper-mikolajczak]

Great @mountiny! PR is ready to be merged 👍

What would be the best steps to go with regarding follow-up fixes? Should I create issues ahead-of-time (not sure if we have correct label), or treat their description in this PR as the origin and wait with creating them after the merge?

[kacper-mikolajczak]

@mananjadhav thanks for thorough review! 🥇

[mananjadhav]

I’ll test this in a while.

[kacper-mikolajczak]

Here are the results of monitoring the cache when following QA steps.

Cache details

{
  "appVersion": "9.0.10-2",
  "environment": "development",
  "platform": "android",
  "totalMemory": "1.92 GiB",
  "usedMemory": "774.04 MiB",
  "memoizeStats": [
    {
      "id": "NumberFormat",
      "stats": {
        "calls": 30,
        "hits": 26,
        "avgCacheRetrievalTime": 0.01402397899907994,
        "avgFnTime": 6.5312082500895485,
        "cacheSize": 4
      }
    },
    {
      "id": "getLocaleDigits",
      "stats": {
        "calls": 11,
        "hits": 10,
        "avgCacheRetrievalTime": 0.0018999999854713678,
        "avgFnTime": 0.8545420002192259,
        "cacheSize": 1
      }
    },
    {
      "id": "getEmojiUnicode",
      "stats": {
        "calls": 116,
        "hits": 104,
        "avgCacheRetrievalTime": 0.005968057494505178,
        "avgFnTime": 0.0840590833298241,
        "cacheSize": 12
      }
    },
    {
      "id": "getUnreadReportsForUnreadIndicator",
      "stats": {
        "calls": 14,
        "hits": 9,
        "avgCacheRetrievalTime": 0.5056088889293648,
        "avgFnTime": 0.3653247999958694,
        "cacheSize": 6
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 0,
        "hits": 0,
        "avgCacheRetrievalTime": 0,
        "avgFnTime": 0,
        "cacheSize": 0
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 0,
        "hits": 0,
        "avgCacheRetrievalTime": 0,
        "avgFnTime": 0,
        "cacheSize": 0
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 0,
        "hits": 0,
        "avgCacheRetrievalTime": 0,
        "avgFnTime": 0,
        "cacheSize": 0
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 2,
        "hits": 1,
        "avgCacheRetrievalTime": 0.0117080002091825,
        "avgFnTime": 2.003707999829203,
        "cacheSize": 1
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 0,
        "hits": 0,
        "avgCacheRetrievalTime": 0,
        "avgFnTime": 0,
        "cacheSize": 0
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 0,
        "hits": 0,
        "avgCacheRetrievalTime": 0,
        "avgFnTime": 0,
        "cacheSize": 0
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 0,
        "hits": 0,
        "avgCacheRetrievalTime": 0,
        "avgFnTime": 0,
        "cacheSize": 0
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 0,
        "hits": 0,
        "avgCacheRetrievalTime": 0,
        "avgFnTime": 0,
        "cacheSize": 0
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 0,
        "hits": 0,
        "avgCacheRetrievalTime": 0,
        "avgFnTime": 0,
        "cacheSize": 0
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 0,
        "hits": 0,
        "avgCacheRetrievalTime": 0,
        "avgFnTime": 0,
        "cacheSize": 0
      }
    },
    {
      "id": "freezeScreenWithLazyLoading",
      "stats": {
        "calls": 4,
        "hits": 3,
        "avgCacheRetrievalTime": 0.015042000294973453,
        "avgFnTime": 144.09425000008196,
        "cacheSize": 1
      }
    }
  ]
}

Recording

Screen.Recording.2024-07-23.at.09.05.04.mp4

The cache performance seems to be fine, but there are two issues:

• I've noticed currency list is not loading options correctly. @mananjadhav when you'll be testing, could you also take a look if it was only happening for me locally or we have a regression? Thanks!
• freezeScreenWithLazyLoading uses memoization whenever component is mounted, which results in many cache entries. It is an issue with how cahce is used there (not PR implementation). If it was working like that before and it serves the purpose, so we can leave it as-is and then discuss it separately not to provide any regressions

CC @adhorodyski

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
❌ FAILED ❌	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/43868/index.html
The QR code can't be generated, because the android build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/43868/NewExpensify.dmg	https://43868.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[mananjadhav]

I checked and the currency loader worked fine for me. I'll do one round of testing more and update the screenshots.

[mananjadhav]

I added additional screenshots here except for Android. I don't have a physical device right now and having some system issues.

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[OSBotify]

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.0.12-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

[OSBotify]

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

[OSBotify]

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.0.13-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅