[VIP-Travel] Workspace address page and section in workspace profile by smelaa · Pull Request #38381 · Expensify/App

smelaa · 2024-03-15T10:03:31Z

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

Your account needs to be spotnana travel beta otherwise make Permissions.canUseSpotnanaTravel function returning always true.
Log in to New Expensify.
Change server to staging (Account Settings -> Troubleshoot -> Use Staging Server)
Navigate to your profile and then Workspaces.
Choose one of the existing workspaces or create a new one. You need to own a workspace to modify it.
Click on "Company address"
Enter address, press "Save" and close the modal.
Verify whether the address is correctly displayed in workspace profile.
Open address modal again by clicking "Company address" and verify whether everything is correct.
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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

BrtqKr · 2024-04-26T09:13:49Z

+    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);


move it to form, please

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.

BrtqKr · 2024-04-26T09:14:28Z

+        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);
+    }, []);


this will get simplified afterwards I guess

Same as here.

BrtqKr · 2024-04-26T09:15:37Z

+                city={city}
+                country={currentCountry}
+                onAddressChanged={handleAddressChange}
+                state={state}
+                street1={street1}
+                street2={street2}
+                zip={zipcode}


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

Same as here.

BrtqKr · 2024-04-26T09:16:52Z

+        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,
+    };


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

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.

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.

melvin-bot · 2024-04-26T13:24:39Z

@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 · 2024-04-26T20:27:27Z

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

shubham1206agra · 2024-04-29T15:58:42Z

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 · 2024-04-29T16:50:41Z

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

melvin-bot · 2024-04-29T16:51:06Z

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!

shubham1206agra · 2024-04-29T16:52:15Z

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

lakchote · 2024-04-30T06:31:05Z

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


Has an issue been created for it?

cc @danieldoglas

@deetergp is working on it here: https://github.com/Expensify/Web-Expensify/pull/41840

WojtekBoman · 2024-04-30T09:16:38Z

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 · 2024-04-30T10:12:08Z

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

twisterdotcom · 2024-04-30T13:36:25Z

Anything stopping us from merging now?

shubham1206agra · 2024-04-30T13:39:41Z

Nothing.

twisterdotcom · 2024-05-01T12:26:32Z

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

anmurali · 2024-05-06T13:59:07Z

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

OSBotify · 2024-05-07T01:36:58Z

🚀 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 · 2024-05-07T14:00:27Z

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

smelaa · 2024-05-07T14:03:26Z

Sure, the draft PR is almost done.

smelaa and others added 9 commits March 13, 2024 10:52

Initial config to workspace address page

42b22e0

Create workspace address page and section in workspace profile

c001a15

Merge branch 'main' into travel/workspace-profile-address

572411c

Merge branch 'main' into travel/workspace-profile-address

5478015

Merge branch 'main' into travel/workspace-profile-address

c2dd7fb

Change workspace address page route & add beta visibility

90bdc7e

Merge branch 'main' into travel/workspace-profile-address

49797a7

Fix workspace address page routing

28c66fc

Fix diff in routes to address page and checking beta

4fdbaba

smelaa mentioned this pull request Apr 9, 2024

[CRITICAL] [VIP-Travel] Create workspace address page and section in overview #37827

Closed

smelaa added 9 commits April 9, 2024 15:17

Merge branch 'main' into travel/workspace-profile-address

99eb0c7

Merge branch 'main' into travel/workspace-profile-address

e4ecae4

Go back after submitting address form

352478c

Merge branch 'main' into travel/workspace-profile-address

9218e43

Change translations

7d25e4d

Merge branch 'main' into travel/workspace-profile-address

fb5c648

First tries to call API

2bbf2d5

Comunicate frontend with backend

63eefbc

Street address line fix

d9ed6fc

BrtqKr suggested changes Apr 26, 2024

View reviewed changes

smelaa added 2 commits April 26, 2024 11:56

Merge branch 'main' into travel/workspace-profile-address

b8975cb

Fix typecheck errors

8d2fd83

smelaa marked this pull request as ready for review April 26, 2024 13:24

smelaa requested a review from a team as a code owner April 26, 2024 13:24

melvin-bot Bot requested review from shubham1206agra and removed request for a team April 26, 2024 13:24

twisterdotcom mentioned this pull request Apr 26, 2024

[HOLD for payment 2024-05-31] [HIGH] [VIP Travel] Add Workspace Address context - newDot #41119

Closed

shubham1206agra reviewed Apr 27, 2024

View reviewed changes

Comment thread src/pages/workspace/WorkspaceProfileAddressPage.tsx

smelaa added 2 commits April 29, 2024 12:14

Merge branch 'main' into travel/workspace-profile-address

40b9a28

Fix small bugs & address review comments

f7da8c4

smelaa requested a review from shubham1206agra April 29, 2024 11:10

smelaa mentioned this pull request Apr 29, 2024

[VIP Travel] Add Workspace Address context - newDot #41201

Merged

48 tasks

shubham1206agra approved these changes Apr 29, 2024

View reviewed changes

melvin-bot Bot requested a review from lakchote April 29, 2024 16:51

lakchote reviewed Apr 30, 2024

View reviewed changes

lakchote approved these changes Apr 30, 2024

View reviewed changes

twisterdotcom assigned rushatgabhane May 1, 2024

twisterdotcom unassigned rushatgabhane May 1, 2024

twisterdotcom merged commit c8aa591 into Expensify:main May 1, 2024

github-actions Bot mentioned this pull request May 2, 2024

Deploy Checklist: New Expensify 2024-05-02 #41494

Closed

60 tasks

rlinoz mentioned this pull request May 2, 2024

[HOLD for payment 2024-05-22] [CRITICAL] [VIP-Travel] Workspace - Unable to select country in Company address #41505

Closed

6 tasks

francoisl mentioned this pull request May 2, 2024

Workspace - "Company address" shows up for employee when it is not set up #41506

Closed

6 tasks

srikarparsi mentioned this pull request May 2, 2024

Revert "[VIP-Travel] Workspace address page and section in workspace profile" #41543

Closed

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

Uh oh!

Conversation

smelaa commented Mar 15, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

smelaa Apr 26, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Apr 26, 2024

Uh oh!

twisterdotcom commented Apr 26, 2024

Uh oh!

Uh oh!

shubham1206agra commented Apr 29, 2024

Uh oh!

shubham1206agra commented Apr 29, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Apr 29, 2024

Uh oh!

shubham1206agra commented Apr 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WojtekBoman commented Apr 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

twisterdotcom commented Apr 30, 2024

Uh oh!

twisterdotcom commented Apr 30, 2024

Uh oh!

shubham1206agra commented Apr 30, 2024

Uh oh!

twisterdotcom commented May 1, 2024

Uh oh!

anmurali commented May 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented May 7, 2024

Uh oh!

stitesExpensify commented May 7, 2024

Uh oh!

smelaa commented May 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

smelaa commented Mar 15, 2024 •

edited

Loading

smelaa Apr 26, 2024 •

edited

Loading

shubham1206agra commented Apr 29, 2024 •

edited

Loading

WojtekBoman commented Apr 30, 2024 •

edited

Loading

anmurali commented May 6, 2024 •

edited

Loading