Improve onboarding task description and replies #41096

rezkiy37 · 2024-04-26T13:01:37Z

Details

The PR improves onboarding task views:

Subtitle and instruction comments have been combined into a task description.
Omited task action replies.

Fixed Issues

$ #40998
PROPOSAL: N/A

Tests

Note: you can run the flow as many times as you want by adding a test button into TestToolMenu.tsx.

Details

<TestToolRow title="Onboarding Flow">
    <Button
        small
        text="Navigate"
        onPress={() => {
            Navigation.dismissModal();
            Navigation.navigate(ROUTES.ONBOARDING_PURPOSE);
        }}
    />
</TestToolRow>

Open the app with an entire new user.
Complete the onboarding flow.
Verify that the app has generated the proper messages.
Verify that task actions don't have replies.
Click on a task action.
Verify that the task has a description.
Verify that the description is formatted and renders bold text and links properly.
Verify that the task does not have any actions, except the "marked as completed" for the "create a workspace" case.

Verify that no errors appear in the JS console

Offline tests

Same as "Tests".

QA Steps

Same as "Tests".

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

Android.Chrome.mp4

iOS: Native

IOS.mp4

iOS: mWeb Safari

IOS.Safari.mp4

MacOS: Chrome / Safari

Chrome.mp4

MacOS: Desktop

Desktop.mp4

melvin-bot · 2024-04-26T13:38:58Z

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

rayane-djouah · 2024-04-26T16:58:58Z

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

Screen.Recording.2024-04-26.at.7.44.22.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-04-26.at.7.41.52.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-04-26.at.18.40.32.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-04-26.at.18.33.21.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-04-26.at.6.24.19.PM.mov

MacOS: Desktop

Screen.Recording.2024-04-26.at.6.30.40.PM.mov

melvin-bot · 2024-04-26T18:17:37Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #40998 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

srikarparsi · 2024-04-26T19:22:27Z

Un-assigning you @rushatgabhane since @rayane-djouah took care of it.

srikarparsi · 2024-04-26T19:26:45Z

Code looks good to me, testing it out.

srikarparsi

lgtm, see that it's on hold

francoisl · 2024-04-26T22:08:54Z

src/CONST.ts

-                    subtitle: '<strong>Create a workspace</strong> to track expenses, scan receipts, chat, and more.',
-                    message:
+                    description:
+                        '<strong>Create a workspace</strong> to track expenses, scan receipts, chat, and more.\n' +


Not sure it really matters since it works as it is and people have no real reason to edit the description, but it appears that we block from using HTML tags when manually setting a task description.

Whereas markdown syntax is allowed and also rendered correctly

I think this is a good point. @rezkiy37 @rayane-djouah do you think we could look into fixing this?

Yeah, we can use markdown (* instead of <strong> html tag) in all messages

rayane-djouah · 2024-04-29T16:31:56Z

@waterim, any idea on why this PR is marked on hold? Asking you because it seems that @rezkiy37 is OOO this week.

trjExpensify · 2024-04-29T18:05:27Z

@waterim, any idea on why this PR is marked on hold? Asking you because it seems that @rezkiy37 is OOO this week.

Yeah, we have an Auth PR that's merged, but needs to get deployed before we can hit the merge button on this one. I've updated the title for clarity.

trjExpensify · 2024-04-30T12:30:19Z

Auth PR deployed to production, removing the hold. This should be able to be merged.

francoisl · 2024-05-01T00:36:10Z

Fixed the conflict, the TRACK option has been removed in #41354. Going to do a final review and merge.
We can change the messages to use markdown in a follow-up PR, it's not breaking anything.

OSBotify · 2024-05-01T01:02:24Z

✋ 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 · 2024-05-01T03:02:13Z

🚀 Deployed to staging by https://github.com/francoisl in version: 1.4.69-0 🚀

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

OSBotify · 2024-05-02T13:05:48Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.69-2 🚀

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

rezkiy37 added 4 commits April 26, 2024 14:54

omit replies config

8aed339

move comments to task description

042c9a8

create hasURL

65bdee1

integrate hasURL

857433f

rezkiy37 marked this pull request as ready for review April 26, 2024 13:38

rezkiy37 requested a review from a team as a code owner April 26, 2024 13:38

melvin-bot bot removed the request for review from a team April 26, 2024 13:38

melvin-bot bot requested a review from rushatgabhane April 26, 2024 13:38

rezkiy37 mentioned this pull request Apr 26, 2024

[HOLD for payment 2024-05-09] [$250] [Guided Setup Stage 2] Put the threaded messages in the task description instead #40998

Closed

rezkiy37 changed the title ~~Improve onboarding task description and replies~~ [HOLD] Improve onboarding task description and replies Apr 26, 2024

trjExpensify requested a review from rayane-djouah April 26, 2024 16:56

rayane-djouah approved these changes Apr 26, 2024

View reviewed changes

melvin-bot bot requested a review from srikarparsi April 26, 2024 18:18

srikarparsi removed the request for review from rushatgabhane April 26, 2024 19:22

srikarparsi previously approved these changes Apr 26, 2024

View reviewed changes

francoisl reviewed Apr 26, 2024

View reviewed changes

trjExpensify changed the title ~~[HOLD] Improve onboarding task description and replies~~ [HOLD Auth PR #10708] Improve onboarding task description and replies Apr 29, 2024

trjExpensify changed the title ~~[HOLD Auth PR #10708] Improve onboarding task description and replies~~ Improve onboarding task description and replies Apr 30, 2024

Merge branch 'main' into feature/40998-improve-task-replies

8eab7df

francoisl dismissed srikarparsi’s stale review via 8eab7df May 1, 2024 00:34

francoisl approved these changes May 1, 2024

View reviewed changes

francoisl merged commit e665d5c into Expensify:main May 1, 2024
16 checks passed

github-actions bot mentioned this pull request May 1, 2024

Deploy Checklist: New Expensify 2024-05-01 #41376

Closed

59 tasks

francoisl mentioned this pull request May 1, 2024

[HOLD for payment 2024-05-09] Mark Down - Mark down doesn't work for task description after saving #41422

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve onboarding task description and replies #41096

Improve onboarding task description and replies #41096

rezkiy37 commented Apr 26, 2024 •

edited

Loading

melvin-bot bot commented Apr 26, 2024

rayane-djouah commented Apr 26, 2024 •

edited

Loading

melvin-bot bot commented Apr 26, 2024

srikarparsi commented Apr 26, 2024

srikarparsi commented Apr 26, 2024

srikarparsi left a comment •

edited

Loading

francoisl Apr 26, 2024 •

edited

Loading

srikarparsi Apr 30, 2024

rayane-djouah Apr 30, 2024 •

edited

Loading

rayane-djouah commented Apr 29, 2024 •

edited

Loading

trjExpensify commented Apr 29, 2024

trjExpensify commented Apr 30, 2024

francoisl commented May 1, 2024

OSBotify commented May 1, 2024

OSBotify commented May 1, 2024

OSBotify commented May 2, 2024

Improve onboarding task description and replies #41096

Improve onboarding task description and replies #41096

Conversation

rezkiy37 commented Apr 26, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 26, 2024

rayane-djouah commented Apr 26, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Apr 26, 2024

srikarparsi commented Apr 26, 2024

srikarparsi commented Apr 26, 2024

srikarparsi left a comment • edited Loading

Choose a reason for hiding this comment

francoisl Apr 26, 2024 • edited Loading

Choose a reason for hiding this comment

srikarparsi Apr 30, 2024

Choose a reason for hiding this comment

rayane-djouah Apr 30, 2024 • edited Loading

Choose a reason for hiding this comment

rayane-djouah commented Apr 29, 2024 • edited Loading

trjExpensify commented Apr 29, 2024

trjExpensify commented Apr 30, 2024

francoisl commented May 1, 2024

OSBotify commented May 1, 2024

OSBotify commented May 1, 2024

OSBotify commented May 2, 2024

rezkiy37 commented Apr 26, 2024 •

edited

Loading

rayane-djouah commented Apr 26, 2024 •

edited

Loading

srikarparsi left a comment •

edited

Loading

francoisl Apr 26, 2024 •

edited

Loading

rayane-djouah Apr 30, 2024 •

edited

Loading

rayane-djouah commented Apr 29, 2024 •

edited

Loading