[TS migration] Migrate 'PolicyUtils.js' lib to TypeScript by BartoszGrajdek · Pull Request #28587 · Expensify/App

BartoszGrajdek · 2023-10-02T08:59:18Z

Details

Migrate 'PolicyUtils.js' lib file to TypeScript

Fixed Issues

$ #24867

Tests

Since this is a lib file test main application functionalities so check:

Sending messages
Adding tasks
Sending money
Verify that no errors appear in the JS console

Offline tests

QA Steps

Since this is a lib file test main application functionalities so check:

Sending messages
Adding tasks
Sending money
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

ios.mov

Android

android.mov

…tils-lib

melvin-bot · 2023-10-02T09:13:14Z

@mollfpr 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]

melvin-bot · 2023-10-02T09:25:40Z

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

AndrewGable · 2023-10-02T16:34:52Z

Please write QA steps

BartoszGrajdek · 2023-10-03T08:05:10Z

Callstack asked to change it to draft, so I'm doing that for now

src/libs/PolicyUtils.ts

BartoszGrajdek · 2023-10-03T17:19:55Z

Updated! WDYT @fabioh8010? :)

fabioh8010

@BartoszGrajdek Did some review, but I'll come back to this later. I think our PolicyTag / PolicyTags structure is incorrect, there is something odd..

src/ONYXKEYS.ts

src/libs/PolicyUtils.ts

fabioh8010 · 2023-10-05T14:18:28Z

FYI I will be on vacations starting tomorrow for the next two weeks and will return on Oct 23, so @kubabutkiewicz will replace me on this PR review!

BartoszGrajdek · 2023-10-11T09:43:54Z

@kubabutkiewicz let me know WDYT :)

src/libs/PolicyUtils.ts

kubabutkiewicz · 2023-10-11T11:46:46Z

@BartoszGrajdek Left two comments, other than that LGTM 😄

BartoszGrajdek · 2023-10-16T08:35:23Z

Done! @kubabutkiewicz

kubabutkiewicz

LGTM 😄

mollfpr · 2023-10-18T14:30:34Z

@BartoszGrajdek Could you add the test case you use in this PR? Thanks!

BartoszGrajdek · 2023-10-19T08:20:14Z

@mollfpr for libs & utils we were just supposed to test the main functionalities like sending messages, adding some tasks and sending money requests

mollfpr

I think the file PolicyUtils.js should be renamed to PolicyUtils.ts in this PR instead only adding PolicyUtils.ts file.

src/libs/PolicyUtils.ts

AndrewGable

Please write QA steps

mollfpr · 2023-10-24T04:56:30Z

@BartoszGrajdek Mostly, the changes look good! I'll record the test after the conflict is resolved, thank you!

BartoszGrajdek · 2023-10-24T10:37:53Z

@mollfpr done!

mollfpr · 2023-10-25T16:05:11Z

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

Web

28587.Web.mp4

Mobile Web - Chrome

28587.mWeb-Chrome.mp4

Mobile Web - Safari

28587.mWeb-Safari.mp4

Desktop

28587.Desktop.mp4

iOS

28587.iOS.mp4

Android

28587.Android.mp4

mollfpr

LGTM 👍

All yours @AndrewGable

OSBotify · 2023-10-26T22:44:53Z

✋ 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 · 2023-10-30T08:02:41Z

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

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

OSBotify · 2023-10-31T21:35:50Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.93-1 🚀

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

OSBotify · 2023-10-31T22:02:43Z

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

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

OSBotify · 2023-11-01T08:54:42Z

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

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

OSBotify · 2023-11-02T10:18:04Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.94-2 🚀

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

fedirjh · 2023-12-28T05:15:42Z

src/libs/PolicyUtils.ts

+ * Check if the policy has any error fields.
+ */
+function hasPolicyErrorFields(policy: OnyxEntry<Policy>): boolean {
+    return Object.keys(policy?.errorFields ?? {}).some((fieldErrors) => Object.keys(fieldErrors ?? {}).length > 0);


This has caused regression in #32513 , we should have used Object.values, more context here #32513 (comment)

BartoszGrajdek added 5 commits September 20, 2023 23:32

Migrate policy utils lib

e608638

Type fixes

8113ebf

Resolve merge conflicts

466814e

Migrate PolicyUtils to TS

837bd88

Merge remote-tracking branch 'origin/main' into ts-migration/policy-u…

e464283

…tils-lib

BartoszGrajdek changed the title ~~Ts migration/policy utils lib~~ [No QA] [TS migration] Migrate 'PolicyUtils.js' lib to TypeScript Oct 2, 2023

BartoszGrajdek marked this pull request as ready for review October 2, 2023 09:13

BartoszGrajdek requested a review from a team as a code owner October 2, 2023 09:13

melvin-bot bot requested review from mollfpr and removed request for a team October 2, 2023 09:13

mollfpr approved these changes Oct 2, 2023

View reviewed changes

melvin-bot bot requested a review from AndrewGable October 2, 2023 09:25

BartoszGrajdek marked this pull request as draft October 3, 2023 08:05

blazejkustra suggested changes Oct 3, 2023

View reviewed changes

src/libs/PolicyUtils.ts Outdated Show resolved Hide resolved

src/libs/PolicyUtils.ts Outdated Show resolved Hide resolved

fabioh8010 reviewed Oct 3, 2023

View reviewed changes

Changes after review of PolicyUtils

bbcdbd1

fabioh8010 reviewed Oct 4, 2023

View reviewed changes

src/ONYXKEYS.ts Outdated Show resolved Hide resolved

src/libs/PolicyUtils.ts Show resolved Hide resolved

src/libs/PolicyUtils.ts Show resolved Hide resolved

src/libs/PolicyUtils.ts Outdated Show resolved Hide resolved

Fixes in onyxkeys

3c41ef5

kubabutkiewicz reviewed Oct 11, 2023

View reviewed changes

src/libs/PolicyUtils.ts Show resolved Hide resolved

src/libs/PolicyUtils.ts Outdated Show resolved Hide resolved

Quick fixes for policy utils

010b47b

kubabutkiewicz approved these changes Oct 16, 2023

View reviewed changes

BartoszGrajdek added 2 commits October 18, 2023 11:02

Resolve merge conflicts

acba999

Resolve merge conflicts in onyx/index.ts

8d20b1e

BartoszGrajdek marked this pull request as ready for review October 18, 2023 09:13

mollfpr reviewed Oct 19, 2023

View reviewed changes

src/libs/PolicyUtils.ts Show resolved Hide resolved

BartoszGrajdek added 3 commits October 23, 2023 09:39

Remove PolicyUtils.ts

f921458

Rename PolicyUtils

db43443

Migrate PolicyUtils to TS

560b8ca

AndrewGable requested changes Oct 23, 2023

View reviewed changes

Resolve merge conflicts

df8c11c

AndrewGable changed the title ~~[No QA] [TS migration] Migrate 'PolicyUtils.js' lib to TypeScript~~ [TS migration] Migrate 'PolicyUtils.js' lib to TypeScript Oct 24, 2023

mollfpr approved these changes Oct 25, 2023

View reviewed changes

AndrewGable approved these changes Oct 26, 2023

View reviewed changes

AndrewGable merged commit c9abaf6 into Expensify:main Oct 26, 2023

OSBotify mentioned this pull request Oct 30, 2023

Deploy Checklist: New Expensify 2023-10-30 #30560

Closed

lanitochka17 mentioned this pull request Oct 30, 2023

Chat - Unable to type a few symbols and console error shows up #30583

Closed

6 tasks

melvin-bot bot mentioned this pull request Oct 31, 2023

[HOLD for payment 2023-11-07] [TS migration] Migrate 'PolicyUtils.js' lib to TypeScript #24867

Closed

OSBotify mentioned this pull request Oct 31, 2023

Deploy Checklist: New Expensify 2023-10-31 #30662

Closed

97 tasks

bernhardoj mentioned this pull request Dec 5, 2023

[HOLD for payment 2023-12-28] [$500] Desktop - WS Settings - Red dot appears after uploading a Workspace avatar when offline #32513

Closed

6 tasks

fedirjh reviewed Dec 28, 2023

View reviewed changes

Conversation

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

melvin-bot bot commented Oct 2, 2023

Uh oh!

melvin-bot bot commented Oct 2, 2023

Uh oh!

AndrewGable commented Oct 2, 2023

Uh oh!

BartoszGrajdek commented Oct 3, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BartoszGrajdek commented Oct 3, 2023

Uh oh!

fabioh8010 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabioh8010 commented Oct 5, 2023

Uh oh!

BartoszGrajdek commented Oct 11, 2023

Uh oh!

Uh oh!

Uh oh!

kubabutkiewicz commented Oct 11, 2023

Uh oh!

BartoszGrajdek commented Oct 16, 2023

Uh oh!

kubabutkiewicz left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr commented Oct 18, 2023

Uh oh!

BartoszGrajdek commented Oct 19, 2023

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AndrewGable left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr commented Oct 24, 2023

Uh oh!

BartoszGrajdek commented Oct 24, 2023

Uh oh!

mollfpr commented Oct 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 26, 2023

Uh oh!

OSBotify commented Oct 30, 2023

Uh oh!

BartoszGrajdek commented Oct 2, 2023 •

edited

Loading

mollfpr commented Oct 25, 2023 •

edited

Loading