Show errors after workspace creation failure by Justicea83 · Pull Request #12117 · Expensify/App

Justicea83 · 2022-10-25T13:30:16Z

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/236995

Tests

Changes For Testing

diff --git a/lib/PolicyAPI.php b/lib/PolicyAPI.php
index 51a480c4f4d..5ba7b05efec 100644
--- a/lib/PolicyAPI.php
+++ b/lib/PolicyAPI.php
@@ -52,6 +52,7 @@ class PolicyAPI
                                   string $adminsChatReportID = '',
                                   string $expenseChatReportID = ''): array
     {
+        self::sayHello();
         $user = User_Store::get($authToken);
         $email = $user->getEmail();
         $callerEmail = $email;
(END)

Signin to NewDot.
If you don't have a workspace yet click on the + button > Create Workspace else skip to 3.
Click on your profile picture.
Click on any workspace.
Click on the elipses(...) > New Workspace.
Ensure you see an error like in the screenshot below.
Click on x to dismiss the error and ensure the workspace is removed(Not showing in the list).

QA Steps

Sign to OldDot as the domain admin(with a domain admin account).
Go to Settings > Domains > Groups.
Click on any group and turn Restrict expense policy creation/removal on.
Signin to NewDot with the account of any user on the group in step 3 that you turned Restrict expense policy creation/removal on.
If you don't have a workspace yet click on the + button > Create Workspace else skip to 3.
Click on your profile picture.
Click Workspaces.
Click on the elipses(...) > New Workspace.
Ensure workspace creation fails with RBR like in the screenshot below.
Click on x to dismiss the error and ensure the workspace is removed(Not showing in the list).

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

Web

2022-10-31_09-29-59.mp4

Mobile Web - Chrome

2022-10-31_09-30-55.mp4

Mobile Web - Safari

2022-10-31_09-32-05.mp4

Desktop

2022-10-31_09-35-03.mp4

iOS

2022-10-31_09-53-49.mp4

Android

2022-10-26_17-50-32.mp4

Justicea83 · 2022-10-26T15:50:18Z

There was an awkward behaviour with the offline testing, so I'll wait for this PR to be merged before I continue with this.

Justicea83 · 2022-10-27T08:39:38Z

Awkward behaviour fixed, after the PR was merged.

tgolen · 2022-10-27T14:08:04Z

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

tgolen · 2022-10-27T14:35:50Z

I did run into an odd UX while testing this. Probably not blockers for this specific PR, but things that are still weird in the overall flow that you might want to look into.

Issue One

Create the workspace (making sure the server threw an error on creation)
Right away in the app, there is no indication that anything went wrong because you land on the workspace settings page and everything looks normal
If you close the settings modal, or click the back button to return to the list of workspaces, that's when you see the RBR

It would be great if we could show the RBR on the workspace settings page, and perhaps leave all options disabled if there was an error on creation.

Issue Two

Create the workspace (making sure the server threw an error on creation)
Go to the Manage Members setting
The page shows an error saying "the page is nowhere to be found"
If you click < or X, then you are returned to the LHN with no RBR and the failed workspace is not listed in the profile menu any more

parasharrajat · 2022-10-27T15:49:13Z

Do you need C+ review here?

tgolen · 2022-10-27T16:46:15Z

You can review it if you want. No need to do all the testing though

Justicea83 · 2022-10-27T16:49:54Z

@tgolen , I updated the logic to make the children non interactive when creation fails. You can take a look/test.

parasharrajat · 2022-10-27T16:55:39Z

I am busy with stuff so I will let it go. Thanks.

tgolen

Cool, thanks for disabling those!

src/pages/workspace/WorkspaceInitialPage.js

Justicea83 · 2022-10-28T11:19:10Z

The PR for workspace list was merged, which meant I needed to tweak this, you can join in on the conversation here regarding a few concerns.

Justicea83 · 2022-10-28T14:49:35Z

@tgolen I removed the RBR on the workspace list item, you can review again/test.

tgolen · 2022-10-28T16:07:19Z

Recent tests

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Justicea83 · 2022-10-28T16:54:30Z

I'll update the PR description with the latest tests videos

OSBotify · 2022-11-01T18:56:33Z

✋ 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 · 2022-11-02T20:21:36Z

🚀 Deployed to staging by @Justicea83 in version: 1.2.23-0 🚀

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

kavimuru · 2022-11-03T17:08:19Z

@Justicea83 We are not getting error when creating workspace. Is there any steps to trigger the workspace creation failure error?

roryabraham · 2022-11-04T01:31:55Z

src/pages/workspace/WorkspacesListPage.js

                brickRoadIndicator: PolicyUtils.getPolicyBrickRoadIndicatorStatus(policy, this.props.policyMembers),
                pendingAction: policy.pendingAction,
                isPolicy: true,
-                errors: policy.errors,


This change caused a regression

Didn't see any discussion about this change on this PR. Going to remove it and perform all the testing steps again to see if it can be safely added back

We had a discussion on this. We wanted to only show the error message on the workspace details page. Like in this video.

2022-10-31_09-35-03.mp4

https://expensify.slack.com/archives/C01GTK53T8Q/p1666955764560879

I now understand the context of that thread, and can see that my fix wasn't what was agreed upon in that thread. However, this PR didn't achieve what was agreed upon in that thread either. It was still a regression – we forgot to test the delete workspace flow with this PR. In that case, the workspace was just not showing at all, so there was no way to dismiss the red dot error that appeared in the settings menu.

OSBotify · 2022-11-04T17:11:59Z

🚀 Deployed to production by @Julesssss in version: 1.2.23-9 🚀

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

ikevin127 · 2024-05-20T19:15:44Z

src/pages/workspace/WorkspaceInitialPage.js

+     * @returns {Boolean}
+     */
+    hasPolicyCreationError() {
+        return Boolean(this.props.policy.pendingAction === CONST.RED_BRICK_ROAD_PENDING_ACTION.ADD && this.props.policy.errors);


The above logic caused issue:

[HOLD for payment 2024-05-22] [$250] Categories - Unable to go to other tabs after enabling " must categorize all spend" offline #41325

because optimistic / success data is setting requiresCategory to null, therefore policy.errors will always be true.

App/src/libs/actions/Policy.ts

Lines 3571 to 3599 in 942c851

optimisticData: [

{

onyxMethod: Onyx.METHOD.MERGE,

key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,

value: {

requiresCategory,

errors: {

requiresCategory: null,

},

pendingFields: {

requiresCategory: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,

},

},

},

],

successData: [

{

onyxMethod: Onyx.METHOD.MERGE,

key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,

value: {

errors: {

requiresCategory: null,

},

pendingFields: {

requiresCategory: null,

},

},

},

],

The proposed and implemented solution to fix this was to check !isEmptyObject(policy.errors) instead.

Justice Arthur added 2 commits October 25, 2022 14:26

add errors to workspace creation

5edd8c5

reformat policy mapping

f07b9fc

Justicea83 self-assigned this Oct 25, 2022

Justicea83 changed the title ~~Show errors after workspace creation failure~~ [Hold Offline Testing]Show errors after workspace creation failure Oct 25, 2022

Justicea83 changed the title ~~[Hold Offline Testing]Show errors after workspace creation failure~~ [Hold Offline Testing & Web-E#35285]Show errors after workspace creation failure Oct 25, 2022

Justicea83 changed the title ~~[Hold Offline Testing & Web-E#35285]Show errors after workspace creation failure~~ [Hold Offline & Mobile Testing & Web-E#35285]Show errors after workspace creation failure Oct 26, 2022

Justicea83 changed the title ~~[Hold Offline & Mobile Testing & Web-E#35285]Show errors after workspace creation failure~~ [Hold Web-E#35285]Show errors after workspace creation failure Oct 27, 2022

Justicea83 marked this pull request as ready for review October 27, 2022 08:38

Justicea83 requested a review from a team as a code owner October 27, 2022 08:38

Justicea83 requested review from a team and removed request for a team October 27, 2022 09:38

melvin-bot bot requested review from parasharrajat and tgolen and removed request for a team October 27, 2022 09:38

tgolen previously approved these changes Oct 27, 2022

View reviewed changes

address issues with error on creation

8c7395a

Justicea83 dismissed tgolen’s stale review via 8c7395a October 27, 2022 16:47

Justicea83 requested a review from tgolen October 27, 2022 16:50

tgolen requested changes Oct 27, 2022

View reviewed changes

src/pages/workspace/WorkspaceInitialPage.js Outdated Show resolved Hide resolved

src/pages/workspace/WorkspaceInitialPage.js Outdated Show resolved Hide resolved

Justice Arthur added 3 commits October 28, 2022 11:36

apply suggestions

6d01d82

fix merge conflicts

d609cf4

include RBR on workspace list

eac41f2

include RBR

09fdaef

Justicea83 requested a review from tgolen October 28, 2022 11:32

remove RBR on workspace list item on workspace lists page

38b34a4

Justice Arthur added 2 commits October 28, 2022 16:03

remove unused default prop

6be3ef2

add RBR

d0408fb

tgolen approved these changes Oct 28, 2022

View reviewed changes

Justicea83 changed the title ~~[Hold Web-E#35285]Show errors after workspace creation failure~~ Show errors after workspace creation failure Nov 1, 2022

Justicea83 merged commit 5ebbde0 into main Nov 1, 2022

Justicea83 deleted the justice-refactor-create-workspace branch November 1, 2022 18:50

OSBotify mentioned this pull request Nov 2, 2022

Deploy Checklist: New Expensify 2022-11-02 #12397

Closed

44 tasks

roryabraham mentioned this pull request Nov 3, 2022

Workspace - User does not see the "error message" when deleting a workspace #12452

Closed

roryabraham reviewed Nov 4, 2022

View reviewed changes

roryabraham mentioned this pull request Nov 4, 2022

Add errors object back to menu item, remove unused isPolicy #12460

Merged

92 tasks

aldo-expensify mentioned this pull request Nov 16, 2022

Fix redbrick path for workspace #12329

Merged

92 tasks

ikevin127 reviewed May 20, 2024

View reviewed changes

ikevin127 mentioned this pull request May 20, 2024

[HOLD for payment 2024-05-22] [$250] Categories - Unable to go to other tabs after enabling " must categorize all spend" offline #41325

Closed

6 tasks

	optimisticData: [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
	value: {
	requiresCategory,
	errors: {
	requiresCategory: null,
	},
	pendingFields: {
	requiresCategory: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,
	},
	},
	},
	],
	successData: [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
	value: {
	errors: {
	requiresCategory: null,
	},
	pendingFields: {
	requiresCategory: null,
	},
	},
	},
	],

Conversation

Justicea83 commented Oct 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

QA Steps

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Uh oh!

Justicea83 commented Oct 26, 2022

Uh oh!

Justicea83 commented Oct 27, 2022

Uh oh!

tgolen commented Oct 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

tgolen commented Oct 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue One

Issue Two

Uh oh!

parasharrajat commented Oct 27, 2022

Uh oh!

tgolen commented Oct 27, 2022

Uh oh!

Justicea83 commented Oct 27, 2022

Uh oh!

parasharrajat commented Oct 27, 2022

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Justicea83 commented Oct 28, 2022

Uh oh!

Justicea83 commented Oct 28, 2022

Uh oh!

tgolen commented Oct 28, 2022

Screenshots/Videos

Uh oh!

Justicea83 commented Oct 28, 2022

Uh oh!

OSBotify commented Nov 1, 2022

Uh oh!

OSBotify commented Nov 2, 2022

Uh oh!

kavimuru commented Nov 3, 2022

Uh oh!

roryabraham Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

roryabraham Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

Justicea83 Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

Justicea83 Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

roryabraham Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 4, 2022

Uh oh!

ikevin127 May 20, 2024

Choose a reason for hiding this comment

Uh oh!

Justicea83 commented Oct 25, 2022 •

edited

Loading

tgolen commented Oct 27, 2022 •

edited

Loading

tgolen commented Oct 27, 2022 •

edited

Loading