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

Followup/23961 edit request headers #25399

Merged
merged 7 commits into from
Aug 21, 2023

Conversation

koko57
Copy link
Contributor

@koko57 koko57 commented Aug 17, 2023

Details

  • improved the optimistic styles when the transaction is changed offline
  • improves the modified message text when there was no value set before

Fixed Issues

$ #23961
PROPOSAL: $ #23961

Tests

Offline styles:

  1. Go to request details
  2. Go offline
  3. Verify that the amount, date and description menu items are greyed out but still clickable.

Modified expense message

  1. Change the date, amount, the description (then once again to empty string).
  2. Verify that messages are using this schema:
  • no old value: set the [valueName] to [newValue]

  • no new value: removed the [valueName] (previously [oldValue])

  • old and new value changed the [valueName] to [newValue] (previously [oldValue])

  • Verify that no errors appear in the JS console

Offline tests

Offline styles:

  1. Go to request details
  2. Go offline
  3. Verify that the amount, date and description menu items are greyed out but still clickable.

Modified expense message

  1. Change the date, amount, the description (then once again to an empty string).
  2. Verify that messages are using this schema:
  • no old value: set the [valueName] to [newValue]
  • no new value: removed the [valueName] (previously [oldValue])
  • old and new value changed the [valueName] to [newValue] (previously [oldValue])

QA Steps

Offline styles:

  1. Go to request details
  2. Go offline
  3. Verify that the amount, date and description menu items are greyed out but still clickable.

Modified expense message

  1. Change the date, amount, the description (then once again to an empty string).
  2. Verify that messages are using this schema:
  • no old value: set the [valueName] to [newValue]

  • no new value: removed the [valueName] (previously [oldValue])

  • old and new value changed the [valueName] to [newValue] (previously [oldValue])

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screenshot 2023-08-17 at 18 40 56
Screenshot 2023-08-17 at 18 42 42

Mobile Web - Chrome

Screenshot_1692292561

Mobile Web - Safari

Simulator Screen Shot - iPhone 13 - 2023-08-17 at 19 08 14
simulator_screenshot_27F4872B-20F7-49B0-BD8D-2367EFB9A69A

Desktop

Screenshot 2023-08-17 at 18 52 16
Screenshot 2023-08-17 at 18 53 19

iOS

Simulator Screen Shot - iPhone 13 - 2023-08-17 at 19 21 51

Android

Screenshot_1692296306

@koko57
Copy link
Contributor Author

koko57 commented Aug 17, 2023

Still not solved: after updating values when offline the headers (amount, description, date) don't change immediately - they change after changing other values or refocusing the screen.

Screenshot 2023-08-17 at 18 41 34

Could it be possibly because we're updating only the transaction object and the transaction data is not taken directly from Onyx? The keys we're subscribing to are not changing.

@koko57 koko57 marked this pull request as ready for review August 17, 2023 18:23
@koko57 koko57 requested a review from a team as a code owner August 17, 2023 18:23
@melvin-bot melvin-bot bot removed the request for review from a team August 17, 2023 18:23
@melvin-bot
Copy link

melvin-bot bot commented Aug 17, 2023

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

@allroundexperts
Copy link
Contributor

allroundexperts commented Aug 17, 2023

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 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 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-08-21.at.2.31.49.PM.mov
Mobile Web - Chrome
Screen.Recording.2023-08-21.at.2.35.54.PM.mov
Mobile Web - Safari
Screen.Recording.2023-08-21.at.2.38.31.PM.mov
Desktop
Screen.Recording.2023-08-21.at.2.33.37.PM.mov
iOS
Screen.Recording.2023-08-21.at.2.40.01.PM.mov
Android
Screen.Recording.2023-08-21.at.2.37.34.PM.mov

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Code is looking fine to me. Testing now!

@allroundexperts
Copy link
Contributor

@koko57 Should I wait for this to be resolved? Or will this be fixed in another followup? cc @mountiny If you know.

@koko57
Copy link
Contributor Author

koko57 commented Aug 17, 2023

@allroundexperts I think it can be fixed in another follow-up.

@allroundexperts
Copy link
Contributor

Sounds good. Continuing my testing then!

@mountiny
Copy link
Contributor

I think we could pull the transaction directly from onyx on the component to ensure it rerenders whenever it changes

@allroundexperts
Copy link
Contributor

Looking good. At this point, only waiting for the android build to complete so I can add its screenshots (its painfully slow lately).

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Finally android build is complete and so is the checklist.

One final comment. On tasks, we are greying out title / description / assignee only when you're offline and someone changes it. On the contrary, here, we are greying it out regardless if someone has edited it out or not. I'm not sure which behaviour is the correct one but we should be consistent between screens.

Screenshot 2023-08-18 at 2 17 14 AM

@mountiny
Copy link
Contributor

Noting that Carlos is adding the transaction subscriber to the money request view here https://github.com/Expensify/App/pull/25435/files

@allroundexperts @koko57 Thanks for highlighting this, we might not have ben clear, when offline the header should be grey only when you edit it as that symbols the change is optimistic, ie only at your client locally.

It should not be grey just because you are offline.

@allroundexperts
Copy link
Contributor

It should not be grey just because you are offline.

Right. @koko57 You might want to update the PR to handle this then. Also, please update your test steps and I'll review it again!

@koko57
Copy link
Contributor Author

koko57 commented Aug 18, 2023

@allroundexperts @mountiny thanks for the review! I'm OOO from today, someone from my team will take it over. Seems that Carlos PR will solve the updating the headers issue here, so the only thing to do is to apply greying out only to edited headers 🙂 I guess that the changes that Carlos made will also be necessary to do that, so we'll probably need to wait for this PR to be merged

@BeeMargarida
Copy link
Contributor

Hey, I'll be picking this up while Agata is OOO. I'll get up to speed on this and work on applying the greying out on the edited headers.

@BeeMargarida
Copy link
Contributor

BeeMargarida commented Aug 18, 2023

@allroundexperts @mountiny I've updated the greying out logic, let me know if there's any error or misunderstanding on my part. It should now be working similar to the Task view. This is still dependent on Carlos PR for the re-render of the component when the transaction changes.

@mountiny
Copy link
Contributor

@allroundexperts also shoul be ready once you get time thanks

@allroundexperts
Copy link
Contributor

@allroundexperts
Copy link
Contributor

BUG

  1. Go offline.
  2. Create a new money request.
  3. Go to the created money request details page.

The amount / description / date should be greyed out since the request was created while being offline but it is not.

Screenshot 2023-08-18 at 8 24 50 PM

@allroundexperts
Copy link
Contributor

@BeeMargarida Also, when I edit a request, it becomes greyed out only AFTER I re-focus the tab. Is that expected?

@BeeMargarida
Copy link
Contributor

@BeeMargarida Also, when I edit a request, it becomes greyed out only AFTER I re-focus the tab. Is that expected?

I think that's related to the fact that this is dependent on Carlos PR, which re-renders the component when the transaction changes. Currently this is not happening.

@allroundexperts
Copy link
Contributor

Makes sense. Please let me know once this is fixed and I'll re-review.

@BeeMargarida
Copy link
Contributor

@allroundexperts Should be fixed now 👍

@allroundexperts
Copy link
Contributor

@BeeMargarida Conflicts 🤯 🤯

@BeeMargarida
Copy link
Contributor

@allroundexperts Fixed 👍

@allroundexperts
Copy link
Contributor

Tests well. Updated the screen recordings.

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks everyone, really helpful!

@mountiny mountiny merged commit 49d42a9 into Expensify:main Aug 21, 2023
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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

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

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

@roryabraham
Copy link
Contributor

#25399 - Failing #22640

@mvtglobally Applause reported this as a QA fail. Not a deploy blocker, but can you provide some more details please?

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

@koko57 koko57 deleted the followup/23961-edit-request-headers branch September 28, 2023 15:54
shouldShowRightIcon={canEdit}
onPress={() => Navigation.navigate(ROUTES.getEditRequestRoute(report.reportID, CONST.EDIT_REQUEST_FIELD.DATE))}
/>
<OfflineWithFeedback pendingAction={lodashGet(transaction, 'pendingFields.amount') || lodashGet(transaction, 'pendingAction')}>
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #26235

When adding this, we didn't take into consideration that MoneyRequestView itself is wrapped in <OfflineWithFeedback>, which can lead to a cumulated grey-out effect.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, but in the same commit wrapping the whole component was removed. So it looks like it was restored later and caused the issue

Copy link
Contributor

Choose a reason for hiding this comment

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

I missed that! Thank you, I'll update my checklist.

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

7 participants