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

[23304] Update tasks status color. #23912

Merged
merged 3 commits into from
Aug 1, 2023
Merged

[23304] Update tasks status color. #23912

merged 3 commits into from
Aug 1, 2023

Conversation

DanutGavrus
Copy link
Contributor

@DanutGavrus DanutGavrus commented Jul 31, 2023

Details

Task status used to be a link in the past, but it's not anymore. Updated it's color from a blue link color to a gray color.

Fixed Issues

$ #23304
PROPOSAL: #23304 (comment)

Tests

Same as QA Steps.

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps.

QA Steps

  1. Create a task with any title, description and asignee;
  2. Mark it as done -> reopen it -> close it;
  3. Verify that "completed task", "reopened task" & "canceled task" messages are gray.
  • 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 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
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@DanutGavrus DanutGavrus requested a review from a team as a code owner July 31, 2023 08:26
@melvin-bot melvin-bot bot requested review from ArekChr and removed request for a team July 31, 2023 08:26
@melvin-bot
Copy link

melvin-bot bot commented Jul 31, 2023

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

@shawnborton
Copy link
Contributor

The entire system message should use the textSupporting color. The task title should not appear in the regular text color. Can you please update? cc @JmillsExpensify @trjExpensify

@DanutGavrus
Copy link
Contributor Author

@shawnborton

The entire system message should use the textSupporting color

From what I see, colorMuted style sets the textSupporting color:

App/src/styles/styles.js

Lines 417 to 419 in cbf6666

colorMuted: {
color: themeColors.textSupporting,
},

@shawnborton
Copy link
Contributor

Correct. But where it says "Test Title" here, those are in the wrong color:
image

@DanutGavrus
Copy link
Contributor Author

Hmm, I didn't modify that part. From what I know, it was not discussed in the issue/proposal, but it's very easy to update if needed.

The entire system message ...

"Test Title" is the actual title which I've gave to the task. Should I leave its color as it was, or to update it?

@shawnborton
Copy link
Contributor

Oh, interesting. Can you share any existing system messages that use that style for reference? My understanding was that the entire system message should appear in the textSupporting color.

@DanutGavrus
Copy link
Contributor Author

I don't know if any system message uses that style. My understanding is almost the same. The only difference is that I understood that only the task's status is part of the system message, while the task title would not be part of the system message as it's user input and does not come from the system. Comments in the issue also referenced the blue text.

Let me know if I misunderstood and should update.

@shawnborton
Copy link
Contributor

Yeah, again, my understanding is that the entire system message should use the text supporting color. So let's update it to use that.

Also, this should be a shared component that all system messages use. Is there a way to dry this up to make sure we're using the same, consistent system message component everywhere?

@DanutGavrus
Copy link
Contributor Author

the entire system message should use the text supporting color. So let's update it to use that.

So, you're saying that the task's title is considered a system message?

@shawnborton
Copy link
Contributor

Yes, we are showing the title within the system message itself.

@DanutGavrus
Copy link
Contributor Author

DanutGavrus commented Jul 31, 2023

this should be a shared component that all system messages use

There's this existing component: InlineSystemMessage, which uses:

App/src/styles/styles.js

Lines 3152 to 3157 in dc32700

inlineSystemMessage: {
color: themeColors.textSupporting,
fontSize: variables.fontSizeLabel,
fontFamily: fontFamily.EXP_NEUE,
marginLeft: 6,
},

Don't know if the font is a good fit for this, and also don't think that the marginLeft is desired here, but I think we can pass some style props in order to add/override what we need, or to create a new component: SystemMessage.

I think I have to wait for @ArekChr & @dangrous feedback in order to know if it's ok to implement it like that.

@ArekChr
Copy link
Contributor

ArekChr commented Jul 31, 2023

Also, this should be a shared component that all system messages use. Is there a way to dry this up to make sure we're using the same, consistent system message component everywhere?

We can achieve this by combining styles.chatItemMessage and styles.colorMuted into a single style or creating a custom Text component that utilizes both styles. Based on what I see in the codebase, it seems unlikely to create text wrappers everywhere, as it consistently uses styles directly.

@shawnborton
Copy link
Contributor

I'm not so much talking about styles, I'm also talking about the code here. I would imagine we will use system messages in many other situations, not just tasks.

@shawnborton
Copy link
Contributor

@JmillsExpensify do you mind chiming in here? Where else do we currently use system messages?

@ArekChr
Copy link
Contributor

ArekChr commented Jul 31, 2023

this should be a shared component that all system messages use

There's this existing component: InlineSystemMessage, which uses:

App/src/styles/styles.js

Lines 3152 to 3157 in dc32700

inlineSystemMessage: {
color: themeColors.textSupporting,
fontSize: variables.fontSizeLabel,
fontFamily: fontFamily.EXP_NEUE,
marginLeft: 6,
},

Don't know if the font is a good fit for this, and also don't think that the marginLeft is desired here, but I think we can pass some style props in order to add/override what we need, or to create a new component: SystemMessage.

I think I have to wait for @ArekChr & @dangrous feedback in order to know if it's ok to implement it like that.

This style is used for inline system errors, has different font size and margins

image

@DanutGavrus
Copy link
Contributor Author

@ArekChr

This style is used for inline system errors, has different font size and margins

I think we may make it more customizable as to receive and apply only the style(s) received through props(for the parent View & for the Text) , and also to display the icon based on a boolean.

Or, we may create a new component in a similar manner.

@shawnborton
Copy link
Contributor

Sorry to clarify, this system message is different from the inlineSystemError messages. Let's ignore that as it relates to this particular project.

Here is an example of where we'd use system messages elsewhere, in a different project:
image

The point being, let's not duplicate the work and have multiple ways in the code to render a system message. It's a shared style that will be used all over the platform, not just for tasks.

But that being said, I can see where that is something we should tackle elsewhere, and this issue should just be about updating the color.

cc @jasperhuangg @thienlnam - can you comment on the idea of drying this up for future use?

@DanutGavrus
Copy link
Contributor Author

@shawnborton
I've updated the styles based on our discussion, is it ok? (only the Web screenshot was updated until confirmation).

@ArekChr
Copy link
Contributor

ArekChr commented Jul 31, 2023

@shawnborton, what do you think about adding a ":" as a separator between the message and the task name?

like here:
Zrzut ekranu 2023-07-31 o 15 23 05

@shawnborton
Copy link
Contributor

Web screenshot looks good. No need to add the : - we can leave the message as-is.

@DanutGavrus
Copy link
Contributor Author

@shawnborton
Ok, thank you!

@ArekChr
I will proceed to update the other screenshots soon, and make code changes when & if you require. Thanks!

@DanutGavrus
Copy link
Contributor Author

But that being said, I can see where that is something we should tackle elsewhere, and this issue should just be about updating the color.
cc @jasperhuangg @thienlnam - can you comment on the idea of drying this up for future use?

If refactoring the current component as to make it customizable through props will be desired, I'm available to make that PR for no bounty/payment afterwards.

@JmillsExpensify
Copy link

@shawnborton sorry for the delay! We already use system messages on expense reports. I agree with everything you said above around textSupporting, that's what it's supposed to be, it's just for some reason this isn't the case on Tasks. I'm not sure why. Example on expense reports below.

Screenshot 2023-07-31 at 23 32 07

@JmillsExpensify
Copy link

Also very minor but important point. All system messages begin with a lowercase letter, not a capitalized one.

@ArekChr
Copy link
Contributor

ArekChr commented Aug 1, 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 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 web
Mobile Web - Chrome

mweb chrome

Mobile Web - Safari

mweb safari

Desktop desktop
iOS

ios

Android

android

@shawnborton
Copy link
Contributor

Screenshots look good, thanks!

Copy link
Contributor

@ArekChr ArekChr left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from dangrous August 1, 2023 10:51
@DanutGavrus
Copy link
Contributor Author

@dangrous I'm rechecking the changes on all platforms and updating the Screenshots now. Please wait before merging, I want to make sure all is good! Thanks!

@DanutGavrus
Copy link
Contributor Author

Done updating my screenshots too, sorry for the delay!

@dangrous all good now!

Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

Lovely!

@dangrous dangrous merged commit de4e13a into Expensify:main Aug 1, 2023
11 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Aug 1, 2023

✋ 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 Aug 2, 2023

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.49-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 3, 2023

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.50-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 3, 2023

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.49-3 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 7, 2023

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.50-3 🚀

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

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.

6 participants