Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removing compose.ts #42069

Merged
merged 13 commits into from
Jun 14, 2024
Merged

Removing compose.ts #42069

merged 13 commits into from
Jun 14, 2024

Conversation

abzokhattab
Copy link
Contributor

@abzokhattab abzokhattab commented May 13, 2024

Details

Fixed Issues

$ #39117
PROPOSAL: #39117 (comment)

Tests

  • Verify that no errors appear in the JS console

LocaleContextProvider:
interact with app .. LocaleContextProvider is used in withLocalize and and withLocalize is used in AutoUpdateTime which updates the app time automatically.

MapView:

  1. Click on '+' -> 'submit expense' -> 'distance tab'
  2. Pick a start and end locations and make sure the map is shown without errors

TestToolMenu:
this file is only used in Development.

  1. go to settings -> troubleshoot
  2. ensure that the Testing preferences section is shown and no errors are shown

withReportAndReportActionOrNotFound:

  1. Click on '+' -> 'Split Expense' -> 'Manual'
  2. enter any amount and choose two or more participants then confirm the split.
  3. click on the split preview action.
  4. ensure that the details RHP is opened and the split details is shown without error.

withPolicyAndFullscreenLoading:

  1. create a workspace
  2. navigate to workspace settings
  3. ensure that no error is shown up

Offline tests

Same as tests

QA Steps

Same as tests

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

Screenshots/Videos

Android: Native
Screen.Recording.2024-06-11.at.2.33.52.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-06-11.at.2.42.05.PM.mov
iOS: Native
Screen.Recording.2024-06-11.at.2.29.39.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-06-11.at.2.42.05.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-06-11.at.2.38.28.PM.mov
MacOS: Desktop
Screen.Recording.2024-06-11.at.2.45.08.PM.mov

@abzokhattab abzokhattab requested a review from a team as a code owner May 13, 2024 14:07
@melvin-bot melvin-bot bot requested review from shubham1206agra and removed request for a team May 13, 2024 14:07
Copy link

melvin-bot bot commented May 13, 2024

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

@blazejkustra
Copy link
Contributor

Any updates here @abzokhattab?

withPolicy,
withNetwork(),
)(WorkspaceRateAndUnitPage);
export default withNetwork()(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not getting the use of withNetwork here. @abzokhattab Can you please find out why this was introduced in the first place?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it's not needed since the network object is not used anywhere

type WorkspaceRateAndUnitPageBaseProps = WithPolicyProps & {
// eslint-disable-next-line react/no-unused-prop-types
network: OnyxEntry<Network>;
};

this change was introduced here but there is no reference for why it was introduced.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since it not used anymore we should consider removing this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay done

@fabioh8010
Copy link
Contributor

Any updates here? cc @abzokhattab @shubham1206agra

Why is this PR still on Draft? Is it WIP or can we open to review?

@abzokhattab
Copy link
Contributor Author

what kind of manual tests should I make here @shubham1206agra ?

@abzokhattab abzokhattab marked this pull request as ready for review May 28, 2024 14:16
@abzokhattab
Copy link
Contributor Author

Kindly reminder on this @shubham1206agra

@shubham1206agra
Copy link
Contributor

@abzokhattab Can you please add tests and screenshots?

@fabioh8010
Copy link
Contributor

@abzokhattab @shubham1206agra Whats the status of this PR? What can we do to get this moving faster?

@abzokhattab
Copy link
Contributor Author

The PR is ready .. i will update the description today

at the mean time please let me know if you have any comments on the changes made.

thanks

@fabioh8010
Copy link
Contributor

The PR is ready .. i will update the description today

at the mean time please let me know if you have any comments on the changes made.

thanks

Thanks, please let us know once you update the description and add tests / screenshots

@shubham1206agra
Copy link
Contributor

@abzokhattab Please use useOnyx now since withOnyx is officially deprecated.
cc @blazejkustra

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Jun 10, 2024

  • Updating the PR description now.

  • @shubham1206agra i see that withOynx is still not deprecated.

    should we keep it then?

image

@shubham1206agra
Copy link
Contributor

No, please use useOnyx now.

@fabioh8010
Copy link
Contributor

@shubham1206agra just curious, but what replace to useOnyx are we talking about here? As discussed previously in the GH issue we should focus only on removing compose rather than doing migrations to useOnyx here.

@shubham1206agra
Copy link
Contributor

There was an announcement for deprecation of withOnyx.

@abzokhattab
Copy link
Contributor Author

Okay, i reverted the useOnyx change ..
The PR is now ready.

@blazejkustra
Copy link
Contributor

@shubham1206agra Let's test these components, shouldn't make any difference but watch out for any regressions 🚀

@blazejkustra
Copy link
Contributor

We can also consider adjusting contributing guides:

### Composition 

Avoid the usage of `compose` function to compose HOCs in TypeScript files. Use nesting instead.

> Why? `compose` function doesn't work well with TypeScript when dealing with several HOCs being used in a component, many times resulting in wrong types and errors. Instead, nesting can be used to allow a seamless use of multiple HOCs and result in a correct return type of the compoment. Also, you can use [hooks instead of HOCs](#hooks-instead-of-hocs) whenever possible to minimize or even remove the need of HOCs in the component.

@abzokhattab
Copy link
Contributor Author

We can also consider adjusting contributing guides:

should we remove the mentioned section ?

@blazejkustra

@shubham1206agra
Copy link
Contributor

@abzokhattab Yes, please remove that.

@abzokhattab
Copy link
Contributor Author

@abzokhattab Yes, please remove that.

okay i removed the composition section from the readme because the whole section is not relatable now

@shubham1206agra
Copy link
Contributor

@abzokhattab Please merge main

@abzokhattab
Copy link
Contributor Author

Done

@ishpaul777
Copy link
Contributor

ishpaul777 commented Jun 14, 2024

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
VIDEO-2024-06-14-21-20-29.mp4
Android: mWeb Chrome
VIDEO-2024-06-14-21-13-56.mp4
iOS: Native
Screen.Recording.2024-06-14.at.8.32.57.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-06-14.at.8.27.19.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-06-14.at.7.48.17.PM.mov
MacOS: Desktop
Screen.Recording.2024-06-14.at.9.28.55.PM-1.mov

Copy link
Contributor

@ishpaul777 ishpaul777 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

mountiny
mountiny previously approved these changes Jun 14, 2024
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@abzokhattab one question

@@ -159,7 +157,5 @@ export default compose(
workspaceRateAndUnit: {
key: ONYXKEYS.WORKSPACE_RATE_AND_UNIT,
},
}),
withPolicy,
withNetwork(),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this not needed in the page?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes its not used anywhere as specified in the props types:

type WorkspaceRateAndUnitPageBaseProps = WithPolicyProps & {
// eslint-disable-next-line react/no-unused-prop-types
network: OnyxEntry<Network>;
};

also i forgot to remove this type, i just removed it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, as i mentioned here #42069 (comment) the whole ( InitialPage, RatePage,UnitPage ) pages are not used anywhere so i am not sure if we should remove these components or not and if so should we do it in the same PR or in a new one.

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think they will be removed in another project that deprecates anything related to Free policies

@mountiny
Copy link
Contributor

Thanks for all the hard work

@mountiny mountiny merged commit 578e6e9 into Expensify:main Jun 14, 2024
18 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.84-3 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants