[Internal QA] Update error pattern for delete workspace by dominictb · Pull Request #64015 · Expensify/App

dominictb · 2025-06-11T20:48:55Z

Explanation of Change

Errors relating to workspace deletion are displayed in modal
Workspace deletion now follows offline pattern C => It's blocked while offline and we'll show a modal saying you can't take this action in offline

Fixed Issues

$ #63113
PROPOSAL:

Tests

Pre-requisites:

User owns a workspace with three purchases and an annual subscription that has not expired.

Online:

Go to workspace lists page
Click the Delete workspace button in kebab menu
The confirmation alert modal appears
Click Delete to confirm
The Delete button in the modal shows a loading spinner waiting on a response from the API to confirm
[Failure] We show the modal explaining the reason they can’t delete the workspace
[Success] The workspace is deleted and disappears from the list

Go to workspace overview page
Repeat steps 2 - 5
[Failure] We show the modal explaining the reason they can’t delete the workspace
[Success] Go back to workspaces list page and the workspace is deleted and disappears from the list

Tests from Expensify Card - No error message when deleting workspace with Expensify card #71966

Verify that no errors appear in the JS console

Offline tests

Go offline
Try to delete workspace from workspaces list page or workspace overview page
The “you appear to be offline” modal appears (same one used when selecting to export to CSV)

QA Steps

Retest Expensify Card - No error message when deleting workspace with Expensify card #71966
[Failure] We show the modal explaining the reason they can’t delete the workspace
[Success] The workspace is deleted and disappears from the list

Retest Expensify Card - No error message when deleting workspace with Expensify card #71966 but trigger delete from workspace overview page
[Failure] We show the modal explaining the reason they can’t delete the workspace
[Success] Go back to workspaces list page and the workspace is deleted and disappears from the list

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

Screen.Recording.2025-06-12.at.04.14.45.mov

iOS: Native

iOS: mWeb Safari

Screen.Recording.2025-06-12.at.04.11.40.mov

Screen.Recording.2025-06-12.at.04.12.05.mov

MacOS: Chrome / Safari

Online case

Screen.Recording.2025-06-12.at.04.09.31.mov

Offline case

Screen.Recording.2025-06-12.at.04.09.54.mov

MacOS: Desktop

…ription

melvin-bot · 2025-06-11T21:13:18Z

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

shubham1206agra · 2025-06-12T03:42:04Z

+    }
+
+    // eslint-disable-next-line rulesdir/no-api-side-effects-method, rulesdir/no-multiple-api-calls
+    API.makeRequestWithSideEffects(SIDE_EFFECT_REQUEST_COMMANDS.DELETE_WORKSPACE, params, {optimisticData, finallyData, failureData}).then((response) => {


@blimpich I don't think this is a good pattern at all.

@shubham1206agra Please elaborate why you think it isn't a good pattern when giving PR feedback. I'm going to assume you think it is bad because we're no suppose to use makeRequestWithSideEffects, and I'd agree. As it says in the documentation for the method, it should only be used "when all other alternatives have been exhausted."

Not sure why you are pinging me on this, did you think that I wanted us to use makeRequestWithSideEffects?

I am really sorry. I think my edit is not published to GH.

Let me write this again.

The reason why I am saying this is that we don't have another way to do this yet. So I want to make a proposal here. Introduce a property in policy object named errorKey, which will return error translation key. It will help us getting localized errors.

@dominictb Can you please use write method? Somehow detect if the user is on the same page when deleting workspace and show the error in pop-up if that's the case, otherwise show the error in red dot indicator.

Ah yes that makes more sense now, thank you for clarifying! Yes I can update the backend to make it return an error key on the policy object 👍 🙂

Issue for this: #64098, will have a PR up today and hopefully will be deployed by tomorrow

@shubham1206agra I still didn't get why we need the errorKey here, like what would it solve in this scenario? Also can you elaborate your approach when using API.write?

I know a way to handle the BE error, but in the HTTP layer, but I think this is even worse than makeRequestWithSideEffects:

App/src/libs/HttpUtils.ts

Lines 146 to 149 in 5420e2a

if (response.jsonCode === CONST.JSON_CODE.UPDATE_REQUIRED) {

// Trigger a modal and disable the app as the user needs to upgrade to the latest minimum version to continue

alertUser();

}

@dominictb Show modal only if the user is on the workspace list page. Otherwise, the red dot indicator with a message is fine.

shubham1206agra · 2025-06-13T08:40:15Z

@dominictb Can you mark this PR as draft?

…eat/63113

dominictb · 2025-06-26T14:54:46Z

Will test once Ben is online.

shubham1206agra · 2025-06-30T10:24:35Z

@dominictb Bump here

dominictb · 2025-06-30T12:24:51Z

Sorry I missed this one last weekend. Will check back when Ben is online (maybe in 4 - 5 hours).

…eat/63113

dominictb · 2025-07-03T00:23:57Z

To detect if the deletion took place within the same WorkspacesListPage to display the error modal is complicated because of these scenarios:

It can be rendered underneath other pages and user can switch back to it any time
Delete in workspace overview page and navigate back to workspace list page
Delete in offline

I haven't got a solution for all of them yet.

I think for cases where we rely on BE response like this, requests with side effects are fine.

shubham1206agra · 2025-07-03T09:08:12Z

@dominictb Just add the modal in Expensify.tsx. And clear the error on close. This is the easiest way to access the modal at all places.

…eat/63113

dominictb · 2025-07-08T00:46:21Z

Summary:

Only show the modal if the policy was previously deleted online
Only show the modal in workspaces list page
Clear the error before the modal shows (so it wouldn't show as RBR beneath the modal)

@blimpich Can we ever have multiple workspaces with this same error? Currently I assume we can only have 1 such workspace. Because when I tried to create a new workspace, it said:

blimpich · 2025-07-08T19:58:12Z

Only show the modal if the policy was previously deleted online

~~What? I don't follow this, we only show the modal if the policy was deleted? Can you please elaborate on this, it doesn't make sense to me.~~ Oh you mean don't show the modal if the user is offline?

Only show the modal in workspaces list page

No it should also show also show the modal from the workspace overview page. The following screen recording shows the current behavior:

Screen.Recording.2025-07-08.at.11.41.22.AM.mov

This should be updated so that it shows the modal on the workspace overview page if the user triggers this error from that screen.

Clear the error before the modal shows (so it wouldn't show as RBR beneath the modal)

If that's the best way to do it then that's fine with me. I feel like a better way would be to just stop displaying the error where we are currently displaying it and only display policies errors as a modal. Closing out the modal would clear the onyx error in that situation. But not sure of the implementation details and what would work best here.

Can we ever have multiple workspaces with this same error? Currently I assume we can only have 1 such workspace. Because when I tried to create a new workspace, it said:

No I think you can only get this error with one remaining workspace/policy. But not 100% certain on that. That error that you're getting is a different, separate bug that I'll handle 👍

dominictb · 2025-07-08T21:35:35Z

This should be updated so that it shows the modal on the workspace overview page if the user triggers this error from that screen.

Currently after deleting the workspace, we navigate back to the workspaces list page. It's already the right behavior before this PR. I don't think we should reopen the workspace overview page just to display the modal when the delete was not successful.

Oh you mean don't show the modal if the user is offline?

Yes. We only show RBR in that case.

I feel like a better way would be to just stop displaying the error where we are currently displaying it and only display policies errors as a modal.

That would be quite intriguing to bring this logic to other places like the workspace icon in left-hand sidebar and the workspace item row. I think clearing the error before the modal is best for now if it does not cause any specific problem.

No I think you can only get this error with one remaining workspace/policy.

Got it, thanks!

codecov · 2025-09-30T18:00:00Z

Codecov Report

❌ Patch coverage is 0% with 58 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/pages/workspace/WorkspacesListPage.tsx	0.00%	28 Missing ⚠️
src/pages/workspace/WorkspaceOverviewPage.tsx	0.00%	24 Missing ⚠️
src/libs/actions/Policy/Policy.ts	0.00%	3 Missing ⚠️
src/pages/workspace/WorkspaceInitialPage.tsx	0.00%	3 Missing ⚠️

Files with missing lines	Coverage Δ
src/libs/actions/Policy/Policy.ts	`31.61% <0.00%> (+0.28%)`	⬆️
src/pages/workspace/WorkspaceInitialPage.tsx	`0.00% <0.00%> (ø)`
src/pages/workspace/WorkspaceOverviewPage.tsx	`0.00% <0.00%> (ø)`
src/pages/workspace/WorkspacesListPage.tsx	`0.48% <0.00%> (-0.07%)`	⬇️

... and 94 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…eat/63113

dominictb · 2025-10-13T18:47:23Z

Latest behavior:

Online:

Click the Delete workspace button in the menu
The confirmation alert modal appears
Click Delete to confirm
The Delete button in the modal shows a loading spinner waiting on a response from the API to confirm
[Failure] We show the modal explaining the reason they can’t delete the workspace
[Success] The workspace is deleted and disappears from the list.

Offline:

Click the Delete workspace button
The “you appear to be offline” modal appears (same one used when selecting to export to CSV)

Screen.Recording.2025-10-14.at.01.44.48-compressed.mov

Screen.Recording.2025-10-14.at.01.43.54-compressed.mov

Screen.Recording.2025-10-14.at.01.43.26-compressed.mov

blimpich · 2025-10-13T18:58:07Z

@dominictb behavior looks perfect 👍

shubham1206agra · 2025-10-15T15:25:35Z

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- 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 there are no new alerts related to the canBeMissing param for useOnyx
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 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.ts 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
xIf 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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: HybridApp

Android: mWeb Chrome

Screen.Recording.2025-10-15.at.7.36.17.PM.mov

iOS: HybridApp

Screen.Recording.2025-10-15.at.8.48.17.PM.mov

iOS: mWeb Safari

Screen.Recording.2025-10-15.at.7.28.53.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-10-15.at.7.26.50.PM.mov

MacOS: Desktop

Screen.Recording.2025-10-15.at.8.41.04.PM.mov

OSBotify · 2025-10-15T19:53:58Z

✋ 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 · 2025-10-15T23:13:50Z

🚀 Deployed to staging by https://github.com/blimpich in version: 9.2.32-0 🚀

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

MonilBhavsar · 2025-10-16T10:46:26Z

This PR might have caused #72759
@dominictb @shubham1206agra

OSBotify · 2025-10-16T23:20:17Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.2.32-6 🚀

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

dominictb added 2 commits June 12, 2025 03:44

feat: update error pattern for delete workspace while on annual subsc…

562ac60

…ription

implement offline case

55d9c47

dominictb marked this pull request as ready for review June 11, 2025 21:13

dominictb requested a review from a team as a code owner June 11, 2025 21:13

melvin-bot Bot requested a review from shubham1206agra June 11, 2025 21:13

melvin-bot Bot removed the request for review from a team June 11, 2025 21:13

shubham1206agra reviewed Jun 12, 2025

View reviewed changes

blimpich mentioned this pull request Jun 12, 2025

Update DeletePolicy errors to add error to onyx #64098

Closed

dominictb marked this pull request as draft June 13, 2025 08:49

dominictb changed the title ~~[Internal QA] Update error pattern for delete workspace while on annual subscription~~ [HOLD BE] [Internal QA] Update error pattern for delete workspace while on annual subscription Jun 13, 2025

dominictb changed the title ~~[HOLD BE] [Internal QA] Update error pattern for delete workspace while on annual subscription~~ [Internal QA] Update error pattern for delete workspace while on annual subscription Jun 24, 2025

dominictb added 3 commits June 26, 2025 04:05

Merge branch 'main' of github.com-dominictb:dominictb/epsf-app into f…

754de31

…eat/63113

implement API.write approach

752569a

update languages

3ac7286

dominictb added 2 commits July 1, 2025 00:24

Merge branch 'main' of github.com-dominictb:dominictb/epsf-app into f…

9c7165c

…eat/63113

Merge branch 'main' of github.com-dominictb:dominictb/epsf-app into f…

1c5ace8

…eat/63113

dominictb added 2 commits July 8, 2025 06:28

Merge branch 'main' of github.com-dominictb:dominictb/epsf-app into f…

84aa544

…eat/63113

handle delete in offline

ad1534b

dominictb marked this pull request as ready for review July 8, 2025 00:43

blimpich assigned dominictb Jul 8, 2025

fix bugs

ad0f933

dominictb requested a review from shubham1206agra September 30, 2025 11:50

dominictb added 3 commits October 3, 2025 16:53

Merge branch 'main' of github.com-dominictb:dominictb/epsf-app into f…

0f76d1e

…eat/63113

Merge branch 'main' of github.com-dominictb:dominictb/epsf-app into f…

db90a9d

…eat/63113

Merge branch 'main' of github.com-dominictb:dominictb/epsf-app into f…

5f70575

…eat/63113

luacmartins mentioned this pull request Oct 13, 2025

[Due for payment NOW] Errors incorrectly display in LHN #70987

Closed

Merge branch 'main' of github.com-dominictb:dominictb/epsf-app into f…

1978ae8

…eat/63113

Pujan92 mentioned this pull request Oct 13, 2025

Expensify Card - No error message when deleting workspace with Expensify card #71966

Closed

8 tasks

dominictb added 2 commits October 14, 2025 01:34

feat: show delete workspace errors in modal

92ecf21

feat: handle offline case

cd4ffe6

remove redundant changes

66ec4d9

dominictb changed the title ~~[Internal QA] Update error pattern for delete workspace while on annual subscription~~ [Internal QA] Update error pattern for delete workspace Oct 13, 2025

shubham1206agra approved these changes Oct 15, 2025

View reviewed changes

melvin-bot Bot requested a review from blimpich October 15, 2025 15:26

blimpich approved these changes Oct 15, 2025

View reviewed changes

blimpich merged commit b285277 into Expensify:main Oct 15, 2025
25 checks passed

OSBotify mentioned this pull request Oct 15, 2025

Deploy Checklist: New Expensify 2025-10-15 #72723

Closed

52 tasks

mitarachim mentioned this pull request Oct 16, 2025

[Due for payment 2025-10-27] [Due for payment 2025-10-23] Android - Workspace - Delete modal loads infinitely when deleting workspace offline #72759

Closed

8 tasks

melvin-bot Bot mentioned this pull request Oct 16, 2025

[Due for payment 2025-10-27] [Due for payment 2025-10-23] [$250] Update the error pattern for attempting to delete the last workspace when not allowed because of an annual subscription #63113

Closed

16 tasks

gijoe0295 mentioned this pull request Oct 22, 2025

[Due for payment 2025-12-04] [$250] Android - Workspace - "It´s not here" briefly seen after deleting workspace from "Overview" #73137

Closed

16 tasks

ishpaul777 mentioned this pull request Oct 22, 2025

[$250] Delete WS modal & overview pg briefly appears after clicking "keep only one card feed" #71943

Closed

8 tasks

blimpich mentioned this pull request Oct 24, 2025

[Due for payment 2025-11-06] [$250] Upgrade the delete workspace flow to a non-blocking UI pattern #73440

Closed

	if (response.jsonCode === CONST.JSON_CODE.UPDATE_REQUIRED) {
	// Trigger a modal and disable the app as the user needs to upgrade to the latest minimum version to continue
	alertUser();
	}

Conversation

dominictb commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Online case

Offline case

Uh oh!

melvin-bot Bot commented Jun 11, 2025

Uh oh!

shubham1206agra Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

blimpich Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

shubham1206agra Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

shubham1206agra Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

blimpich Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

blimpich Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

dominictb Jun 25, 2025 • 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!

shubham1206agra Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

shubham1206agra commented Jun 13, 2025

Uh oh!

dominictb commented Jun 26, 2025

Uh oh!

shubham1206agra commented Jun 30, 2025

Uh oh!

dominictb commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dominictb commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shubham1206agra commented Jul 3, 2025

Uh oh!

dominictb commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blimpich commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dominictb commented Jul 8, 2025

Uh oh!

codecov Bot commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dominictb commented Oct 13, 2025

Uh oh!

blimpich commented Oct 13, 2025

Uh oh!

shubham1206agra commented Oct 15, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

OSBotify commented Oct 15, 2025

Uh oh!

OSBotify commented Oct 15, 2025

Uh oh!

MonilBhavsar commented Oct 16, 2025

dominictb commented Jun 11, 2025 •

edited

Loading

dominictb Jun 25, 2025 •

edited

Loading

dominictb commented Jun 30, 2025 •

edited

Loading

dominictb commented Jul 3, 2025 •

edited

Loading

dominictb commented Jul 8, 2025 •

edited

Loading

blimpich commented Jul 8, 2025 •

edited

Loading

codecov Bot commented Sep 30, 2025 •

edited

Loading