fix: Distance rates - Enabled distance rate changes to Disabled after deleting it. #48859

Krishna2323 · 2024-09-10T04:57:44Z

Details

Fixed Issues

$ #48290
PROPOSAL: #48290 (comment)

Tests

Precondition: Workspace has enabled categories, tags & taxes.

Go offline
Go to workspace categories page
Delete an enable category
Verify the category is disabled after being deleted offline
Go to workspace taxes page
Delete an enable tax rate
Verify the tax rate is disabled after being deleted offline
Go to workspace tags page
Delete an enable tag
Verify the tagis disabled after being deleted offline

Verify that no errors appear in the JS console

Offline tests

Go offline
Go to workspace categories page
Delete an enable category
Verify the category is disabled after being deleted offline
Go to workspace taxes page
Delete an enable tax rate
Verify the tax rate is disabled after being deleted offline
Go to workspace tags page
Delete an enable tag
Verify the tagis disabled after being deleted offline

QA Steps

Go offline
Go to workspace categories page
Delete an enable category
Verify the category is disabled after being deleted offline
Go to workspace taxes page
Delete an enable tax rate
Verify the tax rate is disabled after being deleted offline
Go to workspace tags page
Delete an enable tag
Verify the tagis disabled after being deleted offline

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_native.mp4

Android: mWeb Chrome

android_chrome.mp4

iOS: Native

ios_native.mp4

iOS: mWeb Safari

ios_safari.mp4

MacOS: Chrome / Safari

web_chrome.mp4

MacOS: Desktop

desktop_app.mp4

… deleting it. Signed-off-by: krishna2323 <[email protected]>

melvin-bot · 2024-09-10T04:57:49Z

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

Krishna2323 · 2024-09-16T12:51:39Z

will be working on the other issue today.

paultsimura · 2024-09-18T10:14:47Z

@Krishna2323 any updates on the PR?

Krishna2323 · 2024-09-19T09:02:07Z

@paultsimura, sorry for the delay. I will provide an update today for sure.

Krishna2323 · 2024-09-20T08:30:03Z

@paultsimura, I haven't find the solution for the other issue yet but here is the reason why #48290 (comment) is happening.

The correct policy isn't returned from here, this only happens for some policy afaik.

App/src/libs/actions/Policy/ReportField.ts

Lines 42 to 73 in 6510ae4

    
           const allPolicies: OnyxCollection<Policy> = {}; 
        
           Onyx.connect({ 
        
               key: ONYXKEYS.COLLECTION.POLICY, 
        
               callback: (value, key) => { 
        
                   if (!key) { 
        
                       return; 
        
                   } 
        
                   if (value === null || value === undefined) { 
        
                       // If we are deleting a policy, we have to check every report linked to that policy 
        
                       // and unset the draft indicator (pencil icon) alongside removing any draft comments. Clearing these values will keep the newly archived chats from being displayed in the LHN. 
        
                       // More info: https://github.com/Expensify/App/issues/14260 
        
                       const policyID = key.replace(ONYXKEYS.COLLECTION.POLICY, ''); 
        
                       const policyReports = ReportUtils.getAllPolicyReports(policyID); 
        
                       const cleanUpMergeQueries: Record<`${typeof ONYXKEYS.COLLECTION.REPORT}${string}`, NullishDeep<Report>> = {}; 
        
                       const cleanUpSetQueries: Record<`${typeof ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${string}` | `${typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS}${string}`, null> = {}; 
        
                       policyReports.forEach((policyReport) => { 
        
                           if (!policyReport) { 
        
                               return; 
        
                           } 
        
                           const {reportID} = policyReport; 
        
                           cleanUpSetQueries[`${ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${reportID}`] = null; 
        
                           cleanUpSetQueries[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS}${reportID}`] = null; 
        
                       }); 
        
                       Onyx.mergeCollection(ONYXKEYS.COLLECTION.REPORT, cleanUpMergeQueries); 
        
                       Onyx.multiSet(cleanUpSetQueries); 
        
                       delete allPolicies[key]; 
        
                       return; 
        
                   } 
        
                   allPolicies[key] = value; 
        
               }, 
        
           });

Accessing defaultValue from reportField causes error since the policy is empty so the report field is also empty.

App/src/libs/actions/Policy/ReportField.ts

Lines 455 to 463 in 6510ae4

    
           const previousFieldList = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`]?.fieldList ?? {}; 
        
           const reportFieldKey = ReportUtils.getReportFieldKey(reportFieldID); 
        
           const reportField = previousFieldList[reportFieldKey]; 
        
           const updatedReportField = cloneDeep(reportField); 
        
           valueIndexes 
        
               .sort((a, b) => b - a) 
        
               .forEach((valueIndex) => { 
        
                   const shouldResetDefaultValue = reportField.defaultValue === reportField.values[valueIndex];

Please let me know if you know anything about this, I'm trying to find a solution.

paultsimura · 2024-09-21T08:35:30Z

@Krishna2323 thanks for looking into this. This looks like an Onyx bug, I'll report it now.

paultsimura · 2024-09-25T10:48:35Z

@Krishna2323 I think we are good to try again. Let's focus on the "enabled/disabled" change.

As a temp solution for the report fields issue:

If a super quick fix is necessary for this, you can add reuseConnection: false to this Onyx.connect options temporarily, it will disable the connection reuse and it should work properly

The full fix should be delivered in Expensify/react-native-onyx#583

Krishna2323 · 2024-09-25T13:12:09Z

@paultsimura, where should I add reuseConnection: false?

here?:

App/src/libs/Network/SequentialQueue.ts

Lines 151 to 155 in b1720c7

    
           const connection = Onyx.connect({ 
        
               key: ONYXKEYS.PERSISTED_REQUESTS, 
        
               // We exceptionally opt out of reusing the connection here to avoid extra callback calls due to 
        
               // an existing connection already made in PersistedRequests.ts. 
        
               reuseConnection: false,

paultsimura · 2024-09-25T13:14:56Z

@Krishna2323 here:

App/src/libs/actions/Policy/ReportField.ts

Lines 43 to 73 in 9ff01cc

    
           Onyx.connect({ 
        
               key: ONYXKEYS.COLLECTION.POLICY, 
        
               callback: (value, key) => { 
        
                   if (!key) { 
        
                       return; 
        
                   } 
        
                   if (value === null || value === undefined) { 
        
                       // If we are deleting a policy, we have to check every report linked to that policy 
        
                       // and unset the draft indicator (pencil icon) alongside removing any draft comments. Clearing these values will keep the newly archived chats from being displayed in the LHN. 
        
                       // More info: https://github.com/Expensify/App/issues/14260 
        
                       const policyID = key.replace(ONYXKEYS.COLLECTION.POLICY, ''); 
        
                       const policyReports = ReportUtils.getAllPolicyReports(policyID); 
        
                       const cleanUpMergeQueries: Record<`${typeof ONYXKEYS.COLLECTION.REPORT}${string}`, NullishDeep<Report>> = {}; 
        
                       const cleanUpSetQueries: Record<`${typeof ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${string}` | `${typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS}${string}`, null> = {}; 
        
                       policyReports.forEach((policyReport) => { 
        
                           if (!policyReport) { 
        
                               return; 
        
                           } 
        
                           const {reportID} = policyReport; 
        
                           cleanUpSetQueries[`${ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${reportID}`] = null; 
        
                           cleanUpSetQueries[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS}${reportID}`] = null; 
        
                       }); 
        
                       Onyx.mergeCollection(ONYXKEYS.COLLECTION.REPORT, cleanUpMergeQueries); 
        
                       Onyx.multiSet(cleanUpSetQueries); 
        
                       delete allPolicies[key]; 
        
                       return; 
        
                   } 
        
                   allPolicies[key] = value; 
        
               }, 
        
           });

Krishna2323 · 2024-09-26T23:54:10Z

@paultsimura, I'm not sure if we should make the change to show feedback for optimistic data.

App/src/libs/actions/Policy/ReportField.ts

Lines 473 to 474 in a935a15

    
           // We are using the offline pattern A (optimistic without feedback) 
        
           const onyxData: OnyxData = {

paultsimura · 2024-09-27T10:06:21Z

@Krishna2323 this change was only to enable testing removal of the "Report Field" list values, as we have to change the "enabled/disabled" behavior there as well. No need to commit the reuseConnection: false change.

Moreover, the Onyx PR was merged, so you can just use the Onyx v2.0.71 locally.

Please finish the author checklist and tag me when ready for review.

Krishna2323 · 2024-09-27T14:49:44Z

we have to change the "enabled/disabled" behavior there as well.

Yeah, i'm asking the same, should we change that behaviour? Because the comment (// We are using the offline pattern A (optimistic without feedback)) looks like that it was implemented like that intentionally.

Do we only need to change the "enabled/disabled" behavior or we also need to change the value removal behaviour?

paultsimura · 2024-09-27T15:31:56Z

Got you, I just didn't look at the referenced code properly, sorry about that.
Yes, we should implement it here as well. The PR that added that comment was fixing the case when the value would be removed completely while offline.

Krishna2323 · 2024-09-29T00:17:41Z

Yes, we should implement it here as well. The #46961 that added that comment was fixing the case when the value would be removed completely while offline.

@paultsimura, sorry, but I'm still confused about which behavior we should change. Do we want to show the pending action state only when we edit a value, or do we also need to do that when we delete? I don't think we should make changes to the current behavior since it was very recently changed after discussion.

Krishna2323 · 2024-10-02T00:33:08Z

@paultsimura, please let me know your thoughts on the comment above ^

paultsimura · 2024-10-02T12:29:43Z

I'm really sorry @Krishna2323 – I was partly available last week and only now was I able to fully dive deep into the matter of the report fields. You are correct – the report fields were implemented this way intentionally because they use an array, not objects, therefore it cannot support pending actions. We should implement the changes only on:

tags
categories
tax rates
distance rates (already implemented)

I'll start with the checklist now. Please merge main and fill out the checklist from your side. Again, I apologize for the delay and the confusion.

paultsimura · 2024-10-02T13:13:30Z

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

2024-10-02.-.15.45.-.android.mp4

Android: mWeb Chrome

2024-10-02.-.15.22.-.chrome.mp4

iOS: Native

2024-10-02.-.15.06.-.Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-10-02.at.15.05.17.mp4

iOS: mWeb Safari

2024-10-02.-.15.06.-.Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-10-02.at.14.47.50.mp4

MacOS: Chrome / Safari

2024-10-02.-.15.06.-.Screen.Recording.2024-10-02.at.14.44.39.mp4

MacOS: Desktop

2024-10-02.-.15.22.-.Screen.Recording.2024-10-02.at.14.44.39.mp4

Krishna2323 · 2024-10-03T16:14:38Z

Will complete the checklist today.

Krishna2323 · 2024-10-04T03:43:02Z

@paultsimura, checklist completed.

Signed-off-by: krishna2323 <[email protected]>

paultsimura

Let's use !! to cast values to true/false.

src/libs/actions/Policy/Category.ts

src/libs/actions/Policy/Tag.ts

src/libs/actions/TaxRate.ts

Signed-off-by: krishna2323 <[email protected]>

Krishna2323 · 2024-10-05T02:20:21Z

@paultsimura, all done.

paultsimura

LGTM ✔️

fix: Distance rates - Enabled distance rate changes to Disabled after…

fd3dac2

… deleting it. Signed-off-by: krishna2323 <[email protected]>

Krishna2323 requested a review from a team as a code owner September 10, 2024 04:57

melvin-bot bot requested review from paultsimura and removed request for a team September 10, 2024 04:57

Krishna2323 marked this pull request as draft September 10, 2024 04:57

Merge branch 'Expensify:main' into krishna2323/issue/48290

993f1b5

Merge branch 'Expensify:main' into krishna2323/issue/48290

58c33c1

Merge branch 'Expensify:main' into krishna2323/issue/48290

c8dbf9a

Merge branch 'Expensify:main' into krishna2323/issue/48290

fc59823

Krishna2323 marked this pull request as ready for review October 4, 2024 03:41

minor fix.

ec7fd1d

Signed-off-by: krishna2323 <[email protected]>

paultsimura suggested changes Oct 4, 2024

View reviewed changes

src/libs/actions/Policy/Category.ts Outdated Show resolved Hide resolved

src/libs/actions/Policy/Tag.ts Outdated Show resolved Hide resolved

src/libs/actions/TaxRate.ts Outdated Show resolved Hide resolved

minor update.

0bc1ada

Signed-off-by: krishna2323 <[email protected]>

paultsimura approved these changes Oct 5, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath October 5, 2024 07:41

paultsimura approved these changes Oct 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Distance rates - Enabled distance rate changes to Disabled after deleting it. #48859

fix: Distance rates - Enabled distance rate changes to Disabled after deleting it. #48859

Krishna2323 commented Sep 10, 2024 •

edited

Loading

melvin-bot bot commented Sep 10, 2024

Krishna2323 commented Sep 16, 2024

paultsimura commented Sep 18, 2024

Krishna2323 commented Sep 19, 2024

Krishna2323 commented Sep 20, 2024 •

edited

Loading

paultsimura commented Sep 21, 2024

paultsimura commented Sep 25, 2024

Krishna2323 commented Sep 25, 2024

paultsimura commented Sep 25, 2024

Krishna2323 commented Sep 26, 2024

paultsimura commented Sep 27, 2024 •

edited

Loading

Krishna2323 commented Sep 27, 2024 •

edited

Loading

paultsimura commented Sep 27, 2024

Krishna2323 commented Sep 29, 2024

Krishna2323 commented Oct 2, 2024

paultsimura commented Oct 2, 2024

paultsimura commented Oct 2, 2024 •

edited

Loading

Krishna2323 commented Oct 3, 2024

Krishna2323 commented Oct 4, 2024

paultsimura left a comment

Krishna2323 commented Oct 5, 2024

paultsimura left a comment

fix: Distance rates - Enabled distance rate changes to Disabled after deleting it. #48859

Are you sure you want to change the base?

fix: Distance rates - Enabled distance rate changes to Disabled after deleting it. #48859

Conversation

Krishna2323 commented Sep 10, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 10, 2024

Krishna2323 commented Sep 16, 2024

paultsimura commented Sep 18, 2024

Krishna2323 commented Sep 19, 2024

Krishna2323 commented Sep 20, 2024 • edited Loading

paultsimura commented Sep 21, 2024

paultsimura commented Sep 25, 2024

Krishna2323 commented Sep 25, 2024

paultsimura commented Sep 25, 2024

Krishna2323 commented Sep 26, 2024

paultsimura commented Sep 27, 2024 • edited Loading

Krishna2323 commented Sep 27, 2024 • edited Loading

paultsimura commented Sep 27, 2024

Krishna2323 commented Sep 29, 2024

Krishna2323 commented Oct 2, 2024

paultsimura commented Oct 2, 2024

paultsimura commented Oct 2, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

Krishna2323 commented Oct 3, 2024

Krishna2323 commented Oct 4, 2024

paultsimura left a comment

Choose a reason for hiding this comment

Krishna2323 commented Oct 5, 2024

paultsimura left a comment

Choose a reason for hiding this comment

Krishna2323 commented Sep 10, 2024 •

edited

Loading

Krishna2323 commented Sep 20, 2024 •

edited

Loading

paultsimura commented Sep 27, 2024 •

edited

Loading

Krishna2323 commented Sep 27, 2024 •

edited

Loading

paultsimura commented Oct 2, 2024 •

edited

Loading