Feature : Added Promote referral program messaging to OptionsSelector component #30372

waterim · 2023-10-25T17:52:01Z

Details

This PR is to add refferal program messaging to OptionsSelector component

Fixed Issues

$ #29881

Tests

Start Chat Flow

Go to FAB > 'Start Chat'
- Observe that there is a Call-to-Action (CTA) button.
Click on the CTA button.
- Verify that you were taken to the new referral page

Request Money Flow

Go to FAB > 'Request Money'
Select the desired amount.
- Once again, observe the presence of a CTA button.
Click on the CTA button.
- Verify that you were taken to the new referral page

Send Money Flow

Go to FAB > 'Send Money'
Select the desired amount.
- Observe that there is a CTA button.
Click on the CTA button.
- Verify that you were taken to the new referral page

Search Flow

Click on the magnifying glass (search button).
- Observe that there is a CTA button.
Click on the 'Referral' CTA button.
- Verify that you were taken to the new referral page
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

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 / Chrome
- iOS / native
- iOS / 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Web

Video:

Screen.Recording.2023-11-02.at.15.06.12_compressed.mp4

Request:

Start chat:

Send money:

Click the magnifying glass:

…referral-program

melvin-bot · 2023-10-30T17:49:56Z

@dubielzyk-expensify @cubuspl42 One of you needs to 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]

src/libs/ReferralProgramUtils.js

dubielzyk-expensify · 2023-10-31T04:15:49Z

Shaping up nicely! A few things:

Info icon should be 20x20 as per Figma (it looks a bit too big in the screenshots above):
The green text should also be bolded

dubielzyk-expensify · 2023-11-01T04:51:02Z

Would also be great if we could get a screen recording so we can see how the interaction works together :)

waterim · 2023-11-02T14:34:21Z

Updated code and text

waterim · 2023-11-02T15:10:40Z

Added video as well!

waterim · 2023-11-02T15:11:00Z

cc @puneetlath

dubielzyk-expensify

Looks good to me!

src/CONST.ts

src/ROUTES.ts

src/pages/NewChatPage.js

src/components/OptionsSelector/BaseOptionsSelector.js

puneetlath · 2023-11-03T00:25:15Z

@cubuspl42 think we can get a review of this tomorrow (friday)?

cubuspl42 · 2023-11-03T08:02:47Z

@puneetlath Yes, I'll review it in the next hour or so. Sorry for the delay.

src/pages/ReferralDetailsPage.js

cubuspl42 · 2023-11-14T13:12:53Z

src/pages/ReferralDetailsPage.js

+    }
+    const contentHeader = translate(`referralProgram.${contentType}.header`);
+    const contentBody = translate(`referralProgram.${contentType}.body`);
+    const generatedURL = `${CONST.REFERRAL_PROGRAM.LINK}/?thanks=${account && account.primaryLogin}`;


This lacks character escaping!

Also, could be extracted to a separate function, at least

you would like to have a separate function for generatedURL?

What do you mean by this: "This lacks character escaping!"?

you would like to have a separate function for generatedURL?

I think this would be slightly more readable.

What do you mean by this: "This lacks character escaping!"?

Well, this wasn't phrased accurately. We're not talking about character escaping, but rather URL encoding.

You can't just concatenate a URL prefix with an arbitrary string, as some characters in that arbitrary string may be special characters in the URL format. + is just an example. It's a valid character in e-mail, while in an URL it represents a space.

Character escaping is a solution to a similar problem in some languages/data formats, for example in "foo\"bar", the inner " is escaped.

Okay, get it.
Something like this should work:

function generateURL(email) { const baseURL = `${CONST.REFERRAL_PROGRAM.LINK}/?thanks=`; const encodedEmail = encodeURIComponent(email); const generatedURL = baseURL + encodedEmail; return generatedURL; } function generateURL(email) { return `${CONST.REFERRAL_PROGRAM.LINK}/?thanks=${encodeURIComponent(email)}`; }

Yeah, that will do. The second option is fine. 👍

While I know it's only a single expression, it's quite different functionally from the surrounding code; that's why I'd extract it.

Updated @cubuspl42

dubielzyk-expensify · 2023-11-15T00:38:02Z

Can I see a mobile recording of how the keyboard slides away when you click the referral banner?

Love the change to a check when you click copy code. Well done!

waterim · 2023-11-15T14:57:48Z

Screen.Recording.2023-11-15.at.15.54.37.mov

@dubielzyk-expensify

dubielzyk-expensify · 2023-11-15T22:52:51Z

Sorry for my bad explanation. Can you add a recording of where you click the "Refer a friend, get $250" banner? Basically what you have in the video, just tap the banner as well so I can see how the keyboard hides. Then if you can click back from the screen you go to so we can see how that works as well.

jamesdeanexpensify · 2023-11-15T22:59:16Z

Also, can you add a period to the end "Refer a friend, get $250." to see how it looks? Thank you!

puneetlath

Looks great. Just a few small comments.

src/CONST.ts

src/components/OptionsSelector/BaseOptionsSelector.js

src/pages/ReferralDetailsPage.js

waterim · 2023-11-16T19:28:47Z

@dubielzyk-expensify Here is a video, sorry for a bid delay in response

Screen.Recording.2023-11-16.at.20.27.49.mov

waterim · 2023-11-16T19:38:06Z

@puneetlath Updated all your comments

jamesdeanexpensify · 2023-11-16T19:41:30Z

Watching this video, I wonder if it's worth a discussion in Slack @dubielzyk-expensify @puneetlath on how much space the "Refer a friend, get $250" text takes up when you click into the search field. Any strong opinions there?

puneetlath · 2023-11-16T20:47:43Z

I think it looks good. @dubielzyk-expensify feel free to merge if you are good with the video.

@jamesdeanexpensify I say we try it and we can update the behavior if we think it's a problem after experiencing it for a bit.

jamesdeanexpensify · 2023-11-16T22:07:57Z

Sounds good to me!

dubielzyk-expensify · 2023-11-17T05:41:17Z

I'm good with the video (looks great), but I'll let someone else merge it 😂

OSBotify · 2023-11-17T14:05:35Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

situchan · 2023-11-19T02:22:30Z

src/languages/en.ts

+            buttonText1: 'Request money, ',
+            buttonText2: `get $${CONST.REFERRAL_PROGRAM.REVENUE}.`,
+            header: `Request money, get $${CONST.REFERRAL_PROGRAM.REVENUE}`,
+            body: `Request money from a new Expensify account. Get  $${CONST.REFERRAL_PROGRAM.REVENUE} once they start an annual subscription with two or more active members and make the first two payments toward their Expensify bill.`,


Suggested change

body: `Request money from a new Expensify account. Get $${CONST.REFERRAL_PROGRAM.REVENUE} once they start an annual subscription with two or more active members and make the first two payments toward their Expensify bill.`,

body: `Request money from a new Expensify account. Get $${CONST.REFERRAL_PROGRAM.REVENUE} once they start an annual subscription with two or more active members and make the first two payments toward their Expensify bill.`,

Anyone can raise quick fix for this typo?

OSBotify · 2023-11-22T00:49:18Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.1-13 🚀

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

luacmartins · 2023-11-23T18:01:42Z

Just FYI that this PR had this issue. We didn't add a fallback route to Navigation.goBack as mentioned in the navigation guidelines so both deeplinking and refreshing the page broke navigation for RHP

Since you can deeplink to different pages inside the RHP navigator, it is important to provide the possibility for the user to properly navigate back from any page with UP press (HeaderWithBackButton component).

An example can be deeplinking to /settings/profile/personal-details. From there, when pressing the UP button, you should navigate to /settings/profile, so in order for it to work, you should provide the correct route in onBackButtonPress prop of HeaderWithBackButton (Navigation.goBack(ROUTES.SETTINGS_PROFILE) in this example).

perunt · 2023-12-04T13:05:32Z

src/components/OptionsSelector/BaseOptionsSelector.js

@@ -180,6 +197,10 @@ class BaseOptionsSelector extends Component {
        this.props.onChangeText(value);
    }

+    handleReferralModal() {


Hey there! I'm refactoring this whole component and curious about its purpose. It looks like we never call it.

c3024 · 2024-03-01T14:27:07Z

src/pages/SearchPage.js

@@ -203,6 +203,8 @@ class SearchPage extends Component {
                                textInputAlert={
                                    this.props.network.isOffline ? `${this.props.translate('common.youAppearToBeOffline')} ${this.props.translate('search.resultsAreLimited')}` : ''
                                }
+                                shouldShowReferralCTA


When this was added ScreenWrapper should have passed the prop enableMaxHeight. Without that the banner stays behind the on screen keyboard on mWeb causing the issue #35182

situchan · 2024-03-11T16:43:25Z

src/pages/ReferralDetailsPage.js

+        >
+            <HeaderWithBackButton
+                title={translate('common.referral')}
+                onBackButtonPress={() => Navigation.goBack()}


Coming from #31866:
Deep link case should have been considered on back button press. Not simply Navigation.goBack()

waterim added 7 commits October 25, 2023 19:49

refferal page basic view and structure

a0d616c

refactor

5d8e987

adjustments

f7e6269

updated translations

c710e20

Merge remote-tracking branch 'upstream/main' into feat-29881-Promote-…

3bcbb6e

…referral-program

new lint rules fixes

69e34d9

lint

6317b7b

waterim marked this pull request as ready for review October 30, 2023 17:49

waterim requested a review from a team as a code owner October 30, 2023 17:49

melvin-bot bot requested review from cubuspl42 and dubielzyk-expensify and removed request for a team October 30, 2023 17:49

VickyStash reviewed Oct 30, 2023

View reviewed changes

src/libs/ReferralProgramUtils.js Outdated Show resolved Hide resolved

waterim added 2 commits October 30, 2023 19:00

removed unused file

db4946e

fix

00740d2

adjustments

60e0e49

dubielzyk-expensify previously approved these changes Nov 2, 2023

View reviewed changes

puneetlath reviewed Nov 3, 2023

View reviewed changes

src/CONST.ts Outdated Show resolved Hide resolved

puneetlath reviewed Nov 3, 2023

View reviewed changes

src/ROUTES.ts Outdated Show resolved Hide resolved

puneetlath reviewed Nov 3, 2023

View reviewed changes

src/pages/NewChatPage.js Outdated Show resolved Hide resolved

puneetlath reviewed Nov 3, 2023

View reviewed changes

src/components/OptionsSelector/BaseOptionsSelector.js Outdated Show resolved Hide resolved

cubuspl42 reviewed Nov 3, 2023

View reviewed changes

src/pages/ReferralDetailsPage.js Outdated Show resolved Hide resolved

cubuspl42 reviewed Nov 14, 2023

View reviewed changes

update generateURL function

da040d1

cubuspl42 approved these changes Nov 16, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath November 16, 2023 09:11

puneetlath requested changes Nov 16, 2023

View reviewed changes

changes

92829fc

fix lint

c1be188

puneetlath approved these changes Nov 16, 2023

View reviewed changes

puneetlath merged commit c8d3aef into Expensify:main Nov 17, 2023
15 checks passed

situchan reviewed Nov 19, 2023

View reviewed changes

situchan mentioned this pull request Nov 20, 2023

[HOLD for payment 2023-12-07] [$500] Request money get $250 not formatted correctly #31554

Closed

6 tasks

os-botify bot mentioned this pull request Nov 20, 2023

Deploy Checklist: New Expensify 2023-11-20 #31556

Closed

90 tasks

luacmartins mentioned this pull request Nov 23, 2023

[$500] [HOLD for payment 2023-11-30] Web - Referral - 'Got it' button does not take you back to the Previous page after a reload #31628

Closed

6 tasks

perunt reviewed Dec 4, 2023

View reviewed changes

c3024 reviewed Mar 1, 2024

View reviewed changes

c3024 mentioned this pull request Mar 1, 2024

[HOLD for payment March 4th][HOLD for payment 2024-02-15] [$500] Search - "Invite a friend" banner do not move up when input field is focused in search page #35182

Closed

6 tasks

situchan reviewed Mar 11, 2024

View reviewed changes

	body: `Request money from a new Expensify account. Get $${CONST.REFERRAL_PROGRAM.REVENUE} once they start an annual subscription with two or more active members and make the first two payments toward their Expensify bill.`,
	body: `Request money from a new Expensify account. Get $${CONST.REFERRAL_PROGRAM.REVENUE} once they start an annual subscription with two or more active members and make the first two payments toward their Expensify bill.`,

Feature : Added Promote referral program messaging to OptionsSelector component #30372

Feature : Added Promote referral program messaging to OptionsSelector component #30372

Conversation

waterim commented Oct 25, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

melvin-bot bot commented Oct 30, 2023

dubielzyk-expensify commented Oct 31, 2023

dubielzyk-expensify commented Nov 1, 2023

waterim commented Nov 2, 2023

waterim commented Nov 2, 2023

waterim commented Nov 2, 2023

dubielzyk-expensify left a comment

Choose a reason for hiding this comment

puneetlath commented Nov 3, 2023

cubuspl42 commented Nov 3, 2023

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

waterim Nov 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dubielzyk-expensify commented Nov 15, 2023

waterim commented Nov 15, 2023

dubielzyk-expensify commented Nov 15, 2023

jamesdeanexpensify commented Nov 15, 2023

puneetlath left a comment

Choose a reason for hiding this comment

waterim commented Nov 16, 2023

waterim commented Nov 16, 2023

jamesdeanexpensify commented Nov 16, 2023

puneetlath commented Nov 16, 2023

jamesdeanexpensify commented Nov 16, 2023

dubielzyk-expensify commented Nov 17, 2023

OSBotify commented Nov 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Nov 22, 2023

luacmartins commented Nov 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

waterim commented Oct 25, 2023 •

edited

Loading

waterim Nov 14, 2023 •

edited

Loading