clear policy errors #44130

Nodebrute · 2024-06-21T00:48:39Z

Details

Fixed Issues

$ #42765
PROPOSAL: #42765 (comment)

Tests

Create a group chat
Rename the group to something invalid for example "adoadoadoajdoajdoadoajdoajadoadoadoajdoajdoadoajdoajadoadoadoajdoajdoadoajdoajadoadoadoajdoajdoadoaỏ"
Follow the RBR and remove the error message
Confirm RBR on LHN gets removed from LHN as well

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Create a group chat
Rename the group to something invalid for example "adoadoadoajdoajdoadoajdoajadoadoadoajdoajdoadoajdoajadoadoadoajdoajdoadoajdoajadoadoadoajdoajdoadoaỏ"
Follow the RBR and remove the error message
Confirm RBR on LHN gets removed from LHN as well

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-06-21.at.6.22.33.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-06-21.at.6.34.47.AM.mov

iOS: Native

Screen.Recording.2024-06-21.at.6.50.05.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-06-21.at.6.55.32.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-21.at.5.43.14.AM.mov

MacOS: Desktop

Screen.Recording.2024-06-25.at.7.06.02.PM.mov

melvin-bot · 2024-06-21T00:48:44Z

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

rojiphil · 2024-06-24T05:33:45Z

src/libs/actions/Report.ts

@@ -2237,6 +2237,9 @@ function clearPolicyRoomNameErrors(reportID: string) {
        pendingFields: {
            reportName: null,
        },
+        errors: {


@Nodebrute Thanks for the PR. While the current changes will solve this specific problem, I notice that this will lead into another issue as demonstrated in the video below. Here reload of the report using openReport with cause the errorFields to be reset thereby leaving the LHN with GBR which is not correct. I think instead of removing the errors here, we should not add errors here. Would this work?

44130-issue-01.mp4

@rojiphil I'll finish this today.

@rojiphil The PR is ready for review. However, I would suggest that we add errorFields to the failure data.

However, I would suggest that we add errorFields to the failure data.

@Nodebrute What problem would it cause if we do not add errorFields to the failure data?

None. Sorry for the previous comment. We can proceed without adding errorFields.

@danieldoglas bump

Sorry:

errorFields is an object, that may contain several types of errors

For some reason, when we send it with notFound, it is deleting the reportName error

Do you know why that's happening? Are we returning a method SET instead of MERGE when returning the policy?

errorFields is an object, that may contain several types of errors

For some reason, when we send it with notFound, it is deleting the reportName error

Do you know why that's happening? Are we returning a method SET instead of MERGE when returning the policy?

Ah! I get your point. @Nodebrute Can you please investigate this?

I will update today.

@rojiphil I am unable to reproduce this error with openReport; it seems like the issue has been resolved.

Screen.Recording.2024-07-16.at.2.28.31.AM.mov

mountiny · 2024-07-19T21:56:06Z

@rojiphil what is your ETA for the checklist?

rojiphil

I am unable to reproduce this error with openReport; it seems like the issue has been resolved.

@Nodebrute I can still reproduce this error with openReport. And I still think we need to investigate this.
Otherwise, we will get this behavior where the GBR will be shown for some time and disappear due to openReport call i.e. when the user navigates away and then navigates back to the same report .
Here is a test video demonstrating this:

44130-group-name-error.mp4

rojiphil · 2024-07-20T17:52:22Z

src/libs/actions/Report.ts

@@ -654,9 +653,6 @@ function updateGroupChatName(reportID: string, reportName: string) {
            key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
            value: {
                reportName: ReportConnection.getAllReports()?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]?.reportName ?? null,
-                errors: {


I am not sure how our problem gets solved by not setting errors here. The problem mentioned here still exists. When openReport is called, errorFields comes back as follows with null (as shown below) and, strangely, FE resets the errorFields in report in Onyx. Don’t we need to get to the bottom of this?

Investigating

@rojiphil Hey, I'm still unable to reproduce the issue you're mentioning with RBR. You can check the video below. Even after the openReport calls, the RBR isn't disappearing. I've also tried reloading the page, but the RBR remains until we manually remove it by pressing the cross. Please let me know if I am missing any step

Screen.Recording.2024-07-22.at.1.54.12.PM.1.1.1.mov

I am not sure how our problem gets solved by not setting errors here. The problem mentioned here still exists. When openReport is called, errorFields comes back as follows with null (as shown below) and, strangely, FE resets the errorFields in report in Onyx. Don’t we need to get to the bottom of this?

We don't need to set errors here. The backend returns errorFields in case of failure, which is sufficient to display errors here. We don't even set errors when updating the room name. I don't think we need to include errors in the failure data when updating the group name. Removing errors seems to address the main issue of removing RBR after pressing the cross. Let me know your thoughts.

App/src/libs/actions/Report.ts

Lines 2293 to 2305 in eec4d6a

const failureData: OnyxUpdate[] = [

{

onyxMethod: Onyx.METHOD.MERGE,

key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,

value: {

reportName: previousName,

},

},

{

onyxMethod: Onyx.METHOD.MERGE,

key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`,

value: {[optimisticRenamedAction.reportActionID]: null},

},

@rojiphil Additionally, the backend is returning the merge method, so it is not affecting the existing errorFields in the Onyx.

Screen.Recording.2024-07-22.at.2.41.36.PM.mov

We don't need to set errors here. The backend returns errorFields in case of failure, which is sufficient to display errors here.

This is a good cleanup. Earlier as mentioned here settings also had a provision to update room name. But, now, since editing the room name is no longer present within settings page, we can avoid setting GBR for settings menu.

rojiphil · 2024-07-22T10:12:43Z

I can still reproduce this error with openReport. And I still think we need to investigate this.
Otherwise, we will get this behavior where the GBR will be shown for some time and disappear due to openReport call i.e. when the user navigates away and then navigates back to the same report .

@Nodebrute Ok. Let me check this again then with the latest.

rojiphil · 2024-07-22T16:47:56Z

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

MacOS: Chrome / Safari

44130-web-safari-001.mp4

MacOS: Desktop

44130-desktop-001.mp4

iOS: mWeb Safari

44130-mweb-safari-001.mp4

Android: Native

44130-android-native-001.mp4

Android: mWeb Chrome

44130-mweb-chrome-001.mp4

iOS: Native

44130-ios-native-001.mp4

rojiphil · 2024-07-22T16:48:33Z

I can still reproduce this error with openReport. And I still think we need to investigate this.
Otherwise, we will get this behavior where the GBR will be shown for some time and disappear due to openReport call i.e. when the user navigates away and then navigates back to the same report .

@Nodebrute Ok. Let me check this again then with the latest.

We can ignore this as I also cannot reproduce this behaviour now.

rojiphil

@Nodebrute Thanks for the changes.

@mountiny Since we are not setting errors, can we rule out BE returning errors for any missed condition of updateGroupChatName API request? It seems like we moved to errorFields sometime in past. And if at all BE return errors, then, we have to clear errors too here.
Otherwise code LGTM and works well too.

rojiphil · 2024-07-22T16:45:35Z

src/libs/actions/Report.ts

@@ -654,9 +653,6 @@ function updateGroupChatName(reportID: string, reportName: string) {
            key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
            value: {
                reportName: ReportConnection.getAllReports()?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]?.reportName ?? null,
-                errors: {


We don't need to set errors here. The backend returns errorFields in case of failure, which is sufficient to display errors here.

This is a good cleanup. Earlier as mentioned here settings also had a provision to update room name. But, now, since editing the room name is no longer present within settings page, we can avoid setting GBR for settings menu.

rojiphil · 2024-07-22T17:06:09Z

@Nodebrute Regarding test steps, let us use numbers instead of bullet points. Also, we can remove the steps to go offline and come back again online as this issue can be reproduced even otherwise.

Nodebrute · 2024-07-22T17:33:26Z

Thank you @rojiphil, I have updated the steps.

mountiny

It should only ever return the errorFields when error occurs

OSBotify · 2024-07-22T20:41:29Z

✋ 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 · 2024-07-23T08:35:29Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.11-0 🚀

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

OSBotify · 2024-07-24T00:15:47Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 9.0.11-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-25T03:13:45Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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

OSBotify · 2024-07-26T05:12:52Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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

clear policy errors

f2efad0

Nodebrute requested a review from a team as a code owner June 21, 2024 00:48

melvin-bot bot removed the request for review from a team June 21, 2024 00:48

melvin-bot bot requested a review from rojiphil June 21, 2024 00:48

rojiphil reviewed Jun 24, 2024

View reviewed changes

Nodebrute and others added 4 commits June 25, 2024 18:47

Merge branch 'Expensify:main' into policyErrors

143dd13

remove errors

196f16f

fix lint

4a02aee

Merge branch 'Expensify:main' into policyErrors

e875e3f

mountiny self-requested a review July 12, 2024 15:49

Nodebrute and others added 4 commits July 16, 2024 02:04

Merge branch 'main' into policyErrors

a0202fe

fix reportName error

72518c1

remove rbr from settings

e340e43

fix lint errors

0befef8

Nodebrute requested a review from rojiphil July 15, 2024 21:52

rojiphil reviewed Jul 20, 2024

View reviewed changes

Nodebrute and others added 3 commits July 22, 2024 12:34

Merge branch 'Expensify:main' into policyErrors

2ff95e0

Merge branch 'Expensify:main' into policyErrors

671f6cd

import localize

f049a8b

rojiphil approved these changes Jul 22, 2024

View reviewed changes

mountiny assigned Nodebrute Jul 22, 2024

mountiny approved these changes Jul 22, 2024

View reviewed changes

mountiny merged commit 69214a6 into Expensify:main Jul 22, 2024
17 checks passed

github-actions bot mentioned this pull request Jul 23, 2024

Deploy Checklist: New Expensify 2024-07-23 #45991

Closed

95 tasks

melvin-bot bot mentioned this pull request Jul 25, 2024

[$250] [HOLD for payment 2024-08-01] Group name - RBR doesn't disappear from LHN after removing error message #42765

Closed

6 tasks

Nodebrute deleted the policyErrors branch October 4, 2024 18:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

clear policy errors #44130

clear policy errors #44130

Nodebrute commented Jun 21, 2024 •

edited

Loading

melvin-bot bot commented Jun 21, 2024

rojiphil Jun 24, 2024

Nodebrute Jun 25, 2024

Nodebrute Jun 25, 2024

rojiphil Jun 25, 2024

Nodebrute Jun 25, 2024

Nodebrute Jul 11, 2024

danieldoglas Jul 12, 2024

rojiphil Jul 12, 2024

Nodebrute Jul 15, 2024

Nodebrute Jul 15, 2024

mountiny commented Jul 19, 2024

rojiphil left a comment

rojiphil Jul 20, 2024

Nodebrute Jul 22, 2024

Nodebrute Jul 22, 2024

Nodebrute Jul 22, 2024 •

edited

Loading

Nodebrute Jul 22, 2024

rojiphil Jul 22, 2024

rojiphil commented Jul 22, 2024 •

edited

Loading

rojiphil commented Jul 22, 2024

rojiphil commented Jul 22, 2024

rojiphil left a comment

rojiphil Jul 22, 2024

rojiphil commented Jul 22, 2024

Nodebrute commented Jul 22, 2024

mountiny left a comment

OSBotify commented Jul 22, 2024

OSBotify commented Jul 23, 2024

OSBotify commented Jul 24, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

	const failureData: OnyxUpdate[] = [
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
	value: {
	reportName: previousName,
	},
	},
	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`,
	value: {[optimisticRenamedAction.reportActionID]: null},
	},

clear policy errors #44130

clear policy errors #44130

Conversation

Nodebrute commented Jun 21, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mountiny commented Jul 19, 2024

rojiphil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Nodebrute Jul 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rojiphil commented Jul 22, 2024 • edited Loading

rojiphil commented Jul 22, 2024

Reviewer Checklist

Screenshots/Videos

rojiphil commented Jul 22, 2024

rojiphil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rojiphil commented Jul 22, 2024

Nodebrute commented Jul 22, 2024

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 22, 2024

OSBotify commented Jul 23, 2024

OSBotify commented Jul 24, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

Nodebrute commented Jun 21, 2024 •

edited

Loading

Nodebrute Jul 22, 2024 •

edited

Loading

rojiphil commented Jul 22, 2024 •

edited

Loading