Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Unable to select members after adding them to the workspace #36713

Merged
merged 10 commits into from
Mar 4, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Feb 16, 2024

Held on Expensify/react-native-onyx#482

Details

Fixed Issues

$ #34828
PROPOSAL: #34828 (comment)

Tests

  1. Navigate to Settings > Profile > Contact Method > New Contact Method > Add Email
  2. change the new email as the default contact
  3. Copy the main email and remove it
  4. Go to Settings > Workspace > Members > click on Invite> then paste the main email or search for the email used to create the account
  5. Add the email, click on the checkbox, and verify that it's selected
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Navigate to Settings > Profile > Contact Method > New Contact Method > Add Email
  2. change the new email as the default contact
  3. Copy the main email and remove it
  4. Go to Settings > Workspace > Members > click on Invite> then paste the main email or search for the email used to create the account
  5. Add the email, click on the checkbox, and verify that it's selected
  • 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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
Screen.Recording.2024-02-16.at.23.56.47.mov
Android: mWeb Chrome
Screen.Recording.2024-02-16.at.23.52.34.mov
iOS: Native
Screen.Recording.2024-02-16.at.23.50.12.mov
iOS: mWeb Safari
Screen.Recording.2024-02-16.at.23.44.02.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-16.at.22.50.49.mov
MacOS: Desktop
Screen.Recording.2024-02-16.at.23.26.08.mov

@tienifr tienifr marked this pull request as ready for review February 16, 2024 17:02
@tienifr tienifr requested a review from a team as a code owner February 16, 2024 17:02
@melvin-bot melvin-bot bot removed the request for review from a team February 16, 2024 17:02
Copy link

melvin-bot bot commented Feb 16, 2024

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

@melvin-bot melvin-bot bot requested a review from sobitneupane February 16, 2024 17:02
Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tienifr Can we also update policy owner optimistically as suggested here and as mentioned in your alternative proposal.

@tienifr
Copy link
Contributor Author

tienifr commented Feb 21, 2024

@sobitneupane updated

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshots/Videos

Android: Native
Screen.Recording.2024-02-22.at.14.01.34.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2024-02-22.at.14.05.38.mov
iOS: mWeb Safari
Screen.Recording.2024-02-22.at.14.01.34.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-22.at.13.43.51.mov
MacOS: Desktop
Untitled.mov

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.

@melvin-bot melvin-bot bot requested a review from youssef-lr February 22, 2024 08:31
@@ -70,6 +70,14 @@ Onyx.connect({
},
});

let allPolicies: OnyxCollection<Policy>;

Onyx.connect({
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not really a fan of subscribing to all policies in this file, can we subscribe to them in ContactMethodDetailsPage instead and use a selector to only get the policies owned by the user? then pass them to setContactMethodAsDefault

Copy link
Contributor Author

@tienifr tienifr Feb 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should get all policies in ContactMethodDetailsPage because it would be re-rendered even with the small change of policies.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@youssef-lr wdyt ^?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which is why I mentioned using a selector! You can select only the policy IDs owned by the user which is all we care about here and there won't be any re-renders as the ID will never change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about creating the function in libs/actions/Policy.ts to return all policyIDs? I think it's the best way @youssef-lr

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm checking...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@youssef-lr Here's my PR fix on Onyx repo: Expensify/react-native-onyx#482

Why this change? With collection, the returned type of selector shouldn't be the type we defined in ContactMethodDetailsPageOnyxProps a.k.a TOnyxProps[TOnyxProp] since the returned type of selector is just a single entry and TOnyxProps[TOnyxProp] is the collection.

As its name selector, this returned type should be Partial<KeyValueMapping[TOnyxKey]>.

What do you think? cc @sobitneupane

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replied in the PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tienifr @youssef-lr Please have a look at this comment.

@youssef-lr
Copy link
Contributor

Also we have conflicts.

@fabioh8010
Copy link
Contributor

@tienifr @youssef-lr I think it's better to put this PR on HOLD until the fix on Onyx is merged and available in a new release to be used in the App, wdyt?

@youssef-lr youssef-lr changed the title fix: Unable to select members after adding them to the workspace |HOLD react-native-onyx/#482] fix: Unable to select members after adding them to the workspace Mar 1, 2024
@youssef-lr
Copy link
Contributor

Done @fabioh8010

@tienifr
Copy link
Contributor Author

tienifr commented Mar 4, 2024

@youssef-lr The Onyx PR is merged, we're good to go

@youssef-lr youssef-lr changed the title |HOLD react-native-onyx/#482] fix: Unable to select members after adding them to the workspace fix: Unable to select members after adding them to the workspace Mar 4, 2024
Copy link
Contributor

@youssef-lr youssef-lr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your work here @tienifr! We just need to merge main to fix a failing check

@youssef-lr youssef-lr merged commit af0f6a3 into Expensify:main Mar 4, 2024
16 checks passed
@tienifr
Copy link
Contributor Author

tienifr commented Mar 4, 2024

@youssef-lr I think the PR fix on react-native-onyx here would be out of the original scope. Can I get the bonus for that fix? The same situation is in here

@OSBotify
Copy link
Contributor

OSBotify commented Mar 4, 2024

✋ 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
Copy link
Contributor

OSBotify commented Mar 4, 2024

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.4.47-0 🚀

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

@marcochavezf
Copy link
Contributor

This PR caused this regression. Reverting it

@youssef-lr
Copy link
Contributor

@tienifr seems like some changes included in the onyx version we bumped caused the regression.

@youssef-lr
Copy link
Contributor

I think it's worth finding out later which PR in Onyx has caused it.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 6, 2024

@youssef-lr I think this PR: #37804 fixed the issue. After checking the PR I believe the bug doesn't come from my onyx PR

@paultsimura
Copy link
Contributor

After checking the PR I believe the bug doesn't come from my onyx PR

Right, the regression came from Expensify/react-native-onyx#480. Also, the hotfix shouldn't have reverted the changes @tienifr made in Onyx, but it's worth double-checking.

@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.47-10 🚀

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

onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.POLICY}${policy.id}`,
value: {
owner: newDefaultContactMethod,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, this PR didn't address the need to optimistically update the policy employeeList by removing the previous contact method and adding the new one. More details can be found here: #44705 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants