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

chore: update task preview UI #48552

Merged
merged 3 commits into from
Sep 9, 2024
Merged

Conversation

dominictb
Copy link
Contributor

Details

Fixed Issues

$ #48409
PROPOSAL: #48409 (comment)

Tests

  1. Sign-up on NewDot with a new account
  2. Choose an onboarding intent (i.e "Get paid back by my employer")
  3. Complete the onboarding steps
  4. Navigate to the Concierge DM to view the onboarding tasks created

Verify that: all assigned task previews should

  • Not include a mention

  • Use only the avatar of the assigned user instead

  • Clicking on the task preview row (incl. the avatar) will navigate to the task, not the profile.

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Sign-up on NewDot with a new account
  2. Choose an onboarding intent (i.e "Get paid back by my employer")
  3. Complete the onboarding steps
  4. Navigate to the Concierge DM to view the onboarding tasks created

Verify that: all assigned task previews should

  • Not include a mention

  • Use only the avatar of the assigned user instead

  • Clicking on the task preview row (incl. the avatar) will navigate to the task, not the profile.

  • 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 Screenshot 2024-09-04 at 19 35 59
Android: mWeb Chrome Screenshot 2024-09-04 at 19 36 42
iOS: Native

Simulator Screenshot - iPhone 15 Pro Max - 2024-09-04 at 19 37 53

iOS: mWeb Safari

Simulator Screenshot - iPhone 15 Pro Max - 2024-09-04 at 19 38 38

MacOS: Chrome / Safari Screenshot 2024-09-04 at 19 35 15
MacOS: Desktop Screenshot 2024-09-04 at 19 35 15

@dominictb dominictb requested a review from a team as a code owner September 4, 2024 12:48
Copy link

melvin-bot bot commented Sep 4, 2024

@dannymcclain @dukenv0307 One of you needs to 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 removed the request for review from a team September 4, 2024 12:48
@dannymcclain
Copy link
Contributor

Screenshots are looking good so far. cc'ing @Expensify/design because this is a decently significant visual change to the product and I want them to be able to review too if they want.

@dukenv0307
Copy link
Contributor

Codes look good

@dukenv0307
Copy link
Contributor

dukenv0307 commented Sep 4, 2024

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 Screenshot 2024-09-04 at 22 53 10
Android: mWeb Chrome Screenshot 2024-09-04 at 22 54 58
iOS: Native Screenshot 2024-09-04 at 22 53 00
iOS: mWeb Safari Screenshot 2024-09-04 at 22 54 53
MacOS: Chrome / Safari Screenshot 2024-09-04 at 22 54 05
MacOS: Desktop Screenshot 2024-09-04 at 22 57 47

@melvin-bot melvin-bot bot requested a review from blimpich September 4, 2024 15:58
@dukenv0307
Copy link
Contributor

LGTM

@shawnborton
Copy link
Contributor

Small nitpick but I wonder if we should be reusing the same exact avatar size as the thread indicator? Just to try to reduce the amount of sizes we have on the screen for the same kind of thing.

@dannymcclain
Copy link
Contributor

dannymcclain commented Sep 4, 2024

@shawnborton Ah snap, not a bad idea at all!!

Here's a mock comparing thread indicator (28px), your proposed task avatar size (28px), and the original task avatar size (24px).
image

Whatcha think? To me they are like... barely different at all. So I'd be down to use the 28px size (which is the size for the thread indicator AND focus LHN)

@shawnborton
Copy link
Contributor

Dope, thanks for laying it out like that! I like going with 28px as well, I like that it's a size we're using in other places as well. Let's see what @dubielzyk-expensify thinks too!

@dubielzyk-expensify
Copy link
Contributor

dubielzyk-expensify commented Sep 5, 2024

Great call. Dig it. Just on the completed task look. We don't want any sort of strikethrough on the avatar right? Or fade of the avatar? A part of me kinda wishes there was some visual indication that the task is done on the avatar too. But maybe it's just better to leave it for now?

image

Probably just do nothing, right? I could see the fade, but I'm not super passionate

@trjExpensify
Copy link
Contributor

Yeah, I think it looks too much like offline pending delete tbh.

@shawnborton
Copy link
Contributor

Yeah, I think the Nothin' version feels the most correct to me

@shawnborton
Copy link
Contributor

I don't mind the Fade version though... happy to go with whatever you all think is best!

@dominictb
Copy link
Contributor Author

image

Updated with 28px avatar size.

@dannymcclain
Copy link
Contributor

Man I actually really like the Fade version for completed task, but I also am 100% down with Nothin' if we don't want to be messing about with it.

Seems like all the designers like that version but don't feel super duper passionate. How shall we decide?

@shawnborton
Copy link
Contributor

If we're all really feeling the fade version, then I think it's totally okay if we do it personally.

@shawnborton
Copy link
Contributor

I can see where it looks a bit like pending delete but pending delete should look even more faded out, right?

@dannymcclain
Copy link
Contributor

If we're all really feeling the fade version, then I think it's totally okay if we do it personally.

#send-it

I can see where it looks a bit like pending delete but pending delete should look even more faded out, right?

Yeah I think the whole entire row/message would be faded. I think it would probably be fine.

blimpich
blimpich previously approved these changes Sep 5, 2024
@blimpich
Copy link
Contributor

blimpich commented Sep 5, 2024

Sounds like @Expensify/design wants the fade?

@dominictb could you update your PR to make this a reality?

@trjExpensify
Copy link
Contributor

Not gunna' fight it. Fifty Shades of Fade™️

@dukenv0307
Copy link
Contributor

@shawnborton @dannymcclain What should the opacity be?

@dubielzyk-expensify
Copy link
Contributor

Let's do 0.5 or 50% :)

@dominictb
Copy link
Contributor Author

image

Just to confirm this is the expected look right?

@shawnborton
Copy link
Contributor

This portion here:
CleanShot 2024-09-06 at 10 55 49@2x

It should just use our textSupporting color and it shouldn't have reduced opacity. I think only the avatar would have reduced opacity. Is that what you were thinking Danny?

@trjExpensify
Copy link
Contributor

It should just use our textSupporting color and it shouldn't have reduced opacity. I think only the avatar would have reduced opacity. Is that what you were thinking Danny?

I hope so otherwise it does look exactly like pending delete... 🙈🏃‍♂️

@trjExpensify
Copy link
Contributor

Also, I think in Jon's mock above the checkbox doesn't get reduced opacity either:

image

@dannymcclain
Copy link
Contributor

Haha yes Shawn and Tom are absolutely right. Only the avatar should get reduced opacity when it's done. It looks like in your screenshot the whole row is getting reduced opacity which is not what we want here (as that is the pending offline pattern as Tom pointed out).

So checkmark and text should be full opacity, just the avatar should be reduced to 50% opacity.

CleanShot 2024-09-06 at 08 25 33@2x

@dominictb
Copy link
Contributor Author

Just to confirm here:

  • The checkbox and the text won't be faded off
  • The avatar will be faded off
  • The text will be strikethrough

right @dannymcclain @shawnborton @trjExpensify ?

@shawnborton
Copy link
Contributor

shawnborton commented Sep 8, 2024 via email

@dubielzyk-expensify
Copy link
Contributor

Just to confirm here:
The checkbox and the text won't be faded off
The avatar will be faded off
The text will be strikethrough

Exactly!

@dominictb
Copy link
Contributor Author

image

New screenshot

cc @dukenv0307

@shawnborton
Copy link
Contributor

That looks better!

@dubielzyk-expensify
Copy link
Contributor

Looks great 🥲

@trjExpensify
Copy link
Contributor

Great stuff, let's get this thing merged!

@dannymcclain
Copy link
Contributor

dannymcclain commented Sep 9, 2024

Looking good!

@Expensify/design seeing these tasks with the bigger avatar... I'm starting to wonder if we should just use our default size checkbox (20px) instead of the smaller one we're currently using (16px).

Here are some side-by-sides (Current 16px on the left, 20px on the right):

image

image

Note

If we want to make a change like this, I would propose it being a follow-up and not getting in the way of merging this avatar change.

EDIT: I updated the mocks because I realized there was a goof in them—I didn't have all the avatars correctly shown for completed tasks.

@shawnborton
Copy link
Contributor

Super down to standardize on the... standard size of 20px here!

@blimpich blimpich merged commit 1bc85f2 into Expensify:main Sep 9, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Sep 9, 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.

Comment on lines +123 to +125
<View style={[styles.alignSelfCenter]}>
<RenderHTML html={isTaskCompleted ? `<completed-task>${htmlForTaskPreview}</completed-task>` : htmlForTaskPreview} />
</View>
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 caused this issue: #49086. More info in this proposal: #49086 (comment)

Copy link
Contributor

Choose a reason for hiding this comment

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

This also causes the issue #50267

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.

9 participants