32864 md syntax create task by suneox · Pull Request #33428 · Expensify/App

suneox · 2023-12-21T16:42:05Z

Details

Fixed Issues

$ #32864
PROPOSAL: #32864 (comment)

Tests

Open any chat
Typing a message with rule start with [] then mention a user has a chat by @ character then type a title is required

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open any chat
Typing a message with rule start with [] then mention a user has a chat by @ character then type a title is required

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 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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

web-safafi.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2023-12-21T16:42:10Z

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

Ollyws · 2024-01-05T11:17:56Z

@thienlnam Do we also want this functionality for the edit message composer?

suneox · 2024-01-05T12:07:24Z

Currently, a text message and a task are different types, and the API calls are also different so first we have to check the BE ability.
Due to the scope for this issue (based on the description) being only to create a task so I think when BE API is ready we will implement it on another ticket

thienlnam · 2024-01-08T02:37:31Z

@thienlnam Do we also want this functionality for the edit message composer?

We can skip this for now since it's more of an edge case that you would edit an existing message to add a task

Ollyws · 2024-01-08T15:07:41Z

Just an observation:
If we use a @mention that is not a valid email (i.e [] @you testtitle) it will be added as part of the title.
I think this is fine but alternatively we could strip the @mention.

Ollyws · 2024-01-08T15:21:14Z

src/pages/home/ReportScreen.js

+                    }
+                    Task.createTaskAndNavigate(getReportID(route), title, '', assignee.login, assignee.accountID, assignee.assigneeChatReport, report.policyID);
+                } else {
+                    Report.addComment(getReportID(route), text);


Is there a way we could avoid repeating Report.addComment?

sure we just remove the elsewhere condition and return at Task.createTaskAndNavigate, let me update now

I have cleanup a condition to call Report.addComment

Ollyws · 2024-01-08T16:35:40Z

src/pages/home/ReportScreen.js

    const onSubmitComment = useCallback(
        (text) => {
-            Report.addComment(getReportID(route), text);
+            const isHandled = handleCreateTask(text);


Suggested change

const isHandled = handleCreateTask(text);

const isTaskCreated = handleCreateTask(text);

I have updated

Ollyws · 2024-01-09T11:24:03Z

@suneox Thanks for the updates! We have some conflicts that need to be resolved.

…ate-task

suneox · 2024-01-09T14:26:08Z

@suneox Thanks for the updates! We have some conflicts that need to be resolved.

I have resolved conflicts

Ollyws · 2024-01-09T14:57:32Z

src/pages/home/ReportScreen.js

        (text) => {
-            Report.addComment(getReportID(route), text);
+            const isTaskCreated = handleCreateTask(text);
+            if (!isTaskCreated) {


I think we can have an early return here now since the below code was removed.

i have updated

Ollyws · 2024-01-09T15:34:09Z

@suneox I've noticed that since that last conflict resultion, it doesn't scroll to the bottom when creating a task.

Screen.Recording.2024-01-09.at.15.31.47.mov

suneox · 2024-01-09T16:01:27Z

@suneox I've noticed that since that last conflict resultion, it doesn't scroll to the bottom when creating a task.

I think it's a regression from another ticket to remove the logic auto scroll to the bottom because currently it also happens when creating a task from the composer action

Screen.Recording.2024-01-09.at.22.56.49.mov

Ollyws · 2024-01-09T16:08:09Z

Yeah seems out of scope here, just thought I'd bring it up.

Ollyws · 2024-01-09T16:11:47Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

01_Android_Native.mp4

Android: mWeb Chrome

02_Android_Chrome.mp4

iOS: Native

03_iOS_Native.mp4

iOS: mWeb Safari

04_iOS_Safari.mp4

MacOS: Chrome / Safari

05_MacOS_Chrome.mp4

MacOS: Desktop

06_MacOS_Desktop.mp4

Ollyws

LGTM.
Let me know if you disagree with #33428 (comment) @thienlnam

thienlnam · 2024-01-10T02:59:11Z

Looks good thanks!

Just an observation:
If we use a @mention that is not a valid email (i.e [] @you testtitle) it will be added as part of the title.
I think this is fine but alternatively we could strip the @mention.

Yeah this is not a bad idea - though let's try this out in the wild first and see what the responses are. I think it's still possible we might have people using @ in task titles so we don't want to rule that out yet

OSBotify · 2024-01-10T03:03:40Z

✋ 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-01-10T06:20:50Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.4.24-0 🚀

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

OSBotify · 2024-01-11T08:52:30Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.24-3 🚀

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

suneox added 3 commits December 21, 2023 13:01

Expensify#32864 md syntax create task

118dd2d

Expensify#32864 validate email is valid

82b6560

markdown task replace multiple line

a4b21b6

suneox requested a review from a team as a code owner December 21, 2023 16:42

melvin-bot bot requested review from Ollyws and removed request for a team December 21, 2023 16:42

update lint code, prettier

a47ba92

suneox mentioned this pull request Dec 21, 2023

[HOLD for payment 2024-01-18] [$500] Add markdown syntax for creating a new task #32864

Closed

update code lint

06829c8

Ollyws reviewed Jan 8, 2024

View reviewed changes

suneox added 2 commits January 8, 2024 23:18

32864 cleanup elsewhere condition

5d5fe53

32864 cleanup elsewhere condition

6c788e9

Ollyws reviewed Jan 8, 2024

View reviewed changes

update code review

b5f09b6

Merge remote-tracking branch 'upstream/main' into 32864-md-syntax-cre…

239cdef

…ate-task

Ollyws reviewed Jan 9, 2024

View reviewed changes

update early condition

d8dc8d4

Ollyws approved these changes Jan 9, 2024

View reviewed changes

melvin-bot bot requested a review from thienlnam January 9, 2024 16:37

thienlnam approved these changes Jan 10, 2024

View reviewed changes

thienlnam merged commit b849ce7 into Expensify:main Jan 10, 2024

github-actions bot mentioned this pull request Jan 10, 2024

Deploy Checklist: New Expensify 2024-01-10 #34203

Closed

54 tasks

lanitochka17 mentioned this pull request Jan 10, 2024

Task - Error shows up when creating task via [] @mention <task name> pathway #34250

Closed

6 tasks

VickyStash mentioned this pull request Mar 7, 2024

[TS migration] Migrate 'Report' page to TypeScript #35566

Merged

50 tasks

	const isHandled = handleCreateTask(text);
	const isTaskCreated = handleCreateTask(text);

Conversation

suneox commented Dec 21, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Dec 21, 2023

Uh oh!

Ollyws commented Jan 5, 2024

Uh oh!

suneox commented Jan 5, 2024

Uh oh!

thienlnam commented Jan 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ollyws commented Jan 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ollyws Jan 8, 2024

Choose a reason for hiding this comment

Uh oh!

suneox Jan 8, 2024

Choose a reason for hiding this comment

Uh oh!

suneox Jan 8, 2024

Choose a reason for hiding this comment

Uh oh!

Ollyws Jan 8, 2024

Choose a reason for hiding this comment

Uh oh!

suneox Jan 8, 2024

Choose a reason for hiding this comment

Uh oh!

Ollyws commented Jan 9, 2024

Uh oh!

suneox commented Jan 9, 2024

Uh oh!

Ollyws Jan 9, 2024

Choose a reason for hiding this comment

Uh oh!

suneox Jan 9, 2024

Choose a reason for hiding this comment

Uh oh!

Ollyws commented Jan 9, 2024

Uh oh!

suneox commented Jan 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ollyws commented Jan 9, 2024

Uh oh!

Ollyws commented Jan 9, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

Ollyws left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thienlnam commented Jan 10, 2024

Uh oh!

OSBotify commented Jan 10, 2024

Uh oh!

OSBotify commented Jan 10, 2024

Uh oh!

OSBotify commented Jan 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

thienlnam commented Jan 8, 2024 •

edited

Loading

Ollyws commented Jan 8, 2024 •

edited

Loading

suneox commented Jan 9, 2024 •

edited

Loading

Ollyws left a comment •

edited

Loading