Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add conversation styling and shortcuts for Android 🤖 #47626

Merged

Conversation

staszekscp
Copy link
Contributor

cc: @arosiclair

Details

The PR implements conversation notifications for Android alongside with conversation shortcuts. From now on it is possible to go to a conversation from android shortcuts, and manage them in system options.

Fixed Issues

$ #37604
PROPOSAL: N/A

Tests

  • Get a DM notification and press it
  • Leave the app and long press on the app icon
  • The conversation shortcut should appear

Offline tests

N/A

QA Steps

  • Get a DM notification and press it
  • Leave the app and long press on the app icon
  • The conversation shortcut should appear

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
w_4b330eb7fc4209cb67f94012d6eda552b59ace52-2024-08-19.09_47_18.477.mp4
Android: mWeb Chrome N/A
iOS: Native N/A
iOS: mWeb Safari N/A
MacOS: Chrome / Safari N/A
MacOS: Desktop N/A

@staszekscp staszekscp requested a review from a team as a code owner August 19, 2024 09:48
@melvin-bot melvin-bot bot requested review from rayane-djouah and removed request for a team August 19, 2024 09:48
Copy link

melvin-bot bot commented Aug 19, 2024

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

Copy link
Contributor

@arosiclair arosiclair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good other than one more change


builder.setStyle(messagingStyle);
// Conversational styling should be applied to groups chats, rooms, and any 1:1 chats with more than one notification (ensuring the large profile image is always shown)
if (!conversationName.isEmpty()) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (!conversationName.isEmpty()) {
if (!roomName.isEmpty()) {

Can you rename this variable to make it a little more clear?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed 🫡

@arosiclair
Copy link
Contributor

Ad-hoc build is running

This comment has been minimized.

Copy link
Contributor

@rayane-djouah rayane-djouah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels pretty good 🚀

screen-20240819-212547.2.mp4

@rayane-djouah
Copy link
Contributor

@staszekscp - I'm seeing an empty option in the menu when there is a notification:

Screenshot 2024-08-19 at 21 43 09

@rayane-djouah
Copy link
Contributor

Is this expected? If we have two notifications only one of them is displayed in the long press menu:

screen-20240819-215535.mp4

@rayane-djouah
Copy link
Contributor

rayane-djouah commented Aug 19, 2024

Widgets and shortcuts work good 🚀

screen-20240819-215935.mp4

Screenshot_20240819-220202.png

@staszekscp
Copy link
Contributor Author

Is this expected? If we have two notifications only one of them is displayed in the long press menu:

screen-20240819-215535.mp4

I think that's how Android handles it - on other apps it only shows the newest notification, and it looks very similar to the video

@rayane-djouah
Copy link
Contributor

@staszekscp - Is this expected also: #47626 (comment)?

@staszekscp
Copy link
Contributor Author

staszekscp commented Aug 20, 2024

@rayane-djouah I haven't found any way to change that. I also quickly browsed through the Google documentation, and couldn't see anything that could change that behaviour - nevertheless it only appears when there are less than 3 shortcuts. I'll investigate that further

However I've also noticed a small bug I'll have to fix - the shortcuts don't get dismissed after signing out. I'll try to address that this week! (I also have some duties around the HybridApp, that's why I cannot jump straight to it)

@staszekscp
Copy link
Contributor Author

Just a quick update: I've had some time to give it a go. My guts tell me it's possible, but I was still not able to change the behaviour of the shortcut 😄

I also investigated the shortcuts removal upon sign out, however it would be a bit more complicated. Ideally I would write a native class that would handle the shortcuts, and expose the clear method to React Native, and trigger it whenever a user signs out. It would require more work, but I think it's necessary to avoid some strange hacks.

There are some RN libraries out there, but it seems they don't handle our specific use-case of Conversation Shortcuts. Therefore I don't know if they would work correctly. We can always write a tailor-made Native Module that could also handle our navigation quirks if we decide to add other shortcuts (similarly to OldDot)

I would love to hear your feedback! I'll try to find some time next week to move on with it!

@arosiclair
Copy link
Contributor

I also quickly browsed through the Google documentation, and couldn't see anything that could change that behaviour - nevertheless it only appears when there are less than 3 shortcuts. I'll investigate that further

This issue happens on every flavor of Android (Pixel, Samsung, etc) or just some of them?

I also investigated the shortcuts removal upon sign out, however it would be a bit more complicated.

After signing out, do the shortcuts not work at all? Or does the app let you sign in and then redirect to the correct chat?

@staszekscp
Copy link
Contributor Author

Hi everyone!

This issue happens on every flavor of Android (Pixel, Samsung, etc) or just some of them?

I tested on 3 devices, and it seems like it might be the default Android behaviour in that scenario (if there is a Notification targeting one of shortcuts, it doesn't duplicate the data). Although if there is more than 2 shortcuts, the issue doesn't exist (the problematic empty shortcut doesn't show up). I played with shortcut and notification builders, but I couldn't find a way to get rid of this problem

After signing out, do the shortcuts not work at all? Or does the app let you sign in and then redirect to the correct chat?

The shortcuts are available, but if the user is logged out the app opens on the SignIn page. If the user is signed in to another account, the Chat not found page appears.

@arosiclair
Copy link
Contributor

The shortcuts are available, but if the user is logged out the app opens on the SignIn page. If the user is signed in to another account, the Chat not found page appears.

Oh okay good catch. Then we should be sure to reset these shortcuts whenever we log out/in.

@staszekscp
Copy link
Contributor Author

Sorry for answering late, we've had some work after upgrading React Native in Hybrid App 😄

Oh okay good catch. Then we should be sure to reset these shortcuts whenever we log out/in.

So I think that the cleanest solution would be to create a simple NativeModule to expose a clearConversationShortcuts method to React Native side. We could call it in the signOut function to do the clean up. What do you think about it?

@arosiclair
Copy link
Contributor

So I think that the cleanest solution would be to create a simple NativeModule to expose a clearConversationShortcuts method to React Native side. We could call it in the signOut function to do the clean up. What do you think about it?

I can't think of any other option so that makes sense to me too 👍

@staszekscp
Copy link
Contributor Author

Thanks for answering @arosiclair! In this case, let's go with the NativeModule 😄 I'd love to finish the PR myself, but because currently I have a lot of work in the HybridApp project, and I don't want to block the progress @Skalakid will pick up the PR in order to finish the missing pieces! 😄

@Skalakid
Copy link
Contributor

Skalakid commented Sep 2, 2024

Hi, I'm Michał from SWM and I will continue finishing this PR 😄

@Skalakid
Copy link
Contributor

Skalakid commented Sep 3, 2024

Hello, I'm having trouble with testing message notifications when app is in the background. Do we have any problems with notifications system right now? I checked the production Android app and I don't get any alert/pop up when other users text me. The same happens on the latest main and on this PR's branch. Any updates on the backend side?

@arosiclair
Copy link
Contributor

Hello, I'm having trouble with testing message notifications when app is in the background. Do we have any problems with notifications system right now? I checked the production Android app and I don't get any alert/pop up when other users text me. The same happens on the latest main and on this PR's branch. Any updates on the backend side?

Yes we started sending NewDot push notifications only to users that are enrolled in the new experience (tryNewDot.classicRedirect is enabled). Try running this JS snippet in the console in OldDot to enroll your user:

const nvp = NVP.get('tryNewDot');
nvp.classicRedirect.dismissed = false;
NVP.set('tryNewDot', nvp);

Alternatively, creating a new user in NewDot should automatically enroll them.

@arosiclair
Copy link
Contributor

Heads up push notifications for the new experience are indeed bugged. We're working on a fix. Hopefully we can get it out in the next day or two.

@rayane-djouah
Copy link
Contributor

@arosiclair Could you please trigger an adhoc build?

@arosiclair
Copy link
Contributor

Build is running here

Copy link
Contributor

github-actions bot commented Sep 4, 2024

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the android build failed The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/47626/NewExpensify.dmg https://47626.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@rayane-djouah
Copy link
Contributor

Weird

Error: Error: input ruby-version needs to be specified if no .ruby-version or .tool-versions file exists

https://github.com/Expensify/App/actions/runs/10704914058/job/29679050710

@arosiclair
Copy link
Contributor

@rayane-djouah can you build and test locally?

@Skalakid
Copy link
Contributor

Skalakid commented Sep 9, 2024

@arosiclair Hmm I see that there were some problems with the builds, maybe they was caused by not having the latest changes. I just merged the latest main so how about trying building it again?

@arosiclair
Copy link
Contributor

We should just continue testing locally, ad-hoc builds are very slow and inefficient especially if we don't really need them.

@Skalakid
Copy link
Contributor

Skalakid commented Sep 11, 2024

@rayane-djouah Have you been able to test it with notifications enabled?

@rayane-djouah
Copy link
Contributor

Bug:

  1. Open the app
  2. Keep the app in the background
  3. Send yourself a message from another device
  4. Long press on the app shortcut
  5. Click on the message notification shortcut to open the report
  6. Close the app
  7. Long press on the app shortcut
  8. Click on the conversation shortcut to open the report
  9. The app crashes
screen-20240911-220132.mp4

cc @Skalakid

@rayane-djouah
Copy link
Contributor

rayane-djouah commented Sep 11, 2024

Bug: Conversation shortcuts don't work and sometimes take to a not found page:

screen-20240911-221419.mp4
screen-20240911-221643.mp4

cc @Skalakid

@Skalakid
Copy link
Contributor

Skalakid commented Sep 12, 2024

@rayane-djouah, I've added a fix for it. After these changes, I wasn't able to reproduce the issues that you mentioned :D

@rayane-djouah
Copy link
Contributor

rayane-djouah commented Sep 13, 2024

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-20240913-004530.mp4
screen-20240913-005120.mp4
screen-20240913-005204.mp4
Android: mWeb Chrome

N/A

iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-09-13.at.01.12.32.mp4
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-09-13.at.01.11.05.mp4
iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

N/A

Copy link
Contributor

@rayane-djouah rayane-djouah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and tests well

Copy link
Contributor

@arosiclair arosiclair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great overall just one change needed

@@ -205,6 +206,7 @@ function hasAuthToken(): boolean {
function signOutAndRedirectToSignIn(shouldResetToHome?: boolean, shouldStashSession?: boolean, killHybridApp = true) {
Log.info('Redirecting to Sign In because signOut() was called');
hideContextMenu(false);
ShortcutManager.removeAllDynamicShortcuts();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would probably be better to put this in PushNotification.deregister. Can we do a quick test to make sure it still works correctly from there?

@Skalakid
Copy link
Contributor

@arosiclair I've added your suggestion, and everything seems to work well 😄

Screen.Recording.2024-09-16.at.13.30.57.mov

Copy link
Contributor

@arosiclair arosiclair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work thank you!

@arosiclair arosiclair merged commit df070b7 into Expensify:main Sep 16, 2024
16 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/arosiclair in version: 9.0.36-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/grgia in version: 9.0.36-2 🚀

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

@arosiclair
Copy link
Contributor

FYI @Julesssss we deployed conversation notifications for Android (NewDot not HybridApp) with this ^. I'm not on Android anymore so I can't test it normally so lemme know if this is buggy in any way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants