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

[VIP-Travel] Workspace address page and section in workspace profile #38381

Conversation

smelaa
Copy link
Contributor

@smelaa smelaa commented Mar 15, 2024

Details

This PR adds workspace address page and address section in workspace profile. Currently it only saves the data in the state. Once backend is ready it should be adjusted to save the data using API.

Fixed Issues

$#37827
PROPOSAL:

Tests

  1. Your account needs to be spotnana travel beta otherwise make Permissions.canUseSpotnanaTravel function returning always true.
  2. Log in to New Expensify.
  3. Change server to staging (Account Settings -> Troubleshoot -> Use Staging Server)
  4. Navigate to your profile and then Workspaces.
  5. Choose one of the existing workspaces or create a new one. You need to own a workspace to modify it.
  6. Click on "Company address"
  7. Enter address, press "Save" and close the modal.
  8. Verify whether the address is correctly displayed in workspace profile.
  9. Open address modal again by clicking "Company address" and verify whether everything is correct.
  10. Repeat steps 7 and 8 on a different device or account.
  • Verify that no errors appear in the JS console

Offline tests

N/A

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

android1
android2
android3

Android: mWeb Chrome

android android_web2 _web android_web3 1

iOS: Native

ios1
ios2

iOS: mWeb Safari

ios_web1
ios_web2

MacOS: Chrome / Safari web1 web2 web3
MacOS: Desktop desktop1 desktop2

Comment on lines 23 to 29
const {translate} = useLocalize();
const address = useMemo(() => policy?.address, [policy]);
const [currentCountry, setCurrentCountry] = useState(address?.country);
const [street1, street2] = (address?.addressStreet ?? '').split('\n');
const [state, setState] = useState(address?.state);
const [city, setCity] = useState(address?.city);
const [zipcode, setZipcode] = useState(address?.zip);
Copy link
Contributor

Choose a reason for hiding this comment

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

move it to form, please

Copy link
Contributor Author

Choose a reason for hiding this comment

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

AddressForm is already a FormProvider. Those useState hooks are needed for implementation of handleAddressChange. I agree we could simplify this as the performance is quite similar to what happens in AddressPage. But it requires some refactoring to AddressPage and AddressForm and I think it should be handled in a different PR. Especially since this PR's issue is critical.

Comment on lines 49 to 71
if (addressKey !== 'country' && addressKey !== 'state' && addressKey !== 'city' && addressKey !== 'zip') {
return;
}
if (addressKey === 'country') {
setCurrentCountry(countryValue);
setState('');
setCity('');
setZipcode('');
return;
}
if (addressKey === 'state') {
setState(countryValue);
setCity('');
setZipcode('');
return;
}
if (addressKey === 'city') {
setCity(countryValue);
setZipcode('');
return;
}
setZipcode(countryValue);
}, []);
Copy link
Contributor

Choose a reason for hiding this comment

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

this will get simplified afterwards I guess

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as here.

Comment on lines +87 to +93
city={city}
country={currentCountry}
onAddressChanged={handleAddressChange}
state={state}
street1={street1}
street2={street2}
zip={zipcode}
Copy link
Contributor

Choose a reason for hiding this comment

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

afterwards, you can pass form data as a whole, or include it inside of AddressForm

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as here.

Comment on lines 1827 to 1838
policyID,
// eslint-disable-next-line @typescript-eslint/naming-convention
'data[addressStreet]': newAddress.addressStreet,
// eslint-disable-next-line @typescript-eslint/naming-convention
'data[city]': newAddress.city,
// eslint-disable-next-line @typescript-eslint/naming-convention
'data[country]': newAddress.country,
// eslint-disable-next-line @typescript-eslint/naming-convention
'data[state]': newAddress.state,
// eslint-disable-next-line @typescript-eslint/naming-convention
'data[zipCode]': newAddress.zip,
};
Copy link
Contributor

Choose a reason for hiding this comment

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

this definitely needs to be discussed, it's weird we're passing it this way

Copy link
Contributor Author

@smelaa smelaa Apr 26, 2024

Choose a reason for hiding this comment

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

100% agreed. I think this is something what needs backend changes. I tried many different ways to make this API request and this is the only one which works.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The thread about changing the endpoint on backend: https://swmansion.slack.com/archives/C05S5EV2JTX/p1713825690019579
In case of changes we need to modify this part.

@smelaa smelaa marked this pull request as ready for review April 26, 2024 13:24
@smelaa smelaa requested a review from a team as a code owner April 26, 2024 13:24
@melvin-bot melvin-bot bot requested review from shubham1206agra and removed request for a team April 26, 2024 13:24
Copy link

melvin-bot bot commented Apr 26, 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]

@twisterdotcom
Copy link
Contributor

Just noting I created a polish issue above. Doesn't need to be included with this PR.

@shubham1206agra
Copy link
Contributor

Screen.Recording.2024-04-29.at.9.26.27.PM.mov

@smelaa Please observe the logs when I click on the address from auto complete. It is trying to navigate too many times.

@shubham1206agra
Copy link
Contributor

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
Android: mWeb Chrome
Screen.Recording.2024-04-29.at.9.55.58.PM.mov
iOS: Native
Screen.Recording.2024-04-29.at.10.12.44.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-04-29.at.9.43.37.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-29.at.9.30.00.PM.mov
MacOS: Desktop
Screen.Recording.2024-04-29.at.10.01.45.PM.mov

Copy link

melvin-bot bot commented Apr 29, 2024

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

@melvin-bot melvin-bot bot requested a review from lakchote April 29, 2024 16:51
@shubham1206agra
Copy link
Contributor

shubham1206agra commented Apr 29, 2024

@twisterdotcom There seems to be some BE issue where addresses are not retaining for multiple workspaces.

@@ -0,0 +1,12 @@
// TODO: Change API endpoint parameters format to make it possible to follow naming-convention
Copy link
Contributor

Choose a reason for hiding this comment

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

Has an issue been created for it?

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

@WojtekBoman
Copy link
Contributor

WojtekBoman commented Apr 30, 2024

Screen.Recording.2024-04-29.at.9.26.27.PM.mov
@smelaa Please observe the logs when I click on the address from auto complete. It is trying to navigate too many times.

@shubham1206agra I've investigated this issue, and it also happens in AddressPage, it's caused by calling Navigation.setParams({country: undefined}); in onValueChange in the first InputWrapper in the AddressForm component. To me, we should refactor it in another issue, because changing it here might introduce another bugs and delay this PR. It's a problem with the AddressForm, not with this specific screen.

@twisterdotcom
Copy link
Contributor

Nice, @shubham1206agra could you report the bug in #expensify-bugs for that, and we'll get it cleaned up after?

@twisterdotcom
Copy link
Contributor

Anything stopping us from merging now?

@shubham1206agra
Copy link
Contributor

Nothing.

@twisterdotcom
Copy link
Contributor

Ahh, actually don't need you here @rushatgabhane.

@anmurali
Copy link

anmurali commented May 6, 2024

#41505
That seems like a bug related to this PR, which may need to be addressed here?

@OSBotify
Copy link
Contributor

OSBotify commented May 7, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.70-5 🚀

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

@stitesExpensify
Copy link
Contributor

Agreed. @smelaa can you please take a look at that bug?

@smelaa
Copy link
Contributor Author

smelaa commented May 7, 2024

Sure, the draft PR is almost done.

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.

None yet