Allow users to permanently dismiss the referral banners #34842

tgolen · 2024-01-19T21:47:13Z

Held on https://github.com/Expensify/Auth/pull/9697 for NVPs being included in OpenApp
Held on https://github.com/Expensify/Web-Expensify/pull/40603 for the new API command to be added
Held on Make referral banner dismissible #33925 for dismiss functionality

Details

This PR allows users to permanently dismiss the referral banners. It was based off #33925

Fixed Issues

$ #34387

Tests

There are four banners to test. For each banner, you should:

Log in with a brand new account
View the banner
Click the X on the banner
Close whatever view has the banner (it's usually in a modal)
Reopen the view that had the banner
Verify that the banner does is no longer visible

The four banners to test are:

Main search window in the footer
The New Chat page from global create
Select participant page when requesting money
Select participant page when sending money

Verify that no errors appear in the JS console

Offline tests

Go offline
Dismiss a banner
Verify the banner doesn't display again
Go back online
Verify the banner still doesn't display

QA Steps

Same as the tests above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

tgolen · 2024-01-23T15:30:22Z

package.json

@@ -58,7 +58,7 @@
    "setup-https": "mkcert -install && mkcert -cert-file config/webpack/certificate.pem -key-file config/webpack/key.pem dev.new.expensify.com localhost 127.0.0.1"
  },
  "dependencies": {
-    "@dotlottie/react-player": "^1.6.3",
+    "@dotlottie/react-player": "^1.6.15",


Note: The changes to this file and the lockfile aren't strictly related to this PR, but it was something that we found and discussed on Slack and it was easy to add the update to my current PR (ref).

melvin-bot · 2024-01-25T14:48:19Z

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

dylanexpensify · 2024-01-26T12:15:12Z

bump @hoangzinh for review!

hoangzinh · 2024-01-27T14:07:42Z

src/pages/SearchPage/SearchPageFooter.tsx

@@ -2,19 +2,25 @@ import React, {useState} from 'react';
 import {View} from 'react-native';
 import ReferralProgramCTA from '@components/ReferralProgramCTA';
 import useThemeStyles from '@hooks/useThemeStyles';
+import * as User from '@userActions/User';
 import CONST from '@src/CONST';

 function SearchPageFooter() {


Do you think this + its parent redundant components? I found that there are 2 SearchPage components:

src/pages/SearchPage.js

src/pages/SearchPage/index.js

This is confusing, but yes... this change is mostly redundant because the parent component is being removed in another PR. This was discussed over here.

src/pages/SearchPage.js

src/pages/NewChatPage.js

hoangzinh · 2024-01-27T14:19:29Z

@tgolen there are some failed on the checklist:

perf-tests
license/snyk
security/snyk

For perf-tests, I think you can merge latest main to fix. 2 others might be related to PR changes on the package.json file.

Co-authored-by: Vinh Hoang <hoangzinhvn@gmail.com>

tgolen · 2024-01-29T17:40:17Z

I've reverted the package.json change from this PR. Now I'm fixing some of the TS issues. Sorry for pinging you for a review earlier when it wasn't quite ready.

tgolen · 2024-01-29T18:26:10Z

OK, this is ready for review now. I reverted the change to SearchPage.tsx and SearchPageFooter.js since those files are being removed elsewhere and that's what was causing the performance tests to fail.

tgolen · 2024-01-29T18:28:23Z

Oops, I still need SearchPageFooter.js 🤦 putting that back...

tgolen · 2024-01-29T18:46:55Z

OK, I've updated this with the changes necessary for SearchPageFooter and also removed SearchPage.js file completely (or else webpack was confusing it with SearchPage/index.js and not including the proper file).

hoangzinh · 2024-01-30T01:25:23Z

OK, I've updated this with the changes necessary for SearchPageFooter and also removed SearchPage.js file completely (or else webpack was confusing it with SearchPage/index.js and not including the proper file).

According to the commit histories of SearchPage/index.js, I have same thoughts that we moved SearchPage.js to SearchPage/index.js

But somehow (maybe resolve conflict) the SearchPage.js till there. Unluckily, when I compare the commit histories of SearchPage.js there are some recent commits into this component. That means if we just remove this component, we might lose some code. I think we have 2 options:

Option 1: Check and move recent changes from SearchPage.js to SearchPage/index.js in this PR
Option 2: Create another GH issue to check & remove SearchPage.js

tgolen · 2024-01-30T16:23:36Z

OK, considering that I can't get this to work without removing SearchPage.js (due to webpack module resolution preference), I'll look into the first option of copying the few changes over. I'll be able to do that today.

tgolen · 2024-01-30T16:57:06Z

@hoangzinh I looked at the history of SearchPage.js and I found these two PRs that changed the file significantly.

(perf) Implement debounce in OptionList search #33347 implemented a debounced search for the option list. In SearchPage/index.js I see it's using useDebouncedState('') here which should cover the changes from this PR (from how I understand it).
[NoQA] [Reassure] SearchPage perf tests #33872 added performance tests to the page, nothing functional. Considering that the performance tests work with SearchPage/index.js, I believe that everything is good here. The one thing to note though is that in [NoQA] [Reassure] SearchPage perf tests #33872 there was a navigation prop that was added, supposedly because This is required because transitionEnd event doesn't trigger in the automated testing environment.. The navigation prop does not exist on SearchPage/index.js and the tests still pass. So that tells me that the navigation prop wasn't necessary or the tests were written in a way that doesn't utilize it.

Conclusion

I think it's fine to remove SearchPage.js in favor of keeping SearchPage/index.js and there are no changes that need to be copied over.

cc @rinej @TMisiukiewicz

situchan · 2024-01-30T17:01:12Z

I think it's fine to remove SearchPage.js in favor of keeping SearchPage/index.js and there are no changes that need to be copied over.

It will be removed in #35058

hoangzinh · 2024-01-31T14:56:57Z

sweet. Thanks for checking @tgolen @situchan. I will complete review checklist today

hoangzinh · 2024-01-31T14:57:13Z

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

Screen.Recording.2024-01-31.at.22.47.31.android.mov

Android: mWeb Chrome

Screen.Recording.2024-01-31.at.22.30.26.android.chrome.mov

iOS: Native

Screen.Recording.2024-01-31.at.22.59.07.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-01-31.at.22.55.09.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-31.at.22.18.26.web.mov

MacOS: Desktop

Screen.Recording.2024-01-31.at.22.22.41.desktop.mov

hoangzinh

LGTM

melvin-bot · 2024-01-31T16:01:16Z

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

tgolen · 2024-02-02T16:26:20Z

I resolved conflicts and this is ready for review @tylerkaraszewski

OSBotify · 2024-02-02T17:04:07Z

✋ 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-05T23:09:17Z

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

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

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

OSBotify · 2024-02-05T23:31:01Z

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

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

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

OSBotify · 2024-02-07T09:51:25Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.37-7 🚀

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

tgolen added 2 commits January 19, 2024 13:25

Merge branch 'main' into tgolen-perma-dismiss-banners

8c718e1

Add new types to account object

b8ed1e1

tgolen self-assigned this Jan 19, 2024

tgolen changed the title ~~Tgolen perma dismiss banners~~ [HOLD] Allow users to permanently dismiss the referral banners Jan 19, 2024

tgolen mentioned this pull request Jan 19, 2024

[PAID] Make NewDot referral banners permanently dismissible #34387

Closed

tgolen added 11 commits January 22, 2024 13:03

Add action method which calls the API

dad285a

Merge branch 'main' into tgolen-perma-dismiss-banners

ae53491

Merge branch 'main' into tgolen-perma-dismiss-banners

c38713e

Move API call to search page

5113259

Do not show friend banner if it's been dismissed

85a998f

Perma dismiss banner from new chat page

ba74381

Add perma dismiss to the create request page

bb9101c

Add perma dismiss to the edit request page

f03be9c

Make action optimistic

872cf94

Fix style and TS

c6cd3b5

Update lottie packages

0d8e169

tgolen commented Jan 23, 2024

View reviewed changes

Merge branch 'main' into tgolen-perma-dismiss-banners

530a3a6

tgolen changed the title ~~[HOLD] Allow users to permanently dismiss the referral banners~~ Allow users to permanently dismiss the referral banners Jan 25, 2024

tgolen marked this pull request as ready for review January 25, 2024 14:48

tgolen requested a review from a team as a code owner January 25, 2024 14:48

melvin-bot bot requested review from hoangzinh and removed request for a team January 25, 2024 14:48

hoangzinh reviewed Jan 27, 2024

View reviewed changes

tgolen and others added 3 commits January 29, 2024 10:10

Update src/pages/SearchPage.js

f6cf0df

Co-authored-by: Vinh Hoang <hoangzinhvn@gmail.com>

Update src/pages/NewChatPage.js

ac75241

Co-authored-by: Vinh Hoang <hoangzinhvn@gmail.com>

Merge branch 'main' into tgolen-perma-dismiss-banners

14055e8

tgolen added 2 commits January 29, 2024 10:27

Revert package.json again

20645fc

Add more TS fixes

354042e

Remove changes from file that is no longer referenced

3a43633

Put search page footer back, fix prop method name

b9b53bd

prettier

7d28270

Merge branch 'main' into tgolen-perma-dismiss-banners

bf31586

hoangzinh approved these changes Jan 31, 2024

View reviewed changes

melvin-bot bot requested a review from tylerkaraszewski January 31, 2024 16:01

Merge branch 'main' into tgolen-perma-dismiss-banners

c5feb7e

tylerkaraszewski approved these changes Feb 2, 2024

View reviewed changes

tylerkaraszewski merged commit bdc554f into main Feb 2, 2024
15 checks passed

tylerkaraszewski deleted the tgolen-perma-dismiss-banners branch February 2, 2024 16:59

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

Deploy Checklist: New Expensify 2024-02-05 #35857

Closed

66 tasks

izarutskaya mentioned this pull request Feb 6, 2024

[$500] Referral - Referral banner is not permanently dismissed in Search #35895

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow users to permanently dismiss the referral banners #34842

Allow users to permanently dismiss the referral banners #34842

tgolen commented Jan 19, 2024 •

edited

Loading

tgolen Jan 23, 2024

melvin-bot bot commented Jan 25, 2024

dylanexpensify commented Jan 26, 2024

hoangzinh Jan 27, 2024

tgolen Jan 29, 2024

hoangzinh commented Jan 27, 2024

tgolen commented Jan 29, 2024

tgolen commented Jan 29, 2024

tgolen commented Jan 29, 2024

tgolen commented Jan 29, 2024

hoangzinh commented Jan 30, 2024 •

edited

Loading

tgolen commented Jan 30, 2024

tgolen commented Jan 30, 2024

situchan commented Jan 30, 2024

hoangzinh commented Jan 31, 2024

hoangzinh commented Jan 31, 2024 •

edited

Loading

hoangzinh left a comment

melvin-bot bot commented Jan 31, 2024

tgolen commented Feb 2, 2024

OSBotify commented Feb 2, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 7, 2024

Allow users to permanently dismiss the referral banners #34842

Allow users to permanently dismiss the referral banners #34842

Conversation

tgolen commented Jan 19, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

tgolen Jan 23, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Jan 25, 2024

dylanexpensify commented Jan 26, 2024

hoangzinh Jan 27, 2024

Choose a reason for hiding this comment

tgolen Jan 29, 2024

Choose a reason for hiding this comment

hoangzinh commented Jan 27, 2024

tgolen commented Jan 29, 2024

tgolen commented Jan 29, 2024

tgolen commented Jan 29, 2024

tgolen commented Jan 29, 2024

hoangzinh commented Jan 30, 2024 • edited Loading

tgolen commented Jan 30, 2024

tgolen commented Jan 30, 2024

Conclusion

situchan commented Jan 30, 2024

hoangzinh commented Jan 31, 2024

hoangzinh commented Jan 31, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hoangzinh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 31, 2024

tgolen commented Feb 2, 2024

OSBotify commented Feb 2, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 7, 2024

tgolen commented Jan 19, 2024 •

edited

Loading

hoangzinh commented Jan 30, 2024 •

edited

Loading

hoangzinh commented Jan 31, 2024 •

edited

Loading