Add `failureData` to `AddWorkspaceRoom` API command #20734

francoisl · 2023-06-14T01:49:42Z

Details

At the moment, the call to AddWorkspaceRoom doesn't use any failureData, so in the rare occurrence that the backend fails but doesn't include any onyxData in its response, we still optimistically create a workspace and don't show any indication of an error.
This PR adds a default failureData so that if the backend doesn't respond with a 200 jsonCode, we'll still show an error in the room.

Fixed Issues

$ #20502

Tests

On web (Chrome)

Click on + floating action button > New Room
Enter the details, make sure you can create a room
Simulate a backend error that does contain a valid onyxData, by applying the following diff in this block of HttpUtils:

diff --git a/src/libs/HttpUtils.js b/src/libs/HttpUtils.js
index e76517e205..5608c09914 100644
--- a/src/libs/HttpUtils.js
+++ b/src/libs/HttpUtils.js
@@ -87,6 +87,48 @@ function processHTTPRequest(url, method = 'get', body = null, canCancel = true,
             return response.json();
         })
         .then((response) => {
+            if (command === 'AddWorkspaceRoom') {
+                response = {
+                    'code': 666,
+                    'jsonCode': 666,
+                    'type': 'Expensify\\Libs\\Error\\ExpError',
+                    'UUID': '8049BF3C-1161-464F-B749-92172909DF5D',
+                    'message': 'Invalid reportName',
+                    'title': '',
+                    'data': {
+                        'reportName': '#test',
+                        'onyxData': [
+                            {
+                                'onyxMethod': 'merge',
+                                'key': `report_${response.onyxData[0].value.reportID}`,
+                                'value': {
+                                    'errorFields': {
+                                        'addWorkspaceRoom': {
+                                            '1111111111111111': 'Invalid reportName',
+                                        },
+                                    },
+                                },
+                            },
+                        ],
+                    },
+                    'htmlMessage': '',
+                    'onyxData': [
+                        {
+                            'onyxMethod': 'merge',
+                            'key': `report_${response.onyxData[0].value.reportID}`,
+                            'value': {
+                                'errorFields': {
+                                    'addWorkspaceRoom': {
+                                        '1111111111111111': 'Invalid reportName',
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                    'requestID': 'abcdef',
+                };
+            }
+
             // Some retried requests will result in a "Unique Constraints Violation" error from the server, which just means the record already exists
             if (response.jsonCode === CONST.JSON_CODE.BAD_REQUEST && response.message === CONST.ERROR_TITLE.DUPLICATE_RECORD) {
                 throw new HttpsError({

Create a new room again
Make sure you see an error message, and the name of the workspace is grayed out in the LHN:
Now, simulate a backend error that does not contain a valid onyxData, by applying the following diff in this block of HttpUtils (remove the previous change):

diff --git a/src/libs/HttpUtils.js b/src/libs/HttpUtils.js
index e76517e205..3bda24bd77 100644
--- a/src/libs/HttpUtils.js
+++ b/src/libs/HttpUtils.js
@@ -87,6 +87,15 @@ function processHTTPRequest(url, method = 'get', body = null, canCancel = true,
             return response.json();
         })
         .then((response) => {
+            if (command === 'AddWorkspaceRoom') {
+                response = {
+                    'jsonCode': 500,
+                    'message': '500 Refused',
+                    'onyxData': [],
+                    'requestID': 'abcdef',
+                };
+            }
+
             // Some retried requests will result in a "Unique Constraints Violation" error from the server, which just means the record already exists
             if (response.jsonCode === CONST.JSON_CODE.BAD_REQUEST && response.message === CONST.ERROR_TITLE.DUPLICATE_RECORD) {
                 throw new HttpsError({

Create a new room again
Make sure you see an error message, and the name of the workspace is grayed out in the LHN:

** On other platforms**

Make sure you can create a new room from the FAB

Verify that no errors appear in the JS console

Offline tests

While offline, ensure that you can create a new workspace room. After getting back online, make sure you don't see any errors.

QA Steps

We can't really test the case where the backend returns an error without any onyxData, because that would require at lest partially taking down the entire site, so we'll ensure that creating a room still works in normal conditions instead.

Sign in to any account that has at least one workspace
Click on the green + Floating Action Button > New Room
Choose a valid name, workspace and visibility
Create the room
Make sure you don't see any errors

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Regular flow - when creating the room is successful

Screen.Recording.2023-06-13.at.6.55.40.PM.mov

With a hardcoded error response:

Screen.Recording.2023-06-13.at.6.55.03.PM.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

This is in case the backend encounters an error, but returns an empty `onyxData` for whatever reason (e.g. semi-outage)

melvin-bot · 2023-06-14T02:10:30Z

@eVoloshchak @danieldoglas One of you needs to 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]

eVoloshchak · 2023-06-14T19:15:43Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

Screen.Recording.2023-06-14.at.22.31.05.mov

Mobile Web - Chrome

screen-20230614-224805.mp4

Mobile Web - Safari

Screen.Recording.2023-06-14.at.22.38.29.mov

Desktop

Screen.Recording.2023-06-14.at.22.44.01.mov

iOS

Screen.Recording.2023-06-14.at.22.41.42.mov

Android

screen-20230614-225010.mp4

eVoloshchak

Looks good and tests well
cc: @danieldoglas

danieldoglas

LGTM

OSBotify · 2023-06-15T10:17:25Z

✋ 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 · 2023-06-16T18:51:31Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.29-0 🚀

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

OSBotify · 2023-06-21T02:19:02Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.29-11 🚀

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

Add failureData to AddWorkspaceRoom API command

53acdc3

This is in case the backend encounters an error, but returns an empty `onyxData` for whatever reason (e.g. semi-outage)

francoisl self-assigned this Jun 14, 2023

Run prettier

1d83267

francoisl marked this pull request as ready for review June 14, 2023 02:09

francoisl requested a review from a team as a code owner June 14, 2023 02:09

melvin-bot bot requested review from danieldoglas and eVoloshchak and removed request for a team June 14, 2023 02:10

eVoloshchak approved these changes Jun 14, 2023

View reviewed changes

danieldoglas approved these changes Jun 15, 2023

View reviewed changes

danieldoglas merged commit 205899f into main Jun 15, 2023

danieldoglas deleted the francois-failureDataAddWorkspace branch June 15, 2023 10:13

OSBotify mentioned this pull request Jun 16, 2023

Deploy Checklist: New Expensify 2023-06-16 #20928

Closed

melvin-bot bot mentioned this pull request Jun 21, 2023

[HOLD for payment 2023-06-28] Workspace rooms no longer exist #20502

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `failureData` to `AddWorkspaceRoom` API command #20734

Add `failureData` to `AddWorkspaceRoom` API command #20734

francoisl commented Jun 14, 2023 •

edited

Loading

melvin-bot bot commented Jun 14, 2023

eVoloshchak commented Jun 14, 2023 •

edited

Loading

eVoloshchak left a comment

danieldoglas left a comment

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

OSBotify commented Jun 21, 2023

Add failureData to AddWorkspaceRoom API command #20734

Add failureData to AddWorkspaceRoom API command #20734

Conversation

francoisl commented Jun 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 14, 2023

eVoloshchak commented Jun 14, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak left a comment

Choose a reason for hiding this comment

danieldoglas left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

OSBotify commented Jun 21, 2023

Add `failureData` to `AddWorkspaceRoom` API command #20734

Add `failureData` to `AddWorkspaceRoom` API command #20734

francoisl commented Jun 14, 2023 •

edited

Loading

eVoloshchak commented Jun 14, 2023 •

edited

Loading