App icon indicating copy to clipboard operation
App copied to clipboard

fix: Make all task titles/descriptions read-only to all but the author/assignee.

Open Krishna2323 opened this issue 1 year ago โ€ข 3 comments

Explanation of Change

Fixed Issues

$ https://github.com/Expensify/App/issues/52979 PROPOSAL: https://github.com/Expensify/App/issues/52979#issuecomment-2510171819

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)
  • [x] 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)
  • [x] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

Krishna2323 avatar Dec 09 '24 10:12 Krishna2323

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

melvin-bot[bot] avatar Dec 09 '24 10:12 melvin-bot[bot]

@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.

https://github.com/user-attachments/assets/369df260-5c27-4945-8e65-94e24b738fcb

Krishna2323 avatar Dec 09 '24 10:12 Krishna2323

@shawnborton @dubielzyk-expensify @dannymcclain, could you please check the comment above๐Ÿ™๐Ÿป? I think Expensify/design tag isn't working?

Krishna2323 avatar Dec 10 '24 13:12 Krishna2323

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 avatar Dec 10 '24 14:12 dannymcclain

Just realized a video would probably be more clear:

https://github.com/user-attachments/assets/1dd15ce1-9c00-4105-a513-a1bc23db5ad2

dannymcclain avatar Dec 10 '24 14:12 dannymcclain

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.

shawnborton avatar Dec 10 '24 14:12 shawnborton

Agree with the designers ๐Ÿ‘

dubielzyk-expensify avatar Dec 11 '24 03:12 dubielzyk-expensify

@Expensify/design, does this look correct now?

https://github.com/user-attachments/assets/b9efa0ef-bbca-407a-afaa-efcf1236aafa

Krishna2323 avatar Dec 11 '24 04:12 Krishna2323

Looks right to me ๐Ÿ‘

dubielzyk-expensify avatar Dec 11 '24 05:12 dubielzyk-expensify

Yeah that looks right to me too ๐Ÿ‘

dannymcclain avatar Dec 11 '24 14:12 dannymcclain

Yup, looks good to me three!

shawnborton avatar Dec 11 '24 18:12 shawnborton

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

Krishna2323 avatar Dec 12 '24 06:12 Krishna2323

@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.

https://github.com/user-attachments/assets/dd8c5fcd-7d8d-4953-9bff-a0910e3f1914

Krishna2323 avatar Dec 12 '24 08:12 Krishna2323

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

Krishna2323 avatar Dec 12 '24 08:12 Krishna2323

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?

shawnborton avatar Dec 12 '24 14:12 shawnborton

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

dannymcclain avatar Dec 12 '24 14:12 dannymcclain

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.

dubielzyk-expensify avatar Dec 13 '24 05:12 dubielzyk-expensify

@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.

Krishna2323 avatar Dec 14 '24 09:12 Krishna2323

@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.

suneox avatar Dec 14 '24 11:12 suneox

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

Krishna2323 avatar Dec 15 '24 05:12 Krishna2323

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. For all other tasks (author is not Concierge), both the author and the assignee can update the task title, description, and completion status.

@Krishna2323 just wanted to confirm, the idea here is to make a global change to have tasks work for everyone, not just the Concierge user. Let me know if that is your understanding now too.

shawnborton avatar Dec 16 '24 13:12 shawnborton

just wanted to confirm, the idea here is to make a global change to have tasks work for everyone, not just the Concierge user. Let me know if that is your understanding now too.

  • The goal of the PR is to prevent users from modifying the task title and description for Concierge tasks. All other task will behave the same -- Users can modify the task title and description and assignee & author can mark the task as complete/incomplete.

Krishna2323 avatar Dec 16 '24 13:12 Krishna2323

Hmm that's not what we intended as far as I know. The goal here is to make this change for all tasks, regardless of user.

Cc @Expensify/design @puneetlath can you please confirm?

shawnborton avatar Dec 16 '24 13:12 shawnborton

@Krishna2323 please review this from the original issue:

CleanShot 2024-12-16 at 08 46 33@2x

shawnborton avatar Dec 16 '24 13:12 shawnborton

@shawnborton I believe we are making changes based on the confirmation below. However, I may be mistaken. Could you also please take a look, @thienlnam?

Monosnap Make all task titles:descriptions read-only to all but the author ยท Issue #52979 ยท Expensify:App 2024-12-16 19-20-18

image

Krishna2323 avatar Dec 16 '24 13:12 Krishna2323

The goal here is to make this change for all tasks, regardless of user. Cc @Expensify/design @puneetlath can you please confirm?

To be honest I'm not sure where we landed. I'm personally for making it a global change, but I think some people in Slack wanted to just do it with Concierge tasks. But with certain onboarding tasks moving to the #admins room and coming from a set up specialist, I think it makes much more sense to apply this globally.

dannymcclain avatar Dec 16 '24 14:12 dannymcclain

Let's make the change globally please @Krishna2323 - I am fairly certain that was the original intention. @quinthar and @puneetlath can confirm.

shawnborton avatar Dec 16 '24 14:12 shawnborton

Okay, thanks for confirming. Will update this today.

Krishna2323 avatar Dec 16 '24 14:12 Krishna2323

@shawnborton is this going to be an option setting like you mocked up below, or are we just going to start with it being how tasks work more generally?

CleanShot 2024-12-16 at 08 16 03@2x

dannymcclain avatar Dec 16 '24 14:12 dannymcclain

The idea is to just change the edibility for all tasks globally so that only the task author can edit the task title and description - no need for a toggle or anything like that.

shawnborton avatar Dec 16 '24 14:12 shawnborton