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: Make all task titles/descriptions read-only to all but the author/assignee. #53749

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Dec 9, 2024

Explanation of Change

Fixed Issues

$ #52979
PROPOSAL: #52979 (comment)

Tests

  1. [Account A]: Create a new account > complete onboarding and open Concierge chat.
  2. [Account A]: Try to complete the assigned tasks from the preview (should not open the task before doing this step)
  3. [Account A]: Verify task can be completed/incomplete from the task preview checkbox
  4. [Account A]: Open any task > Verify you cannot open task title, description and assignee page.
  5. [Account A]: Verify you can still complete the task using the checkbox
  6. [Account B]: Create a new task (without assignee) in the chat of Account A.
  7. [Account A]: Verify you cannot edit task title, description and assignee page and task status (complete/incomplete)
  8. [Account B]: Assign the task to Account A
  9. [Account A]: Verify you can now edit task title, description and assignee page and task status (complete/incomplete)
  • Verify that no errors appear in the JS console

Offline tests

  1. [Account A]: Create a new account > complete onboarding and open Concierge chat.
  2. [Account A]: Try to complete the assigned tasks from the preview (should not open the task before doing this step)
  3. [Account A]: Verify task can be completed/incomplete from the task preview checkbox
  4. [Account A]: Open any task > Verify you cannot open task title, description and assignee page.
  5. [Account A]: Verify you can still complete the task using the checkbox
  6. [Account B]: Create a new task (without assignee) in the chat of Account A.
  7. [Account A]: Verify you cannot edit task title, description and assignee page and task status (complete/incomplete)
  8. [Account B]: Assign the task to Account A
  9. [Account A]: Verify you can now edit task title, description and assignee page and task status (complete/incomplete)

QA Steps

  1. [Account A]: Create a new account > complete onboarding and open Concierge chat.
  2. [Account A]: Try to complete the assigned tasks from the preview (should not open the task before doing this step)
  3. [Account A]: Verify task can be completed/incomplete from the task preview checkbox
  4. [Account A]: Open any task > Verify you cannot open task title, description and assignee page.
  5. [Account A]: Verify you can still complete the task using the checkbox
  6. [Account B]: Create a new task (without assignee) in the chat of Account A.
  7. [Account A]: Verify you cannot edit task title, description and assignee page and task status (complete/incomplete)
  8. [Account B]: Assign the task to Account A
  9. [Account A]: Verify you can now edit task title, description and assignee page and task status (complete/incomplete)
  • 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 comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
android_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

@Krishna2323 Krishna2323 requested a review from a team as a code owner December 9, 2024 10:32
@melvin-bot melvin-bot bot requested review from suneox and removed request for a team December 9, 2024 10:32
Copy link

melvin-bot bot commented Dec 9, 2024

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

@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Dec 9, 2024

@Expensify/design @thienlnam, before recording the videos, I want to confirm if the disabled cursor looks correct or not. I feel it might confuse users, making them think they can't click the link (which we want them to click).

Context: When users accidentally edit the description of a task assigned to them, it unexpected and feels broken, undermining the perception of product quality and conversion. So we decided to disable editing the task fields if the task created by Concierge, users will be only able to complete/incomplete the tasks.

Monosnap.screencast.2024-12-09.16-18-14.mp4

@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Dec 10, 2024

@shawnborton @dubielzyk-expensify @dannymcclain, could you please check the comment above🙏🏻? I think Expensify/design tag isn't working?

@dannymcclain
Copy link
Contributor

We don't need to use the not-allowed cursor. Just not having the right caret and not being able to click in to edit is enough.

Check out this screenshot from an expense. I can no longer change the merchant or date, but I can still change the description, category, and tag. My cursor is totally normal when I hover over the merchant and date rows, they just don't do anything.

CleanShot 2024-12-10 at 08 23 07@2x

@dannymcclain
Copy link
Contributor

Just realized a video would probably be more clear:

CleanShot.2024-12-10.at.08.25.27.mp4

@shawnborton
Copy link
Contributor

Just not having the right caret and not being able to click in to edit is enough.

Totally agree with that. Your video is exactly what we want to happen with tasks.

@dubielzyk-expensify
Copy link
Contributor

Agree with the designers 👍

Signed-off-by: krishna2323 <[email protected]>
@Krishna2323
Copy link
Contributor Author

@Expensify/design, does this look correct now?

Monosnap.screencast.2024-12-11.09-49-29.mp4

@dubielzyk-expensify
Copy link
Contributor

Looks right to me 👍

@dannymcclain
Copy link
Contributor

dannymcclain commented Dec 11, 2024

Yeah that looks right to me too 👍

@shawnborton
Copy link
Contributor

Yup, looks good to me three!

@Krishna2323
Copy link
Contributor Author

Thanks for the confirmation, I will add the recordings today.

@Krishna2323
Copy link
Contributor Author

@Expensify/design, I just realized we should be using a cursor-disabled style for the checkbox in all cases. After confirmation on this comment, I changed that to a default cursor, but I believe we should maintain consistency across the app by using a cursor-disabled state. I've updated it, but I wanted to confirm.

desktop_app.mp4

@Krishna2323
Copy link
Contributor Author

@suneox you can review the code changes, recordings have been updated.

@shawnborton
Copy link
Contributor

Hmm, why would we block the checkbox from working? I thought the goal was to make the title and description non-editable, but why would we make it so that you can't interact with the checkbox to complete the task?

@dannymcclain
Copy link
Contributor

Agree with Shawn. I'm having a hard time following that video, but I don't think the checkbox should ever be disabled?

@dubielzyk-expensify
Copy link
Contributor

I thought the goal was to make the title and description non-editable, but why would we make it so that you can't interact with the checkbox to complete the task?

Yeah agree with this being unexpected.

@Krishna2323
Copy link
Contributor Author

@suneox, I think I'm a bit lost on this one. Could you please verify if my understanding of the new behavior is correct?

  1. If a task author is Concierge, the assignee cannot edit the task title or description. However, the assignee can still mark the task as complete or incomplete.
  2. For all other tasks (author is not Concierge), both the author and the assignee can update the task title, description, and completion status.

@suneox
Copy link
Contributor

suneox commented Dec 14, 2024

@suneox, I think I'm a bit lost on this one. Could you please verify if my understanding of the new behavior is correct?

  1. If a task author is Concierge, the assignee cannot edit the task title or description. However, the assignee can still mark the task as complete or incomplete.

@Krishna2323 Correct, based on this confirmation

  1. For all other tasks (author is not Concierge), both the author and the assignee can update the task title, description, and completion status.

For other tasks, we should maintain the current logic for canModifyTask and canActionTask function, we're only adding new logic to ensure it returns false for Concierge tasks to prevent regression.
Then we'll introduce a new parameter to skip check the concierge task specifically for the checkbox.

@Krishna2323
Copy link
Contributor Author

@suneox, thanks for the confirmation :), could you please test this out?

Comment on lines +1223 to +1224
taskOwnerAccountID?: number,
taskAssigneeAccountID?: number,
Copy link
Contributor

@suneox suneox Dec 15, 2024

Choose a reason for hiding this comment

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

Suggested change
taskOwnerAccountID?: number,
taskAssigneeAccountID?: number,

Do we have a use case that requires using this parameter? If the change comes from a previous update, I think we can consider remove this prop. (the same with the canActionTask function)

@@ -365,8 +365,8 @@ function getOutstandingChildTask(taskReport: OnyxEntry<OnyxTypes.Report>) {
/**
* Complete a task
*/
function completeTask(taskReport: OnyxEntry<OnyxTypes.Report>) {
const taskReportID = taskReport?.reportID ?? '-1';
function completeTask(taskReport: OnyxEntry<OnyxTypes.Report>, reportIDFromAction?: string) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
function completeTask(taskReport: OnyxEntry<OnyxTypes.Report>, reportIDFromAction?: string) {
function completeTask(taskReport: OnyxEntry<OnyxTypes.Report>) {

Do we have a use case that requires using this parameter? If the change comes from a previous update, I think we can consider remove this prop (the same with the reopenTask function)

Comment on lines +293 to +295
{isTaskReport && !shouldUseNarrowLayout && ReportUtils.isOpenTaskReport(report, parentReportAction) && Task.canActionTask(report, accountID) && (
<TaskHeaderActionButton report={report} />
)}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{isTaskReport && !shouldUseNarrowLayout && ReportUtils.isOpenTaskReport(report, parentReportAction) && Task.canActionTask(report, accountID) && (
<TaskHeaderActionButton report={report} />
)}
{isTaskReport && !shouldUseNarrowLayout && ReportUtils.isOpenTaskReport(report, parentReportAction) && <TaskHeaderActionButton report={report} />}

We should revert the condition checking canActionTask to display the TaskHeaderActionButton, as this component already includes logic to handle disabling based on canActionTask. If there is no use case to hide ActionButton please revert the same change on ReportScreen

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.

5 participants