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

Dont show hidden notif pref in profile page #33387

Merged
merged 3 commits into from
Jan 8, 2024
Merged

Conversation

srikarparsi
Copy link
Contributor

@srikarparsi srikarparsi commented Dec 21, 2023

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/330506
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Test with this Auth PR
Comment out these lines to make testing easier. Taking out these lines will show empty chats in the LHN which makes it easier to detect whether or not the hidden notification preference is set.

  1. Create a DM with another user
  2. Click on their profile and ensure you can't see the notification preferences for that chat
  3. Add a comment on the report
  4. Click on their profile and ensure you can see the notification preferences for the chat (should be always)
  5. Navigate away from the chat
  6. Navigate back to the chat
  7. Click on their profile and ensure you can still see the notification preferences for the chat (should be always)

Offline tests

QA Steps

  • Verify that no errors appear in the JS console
  1. Create a DM with a new user
  2. Click on their profile picture and ensure that you see "Notify me about new messages, Immediately"
  3. Send a message
  4. Click on their profile picture and ensure that you see "Notify me about new messages, Immediately"

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

Screenshots/Videos

Android: Native image
Android: mWeb Chrome image
iOS: Native

IMG_BA4340C61635-1

iOS: mWeb Safari image
MacOS: Chrome / Safari image
MacOS: Desktop image

@srikarparsi srikarparsi self-assigned this Dec 21, 2023
@srikarparsi srikarparsi marked this pull request as ready for review December 22, 2023 08:22
@srikarparsi srikarparsi requested a review from a team as a code owner December 22, 2023 08:22
@melvin-bot melvin-bot bot removed the request for review from a team December 22, 2023 08:23
Copy link

melvin-bot bot commented Dec 22, 2023

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

@@ -133,7 +133,8 @@ function ProfilePage(props) {

const navigateBackTo = lodashGet(props.route, 'params.backTo', ROUTES.HOME);

const notificationPreference = !_.isEmpty(props.report) ? props.translate(`notificationPreferencesPage.notificationPreferences.${props.report.notificationPreference}`) : '';
const shouldShowNotificationPreference = !_.isEmpty(props.report) && props.report.notificationPreference !== CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN;
const notificationPreference = shouldShowNotificationPreference ? props.translate(`notificationPreferencesPage.notificationPreferences.${props.report.notificationPreference}`) : '';
Copy link
Contributor

Choose a reason for hiding this comment

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

It looks like a redundant condition here. The only place notificationPreference is used is in the title={notificationPreference} and the only way that will show is if shouldShowNotificationPreference is true anyway. So, defaulting to an empty string is not needed.

Copy link
Contributor Author

@srikarparsi srikarparsi Dec 29, 2023

Choose a reason for hiding this comment

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

hidden doesn't currently have a translation since it doesn't show up anywhere on the app. So I wanted to add the conditional so that props.translate doesn't have a warning since hidden doesn't exist.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm ok I think I see what you are saying now. But what does it show instead? Do we need some fallback?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't believe so, I wrote similar code to here which is in the report settings page. Since hidden is more of a tool to hide reports than an actual notification preference, I think we should treat hidden reports as reports that the user does not yet have access too. And in that case they would see nothing in the notification preferences section.

@marcaaron
Copy link
Contributor

Change LGTM. Do we need to test on native or desktop? Noticed those were skipped (I typically don't skip them unless there is some reason like the code flows are not used on these platforms or something).

@srikarparsi
Copy link
Contributor Author

Got it, I didn't know if we need to since the changes followed the same structure as the report settings page which was already implemented. But that makes sense, it doesn't hurt to test for native platforms. I added in desktop and ran an ad hoc build for the native devices.

This comment has been minimized.

@srikarparsi
Copy link
Contributor Author

Builds failed, rerunning them

@situchan
Copy link
Contributor

situchan commented Jan 4, 2024

Does this require C+ review?

@srikarparsi
Copy link
Contributor Author

Maybe for testing and the reviewer checklist? Up to @marcaaron I believe.

Copy link
Contributor

github-actions bot commented Jan 4, 2024

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

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

1 similar comment
Copy link
Contributor

github-actions bot commented Jan 4, 2024

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

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

@srikarparsi
Copy link
Contributor Author

srikarparsi commented Jan 4, 2024

Hey @marcaaron, for some reason the ios build seems to keep failing on the adhoc build. Does the build work locally for you?

@srikarparsi
Copy link
Contributor Author

Merged main and re-ran build to hopefully fix iOS build.

Copy link
Contributor

github-actions bot commented Jan 5, 2024

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

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

👀 View the workflow run that generated this build 👀

Copy link
Contributor

github-actions bot commented Jan 5, 2024

@marcaaron
Copy link
Contributor

Just a heads up. I'm not merging this yet because it will fail QA. If we want to assign a C+ we can.

However, it's not ready to test yet I think because we need the Auth changes so we should put a HOLD on it.

@marcaaron
Copy link
Contributor

"QA Steps" section should also be filled out. Looks like the steps we will ask QA to do would be different than what you might ask someone who can build Auth to do.

@marcaaron marcaaron changed the title Dont show hidden notif pref in profile page [HOLD] Dont show hidden notif pref in profile page Jan 6, 2024
@srikarparsi
Copy link
Contributor Author

Hm, I think the Auth PR should be held on this one? Because the Auth PR introduces the hidden notification preference to DMs. And once the Auth PR is deployed, if you:

  1. Create a DM with someone
  2. Click on their profile picture
  3. The app will crash because it will try to translate hidden because of

props.translate(notificationPreferencesPage.notificationPreferences.${props.report.notificationPreference})

So, we need this PR to be deployed first before the Auth PR?

I'll also add QA steps to make sure we're not breaking anything and then make sure to test it again after the Auth PR PR is deployed.

So the QA steps for before the Auth deploy would be:

  1. Create a DM with a new user
  2. Click on their profile picture and ensure that you see "Notify me about new messages, Immediately"
  3. Send a message
  4. Click on their profile picture and ensure that you see "Notify me about new messages, Immediately"

And the QA steps for after the Auth deploy would be (which will be included in the Auth PR):

  1. Create a DM with a new user
  2. Click on their profile picture and ensure that you don't see "Notify me about new messages..."
  3. Send a message
  4. Click on their profile picture and ensure that you see "Notify me about new messages, Immediately"

@srikarparsi srikarparsi changed the title [HOLD] Dont show hidden notif pref in profile page Dont show hidden notif pref in profile page Jan 6, 2024
@marcaaron
Copy link
Contributor

Sounds fine. Mostly I am trying to avoid QA returning this PR during regression testing because it can't be tested without the Auth changes.

@marcaaron marcaaron merged commit 102a2ab into main Jan 8, 2024
18 checks passed
@marcaaron marcaaron deleted the srikar-dontShowHiddenPref branch January 8, 2024 19:00
@OSBotify
Copy link
Contributor

OSBotify commented Jan 8, 2024

✋ 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

OSBotify commented Jan 9, 2024

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.4.23-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.23-4 🚀

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

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.

4 participants