Add default description for Workspace by narefyev91 · Pull Request #38487 · Expensify/App

narefyev91 · 2024-03-18T15:58:58Z

Details

Add default description to Workspace and make changes for Invite member flow

Fixed Issues

$ #38268
PROPOSAL:

Tests

Create or open any existed workspace profile page
Verify that default description is this one - "You have been invited to %workspaceName%! Download the Expensify mobile app at use.expensify.com/download to start tracking your expenses."
Open edit description - verify that the same description is shown
Go to Members flow -> invite one user -> click next -> verify that invite message is default one from Description
Change description to anything else (add/remove something) -> Invite user -> Go to Workspace profile -> Verify that description is not changed
Do item 4 again -> Verify that description still shown from Workspace profile

Verify that no errors appear in the JS console

Offline tests

Create or open any existed workspace profile page
Verify that default description is this one - "You have been invited to %workspaceName%! Download the Expensify mobile app at use.expensify.com/download to start tracking your expenses."
Open edit description - verify that the same description is shown
Go to Members flow -> invite one user -> click next -> verify that invite message is default one from Description
Change description to anything else (add/remove something) -> Invite user -> Go to Workspace profile -> Verify that description is not changed
Do item 4 again -> Verify that description still shown from Workspace profile

QA Steps

Create or open any existed workspace profile page
Verify that default description is this one - "You have been invited to %workspaceName%! Download the Expensify mobile app at use.expensify.com/download to start tracking your expenses."
Open edit description - verify that the same description is shown
Go to Members flow -> invite one user -> click next -> verify that invite message is default one from Description
Change description to anything else (add/remove something) -> Invite user -> Go to Workspace profile -> Verify that description is not changed
Do item 4 again -> Verify that description still shown from Workspace profile

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-03-18T15:59:03Z

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

narefyev91 · 2024-03-18T17:14:40Z

cc @luacmartins

src/pages/workspace/WorkspaceProfileDescriptionPage.tsx

src/pages/workspace/WorkspaceProfilePage.tsx

getusha · 2024-03-19T13:16:52Z

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-03-19.at.6.38.21.in.the.evening.mov

Android: mWeb Chrome

Screen.Recording.2024-03-19.at.5.29.27.in.the.afternoon.mov

iOS: Native

Screen.Recording.2024-03-19.at.6.35.55.in.the.evening.mov

iOS: mWeb Safari

Screen.Recording.2024-03-19.at.6.15.10.in.the.evening.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-19.at.5.12.27.in.the.afternoon.mov

MacOS: Desktop

Screen.Recording.2024-03-19.at.6.44.22.in.the.evening.mov

getusha · 2024-03-19T14:32:15Z

@luacmartins @narefyev91 just to confirm if this is expected. the default description is converted to markdown only after saving it or on invite page.

Screen.Recording.2024-03-19.at.5.15.46.in.the.afternoon.mov

narefyev91 · 2024-03-19T14:44:34Z

@luacmartins @narefyev91 just to confirm if this is expected. the default description is converted to markdown only after saving it or on invite page.

Screen.Recording.2024-03-19.at.5.15.46.in.the.afternoon.mov

Fixed!

luacmartins · 2024-03-19T15:00:40Z

@narefyev91 TS errors

narefyev91 · 2024-03-19T15:02:02Z

@narefyev91 TS errors

Error: src/pages/EnablePayments/OnfidoStep.tsx(6,1): error TS2578: Unused '@ts-expect-error' directive.
Error: src/pages/EnablePayments/OnfidoStep.tsx(69,25): error TS2322: Type 'string | undefined' is not assignable to type 'string'.
Not related to current code

getusha · 2024-03-19T15:02:53Z

Will be fixed once #38596 is merged.

getusha

@narefyev91 #38596 is merged, lets pull main one more time.

luacmartins · 2024-03-19T18:52:56Z

Failing TS checks are on unrelated files and those have been fixed on main. I'm gonna merge this PR to get this out of the door sooner.

melvin-bot · 2024-03-19T18:53:08Z

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

luacmartins · 2024-03-19T18:53:11Z

See comment above

OSBotify · 2024-03-19T18:58:48Z

✋ 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-03-19T23:51:43Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.55-0 🚀

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

OSBotify · 2024-03-20T00:52:18Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.55-0 🚀

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

OSBotify · 2024-03-22T16:11:04Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.55-3 🚀

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

mkhutornyi · 2024-07-29T05:40:09Z

src/pages/workspace/WorkspaceInviteMessagePage.tsx

    useEffect(() => {
        if (!isEmptyObject(invitedEmailsToAccountIDsDraft)) {
-            setWelcomeNote(getDefaultWelcomeNote());
+            setWelcomeNote(parser.htmlToMarkdown(getDefaultWelcomeNote()));


Changes in this file caused regression.
More details about the root cause: #42668 (comment)

Add default description for Workspace

ec142de

narefyev91 requested a review from a team as a code owner March 18, 2024 15:58

melvin-bot bot requested review from getusha and removed request for a team March 18, 2024 15:59

narefyev91 added 2 commits March 18, 2024 18:24

update optional checks and add description from policy to invite flow

a635c74

fix markdown

11916b5

luacmartins self-requested a review March 18, 2024 18:40

luacmartins requested changes Mar 18, 2024

View reviewed changes

src/pages/workspace/WorkspaceProfileDescriptionPage.tsx Outdated Show resolved Hide resolved

src/pages/workspace/WorkspaceProfilePage.tsx Show resolved Hide resolved

update optional checks

30739ac

use markdown for default

2640d95

luacmartins approved these changes Mar 19, 2024

View reviewed changes

Merge branch 'main' into add-generic-invite-description-for-workspace

5ff76af

getusha approved these changes Mar 19, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins March 19, 2024 15:53

luacmartins approved these changes Mar 19, 2024

View reviewed changes

luacmartins merged commit 5ab8d8d into Expensify:main Mar 19, 2024

melvin-bot bot added the Emergency label Mar 19, 2024

luacmartins removed the Emergency label Mar 19, 2024

github-actions bot mentioned this pull request Mar 19, 2024

Deploy Checklist: New Expensify 2024-03-19 #38651

Closed

66 tasks

melvin-bot bot mentioned this pull request Mar 22, 2024

[HOLD for payment 2024-03-29] [Simplified Collect][Profile] Implement default description and invite messages #38268

Closed

mkhutornyi reviewed Jul 29, 2024

View reviewed changes

mkhutornyi mentioned this pull request Jul 29, 2024

[HOLD for payment 2024-07-26] [$250] Android - Workspace- WS invite message shows html message briefly #42668

Closed

6 tasks

Conversation

narefyev91 commented Mar 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 18, 2024

Uh oh!

narefyev91 commented Mar 18, 2024

Uh oh!

Uh oh!

Uh oh!

getusha commented Mar 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

getusha commented Mar 19, 2024

Uh oh!

narefyev91 commented Mar 19, 2024

Uh oh!

luacmartins commented Mar 19, 2024

Uh oh!

narefyev91 commented Mar 19, 2024

Uh oh!

getusha commented Mar 19, 2024

Uh oh!

getusha left a comment

Choose a reason for hiding this comment

Uh oh!

luacmartins commented Mar 19, 2024

Uh oh!

melvin-bot bot commented Mar 19, 2024

Uh oh!

luacmartins commented Mar 19, 2024

Uh oh!

OSBotify commented Mar 19, 2024

Uh oh!

OSBotify commented Mar 19, 2024

Uh oh!

OSBotify commented Mar 20, 2024

Uh oh!

OSBotify commented Mar 22, 2024

Uh oh!

mkhutornyi Jul 29, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

narefyev91 commented Mar 18, 2024 •

edited

Loading

getusha commented Mar 19, 2024 •

edited

Loading