[TS migration] Migrate 'getPermittedDecimalSeparator' lib to TypeScript by BartoszGrajdek · Pull Request #30160 · Expensify/App

BartoszGrajdek · 2023-10-23T07:15:11Z

Details

Fixed Issues

$ #24837

Tests

Check if decimal separators get changed when switching languages:

Go into IOU and try to send a money request with amount using decimal points (for english it should be "." and for spanish ",").
Now change language and try it once again

Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as tests

Verify that no errors appear in the JS console

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 / Chrome
- iOS / native
- iOS / 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

src/libs/getPermittedDecimalSeparator/index.ts

fabioh8010 · 2023-10-25T09:31:02Z

src/libs/getPermittedDecimalSeparator/index.ts

+
+const getPermittedDecimalSeparator: GetPermittedDecimalSeparator = (localizedSeparator) => {
+    if (getOperatingSystem() === CONST.OS.IOS) {
+        return getPermittedDecimalSeparatorIOS(localizedSeparator);


@BartoszGrajdek Is there a reason to be passing localizedSeparator here now? I think is not necessary as it is importing getPermittedDecimalSeparatorIOS from './index.ios' and this param is not used there, so we should keep the previous behavior

I didn't want to change the functionality of these functions, keeping them consistent in types whether it's ios or other plaforms. That's why I've added it as a mandatory parameter, even though it's not being used on ios. If I have changed it to localizedSeparator?: string I would need to provide a default value to getPermittedDecimalSeparator because I don't want to return anything else other than string

I agree with @BartoszGrajdek, the param isn't used in one implementation, but from the usage it does make sense to make it required. Wdyt @fabioh8010?

@BartoszGrajdek Thanks for explanation, makes sense to me!

fabioh8010 · 2023-10-25T09:31:26Z

src/libs/getPermittedDecimalSeparator/types.ts

@@ -0,0 +1,3 @@
+type GetPermittedDecimalSeparator = (localizedSeparator: string) => string;


Suggested change

type GetPermittedDecimalSeparator = (localizedSeparator: string) => string;

type GetPermittedDecimalSeparator = (localizedSeparator?: string) => string;

Should be optional

fabioh8010 · 2023-10-26T11:55:43Z

src/libs/getPermittedDecimalSeparator/index.ts

+
+const getPermittedDecimalSeparator: GetPermittedDecimalSeparator = (localizedSeparator) => {
+    if (getOperatingSystem() === CONST.OS.IOS) {
+        return getPermittedDecimalSeparatorIOS(localizedSeparator);


@BartoszGrajdek Thanks for explanation, makes sense to me!

melvin-bot · 2023-11-03T08:07:46Z

@shubham1206agra 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 · 2023-11-07T12:01:52Z

Please tell me when you are ready for review.

BartoszGrajdek · 2023-11-07T12:31:44Z

@shubham1206agra it's ready 😄

shubham1206agra · 2023-11-07T13:30:59Z

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 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 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(themeColors.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 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-11-07T14:42:27Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #24837 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

OSBotify · 2023-11-07T18:55:31Z

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

shubham1206agra · 2023-11-08T02:03:11Z

Looks like payment issue is not created here.
@AndrewGable Can you check this please?

OSBotify · 2023-11-08T08:30:21Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.96-6 🚀

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

OSBotify · 2023-11-09T22:45:58Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T16:02:00Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:55:27Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

BartoszGrajdek added 2 commits October 23, 2023 08:35

Rename getPermittedDecimalSeparator

433a54b

[TS migration] Migrate 'getPermittedDecimalSeparator' lib to TypeScript

1760004

blazejkustra approved these changes Oct 23, 2023

View reviewed changes

src/libs/getPermittedDecimalSeparator/index.ts Outdated Show resolved Hide resolved

QFix

5d8dfec

fabioh8010 reviewed Oct 25, 2023

View reviewed changes

fabioh8010 approved these changes Oct 26, 2023

View reviewed changes

BartoszGrajdek added 2 commits October 29, 2023 23:29

Resolve merge conflicts

cf37fbf

Prettier fix

3640c82

BartoszGrajdek marked this pull request as ready for review November 3, 2023 08:07

BartoszGrajdek requested a review from a team as a code owner November 3, 2023 08:07

melvin-bot bot requested review from shubham1206agra and removed request for a team November 3, 2023 08:07

shubham1206agra approved these changes Nov 7, 2023

View reviewed changes

melvin-bot bot requested a review from AndrewGable November 7, 2023 14:42

AndrewGable approved these changes Nov 7, 2023

View reviewed changes

AndrewGable merged commit 4a220bd into Expensify:main Nov 7, 2023

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

		@@ -0,0 +1,3 @@
		type GetPermittedDecimalSeparator = (localizedSeparator: string) => string;

Conversation

BartoszGrajdek commented Oct 23, 2023 • edited by AndrewGable 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!

Uh oh!

fabioh8010 Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

BartoszGrajdek Oct 26, 2023 • 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!

blazejkustra Oct 26, 2023

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Oct 26, 2023

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Oct 26, 2023

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Nov 3, 2023

Uh oh!

shubham1206agra commented Nov 7, 2023

Uh oh!

BartoszGrajdek commented Nov 7, 2023

Uh oh!

shubham1206agra commented Nov 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Nov 7, 2023

Uh oh!

OSBotify commented Nov 7, 2023

Uh oh!

shubham1206agra commented Nov 8, 2023

Uh oh!

OSBotify commented Nov 8, 2023

Uh oh!

OSBotify commented Nov 9, 2023

Uh oh!

OSBotify commented Nov 10, 2023

Uh oh!

OSBotify commented Nov 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

BartoszGrajdek commented Oct 23, 2023 •

edited by AndrewGable

Loading

BartoszGrajdek Oct 26, 2023 •

edited

Loading

shubham1206agra commented Nov 7, 2023 •

edited

Loading