[TS migration] Migrate 'OfflineWithFeedback.js' component to TypeScript by kubabutkiewicz · Pull Request #31124 · Expensify/App

kubabutkiewicz · 2023-11-09T14:36:59Z

Details

Fixed Issues

$ #25102

Tests

Login to app
Open Preferences
Go to Offline mode
Start a chat
Send a message
Offline indicator should show up

Verify that no errors appear in the JS console

Offline tests

QA Steps

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: 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 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
  - 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

Android: Native

android.mp4

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

…s-migration/OfflineWithFeedback/component

src/components/MessagesRow.tsx

src/components/OfflineWithFeedback.tsx

src/types/utils/EmptyObject.ts

src/components/OfflineWithFeedback.tsx

…s-migration/OfflineWithFeedback/component

melvin-bot · 2023-11-27T13:38:47Z

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

src/types/utils/EmptyObject.ts

src/components/MessagesRow.tsx

src/components/OfflineWithFeedback.tsx

blazejkustra · 2023-11-29T07:23:33Z

src/components/OfflineWithFeedback.tsx

+
+    const hasErrors = !isEmptyObject(errors);
+    // Some errors have a null message. This is used to apply opacity only and to avoid showing redundant messages.
+    const errorMessages = lodashOmitBy(errors, (e) => e === null);


How about implementation without lodash?

FYI Original implementation used omit, not omitBy:

const errorMessages = _.omit(props.errors, (e) => e === null);

@blazejkustra lodash omit is used only for omits by keys
https://lodash.com/docs/4.17.15#omit
for omit by some function omitBy need to be used
https://lodash.com/docs/4.17.15#omitBy

src/components/OfflineWithFeedback.tsx

…s-migration/OfflineWithFeedback/component

kubabutkiewicz · 2023-11-30T12:21:48Z

@blazejkustra comments resolved

Ollyws · 2023-12-01T10:26:07Z

Could we get some testing steps please? Thanks!

kubabutkiewicz · 2023-12-01T13:39:47Z

@Ollyws added!

kubabutkiewicz · 2023-12-05T15:35:41Z

@Ollyws kindly bump 😄

Ollyws · 2023-12-07T15:34:23Z

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

Ollyws

LGTM.

melvin-bot · 2023-12-07T15:58:00Z

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

OSBotify · 2023-12-07T16:46:18Z

✋ 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-12-08T01:24:02Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.10-0 🚀

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

OSBotify · 2023-12-08T02:53:55Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.10-0 🚀

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

OSBotify · 2023-12-11T10:41:12Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.10-1 🚀

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

OSBotify · 2023-12-11T15:23:07Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.10-1 🚀

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

kubabutkiewicz added 4 commits November 9, 2023 15:35

ref: migrate OfflineWithFeedback to TS

04ef831

fix: migrate MessagesRow to TS

1323fae

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

e5b91bd

…s-migration/OfflineWithFeedback/component

fix: lint errors

5f0b880

VickyStash suggested changes Nov 24, 2023

View reviewed changes

fix: resolve comments

c0b19a9

VickyStash reviewed Nov 24, 2023

View reviewed changes

src/components/OfflineWithFeedback.tsx Outdated Show resolved Hide resolved

fabioh8010 reviewed Nov 24, 2023

View reviewed changes

src/types/utils/EmptyObject.ts Show resolved Hide resolved

src/types/utils/EmptyObject.ts Outdated Show resolved Hide resolved

src/components/OfflineWithFeedback.tsx Outdated Show resolved Hide resolved

kubabutkiewicz added 4 commits November 27, 2023 10:07

fix: resolve comments

03126d4

fix: resolve comment

53cd80e

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

b4d4cd3

…s-migration/OfflineWithFeedback/component

fix: resolve comment

b88897b

fabioh8010 approved these changes Nov 27, 2023

View reviewed changes

kubabutkiewicz marked this pull request as ready for review November 27, 2023 13:38

kubabutkiewicz requested a review from a team as a code owner November 27, 2023 13:38

melvin-bot bot requested review from Ollyws and removed request for a team November 27, 2023 13:38

kubabutkiewicz marked this pull request as draft November 27, 2023 13:39

blazejkustra suggested changes Nov 29, 2023

View reviewed changes

kubabutkiewicz added 2 commits November 30, 2023 12:42

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

3164601

…s-migration/OfflineWithFeedback/component

fix: resolve comments

26782f9

BartoszGrajdek approved these changes Nov 30, 2023

View reviewed changes

kubabutkiewicz marked this pull request as ready for review November 30, 2023 13:19

blazejkustra approved these changes Nov 30, 2023

View reviewed changes

Ollyws approved these changes Dec 7, 2023

View reviewed changes

melvin-bot bot requested a review from cristipaval December 7, 2023 15:58

cristipaval approved these changes Dec 7, 2023

View reviewed changes

cristipaval merged commit 710ebbf into Expensify:main Dec 7, 2023

github-actions bot mentioned this pull request Dec 8, 2023

Deploy Checklist: New Expensify 2023-12-08 #32704

Closed

27 tasks

melvin-bot bot mentioned this pull request Dec 11, 2023

[HOLD for payment 2023-12-18] [TS migration] Migrate 'OfflineWithFeedback.js' component to TypeScript #25102

Closed

Conversation

kubabutkiewicz commented Nov 9, 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!

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!

Uh oh!

melvin-bot bot commented Nov 27, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blazejkustra Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

blazejkustra Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

kubabutkiewicz Nov 30, 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!

Uh oh!

Uh oh!

kubabutkiewicz commented Nov 30, 2023

Uh oh!

Ollyws commented Dec 1, 2023

Uh oh!

kubabutkiewicz commented Dec 1, 2023

Uh oh!

kubabutkiewicz commented Dec 5, 2023

Uh oh!

Ollyws commented Dec 7, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

Ollyws left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Dec 7, 2023

Uh oh!

OSBotify commented Dec 7, 2023

Uh oh!

OSBotify commented Dec 8, 2023

Uh oh!

OSBotify commented Dec 8, 2023

Uh oh!

OSBotify commented Dec 11, 2023

Uh oh!

OSBotify commented Dec 11, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

kubabutkiewicz commented Nov 9, 2023 •

edited

Loading

kubabutkiewicz Nov 30, 2023 •

edited

Loading