fix tag with undefined key is created in offline mode

[tienifr]

Details

Fixed Issues

$ #42885
PROPOSAL: #42885 (comment)

Tests

1. Open app
2. Go offline.
3. Create a new workspace.
4. Go to workspace settings > More features.
5. Enable Tags.
6. Go to Tags.
7. Add a tag.
8. Click on the tag.
9. Disable the tag.
10. Verify tag can be disabled.

• Verify that no errors appear in the JS console

Offline tests

QA Steps

• Same as above
• Verify that no errors appear in the JS console

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (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
    • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • 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 followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• 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
• I verified that if a function's arguments changed that all usages have also been updated correctly
• 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-06-04.at.20.02.07.mov

MacOS: Chrome / Safari

output.mp4

MacOS: Desktop

[melvin-bot]

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

[melvin-bot]

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

[tienifr]

@allgandalf

• Currently, my solution is to disable the "Save" button if the policyTags_${policyID} is empty as I mentioned in my alternative solution.

[allgandalf]

@tienifr , can you please update the PR with implementation from your main solution? We didn’t approve the alternate solution :)

[allgandalf]

NewDot is meant to work in offline mode too, I think we should not block the user from creating tags when they are offline, can you please update the code accordingly @tienifr ?

[tienifr]

@allgandalf Sure. But we need to confirm, where we should add the optimistic policyTags data. I tried to implement my main solution, and I found out that we should not add this in here because it is read method, and the read method can just call if there is no write method in the queue:

App/src/libs/API/index.ts

Line 166 in 24c5fe2

SequentialQueue.waitForIdle().then(() => makeRequestWithSideEffects(command, apiCommandParameters, onyxData, CONST.API_REQUEST_TYPE.READ));

So that why I am implementing my alternative solution.

[tienifr]

Based on this comment, we can discuss the details in the PR.

[allgandalf]

@tienifr Why can’t we set the orderWeight for a tag optimistically while creating the tag ? 🤔

[tienifr]

@allgandalf The RCA of this issue is that, we are allowing user to create a tag that have key is 'undefined':

{
    "undefined": {
        "tags": {
            "test": {
                "name": "test",
                "enabled": true,
                "errors": null,
                "pendingAction": "add"
            }
        }
    }
}

And this also appears in production, not only staging:

• If we set the optimistic orderweight like you said, the above problem still appears.

[allgandalf]

Yeah no conflict with your RCA, those were the basis for the selection of your proposal :), but what i want to imply is that we cannot block the user from creating tags when offline, that would be against the purpose of `ND`.

Based on this #42885 (comment), we can discuss the details in the PR.

Yes we can, tagging @hayata-suenaga , please have a look at this comment,

@tienifr can you please dig in deeper, because we surely want to set data optimistically than blocking the user from creating tag :) thanks

[tienifr]

@allgandalf Based on this comment, I think in this PR, we just need to: In here, we can early return if policyTags_${policyID}.

Then we will discuss about the expected and create a follow up PR. WDYT?

[allgandalf]

Please also update the Videos @tienifr :)

[tienifr]

@allgandalf I updated the video in chrome platform. I have a problem when logging in, where the server's response is too slow. That leads to I cannot add all the recordings now. Will ping you once done.

[allgandalf]

In order to avoid the crash using policyTag.orderWeight ?? route.params.orderWeight according to this proposal is a quick workaround i think then:

App/src/pages/workspace/tags/TagSettingsPage.tsx

Line 69 in 25c5438

setWorkspaceTagEnabled(route.params.policyID, {[currentPolicyTag.name]: {name: currentPolicyTag.name, enabled: value}}, policyTag.orderWeight);

@tienifr , this way we still let the ability to disable/enable tags work while we fix the actual issue at the root!

[tienifr]

@allgandalf We cannot create a new tag so I wonder that how can we disable/enable it?

[allgandalf]

We cannot create a new tag so I wonder that how can we disable/enable it?

We can create a new tag while offline, it's just that in PR, we added a extra prop to the setWorkspaceTagEnabled function which was meant to the used for the multi-level tags, so for single tags we do not have the property orderWeight set optimistically and hence the crash

Screen.Recording.2024-06-04.at.3.55.30.PM.mov

[tienifr]

• In this video, can you check the policyTags_${policyID} data?

We can create a new tag while offline

• We can create a new tag while offline if the policyTags_${policyID} is available

[allgandalf]

In this #43018 (comment), can you check the policyTags_${policyID} data?

Screen.Recording.2024-06-04.at.4.08.38.PM.mov

Here's the Onyx entry

[tienifr]

@allgandalf

• It looks like in here:
  

  App/src/pages/workspace/tags/WorkspaceTagsPage.tsx

  Line 163 in cdfed69

  Navigation.navigate(ROUTES.WORKSPACE_TAG_SETTINGS.getRoute(policyID, 0, tag.value));

  
  we always assumed that there is only one tag list in multiple tag, so we always set the orderWeight param to 0. So in here:
  

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

  Line 180 in cdfed69

  function setWorkspaceTagEnabled(policyID: string, tagsToUpdate: Record<string, {name: string; enabled: boolean}>, tagListIndex: number) {

  
  we can add the default value of tagListIndex to 0, WDYT? Note that this is optional because the current implementation has already fixed the issue.

[allgandalf]

Note that this is optional because the current implementation has already fixed the issue.

The current implementation doesn't fix the issue, we are not able to create new tags when we implement your PR @tienifr, which is not expected, see vit's comment

[tienifr]

@allgandalf What do you think if set the optimistic data:

{
    "Tag": {
        "name": "Tag",
        "orderWeight": 0,
        "required": false,
        "tags": []
    }
}

when calling EnablePolicyTags ? With this, we always can create new tags.

[allgandalf]

when calling EnablePolicyTags ?

But that would create a default tag called Tag whenever we enable the tags right?

[tienifr]

But that would create a default tag called Tag whenever we enable the tags right?

• No. It only creates optimistic if we enable tags and the policyTags_${policyID} is not available

[allgandalf]

In order to solve the crash, these things should happen:

1. We are able to create a workspace offline
2. Enable tags Offline
3. No extra tag is already present
4. Create tag offline
5. Be able to Enable/disable the created tag offline
6. That setting should persist when we are back online.

So if we are able to achieve these goals while setting the data optimistically, then we can test out the solution, would you make changes in your PR if you are able to do all the steps above with your proposed solution

[tienifr]

Sure. I am working on it.

[tienifr]

@allgandalf It looks like the same solution is just merged in latest main. I think we still need to prevent user from adding a new tag if there is no policyTags_ data to reduce the similar bug in the future.

Please review the PR again

[allgandalf]

It looks like the same #43018 (comment) is just merged in latest main.

Which PR merged this ?

[tienifr]

#42734 @allgandalf

[mountiny]

Closing in favour off #42734