Support read only messages #40010

rezkiy37 · 2024-04-10T12:57:39Z

Details

The app blocks actions for read-only chats. Also, the app shows a new footer instead of the composer.

Note: to test the read-only chats optimistically, you would need #40678

Note: to test the PR I would recommend adding a couple of lines to optimistically make the Concierge chat a read-only one. Example - 23b0ba0 (you can revert this commit - ace67dc).

Note: you can run the flow as many times as you want by adding a test button into TestToolMenu.tsx.

Details

<TestToolRow title="Onboarding Flow">
    <Button
        small
        text="Navigate"
        onPress={() => {
            Navigation.dismissModal();
            Navigation.navigate(ROUTES.ONBOARDING_PURPOSE);
        }}
    />
</TestToolRow>

Fixed Issues

$ #38773
PROPOSAL: N/A

Tests

Complete the onboarding flow.
Open the chat.
Verify that the composer is hidden.
Verify that a new footer component exists.
Open a task report.
Verify that the composer is hidden.
Verify that a new footer component exists.
Verify that you cannot complete or delete a task.

Verify that no errors appear in the JS console

Offline tests

Same as "Tests".

QA Steps

Same as "Tests".

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

Android.Chrome.mp4

iOS: Native

IOS.mp4

iOS: mWeb Safari

IOS.Safari.mp4

MacOS: Chrome / Safari

Chrome.mp4

MacOS: Desktop

Desktop.mp4

…b.com/barttom/App-expensify into feature/38773-support-read-only-messages

…ture/38773-support-read-only-messages

….com/rezkiy37/Expensify into feature/38773-support-read-only-messages

…ture/38773-support-read-only-messages

src/languages/es.ts

hungvu193 · 2024-04-26T14:18:01Z

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

Android: mWeb Chrome

android.chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

Screen.Recording.2024-04-26.at.21.50.14.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-26.at.21.41.23.mov

Screen.Recording.2024-04-26.at.21.39.16.mov

Screen.Recording.2024-04-26.at.21.42.07.mov

MacOS: Desktop

Desktop.mov

flodnv · 2024-04-26T14:19:27Z

src/components/Banner.tsx

@@ -17,7 +18,13 @@ import Tooltip from './Tooltip';

 type BannerProps = {
    /** Text to display in the banner. */
-    text: string;
+    text?: string;


Why did this become optional? A banner without text sounds weird.

That's because I've added the content property for a case when I need to pass a react node, not a simple text.

flodnv · 2024-04-26T14:20:34Z

src/libs/ReportUtils.ts

+        return report?.permissions?.includes(CONST.REPORT.PERMISSIONS.WRITE);
+    }
+
+    return true;


If permissions are not an array or the array length is 0, I think this should return false?

I think yes, because it is a new property and I am not sure if it is applied to all kinds of reports. If we return false then all legacy chats will be "read-only".
cc @mountiny

For example:

In Web, we do not return the permissions and we dont return it from the getChats method hence in OpenApp (which uses that method) we also do not include permissions. Its only added in the structureReportForOnyx

We however return this in the OpenReport using the getStructuredOnyxReportAndLastMessageData

So actually the only one I found that does not have the permissions is the selfDM 🤔 although I see the report should be shared with read, write permissions cc @thienlnam

Ah this is because the user owns the report and is so is not in the sharedReports table. Maybe we can an owner check and then populate those permissions in the response

flodnv · 2024-04-26T14:24:02Z

src/pages/home/report/OnboardingReportFooterMessage.tsx

I propose to name this SystemChatReportFooterMessage

Done - 9076bc0.

flodnv · 2024-04-26T14:24:33Z

src/pages/home/report/OnboardingReportFooterMessage.tsx

+    /** Saved onboarding purpose selected by the user */
+    choice: OnyxEntry<OnboardingPurposeType>;
+
+    /** Collection of reports */


Which reports? All users reports?

Yeah, the app is looking for an admin chat to show in the banner.

There is another way: to the active policyID by nvp_expensify_activePolicyID and find an admin chat. Let me try.

What do you think about this approach - 90a72e9?

There is a problem when the user creates a new account, the active policy does not exist yet.

Done - 907167c, 38cbb1b.

flodnv · 2024-04-26T14:24:58Z

src/languages/en.ts

@@ -2763,6 +2763,16 @@ export default {
        },
        copyReferralLink: 'Copy invite link',
    },
+    onboardingBottomMessage: {


I propose to name this systemChatFooterMessage

Done - 62b193a.

hungvu193 · 2024-04-26T14:47:21Z

Should we leave it truncated like this?

Screenshot

Nevermind, it's only truncated when it's selected

mountiny

I think this is looking good, the main comment from @flodnv is I think NAB, because the permission field is returned for most cases and what I found only the selfDM did not populate it yet. But the implementation from @rezkiy37 now should be safe for the current state of things

mountiny · 2024-04-26T21:13:25Z

src/components/Banner.tsx

                                        fill={StyleUtils.getIconFillColor(getButtonState(shouldHighlight))}
                                    />
                                </View>
                            )}
-                            {shouldRenderHTML ? (
+                            {content && content}


NAB: Should we use a Boolean here? I feel like it looks a bit more readable that way

Suggested change

{content && content}

{!!content && content}

mountiny · 2024-04-26T21:44:18Z

src/libs/ReportUtils.ts

+        return report?.permissions?.includes(CONST.REPORT.PERMISSIONS.WRITE);
+    }
+
+    return true;


We however return this in the OpenReport using the getStructuredOnyxReportAndLastMessageData

So actually the only one I found that does not have the permissions is the selfDM 🤔 although I see the report should be shared with read, write permissions cc @thienlnam

mountiny · 2024-04-26T21:47:39Z

src/types/onyx/Report.ts

@@ -187,6 +187,8 @@ type Report = OnyxCommon.OnyxValueWithOfflineFeedback<
        transactionThreadReportID?: string;

        fieldList?: Record<string, PolicyReportField>;
+
+        permissions?: Array<ValueOf<typeof CONST.REPORT.PERMISSIONS>>;


There should be a comment here

mountiny · 2024-04-26T21:55:23Z

As only NAB comments are here and we got C+ and 2 approvals, I will merge before deploy

OSBotify · 2024-04-26T22:02:22Z

✋ 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-04-26T23:20:53Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.67-0 🚀

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

kbecciv · 2024-04-27T22:40:09Z

This PR is failing because of issue #38773

The issue is reproducible in: All environments

1714237983181.bandicam_2024-04-27_20-02-58-191.mp4

1714238446211.video_2024-04-27_20-20-32.mp4

1714238916895._____________2024-04-27___20.24.27.mp4

1714238585094.video_2024-04-27_20-22-52.mp4

1714239337019.video_2024-04-27_20-35-08.mp4

iwiznia · 2024-04-29T14:11:01Z

Seems this PR caused a regression #41135 (comment)

OSBotify · 2024-04-29T23:12:40Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.67-7 🚀

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

OSBotify · 2024-04-30T00:40:09Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.67-7 🚀

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

rojiphil · 2024-06-21T16:47:50Z

src/pages/home/ReportScreen.tsx

@@ -210,6 +210,7 @@ function ReportScreen({
            isOptimisticReport: reportProp?.isOptimisticReport,
            lastMentionedTime: reportProp?.lastMentionedTime,
            avatarUrl: reportProp?.avatarUrl,
+            permissions: reportProp?.permissions,


When a user signs-in via google after viewing a public room, the permissions was not getting updated. A deep comparison was required here to update the dependency. This caused #41955 where the composer was not getting displayed even after signing-in via google.

shubham1206agra · 2024-07-01T06:40:56Z

src/pages/home/report/SystemChatReportFooterMessage.tsx

+            containerStyles={[styles.archivedReportFooter]}
+            shouldShowIcon
+            icon={Expensicons.Lightbulb}
+            content={<Text suppressHighlighting>{content}</Text>}


You have left the styles.flex1 style in this Text component, which overflowed the content in iOS. More context #43115

hoangzinh · 2024-07-24T11:48:37Z

src/pages/home/report/ReportActionItem.tsx

@@ -914,6 +915,7 @@ function ReportActionItem({
                            originalReportID={originalReportID ?? ''}
                            isArchivedRoom={ReportUtils.isArchivedRoom(report)}
                            displayAsGroup={displayAsGroup}
+                            disabledActions={!ReportUtils.canWriteInReport(report) ? RestrictedReadOnlyContextMenuActions : []}


Coming from #43562, we also missed adding those disabledActions in the context menu.

barttom and others added 17 commits April 10, 2024 08:52

feat: added component for displaying static message inm onboarding

7f4f512

Merge branch 'feat/38773/support-read-only-messages' of https://githu…

297a231

…b.com/barttom/App-expensify into feature/38773-support-read-only-messages

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

cd7a95f

…ture/38773-support-read-only-messages

add permissions to report

26bcce6

create isReadOnly

de29862

integrate OnboardingReportFooterMessage into ReportFooter

e2ad69d

prettify

471a02a

restrict task action in header

b4aed0f

read only for TaskView

0c1efc3

read only for TaskPreview

d72ceab

read only for HeaderView

287fbe1

Merge branch 'feature/38771-tasks-for-guided-setup' of https://github…

7adce5f

….com/rezkiy37/Expensify into feature/38773-support-read-only-messages

fix isReadOnly condition

c386da0

improve OnboardingReportFooterMessage

8243a2b

add permissions to report

3896162

improve read only for tasks

af3b05f

Consierge read only

09a118c

rezkiy37 mentioned this pull request Apr 19, 2024

[Awaiting C+ Steps] [Guided Setup Stage 2] Add support for read-only messages (Phase 2) #38773

Closed

rezkiy37 added 8 commits April 22, 2024 11:39

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

cd25155

…ture/38773-support-read-only-messages

revert dev change

15478c0

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

c5da50e

…ture/38773-support-read-only-messages

restrict actions for read-only chats

6b41cde

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

84c583b

…ture/38773-support-read-only-messages

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

1b7d32a

…ture/38773-support-read-only-messages

translate

990e3cb

remove todo

8fa54e6

pecanoro requested changes Apr 25, 2024

View reviewed changes

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

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

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

fix translations

a93647a

rezkiy37 requested a review from pecanoro April 25, 2024 11:43

rezkiy37 marked this pull request as ready for review April 25, 2024 11:43

flodnv reviewed Apr 26, 2024

View reviewed changes

rezkiy37 added 2 commits April 26, 2024 17:01

rename the component

9076bc0

rename keys

62b193a

hungvu193 approved these changes Apr 26, 2024

View reviewed changes

pecanoro previously approved these changes Apr 26, 2024

View reviewed changes

simplify admin chat getting

90a72e9

rezkiy37 dismissed pecanoro’s stale review via 90a72e9 April 26, 2024 15:11

rezkiy37 requested a review from flodnv April 26, 2024 15:11

rezkiy37 added 2 commits April 26, 2024 17:55

improve admin chat searching

907167c

attach chatReportIDAdmins to policy optimistically

38cbb1b

mountiny approved these changes Apr 26, 2024

View reviewed changes

mountiny merged commit 3f379ec into Expensify:main Apr 26, 2024
17 checks passed

github-actions bot mentioned this pull request Apr 26, 2024

Deploy Checklist: New Expensify 2024-04-26 #41122

Closed

63 tasks

quinthar mentioned this pull request Apr 28, 2024

[PAID] [$250] HIGH: [Polish] Revert the Message Concierge for help with setup message #41184

Closed

iwiznia mentioned this pull request Apr 29, 2024

[HOLD for payment 2024-05-08] [HOLD for payment 2024-05-06] Public room - "Message Concierge for help with setup" banner appears for anonymous user #41135

Closed

6 tasks

rojiphil reviewed Jun 21, 2024

View reviewed changes

rojiphil mentioned this pull request Jun 21, 2024

[HOLD for payment 2024-06-20] [HOLD for payment 2024-06-18] Composer doesn't load in #Exfy-roadmap after google sign in #41955

Closed

6 tasks

c3024 mentioned this pull request Jun 27, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] [$250] Expensify personal - Users are able to create threads in the "System" DM chat #43562

Closed

6 tasks

shubham1206agra reviewed Jul 1, 2024

View reviewed changes

shubham1206agra mentioned this pull request Jul 1, 2024

[HOLD for payment 2024-06-28] [HOLD for payment 2024-06-24] [$250] iOS - System chat - Chat with your setup specialist message not aligned and gets out of box #43115

Closed

6 tasks

hoangzinh reviewed Jul 24, 2024

View reviewed changes

Support read only messages #40010

Support read only messages #40010

Conversation

rezkiy37 commented Apr 10, 2024 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hungvu193 commented Apr 26, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rezkiy37 Apr 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hungvu193 commented Apr 26, 2024 • edited Loading

mountiny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mountiny commented Apr 26, 2024

OSBotify commented Apr 26, 2024

OSBotify commented Apr 26, 2024

kbecciv commented Apr 27, 2024

iwiznia commented Apr 29, 2024

OSBotify commented Apr 29, 2024

OSBotify commented Apr 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rezkiy37 commented Apr 10, 2024 •

edited by mountiny

Loading

hungvu193 commented Apr 26, 2024 •

edited

Loading

rezkiy37 Apr 26, 2024 •

edited

Loading

hungvu193 commented Apr 26, 2024 •

edited

Loading