[TS Migration] Migrate WorkspaceProfilePage and WorkspaceProfileCurrencyPage #34897

ruben-rebelo · 2024-01-22T15:53:19Z

Details

[TS migration] Migrate WorkspaceSettingsPage and WorkspaceSettingsCurrencyPage to TypeScript

Fixed Issues

$ #25191
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Test WorkspaceSettingsPage:

Log into an account and create/go to a workspace
Go Settings page and it should show the information
All the fields are editable including the picture

Test WorkspaceSettingsCurrencyPage:

Log into an account and create/go to a workspace
Go Settings page and press currency
Currency can be changed

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Same as in the Tests section.

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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

android-native.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios-native.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

macos-web.mov

MacOS: Desktop

macos-desktop.mov

fabioh8010 · 2024-01-22T16:09:23Z

src/pages/workspace/WorkspaceSettingsCurrencyPage.tsx

 import withPolicyAndFullscreenLoading from './withPolicyAndFullscreenLoading';

-const propTypes = {
+type WorkspaceSettingsCurrentPageWithOnyxProps = {


Suggested change

type WorkspaceSettingsCurrentPageWithOnyxProps = {

type WorkspaceSettingsCurrentPageOnyxProps = {

fabioh8010 · 2024-01-22T16:12:30Z

src/pages/workspace/WorkspaceSettingsCurrencyPage.tsx

-    ),
-    isLoadingReportData: PropTypes.bool,
-    ...policyPropTypes,
+    currencyList: OnyxEntry<Record<string, Currency>>;


Suggested change

currencyList: OnyxEntry<Record<string, Currency>>;

currencyList: OnyxEntry<CurrencyList>;

Could you create a CurrencyList type in src/types/onyx/Currency.ts and use it here and here?

type CurrencyList = Record<string, OnyxTypes.Currency | null>;

fabioh8010 · 2024-01-22T16:13:28Z

src/pages/workspace/WorkspaceSettingsCurrencyPage.tsx


-function WorkspaceSettingsCurrencyPage({currencyList, policy, isLoadingReportData}) {
+function WorkspaceSettingsCurrencyPage({currencyList, policy, isLoadingReportData}: WorkspaceSettingsCurrentPageProps) {


Suggested change

function WorkspaceSettingsCurrencyPage({currencyList, policy, isLoadingReportData}: WorkspaceSettingsCurrentPageProps) {

function WorkspaceSettingsCurrencyPage({currencyList = {}, policy, isLoadingReportData = true}: WorkspaceSettingsCurrentPageProps) {

fabioh8010 · 2024-01-22T16:14:35Z

src/pages/workspace/WorkspaceSettingsPage.tsx

-            symbol: PropTypes.string.isRequired,
-        }),
-    ),
+    currencyList: OnyxEntry<Record<string, Currency>>;


fabioh8010 · 2024-01-22T16:14:50Z

src/pages/workspace/WorkspaceSettingsPage.tsx


-function WorkspaceSettingsPage({policy, currencyList, windowWidth, route}) {
+function WorkspaceSettingsPage({policy, currencyList, route}: WorkSpaceSettingsPageProps) {


Suggested change

function WorkspaceSettingsPage({policy, currencyList, route}: WorkSpaceSettingsPageProps) {

function WorkspaceSettingsPage({policy, currencyList = {}, route}: WorkSpaceSettingsPageProps) {

fabioh8010 · 2024-01-22T16:15:31Z

src/pages/workspace/WorkspaceSettingsPage.tsx

-
-            Policy.updateGeneralSettings(policy.id, values.name.trim(), policy.outputCurrency);
+        (values: WorkSpaceSettingsPageValues) => {
+            Policy.updateGeneralSettings(policy?.id ?? '', values.name.trim(), policy?.outputCurrency ?? '');


Why was this logic removed?

if (policy.isPolicyUpdating) { return; }

isPolicyUpdating doesn't exist on withPolicy hook, this was always coming undefined, I've tested this on web and mobile.

blazejkustra

LGTM!

melvin-bot · 2024-01-29T11:59:38Z

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

…rencyPage

# Conflicts: # src/pages/workspace/WorkspaceSettingsPage.tsx

rushatgabhane · 2024-02-06T21:32:38Z

@ruben-rebelo could you please resolve the conflicts, thanks 🙇

# Conflicts: # src/ONYXKEYS.ts # src/pages/workspace/WorkspaceOverviewCurrencyPage.js # src/pages/workspace/WorkspaceOverviewPage.js # src/pages/workspace/WorkspaceSettingsCurrencyPage.js # src/pages/workspace/WorkspaceSettingsCurrencyPage.tsx # src/types/onyx/Form.ts # src/types/onyx/index.ts

ruben-rebelo · 2024-02-07T16:13:03Z

Hello @rushatgabhane, thank you for the review, I've resolved the conflits!

rushatgabhane · 2024-02-12T12:22:22Z

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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-02-12T13:00:43Z

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

arosiclair

It looks like the WorkspaceSettingsPage and WorkspaceSettingsCurrencyPage are no longer on main... did they get removed/refactored with our new navigation? We may not need those components anymore. @ruben-rebelo @rushatgabhane

# Conflicts: # src/ONYXKEYS.ts # src/pages/workspace/WorkspaceOverviewCurrencyPage.js # src/pages/workspace/WorkspaceOverviewCurrencyPage.tsx # src/pages/workspace/WorkspaceProfileCurrencyPage.js

…me to WorkspaceProfile

# Conflicts: # src/libs/UserUtils.ts

ruben-rebelo · 2024-02-14T12:24:53Z

Hello @arosiclair and @rushatgabhane It seems that were some file refactoring and renaming happening on WorkspaceSettingsPage and WorkspaceSettingsCurrencyPage.
I've updated this PR in order to migrate WorkspaceProfileSettingsPage and WorkspaceProfileCurrencyPage.
Please have a look, thank you!

arosiclair

@ruben-rebelo can you also update the title and description to match the new files we're migrating? Thanks

src/pages/workspace/WorkspaceProfileCurrencyPage.tsx

src/pages/workspace/WorkspaceProfilePage.tsx

src/pages/workspace/WorkspaceOverviewCurrencyPage.tsx

# Conflicts: # src/pages/workspace/WorkspaceProfilePage.tsx

ruben-rebelo · 2024-02-22T15:15:50Z

@arosiclair I've updated the PR with the suggestions and resolved the conflicts

OSBotify · 2024-02-22T15:37:29Z

✋ 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 · 2024-02-26T21:04:59Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.4.44-0 🚀

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

situchan · 2024-02-27T13:55:20Z

src/pages/workspace/WorkspaceProfilePage.tsx

                                <View>
                                    <MenuItemWithTopDescription
                                        title={formattedCurrency}
                                        description={translate('workspace.editor.currencyInputLabel')}
                                        shouldShowRightIcon={!readOnly}
-                                        disabled={hasVBA || readOnly}
+                                        disabled={hasVBA ?? readOnly}


This caused deploy blocker - #37288
During TS migration, please be careful of using nullish coalescing.

OSBotify · 2024-02-28T23:53:35Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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

fabioh8010 reviewed Jan 22, 2024

View reviewed changes

fabioh8010 approved these changes Jan 23, 2024

View reviewed changes

blazejkustra approved these changes Jan 29, 2024

View reviewed changes

ruben-rebelo marked this pull request as ready for review January 29, 2024 11:59

ruben-rebelo requested a review from a team as a code owner January 29, 2024 11:59

melvin-bot bot requested review from rushatgabhane and removed request for a team January 29, 2024 11:59

ruben-rebelo added 8 commits January 30, 2024 15:20

[TS Migration] Migrate WorkspaceSettingsPage and WorkspaceSettingsCur…

8ee9a05

…rencyPage

[TS migration] TS error fix WorkspaceSettingsPage

c8b7d3b

[TS migration] Added default values on currencyList

456e38c

[TS migration] WorkspaceSettings code improvements

63f2976

[TS Migration] WorkspaceSettingsPage ts error fix

fb683a9

[TS migration] WorkspaceSettings prettified

cd50da3

Merge branch 'main' into ts-migration/WorkspaceSettings

4ed1693

# Conflicts: # src/pages/workspace/WorkspaceSettingsPage.tsx

[TS migration][WorkspaceSettings] Removed unused todo

4f20d01

ruben-rebelo force-pushed the ts-migration/WorkspaceSettings branch from 8725ab0 to 4f20d01 Compare January 30, 2024 15:22

ruben-rebelo added 2 commits January 31, 2024 09:06

Merge branch 'main' into ts-migration/WorkspaceSettings

ae6f7f6

[TS migration][WorkspaceSettings] Updated typings based on main merge

9e900e0

ruben-rebelo added 4 commits February 7, 2024 16:21

[TS migration] Lint and ts fixes

b345087

[TS migration][WorkspaceSettings] Fixed wrongly resolved conflicts

37c12e2

[TS migration][WorkscpaceSettings] Lint fixes

b2e0b3b

[TS migration][WorkspaceSettings] Minor ts issues fixed

4c61ce3

rushatgabhane approved these changes Feb 12, 2024

View reviewed changes

melvin-bot bot requested a review from arosiclair February 12, 2024 13:02

arosiclair reviewed Feb 12, 2024

View reviewed changes

ruben-rebelo added 3 commits February 14, 2024 12:12

Merge branch 'main' into ts-migration/WorkspaceSettings

e014172

# Conflicts: # src/ONYXKEYS.ts # src/pages/workspace/WorkspaceOverviewCurrencyPage.js # src/pages/workspace/WorkspaceOverviewCurrencyPage.tsx # src/pages/workspace/WorkspaceProfileCurrencyPage.js

[TS migration] Fixed migration of WorkspaceSettings based on the rena…

4545cc9

…me to WorkspaceProfile

Merge branch 'main' into ts-migration/WorkspaceSettings

0983db3

# Conflicts: # src/libs/UserUtils.ts

[TS migration][WorkspaceSettings] Fixed ts issues

9d451c8

arosiclair requested changes Feb 14, 2024

View reviewed changes

ruben-rebelo added 3 commits February 22, 2024 15:01

[TS migration][WorkspaceSettings] Feedback addressed

6331bdd

Merge branch 'main' into ts-migration/WorkspaceSettings

8fab1ec

# Conflicts: # src/pages/workspace/WorkspaceProfilePage.tsx

[TS migration][WorkspaceSettings] Prettier run after merge

5d06edb

arosiclair changed the title ~~[TS Migration] Migrate WorkspaceSettingsPage and WorkspaceSettingsCurrencyPage~~ [TS Migration] Migrate WorkspaceProfilePage and WorkspaceProfileCurrencyPage Feb 22, 2024

arosiclair approved these changes Feb 22, 2024

View reviewed changes

arosiclair merged commit 6754f15 into Expensify:main Feb 22, 2024
16 checks passed

github-actions bot mentioned this pull request Feb 26, 2024

Deploy Checklist: New Expensify 2024-02-26 #37224

Closed

situchan reviewed Feb 27, 2024

View reviewed changes

rushatgabhane mentioned this pull request Mar 16, 2024

[TS migration] Migrate 'WorkspaceSettings' page to TypeScript #25191

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] Migrate WorkspaceProfilePage and WorkspaceProfileCurrencyPage #34897

[TS Migration] Migrate WorkspaceProfilePage and WorkspaceProfileCurrencyPage #34897

ruben-rebelo commented Jan 22, 2024

fabioh8010 Jan 22, 2024

fabioh8010 Jan 22, 2024

fabioh8010 Jan 22, 2024

fabioh8010 Jan 22, 2024

fabioh8010 Jan 22, 2024

fabioh8010 Jan 22, 2024

ruben-rebelo Jan 22, 2024

blazejkustra left a comment

melvin-bot bot commented Jan 29, 2024

rushatgabhane commented Feb 6, 2024

ruben-rebelo commented Feb 7, 2024

rushatgabhane commented Feb 12, 2024 •

edited

Loading

melvin-bot bot commented Feb 12, 2024

arosiclair left a comment

ruben-rebelo commented Feb 14, 2024

arosiclair left a comment

ruben-rebelo commented Feb 22, 2024

OSBotify commented Feb 22, 2024

OSBotify commented Feb 26, 2024

situchan Feb 27, 2024 •

edited

Loading

OSBotify commented Feb 28, 2024

	type WorkspaceSettingsCurrentPageWithOnyxProps = {
	type WorkspaceSettingsCurrentPageOnyxProps = {

	currencyList: OnyxEntry<Record<string, Currency>>;
	currencyList: OnyxEntry<CurrencyList>;


		function WorkspaceSettingsCurrencyPage({currencyList, policy, isLoadingReportData}) {
		function WorkspaceSettingsCurrencyPage({currencyList, policy, isLoadingReportData}: WorkspaceSettingsCurrentPageProps) {


		function WorkspaceSettingsPage({policy, currencyList, windowWidth, route}) {
		function WorkspaceSettingsPage({policy, currencyList, route}: WorkSpaceSettingsPageProps) {

[TS Migration] Migrate WorkspaceProfilePage and WorkspaceProfileCurrencyPage #34897

[TS Migration] Migrate WorkspaceProfilePage and WorkspaceProfileCurrencyPage #34897

Conversation

ruben-rebelo commented Jan 22, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

fabioh8010 Jan 22, 2024

Choose a reason for hiding this comment

fabioh8010 Jan 22, 2024

Choose a reason for hiding this comment

fabioh8010 Jan 22, 2024

Choose a reason for hiding this comment

fabioh8010 Jan 22, 2024

Choose a reason for hiding this comment

fabioh8010 Jan 22, 2024

Choose a reason for hiding this comment

fabioh8010 Jan 22, 2024

Choose a reason for hiding this comment

ruben-rebelo Jan 22, 2024

Choose a reason for hiding this comment

blazejkustra left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 29, 2024

rushatgabhane commented Feb 6, 2024

ruben-rebelo commented Feb 7, 2024

rushatgabhane commented Feb 12, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Feb 12, 2024

arosiclair left a comment

Choose a reason for hiding this comment

ruben-rebelo commented Feb 14, 2024

arosiclair left a comment

Choose a reason for hiding this comment

ruben-rebelo commented Feb 22, 2024

OSBotify commented Feb 22, 2024

OSBotify commented Feb 26, 2024

situchan Feb 27, 2024 • edited Loading

Choose a reason for hiding this comment

OSBotify commented Feb 28, 2024

rushatgabhane commented Feb 12, 2024 •

edited

Loading

situchan Feb 27, 2024 •

edited

Loading