Add workspace description #36058

esh-g · 2024-02-07T18:41:52Z

Details

Fixed Issues

$ #32955
PROPOSAL: #32955 (comment)

Tests

Make a workspace.
Go to workspace profile and add a description.
Go to the policy expense chat
Make sure the added description is shown both in header and chat mast head.
Make sure clicking on the header description or chat mast head description leads us to description edit page.
Make sure the #admins room has the updated description report action.

Verify that no errors appear in the JS console

Offline tests

Go offline.
Go to a workspace profile page
Add/edit the description for the workspace.
Make sure the option gets greyed out.
Go online.
Make sure the description change persists.

QA Steps

Make a workspace.
Go to workspace profile and add a description.
Go to the policy expense chat
Make sure the added description is shown both in header and chat mast head.
Make sure clicking on the header description or chat mast head description leads us to description edit page.
Make sure the #admins room has the updated description report action.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-02-11.at.5.23.33.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-02-08.at.7.56.41.PM.mov

iOS: Native

Screen.Recording.2024-02-13.at.6.14.14.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-02-08.at.7.51.23.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-02-08.at.7.42.35.PM.mov

MacOS: Desktop

Screen.Recording.2024-02-11.at.5.32.53.PM.mov

melvin-bot · 2024-02-07T18:41:58Z

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

jjcoffee · 2024-02-08T13:18:22Z

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

android-native-2024-02-09_11.20.38.mp4

Android: mWeb Chrome

android-chrome-2024-02-09_11.27.11.mp4

iOS: Native

ios-native-2024-02-09_10.53.47.mp4

iOS: mWeb Safari

ios-safari-2024-02-09_10.46.29.mp4

MacOS: Chrome / Safari

desktop-chrome-2024-02-09_10.35.59.mp4

MacOS: Desktop

desktop-app-2024-02-09_10.38.02.mp4

esh-g · 2024-02-08T14:46:20Z

Sure, thanks for reminding me!

esh-g · 2024-02-08T14:58:21Z

@jjcoffee We show the report details page when the user clicks on report description without permission... So, I thought to be consistent in that case.

For header, I think it makes sense because it helps you see the whole description, which might not be visible from mast head when it is a long chat.
Let me know if we want to do nothing on click on masthead if user doesn't have permission.

esh-g · 2024-02-08T15:30:29Z

@jjcoffee Sure, I agree it feels a little jarring... I'll go ahead with what gets decided. Make sure to raise this in slack in here: https://expensify.slack.com/archives/C01GTK53T8Q/p1706584967766219 for a quicker response...

jjcoffee · 2024-02-08T15:40:50Z

@esh-g Ah thanks I'd missed that Slack convo! Could you also add offline feedback for changing the workspace description?

jjcoffee · 2024-02-09T09:26:02Z

src/pages/workspace/WorkspaceOverviewPage.js

@@ -106,7 +107,7 @@ function WorkspaceOverviewPage({policy, currencyList, route}) {
                        disabled={readOnly}
                        disabledStyle={styles.cursorDefault}
                    />
-                    <OfflineWithFeedback pendingAction={lodashGet(policy, 'pendingFields.generalSettings')}>
+                    <OfflineWithFeedback pendingAction={pendingAction}>


I think it makes more sense to wrap each MenuItemWithTopDescription with a separate OfflineWithFeedback, otherwise we grey out all the items even if only one has changed.

@jjcoffee The problem is that the name and currency are under generalSettings and grouped together while description has different API endpoint. This means that if we have separate OfflineWithFeedback, we would see that upon editing the name, the currency would also get greyed out while the description in between them would not. I think the solution to this is to break up name and currency into separate endpoints, but I think that could be out of scope for the issue. Please let me know what you think!

Commented on Slack too. I think it makes sense to separate it out as it's as separate API command. Once a followup deals with it, the other two fields will update separately too.

jjcoffee · 2024-02-09T09:48:43Z

@esh-g Could you also add missing screenshots please?

src/languages/en.ts

src/pages/home/HeaderView.js

jjcoffee · 2024-02-09T12:42:57Z

BUG: Android Native: The description text input doesn't immediately render at the correct size. We could fix this on a followup if it's out of scope, e.g. if it's a general issue:

android-native-flicker-2024-02-09_13.41.32.mp4

jjcoffee · 2024-02-13T13:32:20Z

Is it fine if we show this cursor? I'm basically disabling the PressableWithFeedback

I'd say it's best with just the normal cursor rather than showing it as disabled. There's no need for visual feedback since it's completely unclickable and the user wouldn't know what it being disabled would mean.

jjcoffee · 2024-02-13T13:33:26Z

Moreover, I have a question. Should we display the empty description item if the user doesn't have permission to edit?

Hmm good question! I think hiding it in this case makes sense.

esh-g · 2024-02-13T13:40:36Z

@jjcoffee I pushed solutions for both of those. Please confirm and hopefully then we can get this approved

jjcoffee · 2024-02-13T13:47:27Z

@esh-g Can you do the same tweak for the header's cursor for non-admins? Or ideally it would behave the same as when there is no description where tapping it opens the Details panel. No worries if that's too complex though.

esh-g · 2024-02-13T13:50:07Z

@jjcoffee For the header, as a whole it is wrapped in a pressable so the cursor would still be the pointer for admin and non-admin, just clicking on the description won't do anything for non-admin. I have been trying to somehow bypass the touch of the child pressable so that the touch is passed to parent in case of non-admin but I'm not finding a method to do that... I've tried disabling pointerEvents but that doesn't work. Let me know if this is worth putting in more effort.

src/pages/home/HeaderView.js

Co-authored-by: Joel Davies <joeld.dev@gmail.com>

jjcoffee

LGTM!

jjcoffee · 2024-02-13T14:06:01Z

@puneetlath Just wanted to flag a few issues that haven't been fixed here.

Bug: Android Native: The description text input doesn't immediately render at the correct size. - we decided this is most likely unrelated to this PR and should be fixed either separately or on a followup.
Bug: Sign out and sign in again, open a workspace chat with a description set. The chat initially shows "Workspace chat" before the actual description loads. (I couldn't replicate the same thing for room descriptions). - this seems like a BE issue
Bug: refreshing after navigating to the settings page to edit the description will display the chat in the background, rather than the settings page. - we've agreed on Slack that this shouldn't be a blocker (I believe this should be fixed at some point though!)

puneetlath

Great job with this. Seems to test well.

puneetlath · 2024-02-14T03:05:29Z

Unfortunately some conflicts came before I could review. If you can fix them, I'll merge first thing in my morning.

esh-g · 2024-02-14T14:32:29Z

@puneetlath Fixed it! Hope we can merge this before any more conflicts arise

OSBotify · 2024-02-14T15:23:52Z

✋ 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-02-15T05:36:34Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.42-0 🚀

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

OSBotify · 2024-02-19T23:34:42Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.42-5 🚀

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

shubham1206agra · 2024-03-12T03:49:56Z

src/pages/home/HeaderView.js

+                                            <PressableWithoutFeedback
+                                                onPress={() => {
+                                                    if (ReportUtils.canEditPolicyDescription(props.policy)) {
+                                                        Navigation.navigate(ROUTES.WORKSPACE_DESCRIPTION.getRoute(props.report.policyID));


This line created a regression. Issue here #36991

Add workspace description

15f1aee

esh-g requested a review from a team as a code owner February 7, 2024 18:41

melvin-bot bot requested review from jjcoffee and removed request for a team February 7, 2024 18:41

This was referenced Feb 7, 2024

[HOLD for payment 2024-02-26] HIGH: Show "Workspace description" everywhere (2/2, external) #32955

Closed

[HOLD for payment 2024-03-11] [$500] [Wave Collect] [Ideal Nav] Navigating back from the Room Description page opens the Room Settings page #36054

Closed

esh-g added 5 commits February 8, 2024 18:59

Fix lint

841d2bf

Fix translations

8a0ca16

Fix subtitle expression

13e0c3e

Fix memo

8be9661

Update description report action

ed4b43d

This comment was marked as resolved.

Sign in to view

Offline and personal expense header

2cd6b39

This comment was marked as resolved.

Sign in to view

jjcoffee reviewed Feb 9, 2024

View reviewed changes

This comment was marked as resolved.

Sign in to view

jjcoffee reviewed Feb 9, 2024

View reviewed changes

src/languages/en.ts Outdated Show resolved Hide resolved

jjcoffee reviewed Feb 9, 2024

View reviewed changes

src/pages/home/HeaderView.js Outdated Show resolved Hide resolved

Merge branch 'main' into workspace-description

9dd554f

esh-g added 2 commits February 13, 2024 19:04

Fix cursor

6d320d8

Hide description if empty and non editable

1282d65

jjcoffee reviewed Feb 13, 2024

View reviewed changes

src/pages/home/HeaderView.js Outdated Show resolved Hide resolved

esh-g and others added 2 commits February 13, 2024 19:27

Update src/pages/home/HeaderView.js

5acf332

Co-authored-by: Joel Davies <joeld.dev@gmail.com>

Prettify 💫

534fe74

jjcoffee approved these changes Feb 13, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath February 13, 2024 14:05

puneetlath previously approved these changes Feb 14, 2024

View reviewed changes

esh-g added 2 commits February 14, 2024 19:33

Merge branch 'main' into workspace-description

4fcc900

Fix forms

2f60134

esh-g dismissed puneetlath’s stale review via 2f60134 February 14, 2024 14:17

Fix drafts

283aefd

puneetlath approved these changes Feb 14, 2024

View reviewed changes

puneetlath merged commit fc37aeb into Expensify:main Feb 14, 2024
15 checks passed

github-actions bot mentioned this pull request Feb 15, 2024

Deploy Checklist: New Expensify 2024-02-15 #36558

Closed

73 tasks

bernhardoj mentioned this pull request Feb 20, 2024

[HOLD for payment 2024-03-14] [$500] Workspace - System message for workspace description edit with mark down is not gray #36598

Closed

6 tasks

dukenv0307 mentioned this pull request Feb 21, 2024

[Payment due][$500] Clicking on workspace description does nothing #36991

Closed

6 tasks

shubham1206agra reviewed Mar 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add workspace description #36058

Add workspace description #36058

esh-g commented Feb 7, 2024 •

edited

Loading

melvin-bot bot commented Feb 7, 2024

jjcoffee commented Feb 8, 2024 •

edited

Loading

This comment was marked as resolved.

esh-g commented Feb 8, 2024

This comment was marked as resolved.

esh-g commented Feb 8, 2024

This comment was marked as resolved.

This comment was marked as resolved.

esh-g commented Feb 8, 2024

jjcoffee commented Feb 8, 2024

This comment was marked as resolved.

This comment was marked as resolved.

jjcoffee Feb 9, 2024

esh-g Feb 9, 2024

jjcoffee Feb 12, 2024

jjcoffee commented Feb 9, 2024

This comment was marked as resolved.

jjcoffee commented Feb 9, 2024 •

edited

Loading

jjcoffee commented Feb 13, 2024

jjcoffee commented Feb 13, 2024

esh-g commented Feb 13, 2024

jjcoffee commented Feb 13, 2024

esh-g commented Feb 13, 2024

jjcoffee left a comment

jjcoffee commented Feb 13, 2024

puneetlath left a comment

puneetlath commented Feb 14, 2024

esh-g commented Feb 14, 2024

OSBotify commented Feb 14, 2024

OSBotify commented Feb 15, 2024

OSBotify commented Feb 19, 2024

shubham1206agra Mar 12, 2024

Add workspace description #36058

Add workspace description #36058

Conversation

esh-g commented Feb 7, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 7, 2024

jjcoffee commented Feb 8, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

This comment was marked as resolved.

esh-g commented Feb 8, 2024

This comment was marked as resolved.

esh-g commented Feb 8, 2024

This comment was marked as resolved.

This comment was marked as resolved.

esh-g commented Feb 8, 2024

jjcoffee commented Feb 8, 2024

This comment was marked as resolved.

This comment was marked as resolved.

jjcoffee Feb 9, 2024

Choose a reason for hiding this comment

esh-g Feb 9, 2024

Choose a reason for hiding this comment

jjcoffee Feb 12, 2024

Choose a reason for hiding this comment

jjcoffee commented Feb 9, 2024

This comment was marked as resolved.

jjcoffee commented Feb 9, 2024 • edited Loading

jjcoffee commented Feb 13, 2024

jjcoffee commented Feb 13, 2024

esh-g commented Feb 13, 2024

jjcoffee commented Feb 13, 2024

esh-g commented Feb 13, 2024

jjcoffee left a comment

Choose a reason for hiding this comment

jjcoffee commented Feb 13, 2024

puneetlath left a comment

Choose a reason for hiding this comment

puneetlath commented Feb 14, 2024

esh-g commented Feb 14, 2024

OSBotify commented Feb 14, 2024

OSBotify commented Feb 15, 2024

OSBotify commented Feb 19, 2024

shubham1206agra Mar 12, 2024

Choose a reason for hiding this comment

esh-g commented Feb 7, 2024 •

edited

Loading

jjcoffee commented Feb 8, 2024 •

edited

Loading

jjcoffee commented Feb 9, 2024 •

edited

Loading