Feat: Add Billable Toggle UI by waterim · Pull Request #27172 · Expensify/App

waterim · 2023-09-11T16:34:18Z

Details

This PR is about to add Billable toggle to money request.
To test please insert this to App.js with your policyID you are testing:

    window.Onyx.merge(`policy_${YOUR_ID}`, {
        disabledFields: {
            defaultBillable: false,
            reimbursable: false,
        },
        defaultBillable: false,
    });

Fixed Issues

$ #26128
PROPOSAL: #26128 (comment)

Tests

Login to the app
Click "+" dropdown
Click on "Request money"
Type any number
Click "Next"
Select any email workspace
Click "Show more"
Look at the toggler
Default state of the toggle should have based on a policy's settings set in OldDot
After we refresh page, selected toggle should remain

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

None

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.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…-toggle-ui

melvin-bot · 2023-09-13T11:47:15Z

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

waterim · 2023-09-13T11:48:00Z

Just have one stupid question, do I need to send "defaultBillable" or another name?
@amyevans

amyevans · 2023-09-13T14:01:23Z

@waterim Do you mean when sending to the API? Let's use billable

Edit: also just to clarify, the API hasn't been updated yet to accept the param, so you won't be able to test end-to-end

waterim · 2023-09-13T14:02:47Z

@amyevans Okay, will change it, thank you

puneetlath · 2023-09-13T16:24:22Z

@waterim looks like you're missing screenshots/videos.

0xmiroslav · 2023-09-13T16:26:19Z

Does this require any permission for testing?

0xmiroslav · 2023-09-13T16:26:47Z

only users in the beta will have the data

I see this in linked issue

puneetlath · 2023-09-13T16:29:48Z

Right now I don't think it's tied to any beta, but this also isn't being sent by the back-end yet, so you'll need to add the fields in Onyx like @waterim recommended in the OP.

@amyevans should this be under the tags beta? Or is it fine to just have it as-is.

amyevans · 2023-09-13T16:40:36Z

We should put it under the tags beta since we're trying to work incrementally so it's not a complete feature yet (and thus we don't want contributors reporting "bugs"). @waterim can you adjust your PR to check for the tags beta before displaying any UI?

waterim · 2023-09-13T16:44:27Z

@amyevans Sorry, thats because of the conflicts resolve, will change today evening

puneetlath · 2023-09-14T00:23:46Z

@waterim just to make sure we're on the same page. You'll want to add the canUseTags check that we added here: https://github.com/Expensify/App/pull/26954/files

If the user has the permission, then we'll want to show the billable toggle.

waterim · 2023-09-14T12:01:43Z

@puneetlath ready for review

Updated screenshots, added beta for tags and changed defaultBillable to billable for an API

…-toggle-ui

waterim · 2023-09-14T12:07:51Z

@0xmiroslav done

0xmiroslav · 2023-09-14T12:32:24Z

                            disabled={didConfirm || props.isReadOnly}
                        />
                    )}
+                    {canUseTags && !lodashGet(props.policy, 'disabledFields.defaultBillable', true) && (


To confirm: billable toggle is only for expense request (workspace) right? Not applicable to IOU request (DM, group)?

As I understand yes
@amyevans to be sure

Yes, that's correct.

Yes, correct. An IOU request doesn't have an associated policy ID so the field is never going to show for one, which is intended.

Whoops I was too slow. Thanks Puneet 😄

Also to confirm that this uses same newDotTags beta permission?

0xmiroslav · 2023-09-14T12:53:50Z

toggle setting doesn't persist after app refresh, while works on other fields

Screen.Recording.2023-09-14.at.2.52.42.PM.mov

waterim · 2023-09-14T19:45:29Z

@0xmiroslav Updated my solution, removed state, now after refresh it takes data from onyx(as all other fields), but after reset(for example go out from the request) it will be updated with default data from policy as it should be.

0xmiroslav · 2023-09-15T17:05:45Z

        if (policyExpenseChat) {
            Policy.openDraftWorkspaceRequest(policyExpenseChat.policyID);
        }
+        if (typeof props.iou.defaultBillable !== 'boolean') IOU.setMoneyRequestDefaultBillable(lodashGet(props.policy, 'defaultBillable', false));


Suggested change

if (typeof props.iou.defaultBillable !== 'boolean') IOU.setMoneyRequestDefaultBillable(lodashGet(props.policy, 'defaultBillable', false));

if (typeof props.iou.defaultBillable !== 'boolean') {

IOU.setMoneyRequestDefaultBillable(lodashGet(props.policy, 'defaultBillable', false));

}

+1 to the code style request, and also please add a comment explaining why we're doing this

0xmiroslav · 2023-09-15T17:21:04Z

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 / Chrome
- iOS / native
- iOS / 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(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 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 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

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

0xmiroslav

LGTM!

Left minor feedback but NAB

amyevans

A few small comments! Also, the Tests section and QA section need updating. For QA, let's say "None" because we're still behind a beta and don't want deploy blockers created for any failures. For tests:

Login to the app
Click "+" dropdown
Click on "Request money"
Type any number
Click "Next"
Select any ~~email~~ workspace
Click "Show more"
Look at the toggler
Please describe what default state the toggle should have based on a policy's settings set in OldDot
Please describe what should happen if you refresh the page

amyevans · 2023-09-17T13:12:10Z

        if (policyExpenseChat) {
            Policy.openDraftWorkspaceRequest(policyExpenseChat.policyID);
        }
+        if (typeof props.iou.defaultBillable !== 'boolean') IOU.setMoneyRequestDefaultBillable(lodashGet(props.policy, 'defaultBillable', false));


+1 to the code style request, and also please add a comment explaining why we're doing this

waterim · 2023-09-18T11:21:19Z

Resolved @amyevans

amyevans

Just 1 super minor update, then we can

amyevans

Awesome 😎

OSBotify · 2023-09-18T13:29:59Z

✋ 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 · 2023-09-20T08:46:36Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.72-0 🚀

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

OSBotify · 2023-09-22T13:28:31Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.72-11 🚀

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

s77rt · 2023-09-25T21:04:24Z

+    withOnyx({
+        policy: {
+            key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY}${report.policyID}`,
+        },
+    }),


This caused a regression #28182. The report object may be undefined and accessing the policyID on an undefined crashes the app.

tgolen · 2023-10-10T19:54:58Z

+                            <Switch
+                                accessibilityLabel={translate('common.billable')}
+                                isOn={props.iouIsBillable}
+                                onToggle={props.onToggleBillable}


It appears this was never added to the propType definitions. Can you please add it?

In progress here: #29327

Thanks for flagging!

ishpaul777 · 2024-07-16T18:00:51Z

+                            <Switch
+                                accessibilityLabel={translate('common.billable')}
+                                isOn={props.iouIsBillable}
+                                onToggle={props.onToggleBillable}


Here we missed to disable switch its readonly, caused #43756

waterim and others added 2 commits September 11, 2023 18:30

added swtich, styles

a0cf731

Merge branch 'main' into feat-26128-billable-toggle-ui

7d2954f

koko57 reviewed Sep 13, 2023

View reviewed changes

Comment thread src/components/MoneyRequestConfirmationList.js Outdated

thiagobrez reviewed Sep 13, 2023

View reviewed changes

Comment thread src/components/MoneyRequestConfirmationList.js Outdated

thiagobrez reviewed Sep 13, 2023

View reviewed changes

Comment thread src/pages/iou/steps/MoneyRequestConfirmPage.js Outdated

waterim added 3 commits September 13, 2023 12:58

added onyx, added to IOU

df03d58

Merge remote-tracking branch 'upstream/main' into feat-26128-billable…

8e62499

…-toggle-ui

adj

f1ace02

rezkiy37 reviewed Sep 13, 2023

View reviewed changes

Comment thread src/pages/iou/steps/MoneyRequestConfirmPage.js Outdated

adjustments, lint fixes

a084124

waterim marked this pull request as ready for review September 13, 2023 11:47

waterim requested a review from a team as a code owner September 13, 2023 11:47

melvin-bot Bot requested review from 0xmiroslav and removed request for a team September 13, 2023 11:47

Merge branch 'main' into feat-26128-billable-toggle-ui

bd88a13

position fix

230c5e3

waterim added 2 commits September 14, 2023 12:40

tags beta

f91c45d

change defaultBillable to billable for an API

007833c

Merge remote-tracking branch 'upstream/main' into feat-26128-billable…

5eead90

…-toggle-ui

0xmiroslav reviewed Sep 14, 2023

View reviewed changes

removed state

99f286a

0xmiroslav reviewed Sep 15, 2023

View reviewed changes

Comment thread src/libs/actions/IOU.js Outdated

change defaultBillable to null

1f3f062

0xmiroslav reviewed Sep 15, 2023

View reviewed changes

0xmiroslav approved these changes Sep 15, 2023

View reviewed changes

melvin-bot Bot requested a review from amyevans September 15, 2023 17:21

amyevans requested changes Sep 17, 2023

View reviewed changes

defaultBillable name to billable

fdaa194

lint fix

7b3a137

amyevans reviewed Sep 18, 2023

View reviewed changes

Comment thread src/libs/actions/IOU.js Outdated

billable to [billable]

caf0cf6

amyevans approved these changes Sep 18, 2023

View reviewed changes

amyevans merged commit 9b302c9 into Expensify:main Sep 18, 2023

OSBotify mentioned this pull request Sep 20, 2023

Deploy Checklist: New Expensify 2023-09-20 #27837

Closed

amyevans mentioned this pull request Sep 21, 2023

[HOLD for payment 2023-10-23] [HOLD for payment 2023-10-23] [HOLD for payment 2023-09-29] [Wave 6: Tags] CRITICAL - Billable Toggle UI #26128

Closed

s77rt reviewed Sep 25, 2023

View reviewed changes

s77rt mentioned this pull request Sep 25, 2023

[HOLD for payment 2023-10-09] [$500] Request Money - App crashes when invalid id entered in the url while requesting money #28182

Closed

6 tasks

tgolen reviewed Oct 10, 2023

View reviewed changes

ishpaul777 reviewed Jul 16, 2024

View reviewed changes

ishpaul777 mentioned this pull request Jul 16, 2024

[HOLD for payment 2024-07-31] [$250] Billable - Billable toggle should have a locked icon in split details view #43756

Closed

6 tasks

Uh oh!

Conversation

waterim commented Sep 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

melvin-bot Bot commented Sep 13, 2023

Uh oh!

waterim commented Sep 13, 2023

Uh oh!

amyevans commented Sep 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

waterim commented Sep 13, 2023

Uh oh!

puneetlath commented Sep 13, 2023

Uh oh!

0xmiroslav commented Sep 13, 2023

Uh oh!

0xmiroslav commented Sep 13, 2023

Uh oh!

puneetlath commented Sep 13, 2023

Uh oh!

amyevans commented Sep 13, 2023

Uh oh!

waterim commented Sep 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

puneetlath commented Sep 14, 2023

Uh oh!

waterim commented Sep 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

waterim commented Sep 14, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

waterim Sep 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xmiroslav commented Sep 14, 2023

Uh oh!

waterim commented Sep 14, 2023

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xmiroslav commented Sep 15, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

0xmiroslav left a comment

Choose a reason for hiding this comment

Uh oh!

amyevans left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

waterim commented Sep 11, 2023 •

edited

Loading

amyevans commented Sep 13, 2023 •

edited

Loading

waterim commented Sep 13, 2023 •

edited

Loading

waterim commented Sep 14, 2023 •

edited

Loading

waterim Sep 14, 2023 •

edited

Loading