Fix task assignee regex can't accept multi-level domains by bernhardoj · Pull Request #49685 · Expensify/App

bernhardoj · 2024-09-25T05:48:27Z

Details

When we create a task from the composer, it can't accept assignee email with multi-level domains (e.g., example@example.co.id).

Fixed Issues

$ #49454
PROPOSAL: #49454 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Open any chat
Enter a task markdown with an assignee with a multi-level domain, for example:

[] @example@example.co.id test

Verify the task title shown is test, not .id test

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

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-09-25T05:48:32Z

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

bernhardoj · 2024-09-25T05:48:49Z

Can't send a message on Android mWeb.

android.mweb.mp4

bernhardoj · 2024-09-25T05:50:46Z

src/pages/home/report/ReportFooter.tsx

             * Group 3: Title is remaining characters
             */
-            const taskRegex = /^\[\]\s+(?:@([^\s@]+(?:@\w+\.\w+)?))?\s*([\s\S]*)/;
+            const emailWithOptionalDomainRegex = /(?=((?=[\w'#%+-]+(?:\.[\w'#%+-]+)*@?)[\w\.'#%+-]{1,64}(?:@(?:(?=[a-z\d]+(?:-+[a-z\d]+)*\.)(?:[a-z\d-]{1,63}\.)+[a-z]{2,63}))?(?= |_|\b))(?<end>.*))\S{3,254}(?=\k<end>$)/


I decided to use the email regex from expensify-common. The only differences is the optional domain.

Oh, I just removed the unnecessary character because the linter asked to.

bernhardoj · 2024-09-25T06:01:34Z

I notice that if we create the task with a short mention, but our email is a public domain, the task will fail, for example:
my logged in email is: bernhard.josephus@gmail.com

[] @bernhard.josephus test

The current logic assumes that the current user is using a private domain email, but in this example, it's a public domain, so we send the API request without the domain as bernhard.josephus (instead of bernhard.josephus@gmail.com) which eventually fails. This happens in stg/prod too. What should we do if the short mention can't be "auto-completed" to a full mention because the user is in a public domain?

Don't create the task?
Treat the short mention as the title? (the title becomes @bernhard.josephus test)
Else?

Ollyws · 2024-09-26T11:10:20Z

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

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.
In response to #49685 (comment), that seems like a seperate issue but I my choice would be option 2, treat it as a title as that seems conruent with what we already do for [] some@thing title

iwiznia · 2024-09-26T14:51:06Z

my choice would be option 2, treat it as a title as that seems conruent with what we already do for [] some@thing title

Agree

bernhardoj · 2024-09-27T08:30:24Z

Done.

web.mp4

I don't have a private domain email, so I edit the code so it behaves as my email as a private domain.

web.mp4

iwiznia · 2024-09-27T12:16:57Z

src/pages/home/report/ReportFooter.tsx

             * Group 3: Title is remaining characters
             */
-            const taskRegex = /^\[\]\s+(?:@([^\s@]+(?:@\w+\.\w+)?))?\s*([\s\S]*)/;
+            const emailWithOptionalDomainRegex =


Can you add a comment here saying this is the same regex as the one in common but with domain removed please?

iwiznia · 2024-09-27T12:18:21Z

src/pages/home/report/ReportFooter.tsx


            const mention = match[1] ? match[1].trim() : undefined;
-            const mentionWithDomain = ReportUtils.addDomainToShortMention(mention ?? '') ?? mention;
+            const mentionWithDomain = ReportUtils.addDomainToShortMention(mention ?? '') ?? mention ?? '';


Goes along with the suggestion in line 146

Suggested change

const mentionWithDomain = ReportUtils.addDomainToShortMention(mention ?? '') ?? mention ?? '';

const mentionWithDomain = ReportUtils.addDomainToShortMention(mention) ?? mention;

iwiznia · 2024-09-27T12:19:21Z

src/pages/home/report/ReportFooter.tsx

                return false;
            }

            const mention = match[1] ? match[1].trim() : undefined;


Better to set the default you want rather than the "wrong" default, only to add it later (in line 147).

Suggested change

const mention = match[1] ? match[1].trim() : undefined;

const mention = match[1] ? match[1].trim() : '';

bernhardoj · 2024-09-28T04:13:25Z

@iwiznia addressed them all

iwiznia · 2024-09-30T13:33:55Z

Prettier check failed

bernhardoj · 2024-09-30T14:35:55Z

@iwiznia done

melvin-bot · 2024-09-30T15:56:43Z

@iwiznia looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

iwiznia · 2024-09-30T16:00:47Z

Tests were passing when merged.

OSBotify · 2024-09-30T16:08:13Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-09-30T22:57:38Z

🚀 Deployed to staging by https://github.com/iwiznia in version: 9.0.42-0 🚀

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

github-actions · 2024-10-02T00:20:29Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.42-3 🚀

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

fix assignee regex can't accept multiple domains

d7c33cd

bernhardoj requested a review from a team as a code owner September 25, 2024 05:48

melvin-bot bot requested review from Ollyws and removed request for a team September 25, 2024 05:48

bernhardoj commented Sep 25, 2024

View reviewed changes

bernhardoj added 2 commits September 25, 2024 13:53

prettier

6f7ab10

remove unnecessary escape character

fb32c16

Ollyws approved these changes Sep 26, 2024

View reviewed changes

melvin-bot bot requested a review from iwiznia September 26, 2024 11:14

bernhardoj added 2 commits September 27, 2024 15:58

Merge branch 'main' into fix/49454-task-assignee-regex

b343464

prevent creating task with an invalid assignee

5e39907

iwiznia requested changes Sep 27, 2024

View reviewed changes

bernhardoj added 4 commits September 28, 2024 11:59

Merge branch 'main' into fix/49454-task-assignee-regex

0e390ab

add the default value early

6e0410f

only add the invalid mention as title if it's not empty

70e390d

add comment

5147c37

iwiznia approved these changes Sep 30, 2024

View reviewed changes

Merge branch 'main' into fix/49454-task-assignee-regex

6ed09b9

iwiznia merged commit 0e39ff9 into Expensify:main Sep 30, 2024

melvin-bot bot added the Emergency label Sep 30, 2024

github-actions bot mentioned this pull request Sep 30, 2024

Deploy Checklist: New Expensify 2024-09-30 #49960

Closed

49 tasks

Ollyws mentioned this pull request Oct 9, 2024

Enable creating tasks with short-mentions using the create task commands #39475

Merged

50 tasks

	const mentionWithDomain = ReportUtils.addDomainToShortMention(mention ?? '') ?? mention ?? '';
	const mentionWithDomain = ReportUtils.addDomainToShortMention(mention) ?? mention;

	const mention = match[1] ? match[1].trim() : undefined;
	const mention = match[1] ? match[1].trim() : '';

Conversation

bernhardoj commented Sep 25, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Sep 25, 2024

Uh oh!

bernhardoj commented Sep 25, 2024

Uh oh!

bernhardoj Sep 25, 2024

Choose a reason for hiding this comment

Uh oh!

bernhardoj Sep 25, 2024

Choose a reason for hiding this comment

Uh oh!

bernhardoj commented Sep 25, 2024

Uh oh!

Ollyws commented Sep 26, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

Ollyws left a comment

Choose a reason for hiding this comment

Uh oh!

iwiznia commented Sep 26, 2024

Uh oh!

bernhardoj commented Sep 27, 2024

Uh oh!

iwiznia Sep 27, 2024

Choose a reason for hiding this comment

Uh oh!

iwiznia Sep 27, 2024 • 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!

iwiznia Sep 27, 2024

Choose a reason for hiding this comment

Uh oh!

bernhardoj commented Sep 28, 2024

Uh oh!

iwiznia commented Sep 30, 2024

Uh oh!

bernhardoj commented Sep 30, 2024

Uh oh!

melvin-bot bot commented Sep 30, 2024

Uh oh!

iwiznia commented Sep 30, 2024

Uh oh!

OSBotify commented Sep 30, 2024

Uh oh!

github-actions bot commented Sep 30, 2024

Uh oh!

github-actions bot commented Oct 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iwiznia Sep 27, 2024 •

edited

Loading