[CP Staging] Fix workspace description shows as HTML in workspace invite message page #45745

bernhardoj · 2024-07-19T05:17:43Z

Details

A workspace description can be an HTML, but we don't convert it to markdown in WS invite message page.

Fixed Issues

$ #45740
$ #42668
PROPOSAL:

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Open a workspace profile page
Update the description to contain markdown or emojis
Open Members > Invite members
Select any member and proceed to the next page
Verify the invite message doesn't show HTML

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

android.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-07-19T05:17:48Z

@mkhutornyi 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-07-19T05:19:05Z

src/pages/workspace/WorkspaceInviteMessagePage.tsx

@@ -83,7 +84,7 @@ function WorkspaceInviteMessagePage({
        workspaceInviteMessageDraft ||
        // policy?.description can be an empty string
        // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
-        policy?.description ||
+        Parser.htmlToMarkdown(policy?.description ?? '') ||


We got an issue where an HTML is shown in the invite message page. This happens when you set the workspace description with a markdown. The description is saved as HTML, so we need to convert it back to markdown.

Before our PR, we covert the HTML to markdown in

App/src/pages/workspace/WorkspaceInviteMessagePage.tsx

Lines 92 to 94 in 3d465c3

if (!isEmptyObject(invitedEmailsToAccountIDsDraft)) {

setWelcomeNote(getDefaultWelcomeNote());

return;

but that has its flaw too because it will convert the message draft HTML to markdown. For example, if user type <b>test</b>, go back and reopen the page, they will see *b*.

So, what we did already correct, but we missed moving the htmlToMarkdown to the workspace description.

trjExpensify · 2024-07-19T13:00:58Z

This is labelled as a deploy blocker, getting a volunteer on it right away.

shubham1206agra · 2024-07-19T13:02:35Z

@bernhardoj Can you merge main please?

…nvite-page

bernhardoj · 2024-07-19T13:08:13Z

Done

shubham1206agra · 2024-07-19T13:09:15Z

Looks like inviting member flow is broken in BE. But I think the user will get the correct message looking from response.

{
    "code": 666,
    "jsonCode": 666,
    "type": "Expensify\\Libs\\Error\\ExpError",
    "UUID": "b4ed6825-5fa3-4cbb-9575-434f490494c6",
    "message": "There was a problem sending your workspace invite.",
    "title": "An unknown problem ocurred",
    "data": {
        "welcomeNote": "<h1>Shubham Agrawal invited you to Work.sa1206+sdm3&#x27;s Workspace 1<\/h1><br \/><h1>Test<\/h1><br \/>This is a test. <emoji>\ud83d\ude28<\/emoji> <strong>bruh<\/strong>",
        "inviteFlow": "modifyEmployees"
    },
    "htmlMessage": "",
    "onyxData": [],
    "requestID": "8a5aeff65942a3b1-AMD"
}

bernhardoj · 2024-07-19T13:10:33Z

@shubham1206agra yeah, I got that error too. You need to rename the workspace to make it work as a workaround.

shubham1206agra · 2024-07-19T13:12:46Z

@shubham1206agra yeah, I got that error too. You need to rename the workspace to make it work as a workaround.

@bernhardoj Still not working.

bernhardoj · 2024-07-19T13:15:23Z

Hmm, that's weird. I renamed "Bernhard.josephus's Workspace 69" to "asd" and it works.

bernhardoj · 2024-07-19T13:17:36Z

Looks like if you have a dot (.) in the name, then the BE will throw an error.

shubham1206agra · 2024-07-19T13:17:36Z

Hmm, that's weird. I renamed "Bernhard.josephus's Workspace 69" to "asd" and it works.

Now it worked.

shubham1206agra · 2024-07-19T13:38:15Z

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

Android: mWeb Chrome

Screen.Recording.2024-07-19.at.6.51.18.PM.mov

iOS: Native

Screen.Recording.2024-07-19.at.7.06.04.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-07-19.at.6.45.17.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-19.at.6.43.07.PM.mov

MacOS: Desktop

Screen.Recording.2024-07-19.at.6.56.07.PM.mov

mountiny

Thanks, moving this ahead as its a last blocker

OSBotify · 2024-07-19T16:34:46Z

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

…d-to-html-in-ws-invite-page [CP Staging] Fix workspace description shows as HTML in workspace invite message page (cherry picked from commit f69f858)

OSBotify · 2024-07-19T17:11:23Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.9-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-19T19:39:46Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.9-5 🚀

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

OSBotify · 2024-07-19T20:15:45Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.10-2 🚀

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

OSBotify · 2024-07-23T08:07:07Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.10-7 🚀

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

convert policy description to markdown

90a7c5f

bernhardoj requested a review from a team as a code owner July 19, 2024 05:17

melvin-bot bot removed the request for review from a team July 19, 2024 05:17

melvin-bot bot requested a review from mkhutornyi July 19, 2024 05:17

bernhardoj mentioned this pull request Jul 19, 2024

[HOLD for payment 2024-07-26] mWeb - Workspace - With emoji as workspace description showing error while inviting members #45740

Closed

6 tasks

bernhardoj commented Jul 19, 2024

View reviewed changes

trjExpensify requested review from shubham1206agra and removed request for mkhutornyi July 19, 2024 13:00

Merge branch 'main' into fix/45740-markdown-converted-to-html-in-ws-i…

4cdcefa

…nvite-page

shubham1206agra approved these changes Jul 19, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham July 19, 2024 13:38

mountiny assigned bernhardoj Jul 19, 2024

mountiny changed the title ~~Fix workspace description shows as HTML in workspace invite message page~~ [CP Staging] Fix workspace description shows as HTML in workspace invite message page Jul 19, 2024

mountiny approved these changes Jul 19, 2024

View reviewed changes

mountiny merged commit f69f858 into Expensify:main Jul 19, 2024
16 checks passed

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

Deploy Checklist: New Expensify 2024-07-18 #45680

Closed

61 tasks

melvin-bot bot mentioned this pull request Jul 19, 2024

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

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Fix workspace description shows as HTML in workspace invite message page #45745

[CP Staging] Fix workspace description shows as HTML in workspace invite message page #45745

bernhardoj commented Jul 19, 2024 •

edited

Loading

melvin-bot bot commented Jul 19, 2024

bernhardoj Jul 19, 2024

bernhardoj Jul 19, 2024

trjExpensify commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024

bernhardoj commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024 •

edited

Loading

bernhardoj commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024

bernhardoj commented Jul 19, 2024

bernhardoj commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024

mountiny left a comment

OSBotify commented Jul 19, 2024

OSBotify commented Jul 19, 2024

OSBotify commented Jul 19, 2024

OSBotify commented Jul 19, 2024

OSBotify commented Jul 23, 2024

	if (!isEmptyObject(invitedEmailsToAccountIDsDraft)) {
	setWelcomeNote(getDefaultWelcomeNote());
	return;

[CP Staging] Fix workspace description shows as HTML in workspace invite message page #45745

[CP Staging] Fix workspace description shows as HTML in workspace invite message page #45745

Conversation

bernhardoj commented Jul 19, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 19, 2024

bernhardoj Jul 19, 2024

Choose a reason for hiding this comment

bernhardoj Jul 19, 2024

Choose a reason for hiding this comment

trjExpensify commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024

bernhardoj commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024 • edited Loading

bernhardoj commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024

bernhardoj commented Jul 19, 2024

bernhardoj commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024

shubham1206agra commented Jul 19, 2024

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 19, 2024

OSBotify commented Jul 19, 2024

OSBotify commented Jul 19, 2024

OSBotify commented Jul 19, 2024

OSBotify commented Jul 23, 2024

bernhardoj commented Jul 19, 2024 •

edited

Loading

shubham1206agra commented Jul 19, 2024 •

edited

Loading