Localize memoize by shubham1206agra · Pull Request #50698 · Expensify/App

shubham1206agra · 2024-10-14T04:30:37Z

Details

Fixed Issues

$ #50194
PROPOSAL: #50194 (comment)

Tests

Test the whole App and confirm that the translations are correct

Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-10-24.at.3.22.06.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-10-14.at.2.23.44.PM.mov

iOS: Native

Screen.Recording.2024-10-14.at.2.31.39.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-10-14.at.2.20.00.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-14.at.2.12.39.PM.mov

MacOS: Desktop

Screen.Recording.2024-10-14.at.2.27.05.PM.mov

shubham1206agra · 2024-10-14T04:58:19Z

+
+    /**
+     * Checks if the cache should be skipped for the given arguments.
+     * @param args Tuple of arguments passed to the memoized function. Does not work with constructable (see description).


@kacper-mikolajczak Can you tell me reason for this? I just copied this from transformKey description.

@shubham1206agra IIRC the transformKey did not work for constructables but it was fixed.

One of the exceptions is Intl.NumberFormat from NumberFormatUtils module.
However, for other constructables and it works:

custom classes

other constructables APIs (e.g. ResizeObserver, URL)

~~In this case I think we can remove the warning or change it to be more descriptive 👍~~

Update!

After testing it more carefully, it looks like it has an issue with resolving arguments for other APIs as well. For example FormData arguments are merged into union as it happens for NumberFormat.

What they have in common is that all the arguments are optional - it may be a good starting point for investigations

What they have in common is that all the arguments are optional - it may be a good starting point for investigations

@kacper-mikolajczak I assume we will investigate this point in another issue, won't we?

Definitely, let's make it separate issue!

melvin-bot · 2024-10-14T05:35:07Z

@hoangzinh Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

shubham1206agra · 2024-10-23T10:36:05Z

@hoangzinh Waiting for your review here

hoangzinh · 2024-10-23T14:42:35Z

@shubham1206agra oh yes, planned to review today

hoangzinh · 2024-10-23T14:42:42Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (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
- 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-10-23.at.23.30.09.android.mov

Android: mWeb Chrome

Screen.Recording.2024-10-23.at.23.32.54.android.chrome.mov

iOS: Native

Screen.Recording.2024-10-23.at.23.33.53.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-10-23.at.23.36.31.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-23.at.23.22.55.web.mov

MacOS: Desktop

Screen.Recording.2024-10-23.at.23.28.22.desktop.mov

hoangzinh · 2024-10-23T16:40:20Z

Hi @shubham1206agra we're missing recording for Android platform, can you add it?

shubham1206agra · 2024-10-24T06:24:02Z

@hoangzinh Done

hoangzinh

LGTM

hoangzinh · 2024-10-28T22:57:20Z

cc @kacper-mikolajczak @mountiny for 2nd review round

kacper-mikolajczak

Just a tiny nitpick and LGTM <3

Let's be mindful and observe whether users of memoize module are fine with current API - the skipCache is triggered before maxArgs and transformKey but it could also have different placement in a pipeline.

This can be emphasized in a JSDoc as well.

Co-authored-by: Kacper Mikołajczak <62747088+kacper-mikolajczak@users.noreply.github.com>

mountiny

Thank you, changes look good to me

OSBotify · 2024-10-30T18:09:51Z

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

github-actions · 2024-10-31T11:40:21Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.56-0 🚀

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

github-actions · 2024-11-04T14:13:05Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.56-9 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

shubham1206agra and others added 3 commits October 4, 2024 08:29

Use localize with libs/memoize

0910231

Merge branch 'Expensify:main' into test-localize-memoize

cfc2483

Added keyFilter to not cache dynamic keys

3cec7fd

shubham1206agra commented Oct 14, 2024

View reviewed changes

shubham1206agra marked this pull request as ready for review October 14, 2024 05:35

shubham1206agra requested a review from a team as a code owner October 14, 2024 05:35

melvin-bot Bot requested review from hoangzinh and removed request for a team October 14, 2024 05:35

hoangzinh reviewed Oct 16, 2024

View reviewed changes

Comment thread src/libs/memoize/types.ts Resolved

shubham1206agra and others added 2 commits October 22, 2024 10:04

Rename variable

d9841be

Merge branch 'Expensify:main' into test-localize-memoize

e20324c

Merge branch 'Expensify:main' into test-localize-memoize

67d8404

hoangzinh approved these changes Oct 24, 2024

View reviewed changes

melvin-bot Bot requested a review from mountiny October 24, 2024 09:44

kacper-mikolajczak suggested changes Oct 29, 2024

View reviewed changes

Comment thread src/libs/Localize/index.ts Resolved

mountiny assigned shubham1206agra Oct 29, 2024

Apply suggestions from code review

5a76892

Co-authored-by: Kacper Mikołajczak <62747088+kacper-mikolajczak@users.noreply.github.com>

mountiny approved these changes Oct 30, 2024

View reviewed changes

mountiny merged commit 192645d into Expensify:main Oct 30, 2024

github-actions Bot mentioned this pull request Oct 31, 2024

Deploy Checklist: New Expensify 2024-10-31 #51778

Closed

izarutskaya mentioned this pull request Nov 1, 2024

Workspace - Spend category names and "Uncategorized" aren't translated to Spanish #51866

Closed

3 of 8 tasks

melvin-bot Bot mentioned this pull request Nov 4, 2024

[HOLD for payment 2024-11-11] [250] Use general-purpose memoization lib in Localize #50194

Closed

shubham1206agra deleted the test-localize-memoize branch February 3, 2025 17:49

Conversation

shubham1206agra commented Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

shubham1206agra Oct 14, 2024

Choose a reason for hiding this comment

Uh oh!

kacper-mikolajczak Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kacper-mikolajczak Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hoangzinh Oct 16, 2024

Choose a reason for hiding this comment

Uh oh!

kacper-mikolajczak Oct 17, 2024

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Oct 14, 2024

Uh oh!

Uh oh!

shubham1206agra commented Oct 23, 2024

Uh oh!

hoangzinh commented Oct 23, 2024

Uh oh!

hoangzinh commented Oct 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

hoangzinh commented Oct 23, 2024

Uh oh!

shubham1206agra commented Oct 24, 2024

Uh oh!

hoangzinh left a comment

Choose a reason for hiding this comment

Uh oh!

hoangzinh commented Oct 28, 2024

Uh oh!

kacper-mikolajczak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 30, 2024

Uh oh!

github-actions Bot commented Oct 31, 2024

Uh oh!

github-actions Bot commented Nov 4, 2024

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

shubham1206agra commented Oct 14, 2024 •

edited

Loading

kacper-mikolajczak Oct 14, 2024 •

edited

Loading

kacper-mikolajczak Oct 14, 2024 •

edited

Loading

hoangzinh commented Oct 23, 2024 •

edited

Loading